././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/0000755000175100001710000000000000000000000014726 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.coveragerc0000644000175100001710000000022600000000000017047 0ustar00runnerdocker[run] omit = # leading `*/` for pytest-dev/pytest-cov#456 */.tox/* tests/* prepare/* */_itertools.py exercises.py [report] show_missing = True ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.editorconfig0000644000175100001710000000030300000000000017377 0ustar00runnerdockerroot = true [*] charset = utf-8 indent_style = tab indent_size = 4 insert_final_newline = true end_of_line = lf [*.py] indent_style = space [*.{yml,yaml}] indent_style = space indent_size = 2 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.flake80000644000175100001710000000023700000000000016103 0ustar00runnerdocker[flake8] max-line-length = 88 # jaraco/skeleton#34 max-complexity = 10 extend-ignore = # Black creates whitespace before colon E203 enable-extensions = U4 ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/.github/0000755000175100001710000000000000000000000016266 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.github/dependabot.yml0000644000175100001710000000022400000000000021114 0ustar00runnerdockerversion: 2 updates: - package-ecosystem: "pip" directory: "/" schedule: interval: "daily" allow: - dependency-type: "all" ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/.github/workflows/0000755000175100001710000000000000000000000020323 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.github/workflows/main.yml0000644000175100001710000000270000000000000021771 0ustar00runnerdockername: tests on: [push, pull_request] jobs: test: strategy: matrix: python: - 3.6 - 3.9 - 3.10.0-alpha - 3.10.99 platform: [ubuntu-latest, macos-latest, windows-latest] runs-on: ${{ matrix.platform }} steps: - uses: actions/checkout@v2 - name: Setup Python uses: actions/setup-python@v2 with: python-version: ${{ matrix.python }} - name: Install tox run: | python -m pip install tox - name: Run tests run: tox diffcov: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 with: fetch-depth: 0 - name: Setup Python uses: actions/setup-python@v2 with: python-version: 3.9 - name: Install tox run: | python -m pip install tox - name: Evaluate coverage run: tox env: TOXENV: diffcov release: needs: test if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Setup Python uses: actions/setup-python@v2 with: python-version: 3.9 - name: Install tox run: | python -m pip install tox - name: Release run: tox -e release env: TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.gitignore0000644000175100001710000000023200000000000016713 0ustar00runnerdockerbuild /coverage.xml /diffcov.html htmlcov importlib_metadata.egg-info .mypy_cache /.coverage /.DS_Store artifacts .eggs .doctrees dist pip-wheel-metadata ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.pre-commit-config.yaml0000644000175100001710000000012100000000000021201 0ustar00runnerdockerrepos: - repo: https://github.com/psf/black rev: 20.8b1 hooks: - id: black ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/.readthedocs.yml0000644000175100001710000000011700000000000020013 0ustar00runnerdockerversion: 2 python: install: - path: . extra_requirements: - docs ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/CHANGES.rst0000644000175100001710000004012700000000000016534 0ustar00runnerdockerv4.6.4 ====== * #334: Correct ``SimplePath`` protocol to match ``pathlib`` protocol for ``__truediv__``. v4.6.3 ====== * Moved workaround for #327 to ``_compat`` module. v4.6.2 ====== * bpo-44784: Avoid errors in test suite when DeprecationWarnings are treated as errors. v4.6.1 ====== * #327: Deprecation warnings now honor call stack variance on PyPy. v4.6.0 ====== * #326: Performance tests now rely on `pytest-perf `_. To disable these tests, which require network access and a git checkout, pass ``-p no:perf`` to pytest. v4.5.0 ====== * #319: Remove ``SelectableGroups`` deprecation exception for flake8. v4.4.0 ====== * #300: Restore compatibility in the result from ``Distribution.entry_points`` (``EntryPoints``) to honor expectations in older implementations and issuing deprecation warnings for these cases: - ``EntryPoints`` objects are once again mutable, allowing for ``sort()`` and other list-based mutation operations. Avoid deprecation warnings by casting to a mutable sequence (e.g. ``list(dist.entry_points).sort()``). - ``EntryPoints`` results once again allow for access by index. To avoid deprecation warnings, cast the result to a Sequence first (e.g. ``tuple(dist.entry_points)[0]``). v4.3.1 ====== * #320: Fix issue where normalized name for eggs was incorrectly solicited, leading to metadata being unavailable for eggs. v4.3.0 ====== * #317: De-duplication of distributions no longer requires loading the full metadata for ``PathDistribution`` objects, entry point loading performance by ~10x. v4.2.0 ====== * Prefer f-strings to ``.format`` calls. v4.1.0 ====== * #312: Add support for metadata 2.2 (``Dynamic`` field). * #315: Add ``SimplePath`` protocol for interface clarity in ``PathDistribution``. v4.0.1 ====== * #306: Clearer guidance about compatibility in readme. v4.0.0 ====== * #304: ``PackageMetadata`` as returned by ``metadata()`` and ``Distribution.metadata()`` now provides normalized metadata honoring PEP 566: - If a long description is provided in the payload of the RFC 822 value, it can be retrieved as the ``Description`` field. - Any multi-line values in the metadata will be returned as such. - For any multi-line values, line continuation characters are removed. This backward-incompatible change means that any projects relying on the RFC 822 line continuation characters being present must be tolerant to them having been removed. - Add a ``json`` property that provides the metadata converted to a JSON-compatible form per PEP 566. v3.10.1 ======= * Minor tweaks from CPython. v3.10.0 ======= * #295: Internal refactoring to unify section parsing logic. v3.9.1 ====== * #296: Exclude 'prepare' package. * #297: Fix ValueError when entry points contains comments. v3.9.0 ====== * Use of Mapping (dict) interfaces on ``SelectableGroups`` is now flagged as deprecated. Instead, users are advised to use the select interface for future compatibility. Suppress the warning with this filter: ``ignore:SelectableGroups dict interface``. Or with this invocation in the Python environment: ``warnings.filterwarnings('ignore', 'SelectableGroups dict interface')``. Preferably, switch to the ``select`` interface introduced in 3.7.0. See the `entry points documentation `_ and changelog for the 3.6 release below for more detail. For some use-cases, especially those that rely on ``importlib.metadata`` in Python 3.8 and 3.9 or those relying on older ``importlib_metadata`` (especially on Python 3.5 and earlier), `backports.entry_points_selectable `_ was created to ease the transition. Please have a look at that project if simply relying on importlib_metadata 3.6+ is not straightforward. Background in #298. * #283: Entry point parsing no longer relies on ConfigParser and instead uses a custom, one-pass parser to load the config, resulting in a ~20% performance improvement when loading entry points. v3.8.2 ====== * #293: Re-enabled lazy evaluation of path lookup through a FreezableDefaultDict. v3.8.1 ====== * #293: Workaround for error in distribution search. v3.8.0 ====== * #290: Add mtime-based caching for ``FastPath`` and its lookups, dramatically increasing performance for repeated distribution lookups. v3.7.3 ====== * Docs enhancements and cleanup following review in `GH-24782 `_. v3.7.2 ====== * Cleaned up cruft in entry_points docstring. v3.7.1 ====== * Internal refactoring to facilitate ``entry_points() -> dict`` deprecation. v3.7.0 ====== * #131: Added ``packages_distributions`` to conveniently resolve a top-level package or module to its distribution(s). v3.6.0 ====== * #284: Introduces new ``EntryPoints`` object, a tuple of ``EntryPoint`` objects but with convenience properties for selecting and inspecting the results: - ``.select()`` accepts ``group`` or ``name`` keyword parameters and returns a new ``EntryPoints`` tuple with only those that match the selection. - ``.groups`` property presents all of the group names. - ``.names`` property presents the names of the entry points. - Item access (e.g. ``eps[name]``) retrieves a single entry point by name. ``entry_points`` now accepts "selection parameters", same as ``EntryPoint.select()``. ``entry_points()`` now provides a future-compatible ``SelectableGroups`` object that supplies the above interface (except item access) but remains a dict for compatibility. In the future, ``entry_points()`` will return an ``EntryPoints`` object for all entry points. If passing selection parameters to ``entry_points``, the future behavior is invoked and an ``EntryPoints`` is the result. * #284: Construction of entry points using ``dict([EntryPoint, ...])`` is now deprecated and raises an appropriate DeprecationWarning and will be removed in a future version. * #300: ``Distribution.entry_points`` now presents as an ``EntryPoints`` object and access by index is no longer allowed. If access by index is required, cast to a sequence first. v3.5.0 ====== * #280: ``entry_points`` now only returns entry points for unique distributions (by name). v3.4.0 ====== * #10: Project now declares itself as being typed. * #272: Additional performance enhancements to distribution discovery. * #111: For PyPA projects, add test ensuring that ``MetadataPathFinder._search_paths`` honors the needed interface. Method is still private. v3.3.0 ====== * #265: ``EntryPoint`` objects now expose a ``.dist`` object referencing the ``Distribution`` when constructed from a Distribution. v3.2.0 ====== * The object returned by ``metadata()`` now has a formally-defined protocol called ``PackageMetadata`` with declared support for the ``.get_all()`` method. Fixes #126. v3.1.1 ====== v2.1.1 ====== * #261: Restored compatibility for package discovery for metadata without version in the name and for legacy eggs. v3.1.0 ====== * Merge with 2.1.0. v2.1.0 ====== * #253: When querying for package metadata, the lookup now honors `package normalization rules `_. v3.0.0 ====== * Require Python 3.6 or later. v2.0.0 ====== * ``importlib_metadata`` no longer presents a ``__version__`` attribute. Consumers wishing to resolve the version of the package should query it directly with ``importlib_metadata.version('importlib-metadata')``. Closes #71. v1.7.0 ====== * ``PathNotFoundError`` now has a custom ``__str__`` mentioning "package metadata" being missing to help guide users to the cause when the package is installed but no metadata is present. Closes #124. v1.6.1 ====== * Added ``Distribution._local()`` as a provisional demonstration of how to load metadata for a local package. Implicitly requires that `pep517 `_ is installed. Ref #42. * Ensure inputs to FastPath are Unicode. Closes #121. * Tests now rely on ``importlib.resources.files`` (and backport) instead of the older ``path`` function. * Support any iterable from ``find_distributions``. Closes #122. v1.6.0 ====== * Added ``module`` and ``attr`` attributes to ``EntryPoint`` v1.5.2 ====== * Fix redundant entries from ``FastPath.zip_children``. Closes #117. v1.5.1 ====== * Improve reliability and consistency of compatibility imports for contextlib and pathlib when running tests. Closes #116. v1.5.0 ====== * Additional performance optimizations in FastPath now saves an additional 20% on a typical call. * Correct for issue where PyOxidizer finder has no ``__module__`` attribute. Closes #110. v1.4.0 ====== * Through careful optimization, ``distribution()`` is 3-4x faster. Thanks to Antony Lee for the contribution. Closes #95. * When searching through ``sys.path``, if any error occurs attempting to list a path entry, that entry is skipped, making the system much more lenient to errors. Closes #94. v1.3.0 ====== * Improve custom finders documentation. Closes #105. v1.2.0 ====== * Once again, drop support for Python 3.4. Ref #104. v1.1.3 ====== * Restored support for Python 3.4 due to improper version compatibility declarations in the v1.1.0 and v1.1.1 releases. Closes #104. v1.1.2 ====== * Repaired project metadata to correctly declare the ``python_requires`` directive. Closes #103. v1.1.1 ====== * Fixed ``repr(EntryPoint)`` on PyPy 3 also. Closes #102. v1.1.0 ====== * Dropped support for Python 3.4. * EntryPoints are now pickleable. Closes #96. * Fixed ``repr(EntryPoint)`` on PyPy 2. Closes #97. v1.0.0 ====== * Project adopts semver for versioning. * Removed compatibility shim introduced in 0.23. * For better compatibility with the stdlib implementation and to avoid the same distributions being discovered by the stdlib and backport implementations, the backport now disables the stdlib DistributionFinder during initialization (import time). Closes #91 and closes #100. 0.23 ==== * Added a compatibility shim to prevent failures on beta releases of Python before the signature changed to accept the "context" parameter on find_distributions. This workaround will have a limited lifespan, not to extend beyond release of Python 3.8 final. 0.22 ==== * Renamed ``package`` parameter to ``distribution_name`` as `recommended `_ in the following functions: ``distribution``, ``metadata``, ``version``, ``files``, and ``requires``. This backward-incompatible change is expected to have little impact as these functions are assumed to be primarily used with positional parameters. 0.21 ==== * ``importlib.metadata`` now exposes the ``DistributionFinder`` metaclass and references it in the docs for extending the search algorithm. * Add ``Distribution.at`` for constructing a Distribution object from a known metadata directory on the file system. Closes #80. * Distribution finders now receive a context object that supplies ``.path`` and ``.name`` properties. This change introduces a fundamental backward incompatibility for any projects implementing a ``find_distributions`` method on a ``MetaPathFinder``. This new layer of abstraction allows this context to be supplied directly or constructed on demand and opens the opportunity for a ``find_distributions`` method to solicit additional context from the caller. Closes #85. 0.20 ==== * Clarify in the docs that calls to ``.files`` could return ``None`` when the metadata is not present. Closes #69. * Return all requirements and not just the first for dist-info packages. Closes #67. 0.19 ==== * Restrain over-eager egg metadata resolution. * Add support for entry points with colons in the name. Closes #75. 0.18 ==== * Parse entry points case sensitively. Closes #68 * Add a version constraint on the backport configparser package. Closes #66 0.17 ==== * Fix a permission problem in the tests on Windows. 0.16 ==== * Don't crash if there exists an EGG-INFO directory on sys.path. 0.15 ==== * Fix documentation. 0.14 ==== * Removed ``local_distribution`` function from the API. **This backward-incompatible change removes this behavior summarily**. Projects should remove their reliance on this behavior. A replacement behavior is under review in the `pep517 project `_. Closes #42. 0.13 ==== * Update docstrings to match PEP 8. Closes #63. * Merged modules into one module. Closes #62. 0.12 ==== * Add support for eggs. !65; Closes #19. 0.11 ==== * Support generic zip files (not just wheels). Closes #59 * Support zip files with multiple distributions in them. Closes #60 * Fully expose the public API in ``importlib_metadata.__all__``. 0.10 ==== * The ``Distribution`` ABC is now officially part of the public API. Closes #37. * Fixed support for older single file egg-info formats. Closes #43. * Fixed a testing bug when ``$CWD`` has spaces in the path. Closes #50. * Add Python 3.8 to the ``tox`` testing matrix. 0.9 === * Fixed issue where entry points without an attribute would raise an Exception. Closes #40. * Removed unused ``name`` parameter from ``entry_points()``. Closes #44. * ``DistributionFinder`` classes must now be instantiated before being placed on ``sys.meta_path``. 0.8 === * This library can now discover/enumerate all installed packages. **This backward-incompatible change alters the protocol finders must implement to support distribution package discovery.** Closes #24. * The signature of ``find_distributions()`` on custom installer finders should now accept two parameters, ``name`` and ``path`` and these parameters must supply defaults. * The ``entry_points()`` method no longer accepts a package name but instead returns all entry points in a dictionary keyed by the ``EntryPoint.group``. The ``resolve`` method has been removed. Instead, call ``EntryPoint.load()``, which has the same semantics as ``pkg_resources`` and ``entrypoints``. **This is a backward incompatible change.** * Metadata is now always returned as Unicode text regardless of Python version. Closes #29. * This library can now discover metadata for a 'local' package (found in the current-working directory). Closes #27. * Added ``files()`` function for resolving files from a distribution. * Added a new ``requires()`` function, which returns the requirements for a package suitable for parsing by ``packaging.requirements.Requirement``. Closes #18. * The top-level ``read_text()`` function has been removed. Use ``PackagePath.read_text()`` on instances returned by the ``files()`` function. **This is a backward incompatible change.** * Release dates are now automatically injected into the changelog based on SCM tags. 0.7 === * Fixed issue where packages with dashes in their names would not be discovered. Closes #21. * Distribution lookup is now case-insensitive. Closes #20. * Wheel distributions can no longer be discovered by their module name. Like Path distributions, they must be indicated by their distribution package name. 0.6 === * Removed ``importlib_metadata.distribution`` function. Now the public interface is primarily the utility functions exposed in ``importlib_metadata.__all__``. Closes #14. * Added two new utility functions ``read_text`` and ``metadata``. 0.5 === * Updated README and removed details about Distribution class, now considered private. Closes #15. * Added test suite support for Python 3.4+. * Fixed SyntaxErrors on Python 3.4 and 3.5. !12 * Fixed errors on Windows joining Path elements. !15 0.4 === * Housekeeping. 0.3 === * Added usage documentation. Closes #8 * Add support for getting metadata from wheels on ``sys.path``. Closes #9 0.2 === * Added ``importlib_metadata.entry_points()``. Closes #1 * Added ``importlib_metadata.resolve()``. Closes #12 * Add support for Python 2.7. Closes #4 0.1 === * Initial release. .. Local Variables: mode: change-log-mode indent-tabs-mode: nil sentence-end-double-space: t fill-column: 78 coding: utf-8 End: ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/LICENSE0000644000175100001710000000107300000000000015734 0ustar00runnerdockerCopyright 2017-2019 Jason R. Coombs, Barry Warsaw Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/PKG-INFO0000644000175100001710000000554600000000000016035 0ustar00runnerdockerMetadata-Version: 2.1 Name: importlib_metadata Version: 4.6.4 Summary: Read metadata from Python packages Home-page: https://github.com/python/importlib_metadata Author: Jason R. Coombs Author-email: jaraco@jaraco.com License: UNKNOWN Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: Apache Software License Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3 :: Only Requires-Python: >=3.6 Provides-Extra: testing Provides-Extra: docs Provides-Extra: perf License-File: LICENSE .. image:: https://img.shields.io/pypi/v/importlib_metadata.svg :target: `PyPI link`_ .. image:: https://img.shields.io/pypi/pyversions/importlib_metadata.svg :target: `PyPI link`_ .. _PyPI link: https://pypi.org/project/importlib_metadata .. image:: https://github.com/python/importlib_metadata/workflows/tests/badge.svg :target: https://github.com/python/importlib_metadata/actions?query=workflow%3A%22tests%22 :alt: tests .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code style: Black .. image:: https://readthedocs.org/projects/importlib-metadata/badge/?version=latest :target: https://importlib-metadata.readthedocs.io/en/latest/?badge=latest .. image:: https://img.shields.io/badge/skeleton-2021-informational :target: https://blog.jaraco.com/skeleton Library to access the metadata for a Python package. This package supplies third-party access to the functionality of `importlib.metadata `_ including improvements added to subsequent Python versions. Compatibility ============= New features are introduced in this third-party library and later merged into CPython. The following table indicates which versions of this library were contributed to different versions in the standard library: .. list-table:: :header-rows: 1 * - importlib_metadata - stdlib * - 4.4 - 3.10 * - 1.4 - 3.8 Usage ===== See the `online documentation `_ for usage details. `Finder authors `_ can also add support for custom package installers. See the above documentation for details. Caveats ======= This project primarily supports third-party packages installed by PyPA tools (or other conforming packages). It does not support: - Packages in the stdlib. - Packages installed without metadata. Project details =============== * Project home: https://github.com/python/importlib_metadata * Report bugs at: https://github.com/python/importlib_metadata/issues * Code hosting: https://github.com/python/importlib_metadata * Documentation: https://importlib_metadata.readthedocs.io/ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/README.rst0000644000175100001710000000435400000000000016423 0ustar00runnerdocker.. image:: https://img.shields.io/pypi/v/importlib_metadata.svg :target: `PyPI link`_ .. image:: https://img.shields.io/pypi/pyversions/importlib_metadata.svg :target: `PyPI link`_ .. _PyPI link: https://pypi.org/project/importlib_metadata .. image:: https://github.com/python/importlib_metadata/workflows/tests/badge.svg :target: https://github.com/python/importlib_metadata/actions?query=workflow%3A%22tests%22 :alt: tests .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code style: Black .. image:: https://readthedocs.org/projects/importlib-metadata/badge/?version=latest :target: https://importlib-metadata.readthedocs.io/en/latest/?badge=latest .. image:: https://img.shields.io/badge/skeleton-2021-informational :target: https://blog.jaraco.com/skeleton Library to access the metadata for a Python package. This package supplies third-party access to the functionality of `importlib.metadata `_ including improvements added to subsequent Python versions. Compatibility ============= New features are introduced in this third-party library and later merged into CPython. The following table indicates which versions of this library were contributed to different versions in the standard library: .. list-table:: :header-rows: 1 * - importlib_metadata - stdlib * - 4.4 - 3.10 * - 1.4 - 3.8 Usage ===== See the `online documentation `_ for usage details. `Finder authors `_ can also add support for custom package installers. See the above documentation for details. Caveats ======= This project primarily supports third-party packages installed by PyPA tools (or other conforming packages). It does not support: - Packages in the stdlib. - Packages installed without metadata. Project details =============== * Project home: https://github.com/python/importlib_metadata * Report bugs at: https://github.com/python/importlib_metadata/issues * Code hosting: https://github.com/python/importlib_metadata * Documentation: https://importlib_metadata.readthedocs.io/ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/conftest.py0000644000175100001710000000123400000000000017125 0ustar00runnerdockerimport sys collect_ignore = [ # this module fails mypy tests because 'setup.py' matches './setup.py' 'prepare/example/setup.py', ] def pytest_configure(): remove_importlib_metadata() def remove_importlib_metadata(): """ Because pytest imports importlib_metadata, the coverage reports are broken (#322). So work around the issue by undoing the changes made by pytest's import of importlib_metadata (if any). """ if sys.meta_path[-1].__class__.__name__ == 'MetadataPathFinder': del sys.meta_path[-1] for mod in list(sys.modules): if mod.startswith('importlib_metadata'): del sys.modules[mod] ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/docs/0000755000175100001710000000000000000000000015656 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/docs/__init__.py0000644000175100001710000000000000000000000017755 0ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/docs/api.rst0000644000175100001710000000030100000000000017153 0ustar00runnerdocker============= API Reference ============= ``importlib_metadata`` module ----------------------------- .. automodule:: importlib_metadata :members: :undoc-members: :show-inheritance: ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/docs/conf.py0000644000175100001710000000240500000000000017156 0ustar00runnerdocker#!/usr/bin/env python3 # -*- coding: utf-8 -*- extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" link_files = { '../CHANGES.rst': dict( using=dict(GH='https://github.com'), replace=[ dict( pattern=r'(Issue #|\B#)(?P\d+)', url='{package_url}/issues/{issue}', ), dict( pattern=r'(?m:^((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n)', with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n', ), dict( pattern=r'PEP[- ](?P\d+)', url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), ], ) } # Be strict about any broken references: nitpicky = True # Support intersphinx links extensions += [ 'sphinx.ext.intersphinx', ] intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), 'importlib_resources': ( 'https://importlib-resources.readthedocs.io/en/latest/', None, ), } # Workaround for #316 nitpick_ignore = [ ('py:class', 'importlib_metadata.EntryPoints'), ('py:class', 'importlib_metadata.SelectableGroups'), ('py:class', 'importlib_metadata._meta._T'), ] ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/docs/history.rst0000644000175100001710000000012100000000000020103 0ustar00runnerdocker:tocdepth: 2 .. _changes: History ******* .. include:: ../CHANGES (links).rst ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/docs/index.rst0000644000175100001710000000354700000000000017530 0ustar00runnerdockerWelcome to |project| documentation! =================================== ``importlib_metadata`` is a library which provides an API for accessing an installed package's metadata (see :pep:`566`), such as its entry points or its top-level name. This functionality intends to replace most uses of ``pkg_resources`` `entry point API`_ and `metadata API`_. Along with :mod:`importlib.resources` in Python 3.7 and newer (backported as :doc:`importlib_resources ` for older versions of Python), this can eliminate the need to use the older and less efficient ``pkg_resources`` package. ``importlib_metadata`` supplies a backport of :doc:`importlib.metadata ` as found in Python 3.8 and later for earlier Python releases. Users of Python 3.8 and beyond are encouraged to use the standard library module when possible and fall back to ``importlib_metadata`` when necessary. When imported on Python 3.8 and later, ``importlib_metadata`` replaces the DistributionFinder behavior from the stdlib, but leaves the API in tact. Developers looking for detailed API descriptions should refer to the Python 3.8 standard library documentation. The documentation here includes a general :ref:`usage ` guide. .. toctree:: :maxdepth: 1 using api history Project details =============== * Project home: https://github.com/python/importlib_metadata * Report bugs at: https://github.com/python/importlib_metadata/issues * Code hosting: https://github.com/python/importlib_metadata * Documentation: https://importlib_metadata.readthedocs.io/ Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _`entry point API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points .. _`metadata API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/docs/using.rst0000644000175100001710000002614700000000000017547 0ustar00runnerdocker.. _using: ================================= Using :mod:`!importlib_metadata` ================================= ``importlib_metadata`` is a library that provides for access to installed package metadata. Built in part on Python's import system, this library intends to replace similar functionality in the `entry point API`_ and `metadata API`_ of ``pkg_resources``. Along with :mod:`importlib.resources` in Python 3.7 and newer (backported as :doc:`importlib_resources ` for older versions of Python), this can eliminate the need to use the older and less efficient ``pkg_resources`` package. By "installed package" we generally mean a third-party package installed into Python's ``site-packages`` directory via tools such as `pip `_. Specifically, it means a package with either a discoverable ``dist-info`` or ``egg-info`` directory, and metadata defined by :pep:`566` or its older specifications. By default, package metadata can live on the file system or in zip archives on :data:`sys.path`. Through an extension mechanism, the metadata can live almost anywhere. Overview ======== Let's say you wanted to get the version string for a package you've installed using ``pip``. We start by creating a virtual environment and installing something into it:: $ python3 -m venv example $ source example/bin/activate (example) $ pip install importlib_metadata (example) $ pip install wheel You can get the version string for ``wheel`` by running the following:: (example) $ python >>> from importlib_metadata import version >>> version('wheel') '0.32.3' You can also get the set of entry points keyed by group, such as ``console_scripts``, ``distutils.commands`` and others. Each group contains a sequence of :ref:`EntryPoint ` objects. You can get the :ref:`metadata for a distribution `:: >>> list(metadata('wheel')) ['Metadata-Version', 'Name', 'Version', 'Summary', 'Home-page', 'Author', 'Author-email', 'Maintainer', 'Maintainer-email', 'License', 'Project-URL', 'Project-URL', 'Project-URL', 'Keywords', 'Platform', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Python', 'Provides-Extra', 'Requires-Dist', 'Requires-Dist'] You can also get a :ref:`distribution's version number `, list its :ref:`constituent files `, and get a list of the distribution's :ref:`requirements`. Functional API ============== This package provides the following functionality via its public API. .. _entry-points: Entry points ------------ The ``entry_points()`` function returns a collection of entry points. Entry points are represented by ``EntryPoint`` instances; each ``EntryPoint`` has a ``.name``, ``.group``, and ``.value`` attributes and a ``.load()`` method to resolve the value. There are also ``.module``, ``.attr``, and ``.extras`` attributes for getting the components of the ``.value`` attribute. Query all entry points:: >>> eps = entry_points() The ``entry_points()`` function returns an ``EntryPoints`` object, a sequence of all ``EntryPoint`` objects with ``names`` and ``groups`` attributes for convenience:: >>> sorted(eps.groups) ['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation'] ``EntryPoints`` has a ``select`` method to select entry points matching specific properties. Select entry points in the ``console_scripts`` group:: >>> scripts = eps.select(group='console_scripts') Equivalently, since ``entry_points`` passes keyword arguments through to select:: >>> scripts = entry_points(group='console_scripts') Pick out a specific script named "wheel" (found in the wheel project):: >>> 'wheel' in scripts.names True >>> wheel = scripts['wheel'] Equivalently, query for that entry point during selection:: >>> (wheel,) = entry_points(group='console_scripts', name='wheel') >>> (wheel,) = entry_points().select(group='console_scripts', name='wheel') Inspect the resolved entry point:: >>> wheel EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts') >>> wheel.module 'wheel.cli' >>> wheel.attr 'main' >>> wheel.extras [] >>> main = wheel.load() >>> main The ``group`` and ``name`` are arbitrary values defined by the package author and usually a client will wish to resolve all entry points for a particular group. Read `the setuptools docs `_ for more information on entry points, their definition, and usage. *Compatibility Note* The "selectable" entry points were introduced in ``importlib_metadata`` 3.6 and Python 3.10. Prior to those changes, ``entry_points`` accepted no parameters and always returned a dictionary of entry points, keyed by group. For compatibility, if no parameters are passed to entry_points, a ``SelectableGroups`` object is returned, implementing that dict interface. In the future, calling ``entry_points`` with no parameters will return an ``EntryPoints`` object. Users should rely on the selection interface to retrieve entry points by group. .. _metadata: Distribution metadata --------------------- Every distribution includes some metadata, which you can extract using the ``metadata()`` function:: >>> wheel_metadata = metadata('wheel') The keys of the returned data structure, a ``PackageMetadata``, name the metadata keywords, and the values are returned unparsed from the distribution metadata:: >>> wheel_metadata['Requires-Python'] '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*' ``PackageMetadata`` also presents a ``json`` attribute that returns all the metadata in a JSON-compatible form per PEP 566:: >>> wheel_metadata.json['requires_python'] '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*' .. _version: Distribution versions --------------------- The ``version()`` function is the quickest way to get a distribution's version number, as a string:: >>> version('wheel') '0.32.3' .. _files: Distribution files ------------------ You can also get the full set of files contained within a distribution. The ``files()`` function takes a distribution package name and returns all of the files installed by this distribution. Each file object returned is a ``PackagePath``, a :class:`pathlib.PurePath` derived object with additional ``dist``, ``size``, and ``hash`` properties as indicated by the metadata. For example:: >>> util = [p for p in files('wheel') if 'util.py' in str(p)][0] >>> util PackagePath('wheel/util.py') >>> util.size 859 >>> util.dist >>> util.hash Once you have the file, you can also read its contents:: >>> print(util.read_text()) import base64 import sys ... def as_bytes(s): if isinstance(s, text_type): return s.encode('utf-8') return s You can also use the ``locate`` method to get a the absolute path to the file:: >>> util.locate() # doctest: +SKIP PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py') In the case where the metadata file listing files (RECORD or SOURCES.txt) is missing, ``files()`` will return ``None``. The caller may wish to wrap calls to ``files()`` in `always_iterable `_ or otherwise guard against this condition if the target distribution is not known to have the metadata present. .. _requirements: Distribution requirements ------------------------- To get the full set of requirements for a distribution, use the ``requires()`` function:: >>> requires('wheel') ["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"] Package distributions --------------------- A convience method to resolve the distribution or distributions (in the case of a namespace package) for top-level Python packages or modules:: >>> packages_distributions() {'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...} Distributions ============= While the above API is the most common and convenient usage, you can get all of that information from the ``Distribution`` class. A ``Distribution`` is an abstract object that represents the metadata for a Python package. You can get the ``Distribution`` instance:: >>> from importlib_metadata import distribution >>> dist = distribution('wheel') Thus, an alternative way to get the version number is through the ``Distribution`` instance:: >>> dist.version '0.32.3' There are all kinds of additional metadata available on the ``Distribution`` instance:: >>> dist.metadata['Requires-Python'] '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*' >>> dist.metadata['License'] 'MIT' The full set of available metadata is not described here. See :pep:`566` for additional details. Extending the search algorithm ============================== Because package metadata is not available through :data:`sys.path` searches, or package loaders directly, the metadata for a package is found through import system `finders`_. To find a distribution package's metadata, ``importlib.metadata`` queries the list of :term:`meta path finders ` on :data:`sys.meta_path`. By default ``importlib_metadata`` installs a finder for distribution packages found on the file system. This finder doesn't actually find any *packages*, but it can find the packages' metadata. The abstract class :py:class:`importlib.abc.MetaPathFinder` defines the interface expected of finders by Python's import system. ``importlib_metadata`` extends this protocol by looking for an optional ``find_distributions`` callable on the finders from :data:`sys.meta_path` and presents this extended interface as the ``DistributionFinder`` abstract base class, which defines this abstract method:: @abc.abstractmethod def find_distributions(context=DistributionFinder.Context()): """Return an iterable of all Distribution instances capable of loading the metadata for packages for the indicated ``context``. """ The ``DistributionFinder.Context`` object provides ``.path`` and ``.name`` properties indicating the path to search and name to match and may supply other relevant context. What this means in practice is that to support finding distribution package metadata in locations other than the file system, subclass ``Distribution`` and implement the abstract methods. Then from a custom finder, return instances of this derived ``Distribution`` in the ``find_distributions()`` method. .. _`entry point API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points .. _`metadata API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api .. _`finders`: https://docs.python.org/3/reference/import.html#finders-and-loaders .. rubric:: Footnotes ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/exercises.py0000644000175100001710000000137000000000000017273 0ustar00runnerdockerfrom pytest_perf.deco import extras @extras('perf') def discovery_perf(): "discovery" import importlib_metadata # end warmup importlib_metadata.distribution('ipython') def entry_points_perf(): "entry_points()" import importlib_metadata # end warmup importlib_metadata.entry_points() @extras('perf') def cached_distribution_perf(): "cached distribution" import importlib_metadata importlib_metadata.distribution('ipython') # end warmup importlib_metadata.distribution('ipython') @extras('perf') def uncached_distribution_perf(): "uncached distribution" import importlib import importlib_metadata # end warmup importlib.invalidate_caches() importlib_metadata.distribution('ipython') ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/importlib_metadata/0000755000175100001710000000000000000000000020567 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/__init__.py0000644000175100001710000007131500000000000022707 0ustar00runnerdockerimport os import re import abc import csv import sys import zipp import email import pathlib import operator import textwrap import warnings import functools import itertools import posixpath import collections from . import _adapters, _meta from ._collections import FreezableDefaultDict, Pair from ._compat import ( NullFinder, PyPy_repr, install, pypy_partial, ) from ._functools import method_cache from ._itertools import unique_everseen from ._meta import PackageMetadata, SimplePath from contextlib import suppress from importlib import import_module from importlib.abc import MetaPathFinder from itertools import starmap from typing import List, Mapping, Optional, Union __all__ = [ 'Distribution', 'DistributionFinder', 'PackageMetadata', 'PackageNotFoundError', 'distribution', 'distributions', 'entry_points', 'files', 'metadata', 'packages_distributions', 'requires', 'version', ] class PackageNotFoundError(ModuleNotFoundError): """The package was not found.""" def __str__(self): return f"No package metadata was found for {self.name}" @property def name(self): (name,) = self.args return name class Sectioned: """ A simple entry point config parser for performance >>> for item in Sectioned.read(Sectioned._sample): ... print(item) Pair(name='sec1', value='# comments ignored') Pair(name='sec1', value='a = 1') Pair(name='sec1', value='b = 2') Pair(name='sec2', value='a = 2') >>> res = Sectioned.section_pairs(Sectioned._sample) >>> item = next(res) >>> item.name 'sec1' >>> item.value Pair(name='a', value='1') >>> item = next(res) >>> item.value Pair(name='b', value='2') >>> item = next(res) >>> item.name 'sec2' >>> item.value Pair(name='a', value='2') >>> list(res) [] """ _sample = textwrap.dedent( """ [sec1] # comments ignored a = 1 b = 2 [sec2] a = 2 """ ).lstrip() @classmethod def section_pairs(cls, text): return ( section._replace(value=Pair.parse(section.value)) for section in cls.read(text, filter_=cls.valid) if section.name is not None ) @staticmethod def read(text, filter_=None): lines = filter(filter_, map(str.strip, text.splitlines())) name = None for value in lines: section_match = value.startswith('[') and value.endswith(']') if section_match: name = value.strip('[]') continue yield Pair(name, value) @staticmethod def valid(line): return line and not line.startswith('#') class EntryPoint( PyPy_repr, collections.namedtuple('EntryPointBase', 'name value group') ): """An entry point as defined by Python packaging conventions. See `the packaging docs on entry points `_ for more information. """ pattern = re.compile( r'(?P[\w.]+)\s*' r'(:\s*(?P[\w.]+))?\s*' r'(?P\[.*\])?\s*$' ) """ A regular expression describing the syntax for an entry point, which might look like: - module - package.module - package.module:attribute - package.module:object.attribute - package.module:attr [extra1, extra2] Other combinations are possible as well. The expression is lenient about whitespace around the ':', following the attr, and following any extras. """ dist: Optional['Distribution'] = None def load(self): """Load the entry point from its definition. If only a module is indicated by the value, return that module. Otherwise, return the named object. """ match = self.pattern.match(self.value) module = import_module(match.group('module')) attrs = filter(None, (match.group('attr') or '').split('.')) return functools.reduce(getattr, attrs, module) @property def module(self): match = self.pattern.match(self.value) return match.group('module') @property def attr(self): match = self.pattern.match(self.value) return match.group('attr') @property def extras(self): match = self.pattern.match(self.value) return list(re.finditer(r'\w+', match.group('extras') or '')) def _for(self, dist): self.dist = dist return self def __iter__(self): """ Supply iter so one may construct dicts of EntryPoints by name. """ msg = ( "Construction of dict of EntryPoints is deprecated in " "favor of EntryPoints." ) warnings.warn(msg, DeprecationWarning) return iter((self.name, self)) def __reduce__(self): return ( self.__class__, (self.name, self.value, self.group), ) def matches(self, **params): attrs = (getattr(self, param) for param in params) return all(map(operator.eq, params.values(), attrs)) class DeprecatedList(list): """ Allow an otherwise immutable object to implement mutability for compatibility. >>> recwarn = getfixture('recwarn') >>> dl = DeprecatedList(range(3)) >>> dl[0] = 1 >>> dl.append(3) >>> del dl[3] >>> dl.reverse() >>> dl.sort() >>> dl.extend([4]) >>> dl.pop(-1) 4 >>> dl.remove(1) >>> dl += [5] >>> dl + [6] [1, 2, 5, 6] >>> dl + (6,) [1, 2, 5, 6] >>> dl.insert(0, 0) >>> dl [0, 1, 2, 5] >>> dl == [0, 1, 2, 5] True >>> dl == (0, 1, 2, 5) True >>> len(recwarn) 1 """ _warn = functools.partial( warnings.warn, "EntryPoints list interface is deprecated. Cast to list if needed.", DeprecationWarning, stacklevel=pypy_partial(2), ) def __setitem__(self, *args, **kwargs): self._warn() return super().__setitem__(*args, **kwargs) def __delitem__(self, *args, **kwargs): self._warn() return super().__delitem__(*args, **kwargs) def append(self, *args, **kwargs): self._warn() return super().append(*args, **kwargs) def reverse(self, *args, **kwargs): self._warn() return super().reverse(*args, **kwargs) def extend(self, *args, **kwargs): self._warn() return super().extend(*args, **kwargs) def pop(self, *args, **kwargs): self._warn() return super().pop(*args, **kwargs) def remove(self, *args, **kwargs): self._warn() return super().remove(*args, **kwargs) def __iadd__(self, *args, **kwargs): self._warn() return super().__iadd__(*args, **kwargs) def __add__(self, other): if not isinstance(other, tuple): self._warn() other = tuple(other) return self.__class__(tuple(self) + other) def insert(self, *args, **kwargs): self._warn() return super().insert(*args, **kwargs) def sort(self, *args, **kwargs): self._warn() return super().sort(*args, **kwargs) def __eq__(self, other): if not isinstance(other, tuple): self._warn() other = tuple(other) return tuple(self).__eq__(other) class EntryPoints(DeprecatedList): """ An immutable collection of selectable EntryPoint objects. """ __slots__ = () def __getitem__(self, name): # -> EntryPoint: """ Get the EntryPoint in self matching name. """ if isinstance(name, int): warnings.warn( "Accessing entry points by index is deprecated. " "Cast to tuple if needed.", DeprecationWarning, stacklevel=2, ) return super().__getitem__(name) try: return next(iter(self.select(name=name))) except StopIteration: raise KeyError(name) def select(self, **params): """ Select entry points from self that match the given parameters (typically group and/or name). """ return EntryPoints(ep for ep in self if ep.matches(**params)) @property def names(self): """ Return the set of all names of all entry points. """ return set(ep.name for ep in self) @property def groups(self): """ Return the set of all groups of all entry points. For coverage while SelectableGroups is present. >>> EntryPoints().groups set() """ return set(ep.group for ep in self) @classmethod def _from_text_for(cls, text, dist): return cls(ep._for(dist) for ep in cls._from_text(text)) @classmethod def _from_text(cls, text): return itertools.starmap(EntryPoint, cls._parse_groups(text or '')) @staticmethod def _parse_groups(text): return ( (item.value.name, item.value.value, item.name) for item in Sectioned.section_pairs(text) ) class Deprecated: """ Compatibility add-in for mapping to indicate that mapping behavior is deprecated. >>> recwarn = getfixture('recwarn') >>> class DeprecatedDict(Deprecated, dict): pass >>> dd = DeprecatedDict(foo='bar') >>> dd.get('baz', None) >>> dd['foo'] 'bar' >>> list(dd) ['foo'] >>> list(dd.keys()) ['foo'] >>> 'foo' in dd True >>> list(dd.values()) ['bar'] >>> len(recwarn) 1 """ _warn = functools.partial( warnings.warn, "SelectableGroups dict interface is deprecated. Use select.", DeprecationWarning, stacklevel=pypy_partial(2), ) def __getitem__(self, name): self._warn() return super().__getitem__(name) def get(self, name, default=None): self._warn() return super().get(name, default) def __iter__(self): self._warn() return super().__iter__() def __contains__(self, *args): self._warn() return super().__contains__(*args) def keys(self): self._warn() return super().keys() def values(self): self._warn() return super().values() class SelectableGroups(Deprecated, dict): """ A backward- and forward-compatible result from entry_points that fully implements the dict interface. """ @classmethod def load(cls, eps): by_group = operator.attrgetter('group') ordered = sorted(eps, key=by_group) grouped = itertools.groupby(ordered, by_group) return cls((group, EntryPoints(eps)) for group, eps in grouped) @property def _all(self): """ Reconstruct a list of all entrypoints from the groups. """ groups = super(Deprecated, self).values() return EntryPoints(itertools.chain.from_iterable(groups)) @property def groups(self): return self._all.groups @property def names(self): """ for coverage: >>> SelectableGroups().names set() """ return self._all.names def select(self, **params): if not params: return self return self._all.select(**params) class PackagePath(pathlib.PurePosixPath): """A reference to a path in a package""" def read_text(self, encoding='utf-8'): with self.locate().open(encoding=encoding) as stream: return stream.read() def read_binary(self): with self.locate().open('rb') as stream: return stream.read() def locate(self): """Return a path-like object for this path""" return self.dist.locate_file(self) class FileHash: def __init__(self, spec): self.mode, _, self.value = spec.partition('=') def __repr__(self): return f'' class Distribution: """A Python distribution package.""" @abc.abstractmethod def read_text(self, filename): """Attempt to load metadata file given by the name. :param filename: The name of the file in the distribution info. :return: The text if found, otherwise None. """ @abc.abstractmethod def locate_file(self, path): """ Given a path to a file in this distribution, return a path to it. """ @classmethod def from_name(cls, name): """Return the Distribution for the given package name. :param name: The name of the distribution package to search for. :return: The Distribution instance (or subclass thereof) for the named package, if found. :raises PackageNotFoundError: When the named package's distribution metadata cannot be found. """ for resolver in cls._discover_resolvers(): dists = resolver(DistributionFinder.Context(name=name)) dist = next(iter(dists), None) if dist is not None: return dist else: raise PackageNotFoundError(name) @classmethod def discover(cls, **kwargs): """Return an iterable of Distribution objects for all packages. Pass a ``context`` or pass keyword arguments for constructing a context. :context: A ``DistributionFinder.Context`` object. :return: Iterable of Distribution objects for all packages. """ context = kwargs.pop('context', None) if context and kwargs: raise ValueError("cannot accept context and kwargs") context = context or DistributionFinder.Context(**kwargs) return itertools.chain.from_iterable( resolver(context) for resolver in cls._discover_resolvers() ) @staticmethod def at(path): """Return a Distribution for the indicated metadata path :param path: a string or path-like object :return: a concrete Distribution instance for the path """ return PathDistribution(pathlib.Path(path)) @staticmethod def _discover_resolvers(): """Search the meta_path for resolvers.""" declared = ( getattr(finder, 'find_distributions', None) for finder in sys.meta_path ) return filter(None, declared) @classmethod def _local(cls, root='.'): from pep517 import build, meta system = build.compat_system(root) builder = functools.partial( meta.build, source_dir=root, system=system, ) return PathDistribution(zipp.Path(meta.build_as_zip(builder))) @property def metadata(self) -> _meta.PackageMetadata: """Return the parsed metadata for this Distribution. The returned object will have keys that name the various bits of metadata. See PEP 566 for details. """ text = ( self.read_text('METADATA') or self.read_text('PKG-INFO') # This last clause is here to support old egg-info files. Its # effect is to just end up using the PathDistribution's self._path # (which points to the egg-info file) attribute unchanged. or self.read_text('') ) return _adapters.Message(email.message_from_string(text)) @property def name(self): """Return the 'Name' metadata for the distribution package.""" return self.metadata['Name'] @property def _normalized_name(self): """Return a normalized version of the name.""" return Prepared.normalize(self.name) @property def version(self): """Return the 'Version' metadata for the distribution package.""" return self.metadata['Version'] @property def entry_points(self): return EntryPoints._from_text_for(self.read_text('entry_points.txt'), self) @property def files(self): """Files in this distribution. :return: List of PackagePath for this distribution or None Result is `None` if the metadata file that enumerates files (i.e. RECORD for dist-info or SOURCES.txt for egg-info) is missing. Result may be empty if the metadata exists but is empty. """ file_lines = self._read_files_distinfo() or self._read_files_egginfo() def make_file(name, hash=None, size_str=None): result = PackagePath(name) result.hash = FileHash(hash) if hash else None result.size = int(size_str) if size_str else None result.dist = self return result return file_lines and list(starmap(make_file, csv.reader(file_lines))) def _read_files_distinfo(self): """ Read the lines of RECORD """ text = self.read_text('RECORD') return text and text.splitlines() def _read_files_egginfo(self): """ SOURCES.txt might contain literal commas, so wrap each line in quotes. """ text = self.read_text('SOURCES.txt') return text and map('"{}"'.format, text.splitlines()) @property def requires(self): """Generated requirements specified for this Distribution""" reqs = self._read_dist_info_reqs() or self._read_egg_info_reqs() return reqs and list(reqs) def _read_dist_info_reqs(self): return self.metadata.get_all('Requires-Dist') def _read_egg_info_reqs(self): source = self.read_text('requires.txt') return source and self._deps_from_requires_text(source) @classmethod def _deps_from_requires_text(cls, source): return cls._convert_egg_info_reqs_to_simple_reqs(Sectioned.read(source)) @staticmethod def _convert_egg_info_reqs_to_simple_reqs(sections): """ Historically, setuptools would solicit and store 'extra' requirements, including those with environment markers, in separate sections. More modern tools expect each dependency to be defined separately, with any relevant extras and environment markers attached directly to that requirement. This method converts the former to the latter. See _test_deps_from_requires_text for an example. """ def make_condition(name): return name and f'extra == "{name}"' def parse_condition(section): section = section or '' extra, sep, markers = section.partition(':') if extra and markers: markers = f'({markers})' conditions = list(filter(None, [markers, make_condition(extra)])) return '; ' + ' and '.join(conditions) if conditions else '' for section in sections: yield section.value + parse_condition(section.name) class DistributionFinder(MetaPathFinder): """ A MetaPathFinder capable of discovering installed distributions. """ class Context: """ Keyword arguments presented by the caller to ``distributions()`` or ``Distribution.discover()`` to narrow the scope of a search for distributions in all DistributionFinders. Each DistributionFinder may expect any parameters and should attempt to honor the canonical parameters defined below when appropriate. """ name = None """ Specific name for which a distribution finder should match. A name of ``None`` matches all distributions. """ def __init__(self, **kwargs): vars(self).update(kwargs) @property def path(self): """ The sequence of directory path that a distribution finder should search. Typically refers to Python installed package paths such as "site-packages" directories and defaults to ``sys.path``. """ return vars(self).get('path', sys.path) @abc.abstractmethod def find_distributions(self, context=Context()): """ Find distributions. Return an iterable of all Distribution instances capable of loading the metadata for packages matching the ``context``, a DistributionFinder.Context instance. """ class FastPath: """ Micro-optimized class for searching a path for children. """ @functools.lru_cache() # type: ignore def __new__(cls, root): return super().__new__(cls) def __init__(self, root): self.root = str(root) def joinpath(self, child): return pathlib.Path(self.root, child) def children(self): with suppress(Exception): return os.listdir(self.root or '') with suppress(Exception): return self.zip_children() return [] def zip_children(self): zip_path = zipp.Path(self.root) names = zip_path.root.namelist() self.joinpath = zip_path.joinpath return dict.fromkeys(child.split(posixpath.sep, 1)[0] for child in names) def search(self, name): return self.lookup(self.mtime).search(name) @property def mtime(self): with suppress(OSError): return os.stat(self.root).st_mtime self.lookup.cache_clear() @method_cache def lookup(self, mtime): return Lookup(self) class Lookup: def __init__(self, path: FastPath): base = os.path.basename(path.root).lower() base_is_egg = base.endswith(".egg") self.infos = FreezableDefaultDict(list) self.eggs = FreezableDefaultDict(list) for child in path.children(): low = child.lower() if low.endswith((".dist-info", ".egg-info")): # rpartition is faster than splitext and suitable for this purpose. name = low.rpartition(".")[0].partition("-")[0] normalized = Prepared.normalize(name) self.infos[normalized].append(path.joinpath(child)) elif base_is_egg and low == "egg-info": name = base.rpartition(".")[0].partition("-")[0] legacy_normalized = Prepared.legacy_normalize(name) self.eggs[legacy_normalized].append(path.joinpath(child)) self.infos.freeze() self.eggs.freeze() def search(self, prepared): infos = ( self.infos[prepared.normalized] if prepared else itertools.chain.from_iterable(self.infos.values()) ) eggs = ( self.eggs[prepared.legacy_normalized] if prepared else itertools.chain.from_iterable(self.eggs.values()) ) return itertools.chain(infos, eggs) class Prepared: """ A prepared search for metadata on a possibly-named package. """ normalized = None legacy_normalized = None def __init__(self, name): self.name = name if name is None: return self.normalized = self.normalize(name) self.legacy_normalized = self.legacy_normalize(name) @staticmethod def normalize(name): """ PEP 503 normalization plus dashes as underscores. """ return re.sub(r"[-_.]+", "-", name).lower().replace('-', '_') @staticmethod def legacy_normalize(name): """ Normalize the package name as found in the convention in older packaging tools versions and specs. """ return name.lower().replace('-', '_') def __bool__(self): return bool(self.name) @install class MetadataPathFinder(NullFinder, DistributionFinder): """A degenerate finder for distribution packages on the file system. This finder supplies only a find_distributions() method for versions of Python that do not have a PathFinder find_distributions(). """ def find_distributions(self, context=DistributionFinder.Context()): """ Find distributions. Return an iterable of all Distribution instances capable of loading the metadata for packages matching ``context.name`` (or all names if ``None`` indicated) along the paths in the list of directories ``context.path``. """ found = self._search_paths(context.name, context.path) return map(PathDistribution, found) @classmethod def _search_paths(cls, name, paths): """Find metadata directories in paths heuristically.""" prepared = Prepared(name) return itertools.chain.from_iterable( path.search(prepared) for path in map(FastPath, paths) ) def invalidate_caches(cls): FastPath.__new__.cache_clear() class PathDistribution(Distribution): def __init__(self, path: SimplePath): """Construct a distribution. :param path: SimplePath indicating the metadata directory. """ self._path = path def read_text(self, filename): with suppress( FileNotFoundError, IsADirectoryError, KeyError, NotADirectoryError, PermissionError, ): return self._path.joinpath(filename).read_text(encoding='utf-8') read_text.__doc__ = Distribution.read_text.__doc__ def locate_file(self, path): return self._path.parent / path @property def _normalized_name(self): """ Performance optimization: where possible, resolve the normalized name from the file system path. """ stem = os.path.basename(str(self._path)) return self._name_from_stem(stem) or super()._normalized_name def _name_from_stem(self, stem): name, ext = os.path.splitext(stem) if ext not in ('.dist-info', '.egg-info'): return name, sep, rest = stem.partition('-') return name def distribution(distribution_name): """Get the ``Distribution`` instance for the named package. :param distribution_name: The name of the distribution package as a string. :return: A ``Distribution`` instance (or subclass thereof). """ return Distribution.from_name(distribution_name) def distributions(**kwargs): """Get all ``Distribution`` instances in the current environment. :return: An iterable of ``Distribution`` instances. """ return Distribution.discover(**kwargs) def metadata(distribution_name) -> _meta.PackageMetadata: """Get the metadata for the named package. :param distribution_name: The name of the distribution package to query. :return: A PackageMetadata containing the parsed metadata. """ return Distribution.from_name(distribution_name).metadata def version(distribution_name): """Get the version string for the named package. :param distribution_name: The name of the distribution package to query. :return: The version string for the package as defined in the package's "Version" metadata key. """ return distribution(distribution_name).version def entry_points(**params) -> Union[EntryPoints, SelectableGroups]: """Return EntryPoint objects for all installed packages. Pass selection parameters (group or name) to filter the result to entry points matching those properties (see EntryPoints.select()). For compatibility, returns ``SelectableGroups`` object unless selection parameters are supplied. In the future, this function will return ``EntryPoints`` instead of ``SelectableGroups`` even when no selection parameters are supplied. For maximum future compatibility, pass selection parameters or invoke ``.select`` with parameters on the result. :return: EntryPoints or SelectableGroups for all installed packages. """ norm_name = operator.attrgetter('_normalized_name') unique = functools.partial(unique_everseen, key=norm_name) eps = itertools.chain.from_iterable( dist.entry_points for dist in unique(distributions()) ) return SelectableGroups.load(eps).select(**params) def files(distribution_name): """Return a list of files for the named package. :param distribution_name: The name of the distribution package to query. :return: List of files composing the distribution. """ return distribution(distribution_name).files def requires(distribution_name): """ Return a list of requirements for the named package. :return: An iterator of requirements, suitable for packaging.requirement.Requirement. """ return distribution(distribution_name).requires def packages_distributions() -> Mapping[str, List[str]]: """ Return a mapping of top-level packages to their distributions. >>> import collections.abc >>> pkgs = packages_distributions() >>> all(isinstance(dist, collections.abc.Sequence) for dist in pkgs.values()) True """ pkg_to_dist = collections.defaultdict(list) for dist in distributions(): for pkg in (dist.read_text('top_level.txt') or '').split(): pkg_to_dist[pkg].append(dist.metadata['Name']) return dict(pkg_to_dist) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_adapters.py0000644000175100001710000000350600000000000023107 0ustar00runnerdockerimport re import textwrap import email.message from ._text import FoldedCase class Message(email.message.Message): multiple_use_keys = set( map( FoldedCase, [ 'Classifier', 'Obsoletes-Dist', 'Platform', 'Project-URL', 'Provides-Dist', 'Provides-Extra', 'Requires-Dist', 'Requires-External', 'Supported-Platform', 'Dynamic', ], ) ) """ Keys that may be indicated multiple times per PEP 566. """ def __new__(cls, orig: email.message.Message): res = super().__new__(cls) vars(res).update(vars(orig)) return res def __init__(self, *args, **kwargs): self._headers = self._repair_headers() # suppress spurious error from mypy def __iter__(self): return super().__iter__() def _repair_headers(self): def redent(value): "Correct for RFC822 indentation" if not value or '\n' not in value: return value return textwrap.dedent(' ' * 8 + value) headers = [(key, redent(value)) for key, value in vars(self)['_headers']] if self._payload: headers.append(('Description', self.get_payload())) return headers @property def json(self): """ Convert PackageMetadata to a JSON-compatible format per PEP 0566. """ def transform(key): value = self.get_all(key) if key in self.multiple_use_keys else self[key] if key == 'Keywords': value = re.split(r'\s+', value) tk = key.lower().replace('-', '_') return tk, value return dict(map(transform, map(FoldedCase, self))) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_collections.py0000644000175100001710000000134700000000000023623 0ustar00runnerdockerimport collections # from jaraco.collections 3.3 class FreezableDefaultDict(collections.defaultdict): """ Often it is desirable to prevent the mutation of a default dict after its initial construction, such as to prevent mutation during iteration. >>> dd = FreezableDefaultDict(list) >>> dd[0].append('1') >>> dd.freeze() >>> dd[1] [] >>> len(dd) 1 """ def __missing__(self, key): return getattr(self, '_frozen', super().__missing__)(key) def freeze(self): self._frozen = lambda key: self.default_factory() class Pair(collections.namedtuple('Pair', 'name value')): @classmethod def parse(cls, text): return cls(*map(str.strip, text.split("=", 1))) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_compat.py0000644000175100001710000000501300000000000022562 0ustar00runnerdockerimport sys import platform __all__ = ['install', 'NullFinder', 'PyPy_repr', 'Protocol'] try: from typing import Protocol except ImportError: # pragma: no cover """ pytest-mypy complains here because: error: Incompatible import of "Protocol" (imported name has type "typing_extensions._SpecialForm", local name has type "typing._SpecialForm") """ from typing_extensions import Protocol # type: ignore def install(cls): """ Class decorator for installation on sys.meta_path. Adds the backport DistributionFinder to sys.meta_path and attempts to disable the finder functionality of the stdlib DistributionFinder. """ sys.meta_path.append(cls()) disable_stdlib_finder() return cls def disable_stdlib_finder(): """ Give the backport primacy for discovering path-based distributions by monkey-patching the stdlib O_O. See #91 for more background for rationale on this sketchy behavior. """ def matches(finder): return getattr( finder, '__module__', None ) == '_frozen_importlib_external' and hasattr(finder, 'find_distributions') for finder in filter(matches, sys.meta_path): # pragma: nocover del finder.find_distributions class NullFinder: """ A "Finder" (aka "MetaClassFinder") that never finds any modules, but may find distributions. """ @staticmethod def find_spec(*args, **kwargs): return None # In Python 2, the import system requires finders # to have a find_module() method, but this usage # is deprecated in Python 3 in favor of find_spec(). # For the purposes of this finder (i.e. being present # on sys.meta_path but having no other import # system functionality), the two methods are identical. find_module = find_spec class PyPy_repr: """ Override repr for EntryPoint objects on PyPy to avoid __iter__ access. Ref #97, #102. """ affected = hasattr(sys, 'pypy_version_info') def __compat_repr__(self): # pragma: nocover def make_param(name): value = getattr(self, name) return f'{name}={value!r}' params = ', '.join(map(make_param, self._fields)) return f'EntryPoint({params})' if affected: # pragma: nocover __repr__ = __compat_repr__ del affected def pypy_partial(val): """ Adjust for variable stacklevel on partial under PyPy. Workaround for #327. """ is_pypy = platform.python_implementation() == 'PyPy' return val + is_pypy ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_functools.py0000644000175100001710000000470500000000000023322 0ustar00runnerdockerimport types import functools # from jaraco.functools 3.3 def method_cache(method, cache_wrapper=None): """ Wrap lru_cache to support storing the cache data in the object instances. Abstracts the common paradigm where the method explicitly saves an underscore-prefixed protected property on first call and returns that subsequently. >>> class MyClass: ... calls = 0 ... ... @method_cache ... def method(self, value): ... self.calls += 1 ... return value >>> a = MyClass() >>> a.method(3) 3 >>> for x in range(75): ... res = a.method(x) >>> a.calls 75 Note that the apparent behavior will be exactly like that of lru_cache except that the cache is stored on each instance, so values in one instance will not flush values from another, and when an instance is deleted, so are the cached values for that instance. >>> b = MyClass() >>> for x in range(35): ... res = b.method(x) >>> b.calls 35 >>> a.method(0) 0 >>> a.calls 75 Note that if method had been decorated with ``functools.lru_cache()``, a.calls would have been 76 (due to the cached value of 0 having been flushed by the 'b' instance). Clear the cache with ``.cache_clear()`` >>> a.method.cache_clear() Same for a method that hasn't yet been called. >>> c = MyClass() >>> c.method.cache_clear() Another cache wrapper may be supplied: >>> cache = functools.lru_cache(maxsize=2) >>> MyClass.method2 = method_cache(lambda self: 3, cache_wrapper=cache) >>> a = MyClass() >>> a.method2() 3 Caution - do not subsequently wrap the method with another decorator, such as ``@property``, which changes the semantics of the function. See also http://code.activestate.com/recipes/577452-a-memoize-decorator-for-instance-methods/ for another implementation and additional justification. """ cache_wrapper = cache_wrapper or functools.lru_cache() def wrapper(self, *args, **kwargs): # it's the first call, replace the method with a cached, bound method bound_method = types.MethodType(method, self) cached_method = cache_wrapper(bound_method) setattr(self, method.__name__, cached_method) return cached_method(*args, **kwargs) # Support cache clear even before cache has been created. wrapper.cache_clear = lambda: None return wrapper ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_itertools.py0000644000175100001710000000113700000000000023326 0ustar00runnerdockerfrom itertools import filterfalse def unique_everseen(iterable, key=None): "List unique elements, preserving order. Remember all elements ever seen." # unique_everseen('AAAABBBCCDAABBB') --> A B C D # unique_everseen('ABBCcAD', str.lower) --> A B C D seen = set() seen_add = seen.add if key is None: for element in filterfalse(seen.__contains__, iterable): seen_add(element) yield element else: for element in iterable: k = key(element) if k not in seen: seen_add(k) yield element ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_meta.py0000644000175100001710000000220200000000000022222 0ustar00runnerdockerfrom ._compat import Protocol from typing import Any, Dict, Iterator, List, TypeVar, Union _T = TypeVar("_T") class PackageMetadata(Protocol): def __len__(self) -> int: ... # pragma: no cover def __contains__(self, item: str) -> bool: ... # pragma: no cover def __getitem__(self, key: str) -> str: ... # pragma: no cover def __iter__(self) -> Iterator[str]: ... # pragma: no cover def get_all(self, name: str, failobj: _T = ...) -> Union[List[Any], _T]: """ Return all values associated with a possibly multi-valued key. """ @property def json(self) -> Dict[str, Union[str, List[str]]]: """ A JSON-compatible form of the metadata. """ class SimplePath(Protocol): """ A minimal subset of pathlib.Path required by PathDistribution. """ def joinpath(self) -> 'SimplePath': ... # pragma: no cover def __truediv__(self) -> 'SimplePath': ... # pragma: no cover def parent(self) -> 'SimplePath': ... # pragma: no cover def read_text(self) -> str: ... # pragma: no cover ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/_text.py0000644000175100001710000000422600000000000022270 0ustar00runnerdockerimport re from ._functools import method_cache # from jaraco.text 3.5 class FoldedCase(str): """ A case insensitive string class; behaves just like str except compares equal when the only variation is case. >>> s = FoldedCase('hello world') >>> s == 'Hello World' True >>> 'Hello World' == s True >>> s != 'Hello World' False >>> s.index('O') 4 >>> s.split('O') ['hell', ' w', 'rld'] >>> sorted(map(FoldedCase, ['GAMMA', 'alpha', 'Beta'])) ['alpha', 'Beta', 'GAMMA'] Sequence membership is straightforward. >>> "Hello World" in [s] True >>> s in ["Hello World"] True You may test for set inclusion, but candidate and elements must both be folded. >>> FoldedCase("Hello World") in {s} True >>> s in {FoldedCase("Hello World")} True String inclusion works as long as the FoldedCase object is on the right. >>> "hello" in FoldedCase("Hello World") True But not if the FoldedCase object is on the left: >>> FoldedCase('hello') in 'Hello World' False In that case, use in_: >>> FoldedCase('hello').in_('Hello World') True >>> FoldedCase('hello') > FoldedCase('Hello') False """ def __lt__(self, other): return self.lower() < other.lower() def __gt__(self, other): return self.lower() > other.lower() def __eq__(self, other): return self.lower() == other.lower() def __ne__(self, other): return self.lower() != other.lower() def __hash__(self): return hash(self.lower()) def __contains__(self, other): return super(FoldedCase, self).lower().__contains__(other.lower()) def in_(self, other): "Does self appear in other?" return self in FoldedCase(other) # cache lower since it's likely to be called frequently. @method_cache def lower(self): return super(FoldedCase, self).lower() def index(self, sub): return self.lower().index(sub.lower()) def split(self, splitter=' ', maxsplit=0): pattern = re.compile(re.escape(splitter), re.I) return pattern.split(self, maxsplit) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/importlib_metadata/py.typed0000644000175100001710000000000000000000000022254 0ustar00runnerdocker././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/importlib_metadata.egg-info/0000755000175100001710000000000000000000000022261 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881502.0 importlib_metadata-4.6.4/importlib_metadata.egg-info/PKG-INFO0000644000175100001710000000554600000000000023370 0ustar00runnerdockerMetadata-Version: 2.1 Name: importlib-metadata Version: 4.6.4 Summary: Read metadata from Python packages Home-page: https://github.com/python/importlib_metadata Author: Jason R. Coombs Author-email: jaraco@jaraco.com License: UNKNOWN Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: Apache Software License Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3 :: Only Requires-Python: >=3.6 Provides-Extra: testing Provides-Extra: docs Provides-Extra: perf License-File: LICENSE .. image:: https://img.shields.io/pypi/v/importlib_metadata.svg :target: `PyPI link`_ .. image:: https://img.shields.io/pypi/pyversions/importlib_metadata.svg :target: `PyPI link`_ .. _PyPI link: https://pypi.org/project/importlib_metadata .. image:: https://github.com/python/importlib_metadata/workflows/tests/badge.svg :target: https://github.com/python/importlib_metadata/actions?query=workflow%3A%22tests%22 :alt: tests .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code style: Black .. image:: https://readthedocs.org/projects/importlib-metadata/badge/?version=latest :target: https://importlib-metadata.readthedocs.io/en/latest/?badge=latest .. image:: https://img.shields.io/badge/skeleton-2021-informational :target: https://blog.jaraco.com/skeleton Library to access the metadata for a Python package. This package supplies third-party access to the functionality of `importlib.metadata `_ including improvements added to subsequent Python versions. Compatibility ============= New features are introduced in this third-party library and later merged into CPython. The following table indicates which versions of this library were contributed to different versions in the standard library: .. list-table:: :header-rows: 1 * - importlib_metadata - stdlib * - 4.4 - 3.10 * - 1.4 - 3.8 Usage ===== See the `online documentation `_ for usage details. `Finder authors `_ can also add support for custom package installers. See the above documentation for details. Caveats ======= This project primarily supports third-party packages installed by PyPA tools (or other conforming packages). It does not support: - Packages in the stdlib. - Packages installed without metadata. Project details =============== * Project home: https://github.com/python/importlib_metadata * Report bugs at: https://github.com/python/importlib_metadata/issues * Code hosting: https://github.com/python/importlib_metadata * Documentation: https://importlib_metadata.readthedocs.io/ ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881502.0 importlib_metadata-4.6.4/importlib_metadata.egg-info/SOURCES.txt0000644000175100001710000000215000000000000024143 0ustar00runnerdocker.coveragerc .editorconfig .flake8 .gitignore .pre-commit-config.yaml .readthedocs.yml CHANGES.rst LICENSE README.rst conftest.py exercises.py mypy.ini pyproject.toml pytest.ini setup.cfg setup.py tox.ini .github/dependabot.yml .github/workflows/main.yml docs/__init__.py docs/api.rst docs/conf.py docs/history.rst docs/index.rst docs/using.rst importlib_metadata/__init__.py importlib_metadata/_adapters.py importlib_metadata/_collections.py importlib_metadata/_compat.py importlib_metadata/_functools.py importlib_metadata/_itertools.py importlib_metadata/_meta.py importlib_metadata/_text.py importlib_metadata/py.typed importlib_metadata.egg-info/PKG-INFO importlib_metadata.egg-info/SOURCES.txt importlib_metadata.egg-info/dependency_links.txt importlib_metadata.egg-info/requires.txt importlib_metadata.egg-info/top_level.txt prepare/example/setup.py prepare/example/example/__init__.py tests/__init__.py tests/fixtures.py tests/py39compat.py tests/test_api.py tests/test_integration.py tests/test_main.py tests/test_zip.py tests/data/__init__.py tests/data/example-21.12-py3-none-any.whl tests/data/example-21.12-py3.6.egg././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881502.0 importlib_metadata-4.6.4/importlib_metadata.egg-info/dependency_links.txt0000644000175100001710000000000100000000000026327 0ustar00runnerdocker ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881502.0 importlib_metadata-4.6.4/importlib_metadata.egg-info/requires.txt0000644000175100001710000000065000000000000024662 0ustar00runnerdockerzipp>=0.5 [:python_version < "3.8"] typing-extensions>=3.6.4 [docs] sphinx jaraco.packaging>=8.2 rst.linker>=1.9 [perf] ipython [testing] pytest>=4.6 pytest-checkdocs>=2.4 pytest-flake8 pytest-cov pytest-enabler>=1.0.1 packaging pep517 pyfakefs flufl.flake8 pytest-perf>=0.9.2 [testing:platform_python_implementation != "PyPy"] pytest-black>=0.3.7 pytest-mypy [testing:python_version < "3.9"] importlib_resources>=1.3 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881502.0 importlib_metadata-4.6.4/importlib_metadata.egg-info/top_level.txt0000644000175100001710000000002300000000000025006 0ustar00runnerdockerimportlib_metadata ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/mypy.ini0000644000175100001710000000004500000000000016424 0ustar00runnerdocker[mypy] ignore_missing_imports = True ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6073062 importlib_metadata-4.6.4/prepare/0000755000175100001710000000000000000000000016364 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/prepare/example/0000755000175100001710000000000000000000000020017 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/prepare/example/example/0000755000175100001710000000000000000000000021452 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/prepare/example/example/__init__.py0000644000175100001710000000004100000000000023556 0ustar00runnerdockerdef main(): return 'example' ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/prepare/example/setup.py0000644000175100001710000000037200000000000021533 0ustar00runnerdockerfrom setuptools import setup setup( name='example', version='21.12', license='Apache Software License', packages=['example'], entry_points={ 'console_scripts': ['example = example:main', 'Example=example:main'], }, ) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/pyproject.toml0000644000175100001710000000055700000000000017651 0ustar00runnerdocker[build-system] requires = ["setuptools>=56", "wheel", "setuptools_scm[toml]>=3.4.1"] build-backend = "setuptools.build_meta" [tool.black] skip-string-normalization = true [tool.setuptools_scm] [pytest.enabler.black] addopts = "--black" [pytest.enabler.mypy] addopts = "--mypy" [pytest.enabler.flake8] addopts = "--flake8" [pytest.enabler.cov] addopts = "--cov" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/pytest.ini0000644000175100001710000000064000000000000016757 0ustar00runnerdocker[pytest] norecursedirs=dist build .tox .eggs addopts=--doctest-modules doctest_optionflags=ALLOW_UNICODE ELLIPSIS # workaround for warning pytest-dev/pytest#6178 junit_family=xunit2 filterwarnings= # Suppress deprecation warning in flake8 ignore:SelectableGroups dict interface is deprecated::flake8 # Suppress deprecation warning in pypa/packaging#433 ignore:The distutils package is deprecated::packaging.tags ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/setup.cfg0000644000175100001710000000225600000000000016554 0ustar00runnerdocker[metadata] name = importlib_metadata author = Jason R. Coombs author_email = jaraco@jaraco.com description = Read metadata from Python packages long_description = file:README.rst url = https://github.com/python/importlib_metadata classifiers = Development Status :: 5 - Production/Stable Intended Audience :: Developers License :: OSI Approved :: Apache Software License Programming Language :: Python :: 3 Programming Language :: Python :: 3 :: Only [options] packages = find_namespace: include_package_data = true python_requires = >=3.6 install_requires = zipp>=0.5 typing-extensions>=3.6.4; python_version < "3.8" [options.packages.find] exclude = build* dist* docs* tests* prepare* [options.extras_require] testing = pytest >= 4.6 pytest-checkdocs >= 2.4 pytest-flake8 pytest-black >= 0.3.7; \ python_implementation != "PyPy" pytest-cov pytest-mypy; \ python_implementation != "PyPy" pytest-enabler >= 1.0.1 importlib_resources>=1.3; python_version < "3.9" packaging pep517 pyfakefs flufl.flake8 pytest-perf >= 0.9.2 docs = sphinx jaraco.packaging >= 8.2 rst.linker >= 1.9 perf = ipython [options.entry_points] [egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/setup.py0000644000175100001710000000013400000000000016436 0ustar00runnerdocker#!/usr/bin/env python import setuptools if __name__ == "__main__": setuptools.setup() ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/tests/0000755000175100001710000000000000000000000016070 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/__init__.py0000644000175100001710000000000000000000000020167 0ustar00runnerdocker././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1628881502.6113064 importlib_metadata-4.6.4/tests/data/0000755000175100001710000000000000000000000017001 5ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/data/__init__.py0000644000175100001710000000000000000000000021100 0ustar00runnerdocker././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/data/example-21.12-py3-none-any.whl0000644000175100001710000000265700000000000024056 0ustar00runnerdockerPKz{N)x!!example/__init__.pyKIMSMдRԒҢ<Ԋ܂Tu.PK{NhX{ example-21.12.dist-info/METADATA] 0E1[7ABΗjyMHSԿA {7 Ū1 l?!)0UeR ޝvQX'ܹn+s_J~ed]8TȬeYjBAoPK{N&\\example-21.12.dist-info/WHEEL HM K-*ϳR03rOK-J,/RHJ,./Q0363 /, (-JLR()*M ILR(4KM̫PK{NM%+A(example-21.12.dist-info/entry_points.txtN+I/N.,()rH-IUUHr3R sPK{Nd R %example-21.12.dist-info/top_level.txtKH-IPK{N<".example-21.12.dist-info/RECORDu̹r@o#E Dpr Ȯ|}3ix>:]P6%iG oyʵw~.eev@lˎ6{ŦLbŻ JDLRbBM#Pu5P?r&Y5NB(v-j[Q"Ͼg0W|1q?֣3>iٝ?;5dQ_6Aʆ` ' ]M+T PsȎ)ܺQ8Ԃ:mp2`)A:VPk(ePKz{N)x!!example/__init__.pyPK{NhX{ Rexample-21.12.dist-info/METADATAPK{N&\\ example-21.12.dist-info/WHEELPK{NM%+A(example-21.12.dist-info/entry_points.txtPK{Nd R %example-21.12.dist-info/top_level.txtPK{N<".`example-21.12.dist-info/RECORDPK././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/data/example-21.12-py3.6.egg0000644000175100001710000000273100000000000022441 0ustar00runnerdockerPKCN3UĄEGG-INFO/PKG-INFO]A 0E9E.b̮BPS!Nm ӄdz{EԀG 0lnVxJOѭ"#vkH\n)Jw\^YM(8 2ʏk,.oucTPKCNfEGG-INFO/SOURCES.txtuA @ Fwq= 1.0 Requires-Dist: pytest; extra == 'test' Keywords: sample package Once upon a time There was a distinfo pkg """, "RECORD": "mod.py,sha256=abc,20\n", "entry_points.txt": """ [entries] main = mod:main ns:sub = mod:main """, }, "mod.py": """ def main(): print("hello world") """, } def setUp(self): super(DistInfoPkg, self).setUp() build_files(DistInfoPkg.files, self.site_dir) def make_uppercase(self): """ Rewrite metadata with everything uppercase. """ shutil.rmtree(self.site_dir / "distinfo_pkg-1.0.0.dist-info") files = copy.deepcopy(DistInfoPkg.files) info = files["distinfo_pkg-1.0.0.dist-info"] info["METADATA"] = info["METADATA"].upper() build_files(files, self.site_dir) class DistInfoPkgWithDot(OnSysPath, SiteDir): files: FilesDef = { "pkg_dot-1.0.0.dist-info": { "METADATA": """ Name: pkg.dot Version: 1.0.0 """, }, } def setUp(self): super(DistInfoPkgWithDot, self).setUp() build_files(DistInfoPkgWithDot.files, self.site_dir) class DistInfoPkgWithDotLegacy(OnSysPath, SiteDir): files: FilesDef = { "pkg.dot-1.0.0.dist-info": { "METADATA": """ Name: pkg.dot Version: 1.0.0 """, }, "pkg.lot.egg-info": { "METADATA": """ Name: pkg.lot Version: 1.0.0 """, }, } def setUp(self): super(DistInfoPkgWithDotLegacy, self).setUp() build_files(DistInfoPkgWithDotLegacy.files, self.site_dir) class DistInfoPkgOffPath(SiteDir): def setUp(self): super(DistInfoPkgOffPath, self).setUp() build_files(DistInfoPkg.files, self.site_dir) class EggInfoPkg(OnSysPath, SiteDir): files: FilesDef = { "egginfo_pkg.egg-info": { "PKG-INFO": """ Name: egginfo-pkg Author: Steven Ma License: Unknown Version: 1.0.0 Classifier: Intended Audience :: Developers Classifier: Topic :: Software Development :: Libraries Keywords: sample package Description: Once upon a time There was an egginfo package """, "SOURCES.txt": """ mod.py egginfo_pkg.egg-info/top_level.txt """, "entry_points.txt": """ [entries] main = mod:main """, "requires.txt": """ wheel >= 1.0; python_version >= "2.7" [test] pytest """, "top_level.txt": "mod\n", }, "mod.py": """ def main(): print("hello world") """, } def setUp(self): super(EggInfoPkg, self).setUp() build_files(EggInfoPkg.files, prefix=self.site_dir) class EggInfoFile(OnSysPath, SiteDir): files: FilesDef = { "egginfo_file.egg-info": """ Metadata-Version: 1.0 Name: egginfo_file Version: 0.1 Summary: An example package Home-page: www.example.com Author: Eric Haffa-Vee Author-email: eric@example.coms License: UNKNOWN Description: UNKNOWN Platform: UNKNOWN """, } def setUp(self): super(EggInfoFile, self).setUp() build_files(EggInfoFile.files, prefix=self.site_dir) class LocalPackage: files: FilesDef = { "setup.py": """ import setuptools setuptools.setup(name="local-pkg", version="2.0.1") """, } def setUp(self): self.fixtures = contextlib.ExitStack() self.addCleanup(self.fixtures.close) self.fixtures.enter_context(tempdir_as_cwd()) build_files(self.files) def build_files(file_defs, prefix=pathlib.Path()): """Build a set of files/directories, as described by the file_defs dictionary. Each key/value pair in the dictionary is interpreted as a filename/contents pair. If the contents value is a dictionary, a directory is created, and the dictionary interpreted as the files within it, recursively. For example: {"README.txt": "A README file", "foo": { "__init__.py": "", "bar": { "__init__.py": "", }, "baz.py": "# Some code", } } """ for name, contents in file_defs.items(): full_name = prefix / name if isinstance(contents, dict): full_name.mkdir() build_files(contents, prefix=full_name) else: if isinstance(contents, bytes): with full_name.open('wb') as f: f.write(contents) else: with full_name.open('w', encoding='utf-8') as f: f.write(DALS(contents)) class FileBuilder: def unicode_filename(self): return FS_NONASCII or self.skip("File system does not support non-ascii.") def DALS(str): "Dedent and left-strip" return textwrap.dedent(str).lstrip() class NullFinder: def find_module(self, name): pass ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/py39compat.py0000644000175100001710000000017500000000000020455 0ustar00runnerdockertry: from test.support.os_helper import FS_NONASCII except ImportError: from test.support import FS_NONASCII # noqa ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/test_api.py0000644000175100001710000002620200000000000020254 0ustar00runnerdockerimport re import textwrap import unittest import warnings import importlib import contextlib from . import fixtures from importlib_metadata import ( Distribution, PackageNotFoundError, distribution, entry_points, files, metadata, requires, version, ) @contextlib.contextmanager def suppress_known_deprecation(): with warnings.catch_warnings(record=True) as ctx: warnings.simplefilter('default', category=DeprecationWarning) yield ctx class APITests( fixtures.EggInfoPkg, fixtures.DistInfoPkg, fixtures.DistInfoPkgWithDot, fixtures.EggInfoFile, unittest.TestCase, ): version_pattern = r'\d+\.\d+(\.\d)?' def test_retrieves_version_of_self(self): pkg_version = version('egginfo-pkg') assert isinstance(pkg_version, str) assert re.match(self.version_pattern, pkg_version) def test_retrieves_version_of_distinfo_pkg(self): pkg_version = version('distinfo-pkg') assert isinstance(pkg_version, str) assert re.match(self.version_pattern, pkg_version) def test_for_name_does_not_exist(self): with self.assertRaises(PackageNotFoundError): distribution('does-not-exist') def test_name_normalization(self): names = 'pkg.dot', 'pkg_dot', 'pkg-dot', 'pkg..dot', 'Pkg.Dot' for name in names: with self.subTest(name): assert distribution(name).metadata['Name'] == 'pkg.dot' def test_prefix_not_matched(self): prefixes = 'p', 'pkg', 'pkg.' for prefix in prefixes: with self.subTest(prefix): with self.assertRaises(PackageNotFoundError): distribution(prefix) def test_for_top_level(self): self.assertEqual( distribution('egginfo-pkg').read_text('top_level.txt').strip(), 'mod' ) def test_read_text(self): top_level = [ path for path in files('egginfo-pkg') if path.name == 'top_level.txt' ][0] self.assertEqual(top_level.read_text(), 'mod\n') def test_entry_points(self): eps = entry_points() assert 'entries' in eps.groups entries = eps.select(group='entries') assert 'main' in entries.names ep = entries['main'] self.assertEqual(ep.value, 'mod:main') self.assertEqual(ep.extras, []) def test_entry_points_distribution(self): entries = entry_points(group='entries') for entry in ("main", "ns:sub"): ep = entries[entry] self.assertIn(ep.dist.name, ('distinfo-pkg', 'egginfo-pkg')) self.assertEqual(ep.dist.version, "1.0.0") def test_entry_points_unique_packages(self): """ Entry points should only be exposed for the first package on sys.path with a given name. """ alt_site_dir = self.fixtures.enter_context(fixtures.tempdir()) self.fixtures.enter_context(self.add_sys_path(alt_site_dir)) alt_pkg = { "distinfo_pkg-1.1.0.dist-info": { "METADATA": """ Name: distinfo-pkg Version: 1.1.0 """, "entry_points.txt": """ [entries] main = mod:altmain """, }, } fixtures.build_files(alt_pkg, alt_site_dir) entries = entry_points(group='entries') assert not any( ep.dist.name == 'distinfo-pkg' and ep.dist.version == '1.0.0' for ep in entries ) # ns:sub doesn't exist in alt_pkg assert 'ns:sub' not in entries def test_entry_points_missing_name(self): with self.assertRaises(KeyError): entry_points(group='entries')['missing'] def test_entry_points_missing_group(self): assert entry_points(group='missing') == () def test_entry_points_dict_construction(self): """ Prior versions of entry_points() returned simple lists and allowed casting those lists into maps by name using ``dict()``. Capture this now deprecated use-case. """ with suppress_known_deprecation() as caught: eps = dict(entry_points(group='entries')) assert 'main' in eps assert eps['main'] == entry_points(group='entries')['main'] # check warning expected = next(iter(caught)) assert expected.category is DeprecationWarning assert "Construction of dict of EntryPoints is deprecated" in str(expected) def test_entry_points_by_index(self): """ Prior versions of Distribution.entry_points would return a tuple that allowed access by index. Capture this now deprecated use-case See python/importlib_metadata#300 and bpo-44246. """ eps = distribution('distinfo-pkg').entry_points with suppress_known_deprecation() as caught: eps[0] # check warning expected = next(iter(caught)) assert expected.category is DeprecationWarning assert "Accessing entry points by index is deprecated" in str(expected) def test_entry_points_groups_getitem(self): """ Prior versions of entry_points() returned a dict. Ensure that callers using '.__getitem__()' are supported but warned to migrate. """ with suppress_known_deprecation(): entry_points()['entries'] == entry_points(group='entries') with self.assertRaises(KeyError): entry_points()['missing'] def test_entry_points_groups_get(self): """ Prior versions of entry_points() returned a dict. Ensure that callers using '.get()' are supported but warned to migrate. """ with suppress_known_deprecation(): entry_points().get('missing', 'default') == 'default' entry_points().get('entries', 'default') == entry_points()['entries'] entry_points().get('missing', ()) == () def test_metadata_for_this_package(self): md = metadata('egginfo-pkg') assert md['author'] == 'Steven Ma' assert md['LICENSE'] == 'Unknown' assert md['Name'] == 'egginfo-pkg' classifiers = md.get_all('Classifier') assert 'Topic :: Software Development :: Libraries' in classifiers def test_importlib_metadata_version(self): resolved = version('importlib-metadata') assert re.match(self.version_pattern, resolved) @staticmethod def _test_files(files): root = files[0].root for file in files: assert file.root == root assert not file.hash or file.hash.value assert not file.hash or file.hash.mode == 'sha256' assert not file.size or file.size >= 0 assert file.locate().exists() assert isinstance(file.read_binary(), bytes) if file.name.endswith('.py'): file.read_text() def test_file_hash_repr(self): try: assertRegex = self.assertRegex except AttributeError: # Python 2 assertRegex = self.assertRegexpMatches util = [p for p in files('distinfo-pkg') if p.name == 'mod.py'][0] assertRegex(repr(util.hash), '') def test_files_dist_info(self): self._test_files(files('distinfo-pkg')) def test_files_egg_info(self): self._test_files(files('egginfo-pkg')) def test_version_egg_info_file(self): self.assertEqual(version('egginfo-file'), '0.1') def test_requires_egg_info_file(self): requirements = requires('egginfo-file') self.assertIsNone(requirements) def test_requires_egg_info(self): deps = requires('egginfo-pkg') assert len(deps) == 2 assert any(dep == 'wheel >= 1.0; python_version >= "2.7"' for dep in deps) def test_requires_dist_info(self): deps = requires('distinfo-pkg') assert len(deps) == 2 assert all(deps) assert 'wheel >= 1.0' in deps assert "pytest; extra == 'test'" in deps def test_more_complex_deps_requires_text(self): requires = textwrap.dedent( """ dep1 dep2 [:python_version < "3"] dep3 [extra1] dep4 [extra2:python_version < "3"] dep5 """ ) deps = sorted(Distribution._deps_from_requires_text(requires)) expected = [ 'dep1', 'dep2', 'dep3; python_version < "3"', 'dep4; extra == "extra1"', 'dep5; (python_version < "3") and extra == "extra2"', ] # It's important that the environment marker expression be # wrapped in parentheses to avoid the following 'and' binding more # tightly than some other part of the environment expression. assert deps == expected def test_as_json(self): md = metadata('distinfo-pkg').json assert 'name' in md assert md['keywords'] == ['sample', 'package'] desc = md['description'] assert desc.startswith('Once upon a time\nThere was') assert len(md['requires_dist']) == 2 def test_as_json_egg_info(self): md = metadata('egginfo-pkg').json assert 'name' in md assert md['keywords'] == ['sample', 'package'] desc = md['description'] assert desc.startswith('Once upon a time\nThere was') assert len(md['classifier']) == 2 def test_as_json_odd_case(self): self.make_uppercase() md = metadata('distinfo-pkg').json assert 'name' in md assert len(md['requires_dist']) == 2 assert md['keywords'] == ['SAMPLE', 'PACKAGE'] class LegacyDots(fixtures.DistInfoPkgWithDotLegacy, unittest.TestCase): def test_name_normalization(self): names = 'pkg.dot', 'pkg_dot', 'pkg-dot', 'pkg..dot', 'Pkg.Dot' for name in names: with self.subTest(name): assert distribution(name).metadata['Name'] == 'pkg.dot' def test_name_normalization_versionless_egg_info(self): names = 'pkg.lot', 'pkg_lot', 'pkg-lot', 'pkg..lot', 'Pkg.Lot' for name in names: with self.subTest(name): assert distribution(name).metadata['Name'] == 'pkg.lot' class OffSysPathTests(fixtures.DistInfoPkgOffPath, unittest.TestCase): def test_find_distributions_specified_path(self): dists = Distribution.discover(path=[str(self.site_dir)]) assert any(dist.metadata['Name'] == 'distinfo-pkg' for dist in dists) def test_distribution_at_pathlib(self): """Demonstrate how to load metadata direct from a directory.""" dist_info_path = self.site_dir / 'distinfo_pkg-1.0.0.dist-info' dist = Distribution.at(dist_info_path) assert dist.version == '1.0.0' def test_distribution_at_str(self): dist_info_path = self.site_dir / 'distinfo_pkg-1.0.0.dist-info' dist = Distribution.at(str(dist_info_path)) assert dist.version == '1.0.0' class InvalidateCache(unittest.TestCase): def test_invalidate_cache(self): # No externally observable behavior, but ensures test coverage... importlib.invalidate_caches() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/test_integration.py0000644000175100001710000000432600000000000022031 0ustar00runnerdockerimport unittest import packaging.requirements import packaging.version from . import fixtures from importlib_metadata import ( Distribution, MetadataPathFinder, _compat, distributions, version, ) class IntegrationTests(fixtures.DistInfoPkg, unittest.TestCase): def test_package_spec_installed(self): """ Illustrate the recommended procedure to determine if a specified version of a package is installed. """ def is_installed(package_spec): req = packaging.requirements.Requirement(package_spec) return version(req.name) in req.specifier assert is_installed('distinfo-pkg==1.0') assert is_installed('distinfo-pkg>=1.0,<2.0') assert not is_installed('distinfo-pkg<1.0') class FinderTests(fixtures.Fixtures, unittest.TestCase): def test_finder_without_module(self): class ModuleFreeFinder(fixtures.NullFinder): """ A finder without an __module__ attribute """ def __getattribute__(self, name): if name == '__module__': raise AttributeError(name) return super().__getattribute__(name) self.fixtures.enter_context(fixtures.install_finder(ModuleFreeFinder())) _compat.disable_stdlib_finder() class LocalProjectTests(fixtures.LocalPackage, unittest.TestCase): def test_find_local(self): dist = Distribution._local() assert dist.metadata['Name'] == 'local-pkg' assert dist.version == '2.0.1' class DistSearch(unittest.TestCase): def test_search_dist_dirs(self): """ Pip needs the _search_paths interface to locate distribution metadata dirs. Protect it for PyPA use-cases (only). Ref python/importlib_metadata#111. """ res = MetadataPathFinder._search_paths('any-name', []) assert list(res) == [] def test_interleaved_discovery(self): """ When the search is cached, it is possible for searches to be interleaved, so make sure those use-cases are safe. Ref #293 """ dists = distributions() next(dists) version('importlib_metadata') next(dists) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/test_main.py0000644000175100001710000002161300000000000020430 0ustar00runnerdockerimport re import json import pickle import textwrap import unittest import warnings import importlib import importlib_metadata import pyfakefs.fake_filesystem_unittest as ffs from . import fixtures from importlib_metadata import ( Distribution, EntryPoint, MetadataPathFinder, PackageNotFoundError, distributions, entry_points, metadata, version, ) class BasicTests(fixtures.DistInfoPkg, unittest.TestCase): version_pattern = r'\d+\.\d+(\.\d)?' def test_retrieves_version_of_self(self): dist = Distribution.from_name('distinfo-pkg') assert isinstance(dist.version, str) assert re.match(self.version_pattern, dist.version) def test_for_name_does_not_exist(self): with self.assertRaises(PackageNotFoundError): Distribution.from_name('does-not-exist') def test_package_not_found_mentions_metadata(self): """ When a package is not found, that could indicate that the packgae is not installed or that it is installed without metadata. Ensure the exception mentions metadata to help guide users toward the cause. See #124. """ with self.assertRaises(PackageNotFoundError) as ctx: Distribution.from_name('does-not-exist') assert "metadata" in str(ctx.exception) def test_new_style_classes(self): self.assertIsInstance(Distribution, type) self.assertIsInstance(MetadataPathFinder, type) class ImportTests(fixtures.DistInfoPkg, unittest.TestCase): def test_import_nonexistent_module(self): # Ensure that the MetadataPathFinder does not crash an import of a # non-existent module. with self.assertRaises(ImportError): importlib.import_module('does_not_exist') def test_resolve(self): ep = entry_points(group='entries')['main'] self.assertEqual(ep.load().__name__, "main") def test_entrypoint_with_colon_in_name(self): ep = entry_points(group='entries')['ns:sub'] self.assertEqual(ep.value, 'mod:main') def test_resolve_without_attr(self): ep = EntryPoint( name='ep', value='importlib_metadata', group='grp', ) assert ep.load() is importlib_metadata class NameNormalizationTests(fixtures.OnSysPath, fixtures.SiteDir, unittest.TestCase): @staticmethod def pkg_with_dashes(site_dir): """ Create minimal metadata for a package with dashes in the name (and thus underscores in the filename). """ metadata_dir = site_dir / 'my_pkg.dist-info' metadata_dir.mkdir() metadata = metadata_dir / 'METADATA' with metadata.open('w', encoding='utf-8') as strm: strm.write('Version: 1.0\n') return 'my-pkg' def test_dashes_in_dist_name_found_as_underscores(self): """ For a package with a dash in the name, the dist-info metadata uses underscores in the name. Ensure the metadata loads. """ pkg_name = self.pkg_with_dashes(self.site_dir) assert version(pkg_name) == '1.0' @staticmethod def pkg_with_mixed_case(site_dir): """ Create minimal metadata for a package with mixed case in the name. """ metadata_dir = site_dir / 'CherryPy.dist-info' metadata_dir.mkdir() metadata = metadata_dir / 'METADATA' with metadata.open('w', encoding='utf-8') as strm: strm.write('Version: 1.0\n') return 'CherryPy' def test_dist_name_found_as_any_case(self): """ Ensure the metadata loads when queried with any case. """ pkg_name = self.pkg_with_mixed_case(self.site_dir) assert version(pkg_name) == '1.0' assert version(pkg_name.lower()) == '1.0' assert version(pkg_name.upper()) == '1.0' class NonASCIITests(fixtures.OnSysPath, fixtures.SiteDir, unittest.TestCase): @staticmethod def pkg_with_non_ascii_description(site_dir): """ Create minimal metadata for a package with non-ASCII in the description. """ metadata_dir = site_dir / 'portend.dist-info' metadata_dir.mkdir() metadata = metadata_dir / 'METADATA' with metadata.open('w', encoding='utf-8') as fp: fp.write('Description: pôrˈtend') return 'portend' @staticmethod def pkg_with_non_ascii_description_egg_info(site_dir): """ Create minimal metadata for an egg-info package with non-ASCII in the description. """ metadata_dir = site_dir / 'portend.dist-info' metadata_dir.mkdir() metadata = metadata_dir / 'METADATA' with metadata.open('w', encoding='utf-8') as fp: fp.write( textwrap.dedent( """ Name: portend pôrˈtend """ ).strip() ) return 'portend' def test_metadata_loads(self): pkg_name = self.pkg_with_non_ascii_description(self.site_dir) meta = metadata(pkg_name) assert meta['Description'] == 'pôrˈtend' def test_metadata_loads_egg_info(self): pkg_name = self.pkg_with_non_ascii_description_egg_info(self.site_dir) meta = metadata(pkg_name) assert meta['Description'] == 'pôrˈtend' class DiscoveryTests(fixtures.EggInfoPkg, fixtures.DistInfoPkg, unittest.TestCase): def test_package_discovery(self): dists = list(distributions()) assert all(isinstance(dist, Distribution) for dist in dists) assert any(dist.metadata['Name'] == 'egginfo-pkg' for dist in dists) assert any(dist.metadata['Name'] == 'distinfo-pkg' for dist in dists) def test_invalid_usage(self): with self.assertRaises(ValueError): list(distributions(context='something', name='else')) class DirectoryTest(fixtures.OnSysPath, fixtures.SiteDir, unittest.TestCase): def test_egg_info(self): # make an `EGG-INFO` directory that's unrelated self.site_dir.joinpath('EGG-INFO').mkdir() # used to crash with `IsADirectoryError` with self.assertRaises(PackageNotFoundError): version('unknown-package') def test_egg(self): egg = self.site_dir.joinpath('foo-3.6.egg') egg.mkdir() with self.add_sys_path(egg): with self.assertRaises(PackageNotFoundError): version('foo') class MissingSysPath(fixtures.OnSysPath, unittest.TestCase): site_dir = '/does-not-exist' def test_discovery(self): """ Discovering distributions should succeed even if there is an invalid path on sys.path. """ importlib_metadata.distributions() class InaccessibleSysPath(fixtures.OnSysPath, ffs.TestCase): site_dir = '/access-denied' def setUp(self): super(InaccessibleSysPath, self).setUp() self.setUpPyfakefs() self.fs.create_dir(self.site_dir, perm_bits=000) def test_discovery(self): """ Discovering distributions should succeed even if there is an invalid path on sys.path. """ list(importlib_metadata.distributions()) class TestEntryPoints(unittest.TestCase): def __init__(self, *args): super(TestEntryPoints, self).__init__(*args) self.ep = importlib_metadata.EntryPoint('name', 'value', 'group') def test_entry_point_pickleable(self): revived = pickle.loads(pickle.dumps(self.ep)) assert revived == self.ep def test_immutable(self): """EntryPoints should be immutable""" with self.assertRaises(AttributeError): self.ep.name = 'badactor' def test_repr(self): assert 'EntryPoint' in repr(self.ep) assert 'name=' in repr(self.ep) assert "'name'" in repr(self.ep) def test_hashable(self): """EntryPoints should be hashable""" hash(self.ep) def test_json_dump(self): """ json should not expect to be able to dump an EntryPoint """ with self.assertRaises(Exception): with warnings.catch_warnings(record=True): json.dumps(self.ep) def test_module(self): assert self.ep.module == 'value' def test_attr(self): assert self.ep.attr is None def test_sortable(self): """ EntryPoint objects are sortable, but result is undefined. """ sorted( [ EntryPoint('b', 'val', 'group'), EntryPoint('a', 'val', 'group'), ] ) class FileSystem( fixtures.OnSysPath, fixtures.SiteDir, fixtures.FileBuilder, unittest.TestCase ): def test_unicode_dir_on_sys_path(self): """ Ensure a Unicode subdirectory of a directory on sys.path does not crash. """ fixtures.build_files( {self.unicode_filename(): {}}, prefix=self.site_dir, ) list(distributions()) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tests/test_zip.py0000644000175100001710000000530500000000000020306 0ustar00runnerdockerimport sys import unittest from contextlib import ExitStack from importlib_metadata import ( PackageNotFoundError, distribution, distributions, entry_points, files, version, ) try: from importlib import resources getattr(resources, 'files') getattr(resources, 'as_file') except (ImportError, AttributeError): import importlib_resources as resources # type: ignore class TestZip(unittest.TestCase): root = 'tests.data' def _fixture_on_path(self, filename): pkg_file = resources.files(self.root).joinpath(filename) file = self.resources.enter_context(resources.as_file(pkg_file)) assert file.name.startswith('example-'), file.name sys.path.insert(0, str(file)) self.resources.callback(sys.path.pop, 0) def setUp(self): # Find the path to the example-*.whl so we can add it to the front of # sys.path, where we'll then try to find the metadata thereof. self.resources = ExitStack() self.addCleanup(self.resources.close) self._fixture_on_path('example-21.12-py3-none-any.whl') def test_zip_version(self): self.assertEqual(version('example'), '21.12') def test_zip_version_does_not_match(self): with self.assertRaises(PackageNotFoundError): version('definitely-not-installed') def test_zip_entry_points(self): scripts = entry_points(group='console_scripts') entry_point = scripts['example'] self.assertEqual(entry_point.value, 'example:main') entry_point = scripts['Example'] self.assertEqual(entry_point.value, 'example:main') def test_missing_metadata(self): self.assertIsNone(distribution('example').read_text('does not exist')) def test_case_insensitive(self): self.assertEqual(version('Example'), '21.12') def test_files(self): for file in files('example'): path = str(file.dist.locate_file(file)) assert '.whl/' in path, path def test_one_distribution(self): dists = list(distributions(path=sys.path[:1])) assert len(dists) == 1 class TestEgg(TestZip): def setUp(self): # Find the path to the example-*.egg so we can add it to the front of # sys.path, where we'll then try to find the metadata thereof. self.resources = ExitStack() self.addCleanup(self.resources.close) self._fixture_on_path('example-21.12-py3.6.egg') def test_files(self): for file in files('example'): path = str(file.dist.locate_file(file)) assert '.egg/' in path, path def test_normalized_name(self): dist = distribution('example') assert dist._normalized_name == 'example' ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1628881484.0 importlib_metadata-4.6.4/tox.ini0000644000175100001710000000204200000000000016237 0ustar00runnerdocker[tox] envlist = python minversion = 3.2 # https://github.com/jaraco/skeleton/issues/6 tox_pip_extensions_ext_venv_update = true toxworkdir={env:TOX_WORK_DIR:.tox} [testenv] deps = commands = pytest {posargs} passenv = HOME usedevelop = True extras = testing setenv = # workaround pypa/pip#9143 PIP_USE_DEPRECATED=legacy-resolver [testenv:docs] extras = docs testing changedir = docs commands = python -m sphinx -W --keep-going . {toxinidir}/build/html [testenv:diffcov] deps = diff-cover commands = pytest {posargs} --cov-report xml diff-cover coverage.xml --compare-branch=origin/main --html-report diffcov.html diff-cover coverage.xml --compare-branch=origin/main --fail-under=100 [testenv:release] skip_install = True deps = build twine>=3 jaraco.develop>=7.1 passenv = TWINE_PASSWORD GITHUB_TOKEN setenv = TWINE_USERNAME = {env:TWINE_USERNAME:__token__} commands = python -c "import shutil; shutil.rmtree('dist', ignore_errors=True)" python -m build python -m twine upload dist/* python -m jaraco.develop.create-github-release