bpo-35181: Correct importlib documentation for some module attributes #15190

geryogam · 2019-08-09T08:29:55Z

@ericsnowcurrently This PR will change the following:

In the library documentation importlib.rst:

module.__package__ can be module.__name__ for packages;
spec.parent can be spec.__name__ for packages;
spec.loader is not None for namespaces packages.

In the language documentation import.rst:

spec.loader is not None for namespace packages.

https://bugs.python.org/issue35181

Automerge-Triggered-By: GH:warsaw

aeros

Thanks for the PR. The title should be changed to something a bit more descriptive so that the core devs know which top-level module it involves without having to look at the PR itself. I would advise something along the lines of "Update importlib documentation for module attributes".

I have a few suggestions:

Doc/library/importlib.rst

geryogam · 2019-08-10T22:04:22Z

@aeros167 Thank you for the suggestions. I have updated the PR title. As for your other suggestions, I am fine with them but I would like to have @ericsnowcurrently's opinion before applying them.

aeros · 2019-08-21T03:47:50Z

Since this PR is involving documentation corrections and does not add any new sections, I'll add a skip news label. If you'd like to include one, I can remove it though.

geryogam · 2019-09-11T15:25:04Z

@ericsnowcurrently What do you think of @aeros167 suggested changes?

Co-authored-by: Kyle Stanley <[email protected]>

See comments in place above. Thank you for the requested changes, but I think this PR is good now. Using Dismiss review was the only way I could see to avoid this blocking the PR.

miss-islington · 2020-10-21T19:03:34Z

@maggyero: Status check is done, and it's a failure ❌ .

warsaw · 2020-10-21T19:09:29Z

I'll check out this branch locally and repair the build failures.

miss-islington · 2020-10-21T20:53:55Z

@maggyero: Status check is done, and it's a success ✅ .

miss-islington · 2020-10-21T20:53:58Z

Sorry, I can't merge this PR. Reason: 2 of 4 required status checks are expected..

miss-islington · 2020-10-21T21:00:06Z

@maggyero: Status check is done, and it's a success ✅ .

miss-islington · 2020-10-21T21:00:07Z

@maggyero: Status check is done, and it's a success ✅ .

miss-islington · 2020-10-21T21:00:07Z

Sorry, I can't merge this PR. Reason: 2 of 4 required status checks are expected..

miss-islington · 2020-10-21T21:00:08Z

Sorry, I can't merge this PR. Reason: 2 of 4 required status checks are expected..

miss-islington · 2020-10-21T21:10:39Z

@maggyero: Status check is done, and it's a failure ❌ .

miss-islington · 2020-10-21T21:17:35Z

@maggyero: Status check is done, and it's a success ✅ .

miss-islington · 2020-10-21T21:17:39Z

Thanks @maggyero for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

@ericsnowcurrently

…pythonGH-15190) @ericsnowcurrently This PR will change the following: In the library documentation importlib.rst: - `module.__package__` can be `module.__name__` for packages; - `spec.parent` can be `spec.__name__` for packages; - `spec.loader` is not `None` for namespaces packages. In the language documentation import.rst: - `spec.loader` is not `None` for namespace packages. Automerge-Triggered-By: GH:warsaw (cherry picked from commit 27f1bd8) Co-authored-by: Géry Ogam <[email protected]>

bedevere-bot · 2020-10-21T21:17:51Z

GH-22872 is a backport of this pull request to the 3.9 branch.

@ericsnowcurrently

…pythonGH-15190) @ericsnowcurrently This PR will change the following: In the library documentation importlib.rst: - `module.__package__` can be `module.__name__` for packages; - `spec.parent` can be `spec.__name__` for packages; - `spec.loader` is not `None` for namespaces packages. In the language documentation import.rst: - `spec.loader` is not `None` for namespace packages. Automerge-Triggered-By: GH:warsaw (cherry picked from commit 27f1bd8) Co-authored-by: Géry Ogam <[email protected]>

bedevere-bot · 2020-10-21T21:17:59Z

GH-22873 is a backport of this pull request to the 3.8 branch.

@ericsnowcurrently

…GH-15190) @ericsnowcurrently This PR will change the following: In the library documentation importlib.rst: - `module.__package__` can be `module.__name__` for packages; - `spec.parent` can be `spec.__name__` for packages; - `spec.loader` is not `None` for namespaces packages. In the language documentation import.rst: - `spec.loader` is not `None` for namespace packages. Automerge-Triggered-By: GH:warsaw (cherry picked from commit 27f1bd8) Co-authored-by: Géry Ogam <[email protected]>

