Skip to content

Doc: update term "namespace package" #129251

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
merged 6 commits into from
Feb 14, 2025
Merged

Doc: update term "namespace package" #129251

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5215bae
Doc: update term "namespace package"
methane Jan 24, 2025
16d5407
Apply suggestions from code review
methane Jan 24, 2025
64f6e73
Update Doc/glossary.rst
methane Jan 25, 2025
c33cc85
simplify
methane Feb 14, 2025
b6b4c09
Merge remote-tracking branch 'upstream/main' into doc-namespace-package
methane Feb 14, 2025
4e47450
Merge branch 'main' into doc-namespace-package
merwok Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions Doc/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,11 +936,17 @@ Glossary
modules, respectively.

namespace package
A :pep:`420` :term:`package` which serves only as a container for
subpackages. Namespace packages may have no physical representation,
A :term:`package` which serves only as a container for subpackages.
Namespace packages may have no physical representation,
and specifically are not like a :term:`regular package` because they
have no ``__init__.py`` file.

Namespace packages allow you to split single package across multiple directories or distributions.
On the other hand, namespace packages have some drawbacks and pitfalls.
Use :term:`regular package` always when it fits your needs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Use :term:`regular package` always when it fits your needs.
It is recommended to use a :term:`regular package` when possible.

Copy link
Member Author

Choose a reason for hiding this comment

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

Does "When possible" and "fits your needs" have same nuance?

For example, user who are thinking splitting their packages to two distribution, but it is "possible" to keep releasing one distribution.

In this case, regular package is not fits their need, but it is possible to use regular package.

Copy link
Member

Choose a reason for hiding this comment

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

The suggested edit makes text less direct, which is the style wanted for our docs.

Copy link
Member

Choose a reason for hiding this comment

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

But I think the wording should be improved. «always» seems strong but is weakened by «when it fits your needs» – people may not now if they do need to split a project!

Also, «across multiple directories» is talking about source trees but «across multiple distributions» is a concern for packaging and installation, so they’re not on the same level.

I’ll think on this and suggest edits!

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, it is friendlier

Copy link
Member

Choose a reason for hiding this comment

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

You misunderstand – I meant that the previous wording was more direct, which is what we want. «It is recommended» is not an improvement.

Copy link
Contributor

Choose a reason for hiding this comment

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

For context, @StanFromIreland, Open telemetry is an example of a namespace package.

I recommend removing "On the other hand ... your needs." This is a glossary entry so the prose should be brief and direct. I think if you add @methane's suggestion Namespace packages allow several individually installable packages to have a common parent package., then there is no need for the two sentences and they can be removed.


For more information, see :pep:`420` and :ref:`reference-namespace-package`.

See also :term:`module`.

nested scope
Expand Down
2 changes: 2 additions & 0 deletions Doc/reference/import.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ Importing ``parent.one`` will implicitly execute ``parent/__init__.py`` and
``parent/three/__init__.py`` respectively.


.. _reference-namespace-package:

Namespace packages
------------------

Expand Down
Loading