pypa / pypa/setuptools

[Docs] Clarity on transition for `pkg_resources.declare_namespace`

Open
#4,073 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Summary

I'm trying to work out how to remove uses of:

import pkg_resources
pkg_resources.declare_namespace(__name__)

Now that pkg_resources is deprecated.

There is a docs section on this:

https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#pkg-resource-style-namespace-package

Which suggests the following snippet:

__import__("pkg_resources").declare_namespace(__name__)

Won't this also not work because pkg_resources is deprecated?

OS / Environment

No response

Additional Information

na

Code of Conduct
  • I agree to follow the PSF Code of Conduct

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the package discovery documentation section on “pkg_resources-style namespace packages” and compare its recommended snippet with the deprecation concern in the issue. Check whether the documented transition remains valid, then update or clarify that documentation so the guidance addresses the use of pkg_resources.declare_namespace.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.