https://github.com/wheelodex/entry-points-txt

Read & write entry_points.txt files
https://github.com/wheelodex/entry-points-txt

available-on-pypi entry-points python

Last synced: about 1 year ago
JSON representation

Read & write entry_points.txt files

• Host: GitHub
• URL: https://github.com/wheelodex/entry-points-txt
• Owner: wheelodex
• License: mit
• Created: 2020-07-20T16:37:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-23T14:07:26.000Z (over 1 year ago)
• Last Synced: 2025-04-09T19:49:38.863Z (about 1 year ago)
• Topics: available-on-pypi, entry-points, python
• Language: Python
• Homepage:
• Size: 57.6 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
|repostatus| |ci-status| |coverage| |pyversions| |license|

.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg

    :target: https://www.repostatus.org/#active

    :alt: Project Status: Active — The project has reached a stable, usable

          state and is being actively developed.

.. |ci-status| image:: https://github.com/wheelodex/entry-points-txt/actions/workflows/test.yml/badge.svg

    :target: https://github.com/wheelodex/entry-points-txt/actions/workflows/test.yml

    :alt: CI Status

.. |coverage| image:: https://codecov.io/gh/wheelodex/entry-points-txt/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/wheelodex/entry-points-txt

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/entry-points-txt.svg

    :target: https://pypi.org/project/entry-points-txt/

.. |license| image:: https://img.shields.io/github/license/wheelodex/entry-points-txt.svg

    :target: https://opensource.org/licenses/MIT

    :alt: MIT License

`GitHub `_

| `PyPI `_

| `Issues `_

| `Changelog `_

``entry-points-txt`` provides functions for reading & writing

``entry_points.txt`` files according to `the spec`_.  That is the one thing it

does, and it endeavors to do it well.

.. _the spec: https://packaging.python.org/specifications/entry-points/

Installation

============

``entry-points-txt`` requires Python 3.8 or higher.  Just use `pip

`_ for Python 3 (You have pip, right?) to install

``entry-points-txt``::

    python3 -m pip install entry-points-txt

API

===

``EntryPoint``

--------------

.. code:: python

    class EntryPoint(NamedTuple)

A representation of an entry point as a namedtuple.  Instances have the

following attributes and methods:

``group: str``

   The name of the entry point group (e.g., ``"console_scripts"``)

``name: str``

   The name of the entry point

``module: str``

   The module portion of the attribute reference (the part before the colon)

``attr: Optional[str]``

   The attribute/object portion of the attribute reference (the part after the

   colon), or ``None`` if not specified

``extras: Tuple[str, ...]``

   Extras required for the entry point

``load() -> Any``

   Returns the object referred to by the entry point

``to_line() -> str``

   Returns the representation of the entry point as a line in

   ``entry_points.txt``, i.e., a line of the form ``name = module:attr

   [extras]``

``EntryPointSet``

-----------------

.. code:: python

    EntryPointSet = Dict[str, Dict[str, EntryPoint]]

An alias for the return type of ``load()`` & ``loads()`` and the argument type

of ``dump()`` & ``dumps()``.  Entry points are organized into a ``dict`` that

maps group names to sub-``dict``\s that map entry point names to ``EntryPoint``

instances.

``load()``

----------

.. code:: python

    entry_points_txt.load(fp: IO[str]) -> EntryPointSet

Parse a file-like object as an ``entry_points.txt``-format file and return the

results.

For example, the following input:

.. code:: ini

    [console_scripts]

    foo = package.__main__:main

    bar = package.cli:klass.attr

    [thingy.extension]

    quux = package.thingy [xtr]

would be parsed as:

.. code:: python

    {

        "console_scripts": {

            "foo": EntryPoint(group="console_scripts", name="foo", module="package.__main__", attr="main", extras=()),

            "bar": EntryPoint(group="console_scripts", name="bar", module="package.cli", attr="klass.attr", extras=()),

        },

        "thingy.extension": {

            "quux": EntryPoint(group="thingy.extension", name="quux", module="package.thingy", attr=None, extras=("xtr",)),

        },

    }

``loads()``

-----------

.. code:: python

    entry_points_txt.loads(s: str) -> EntryPointSet

Like ``load()``, but reads from a string instead of a filehandle

``dump()``

----------

.. code:: python

    entry_points_txt.dump(eps: EntryPointSet, fp: IO[str]) -> None

Write a collection of entry points to a file-like object in

``entry_points.txt`` format.  A ``ValueError`` is raised and nothing is written

if the group or name key under which an ``EntryPoint`` is located does not

match its ``group`` or ``name`` attribute.

``dumps()``

-----------

.. code:: python

    entry_points_txt.dumps(eps: EntryPointSet) -> str

Like ``dump()``, but returns a string instead of writing to a filehandle

``dump_list()``

---------------

.. code:: python

    entry_points_txt.dump_list(eps: Iterable[EntryPoint], fp: IO[str]) -> None

Write an iterable of entry points to a file-like object in ``entry_points.txt``

format.  If two or more entry points have the same group & name, only the last

one will be output.

``dumps_list()``

----------------

.. code:: python

    entry_points_txt.dumps_list(eps: Iterable[EntryPoint]) -> str

Like ``dump_list()``, but returns a string instead of writing to a filehandle

``ParseError``

--------------

.. code:: python

    class ParseError(ValueError)

Exception raised by ``load()`` or ``loads()`` when given invalid input