Skip to content

gh-97959: [pydoc] now help() does not show extra notes for classmethods#98120

Closed
sobolevn wants to merge 3 commits intopython:mainfrom
sobolevn:issue-97959
Closed

gh-97959: [pydoc] now help() does not show extra notes for classmethods#98120
sobolevn wants to merge 3 commits intopython:mainfrom
sobolevn:issue-97959

Conversation

@sobolevn
Copy link
Member

@sobolevn sobolevn commented Oct 9, 2022 •
edited
Loading

Demo:

>>> class A:
...    @classmethod
...    def some(cls):
...       pass
... 
>>> help(A)

Before:

Help on class A in module __main__:

class A(builtins.object)
 |  Class methods defined here:
 |
 |  some() from builtins.type
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables (if defined)
 |
 |  __weakref__
 |      list of weak references to the object (if defined)

After:

Help on class A in module __main__:

class A(builtins.object)
 |  Class methods defined here:
 |
 |  some()
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables (if defined)
 |
 |  __weakref__
 |      list of weak references to the object (if defined)

Note that other use-cases for from note are still supported, I've added MethodType test case especially for that.

@sobolevn
Copy link
Member Author

sobolevn commented Oct 9, 2022

I am not sure about the enum case:

   |  Methods inherited from enum.EnumType:
   |
-  |  __contains__(value)
+  |  __contains__(value) from enum.EnumType
   |      Return True if `value` is in `cls`.

This needs some more work.

@sobolevn sobolevn mentioned this pull request Nov 7, 2022
Closed
@ethanfurman
Copy link
Member

ethanfurman commented Dec 8, 2022

I am not sure about the enum case:

   |  Methods inherited from enum.EnumType:
   |
-  |  __contains__(value)
+  |  __contains__(value) from enum.EnumType
   |      Return True if `value` is in `cls`.

Showing from enum.EnumType is accurate, and seems like a good thing.

@sobolevn sobolevn mentioned this pull request Mar 15, 2023
Merged
@serhiy-storchaka serhiy-storchaka mentioned this pull request Feb 4, 2024
Merged
@serhiy-storchaka
Copy link
Member

serhiy-storchaka commented Feb 11, 2024

More fundamental #113941 supersedes this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

Assignees

No one assigned

Labels

awaiting review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sobolevn @ethanfurman @serhiy-storchaka @bedevere-bot @JelleZijlstra