GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-20285: Improve help docs for object by csabella · Pull Request #4759 · python/cpython

bpo-20285: Improve help docs for object #4759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csabella merged 7 commits into python:master from csabella:bpo20285
May 24, 2019

Uh oh!

There was an error while loading. Please reload this page.
Merged

bpo-20285: Improve help docs for object #4759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c6e7fe9
bpo-20285: Improve help docs for object
csabella Dec 9, 2017
6ea9419
Requested changes.
csabella Dec 22, 2017
5b4d0e6
Merge remote-tracking branch 'upstream/master' into pr_4759
terryjreedy Feb 2, 2018
cc58380
Modify news.
terryjreedy Feb 2, 2018
6abc7f3
Improve docstring for object
csabella Feb 12, 2018
fce40fe
Merge branch 'bpo20285' of github.com:csabella/cpython into bpo20285
csabella Feb 12, 2018
51b59fd
Merge remote-tracking branch 'origin/master' into pr_4759
terryjreedy May 24, 2019
File filter
Filter by extension
Clear filters
Conversations
Failed to load comments.
Loading

Uh oh!

There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading

Uh oh!

There was an error while loading. Please reload this page.
Diff view
Diff view

There are no files selected for viewing

4 changes: 2 additions & 2 deletions 4 Lib/pydoc.py
Show comments
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -867,7 +867,7 @@ def spilldata(msg, attrs, predicate):
thisclass = attrs[0][2]
attrs, inherited = _split_list(attrs, lambda t: t[2] is thisclass)

if thisclass is builtins.object:
if object is not builtins.object and thisclass is builtins.object:
Comment thread Outdated

@serhiy-storchaka serhiy-storchaka Dec 9, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of this change?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@terryjreedy terryjreedy Dec 9, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The have help(object) print the methods defined on object, the same as it does for every other class.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@csabella csabella Dec 9, 2017

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One confusing thing about this module is that the argument that the docs are being created for is named is object. So, for this PR, object both can refer to the name of the argument and the class called object.

thisclass is the third value (index 2) in the sequence returned from inspect.classify_class_attrs(object), which is defined as "The class which defined this attribute" (from the docstring). When the value of the class is object, the current if statement if thisclass is builtins.object: results in that attribute being skipped from the output.

The change is to skip the logic when the argument value is not builtins.object so that the attributes will be displayed when help(object) is used. Without this change, all of the attributes are skipped because "The class which defined this attribute" is always object.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
attrs = inherited
continue
elif thisclass is object:
Expand Down Expand Up @@ -1327,7 +1327,7 @@ def spilldata(msg, attrs, predicate):
thisclass = attrs[0][2]
attrs, inherited = _split_list(attrs, lambda t: t[2] is thisclass)

if thisclass is builtins.object:
if object is not builtins.object and thisclass is builtins.object:
attrs = inherited
continue
elif thisclass is object:
Expand Down
3 changes: 3 additions & 0 deletions 3 Misc/NEWS.d/next/Documentation/2017-12-08-20-30-37.bpo-20285.cfnp0J.rst
Show comments
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Expand object.__doc__ (docstring) to make it clearer.
Modify pydoc.py so that help(object) lists object methods
(for other classes, help omits methods of the object base class.)
7 changes: 6 additions & 1 deletion 7 Objects/typeobject.c
Show comments
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4750,6 +4750,11 @@ static PyMethodDef object_methods[] = {
{0}
};

PyDoc_STRVAR(object_doc,
"object()\n--\n\n"
"The base class of the class hierarchy.\n\n"
"When called, it accepts no arguments and returns a new featureless\n"
"instance that has no instance attributes and cannot be given any.\n");

PyTypeObject PyBaseObject_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
Expand All @@ -4772,7 +4777,7 @@ PyTypeObject PyBaseObject_Type = {
PyObject_GenericSetAttr, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
PyDoc_STR("object()\n--\n\nThe most base type"), /* tp_doc */
object_doc, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
object_richcompare, /* tp_richcompare */
Expand Down
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.