@ericsnowcurrently

…GH-15190) @ericsnowcurrently This PR will change the following: In the library documentation importlib.rst: - `module.__package__` can be `module.__name__` for packages; - `spec.parent` can be `spec.__name__` for packages; - `spec.loader` is not `None` for namespaces packages. In the language documentation import.rst: - `spec.loader` is not `None` for namespace packages. Automerge-Triggered-By: GH:warsaw (cherry picked from commit 27f1bd8) Co-authored-by: Géry Ogam <[email protected]>

@ericsnowcurrently

…pythonGH-15190) @ericsnowcurrently This PR will change the following: In the library documentation importlib.rst: - `module.__package__` can be `module.__name__` for packages; - `spec.parent` can be `spec.__name__` for packages; - `spec.loader` is not `None` for namespaces packages. In the language documentation import.rst: - `spec.loader` is not `None` for namespace packages. Automerge-Triggered-By: GH:warsaw

Update importlib.rst

f3be051

the-knights-who-say-ni added the CLA signed label Aug 9, 2019

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 9, 2019

Update import.rst

ed4c2e0

geryogam marked this pull request as ready for review August 9, 2019 10:13

geryogam mentioned this pull request Aug 9, 2019

bpo-37800: Clean up importlib documentation for some module attributes #10016

Merged

geryogam changed the title ~~bpo-35181: Correct some module attribute descriptions in the documentation~~ bpo-35181: Correct the documentation on some module attributes Aug 9, 2019

ericsnowcurrently self-requested a review August 9, 2019 15:04

aeros previously requested changes Aug 10, 2019

View reviewed changes

Doc/library/importlib.rst Show resolved Hide resolved

Doc/library/importlib.rst Show resolved Hide resolved

Doc/library/importlib.rst Outdated Show resolved Hide resolved

Doc/library/importlib.rst Outdated Show resolved Hide resolved

bedevere-bot added awaiting core review and removed awaiting review labels Aug 10, 2019

geryogam changed the title ~~bpo-35181: Correct the documentation on some module attributes~~ bpo-35181: Correct importlib library and import language documentation for some module attributes Aug 10, 2019

geryogam changed the title ~~bpo-35181: Correct importlib library and import language documentation for some module attributes~~ bpo-35181: Correct importlib documentation for some module attributes Aug 10, 2019

aeros added the skip news label Aug 21, 2019

warsaw and others added 2 commits October 21, 2020 11:39

Use a term link instead of a class link

583eb62

Co-authored-by: Kyle Stanley <[email protected]>

Add a term link for "Finders"

3c10dfb

Co-authored-by: Kyle Stanley <[email protected]>

warsaw requested a review from aeros October 21, 2020 18:41

Merge branch 'master' into patch-7

aa85e74

warsaw approved these changes Oct 21, 2020

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Oct 21, 2020

warsaw added needs backport to 3.8 needs backport to 3.9 only security fixes labels Oct 21, 2020

warsaw added the 🤖 automerge label Oct 21, 2020

Fix the reference for the "loader" term

6bd63be

Fix trailing whitespace

8f6192a

miss-islington merged commit 27f1bd8 into python:master Oct 21, 2020

bedevere-bot removed the awaiting merge label Oct 21, 2020

bedevere-bot removed the needs backport to 3.9 only security fixes label Oct 21, 2020

bedevere-bot removed the needs backport to 3.8 label Oct 21, 2020

warsaw mentioned this pull request Apr 27, 2022

Doc: Namespace Packages: Inconsistent documentation of __loader__ being None #79362

Closed

Uh oh!

bpo-35181: Correct importlib documentation for some module attributes #15190

bpo-35181: Correct importlib documentation for some module attributes #15190

Uh oh!

Conversation

geryogam commented Aug 9, 2019 • edited by miss-islington Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aeros left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

geryogam commented Aug 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aeros commented Aug 21, 2019

Uh oh!

geryogam commented Sep 11, 2019

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

warsaw commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

miss-islington commented Oct 21, 2020

Uh oh!

bedevere-bot commented Oct 21, 2020

Uh oh!

bedevere-bot commented Oct 21, 2020

Uh oh!

Uh oh!

geryogam commented Aug 9, 2019 •

edited by miss-islington

Loading

aeros left a comment •

edited

Loading

geryogam commented Aug 10, 2019 •

edited

Loading