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

Bases: TypedDict

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

Optional Keys

• name (Optional[str])

• email (Optional[str])

typeddict BuildSystemDict

Bases: TypedDict

typing.TypedDict representing the output from the BuildSystemParser class.

Required Keys

• requires (List[ComparableRequirement])

• build-backend (Optional[str])

• backend-path (Optional[List[str]])

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: TypedDict

typing.TypedDict representing the output from the PEP621Parser class.

Required Keys

• name (str)

• version (Optional[Version])

• description (Optional[str])

• readme (Optional[Readme])

• requires-python (Optional[Marker])

• license (Optional[License])

• authors (List[Author])

• maintainers (List[Author])

• keywords (List[str])

• classifiers (List[str])

• urls (Dict[str, str])

• scripts (Dict[str, str])

• gui-scripts (Dict[str, str])

• entry-points (Dict[str, Dict[str, str]])

• dependencies (List[ComparableRequirement])

• optional-dependencies (Dict[str, List[ComparableRequirement]])

• dynamic (List[Literal['name', 'version', 'description', 'readme', 'requires-python', 'license', 'authors', 'maintainers', 'keywords', 'classifiers', 'urls', 'scripts', 'gui-scripts', 'entry-points', 'dependencies', 'optional-dependencies']])

typeddict ReadmeDict

Bases: TypedDict

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'])