Skip to content

Commit

Permalink
pythonGH-65961: Document the deprecation of __package__ and `__cach…
Browse files Browse the repository at this point in the history
…ed__` (pythonGH-124377)

The code changes for warning related to `__package__` landed in Python 3.12. `__cached__` doesn't have any changes as it isn't used but only set by the import system.
(cherry picked from commit 67201ad)

Co-authored-by: Brett Cannon <brett@python.org>
  • Loading branch information
brettcannon authored and miss-islington committed Sep 23, 2024
1 parent 6364c46 commit 6d39315
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 5 deletions.
3 changes: 0 additions & 3 deletions Doc/deprecations/pending-removal-in-3.14.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ Pending Removal in Python 3.14
* :mod:`email`: Deprecated the *isdst* parameter in :func:`email.utils.localtime`.
(Contributed by Alan Williams in :gh:`72346`.)

* :mod:`importlib`: ``__package__`` and ``__cached__`` will cease to be set or
taken into consideration by the import system (:gh:`97879`).

* :mod:`importlib.abc` deprecated classes:

* :class:`!importlib.abc.ResourceReader`
Expand Down
3 changes: 3 additions & 0 deletions Doc/deprecations/pending-removal-in-3.15.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Pending Removal in Python 3.15
* The :option:`!--cgi` flag to the :program:`python -m http.server`
command-line interface has been deprecated since Python 3.13.

* :mod:`importlib`: ``__package__`` and ``__cached__`` will cease to be set or
taken into consideration by the import system (:gh:`97879`).

* :class:`locale`:

* The :func:`~locale.getdefaultlocale` function
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/importlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1237,8 +1237,8 @@ find and load modules.
.. attribute:: has_location

``True`` if the spec's :attr:`origin` refers to a loadable location,
``False`` otherwise. This value impacts how :attr:`origin` is interpreted
and how the module's :attr:`__file__` is populated.
``False`` otherwise. This value impacts how :attr:`origin` is interpreted
and how the module's :attr:`__file__` is populated.


.. class:: AppleFrameworkLoader(name, path)
Expand Down
8 changes: 8 additions & 0 deletions Doc/reference/import.rst
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,10 @@ listed below.
Raise :exc:`DeprecationWarning` instead of :exc:`ImportWarning`
when falling back to ``__package__``.

.. deprecated-removed:: 3.13 3.15
``__package__`` will cease to be set or taken into consideration
by the import system or standard library.


.. attribute:: __spec__

Expand Down Expand Up @@ -653,6 +657,10 @@ listed below.
It is **strongly** recommended that you rely on :attr:`__spec__`
instead of ``__cached__``.

.. deprecated-removed:: 3.13 3.15
``__cached__`` will cease to be set or taken into consideration
by the import system or standard library.

.. _package-path-rules:

module.__path__
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Deprecate the setting and using ``__package__`` and ``__cached__``.

0 comments on commit 6d39315

Please sign in to comment.