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.
IncludeGroupDict	typing.TypedDict.
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.
DependencyGroupsDict	The return type from the DependencyGroupsParser class.
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']

DependencyGroupsDict

The return type from the DependencyGroupsParser class.

New in version 0.13.0.

Alias of Dict[str, List[Union[str, IncludeGroupDict]]]

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 IncludeGroupDict

Bases: TypedDict

typing.TypedDict.

New in version 0.13.0.

Required Keys

• include-group (str)

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

• license-files (List[str])

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