Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 6 additions & 7 deletions 13 Doc/library/importlib.resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,12 @@ for example, a package and its resources can be imported from a zip file using

.. versionadded:: 3.9

.. versionchanged:: 3.12
*package* parameter was renamed to *anchor*. *anchor* can now
be a non-package module and if omitted will default to the caller's
module. *package* is still accepted for compatibility but will raise
a :exc:`DeprecationWarning`. Consider passing the anchor positionally or
using ``importlib_resources >= 5.10`` for a compatible interface
on older Pythons.
.. deprecated-removed:: 3.12 3.15
*package* parameter was renamed to *anchor*. *anchor* can now be a
non-package module and if omitted will default to the caller's module.
*package* is no longer accepted since Python 3.15. Consider passing the
anchor positionally or using ``importlib_resources >= 5.10`` for a
compatible interface on older Pythons.

.. function:: as_file(traversable)

Expand Down
34 changes: 0 additions & 34 deletions 34 Lib/importlib/resources/_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import types
import importlib
import inspect
import warnings
import itertools

from typing import Union, Optional, cast
Expand All @@ -16,39 +15,6 @@
Anchor = Package


def package_to_anchor(func):
"""
Replace 'package' parameter as 'anchor' and warn about the change.

Other errors should fall through.

>>> files('a', 'b')
Traceback (most recent call last):
TypeError: files() takes from 0 to 1 positional arguments but 2 were given

Remove this compatibility in Python 3.14.
"""
undefined = object()

@functools.wraps(func)
def wrapper(anchor=undefined, package=undefined):
if package is not undefined:
if anchor is not undefined:
return func(anchor, package)
warnings.warn(
"First parameter to files is renamed to 'anchor'",
DeprecationWarning,
stacklevel=2,
)
return func(package)
elif anchor is undefined:
return func()
return func(anchor)

return wrapper


@package_to_anchor
def files(anchor: Optional[Anchor] = None) -> Traversable:
"""
Get a Traversable resource for an anchor.
Expand Down
8 changes: 0 additions & 8 deletions 8 Lib/test/test_importlib/resources/test_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,6 @@ def test_joinpath_with_multiple_args(self):
binfile = files.joinpath('subdirectory', 'binary.file')
self.assertTrue(binfile.is_file())

def test_old_parameter(self):
"""
Files used to take a 'package' parameter. Make sure anyone
passing by name is still supported.
"""
with suppress_known_deprecation():
resources.files(package=self.data)


class OpenDiskTests(FilesTests, util.DiskSetup, unittest.TestCase):
pass
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Remove compatibility shim for deprecated parameter *package* in
:func:`importlib.resources.files`. Patch by Semyon Moroz.
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.