From d287ff504d37b54a5aa78d3f570586e765519527 Mon Sep 17 00:00:00 2001 From: Inada Naoki Date: Sat, 15 Feb 2025 03:47:54 +0900 Subject: [PATCH] Doc: update term "namespace package" (GH-129251) (cherry picked from commit e65e9f90626a4c62da4d3500044f354b51e51dbb) Co-authored-by: Inada Naoki --- Doc/glossary.rst | 9 +++++++-- Doc/reference/import.rst | 2 ++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index be8201ef41941f..f57f00b0ae133c 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -873,11 +873,16 @@ 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 several individually installable packages to have a common parent package. + Otherwise, it is recommended to use a :term:`regular package`. + + For more information, see :pep:`420` and :ref:`reference-namespace-package`. + See also :term:`module`. nested scope diff --git a/Doc/reference/import.rst b/Doc/reference/import.rst index ac363e8cfa00dc..26a8b2d9c7187e 100644 --- a/Doc/reference/import.rst +++ b/Doc/reference/import.rst @@ -123,6 +123,8 @@ Importing ``parent.one`` will implicitly execute ``parent/__init__.py`` and ``parent/three/__init__.py`` respectively. +.. _reference-namespace-package: + Namespace packages ------------------