pyproject_parser.type_hints

Type hints for pyproject_parser.

Classes:

Author

typing.TypedDict representing the items in the authors/maintainers key of PEP 621.

BuildSystemDict

typing.TypedDict representing the output from the BuildSystemParser class.

ProjectDict

typing.TypedDict representing the output from the PEP621Parser class.

ReadmeDict

typing.TypedDict representing the return type of to_dict().

Data:

ContentTypes

Type hint for the valid content-types in the license table defined in PEP 621.

Dynamic

Type hint for the dynamic field defined in PEP 621.

typeddict Author[source]

Bases: dict

typing.TypedDict representing the items in the authors/maintainers key of PEP 621.

Optional Keys
typeddict BuildSystemDict

Bases: dict

typing.TypedDict representing the output from the BuildSystemParser class.

Required Keys
ContentTypes

Type hint for the valid content-types in the license table defined in PEP 621.

Alias of Literal['text/markdown', 'text/x-rst', 'text/plain']

Dynamic

Type hint for the dynamic field defined in PEP 621.

Alias of Literal['name', 'version', 'description', 'readme', 'requires-python', 'license', 'authors', 'maintainers', 'keywords', 'classifiers', 'urls', 'scripts', 'gui-scripts', 'entry-points', 'dependencies', 'optional-dependencies']

typeddict ProjectDict

Bases: dict

typing.TypedDict representing the output from the PEP621Parser class.

Required Keys
typeddict ReadmeDict[source]

Bases: dict

typing.TypedDict representing the return type of to_dict().

Optional Keys
  • text (str)

  • file (str)

  • charset (str)

  • content_type (Literal['text/markdown', 'text/x-rst', 'text/plain'])