Skip to content

Remove dead link to pkg_resources #2002

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

Open
woodruffw wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove dead link to pkg_resources #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
307f8b1
Remove dead link to pkg_resources
woodruffw Feb 10, 2026
b26e2c4
Remove more dead references
woodruffw Feb 10, 2026
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
4 changes: 0 additions & 4 deletions source/guides/multi-version-installs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,3 @@ time, but that approach does mean that standard command line invocations of
the affected tools can't be used - it's necessary to write a custom
wrapper script or use ``python3 -c '<command>'`` to invoke the application's
main entry point directly.

Refer to the `pkg_resources documentation
<https://setuptools.readthedocs.io/en/latest/pkg_resources.html#workingset-objects>`__
for more details.
14 changes: 9 additions & 5 deletions source/guides/packaging-namespace-packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,16 @@ the `native namespace package example project`_.
Legacy namespace packages
-------------------------

.. warning::

The information in this section is obsolete and is no longer functional
(as of Setuptools 82.0.0). It is only retained for historical reference.
Copy link
Member

@ncoghlan ncoghlan Feb 23, 2026

Choose a reason for hiding this comment

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

This warning is misplaced - it should be down in the pkg_resources subsection.

pkgutil based legacy namespace packages have no connection to setuptools, they rely solely on the standard library (and we don't have any plans to break them that I'm aware of).


``pkg_resources`` has been deprecated and was fully removed in Setuptools 82.0.0.

These two methods, that were used to create namespace packages prior to :pep:`420`,
are now considered to be obsolete and should not be used unless you need compatibility
with packages already using this method. Also, :doc:`pkg_resources <setuptools:pkg_resources>`
has been deprecated.
with packages already using this method.
Copy link
Member

@ncoghlan ncoghlan Feb 23, 2026

Choose a reason for hiding this comment

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

Suggested change
with packages already using this method.
with packages already using one of these methods.


To migrate an existing package, all packages sharing the namespace must be migrated simultaneously.

Expand Down Expand Up @@ -216,7 +222,7 @@ in the `pkgutil namespace example project`_.
pkg_resources-style namespace packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

:doc:`Setuptools <setuptools:index>` provides the `pkg_resources.declare_namespace`_ function and
:doc:`Setuptools <setuptools:index>` previously provided the ``pkg_resources.declare_namespace`` function and
the ``namespace_packages`` argument to :func:`~setuptools.setup`. Together
these can be used to declare namespace packages. While this approach is no
Copy link
Member

@ncoghlan ncoghlan Feb 23, 2026

Choose a reason for hiding this comment

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

Suggested change
these can be used to declare namespace packages. While this approach is no
these could be used to declare namespace packages. While this approach is no

longer recommended, it is widely present in most existing namespace packages.
Copy link
Member

@ncoghlan ncoghlan Feb 23, 2026

Choose a reason for hiding this comment

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

Suggested change
longer recommended, it is widely present in most existing namespace packages.
longer supported, it may still be encountered in environments using older `setuptools` versions.

Expand Down Expand Up @@ -285,7 +291,5 @@ to :func:`~setuptools.setup` in :file:`setup.py`. For example:
A complete working example of two pkg_resources-style namespace packages can be found
in the `pkg_resources namespace example project`_.

Comment on lines 291 to 293
Copy link
Member

@ncoghlan ncoghlan Feb 23, 2026

Choose a reason for hiding this comment

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

Suggested change
A complete working example of two pkg_resources-style namespace packages can be found
in the `pkg_resources namespace example project`_.

We shouldn't link to an example that no longer works.

.. _pkg_resources.declare_namespace:
https://setuptools.readthedocs.io/en/latest/pkg_resources.html#namespace-package-support
.. _pkg_resources namespace example project:
https://github.com/pypa/sample-namespace-packages/tree/master/pkg_resources
Comment on lines 294 to 295
Copy link
Member

@ncoghlan ncoghlan Feb 23, 2026

Choose a reason for hiding this comment

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

Suggested change
.. _pkg_resources namespace example project:
https://github.com/pypa/sample-namespace-packages/tree/master/pkg_resources