Requirements parsing (requirements)

Functions:

resolve_extras(*, extras, package_name, ...)	Resolve extras
resolve_group(requirements, package_name, extras)	Resolve project.name[extra] in a group

Classes:

ParseDepends(data)

Parse pyproject.toml file for dependencies

pyproject2conda.requirements.resolve_extras(*, extras: str | Iterable[str], package_name: str, unresolved: dict[str, list[Requirement]]) → list[Requirement]

Resolve extras

pyproject2conda.requirements.resolve_group(requirements: list[Requirement], package_name: str, extras: dict[str, list[Requirement]]) → list[Requirement]

Resolve project.name[extra] in a group

class pyproject2conda.requirements.ParseDepends(data: dict[str, Any]) → None

Bases: object

Parse pyproject.toml file for dependencies

Parameters:

data (dict)

Methods:

get_in(*keys[, default, factory])	Generic getter.
pip_requirements(*[, extras, groups, ...])	Pip dependencies.
conda_and_pip_requirements(*[, extras, ...])	Conda and pip requirements.
to_conda_yaml(*[, extras, groups, ...])	Create yaml string.
to_requirements(*[, extras, groups, ...])	Create requirements string.
to_conda_requirements(*[, extras, groups, ...])	Create conda and pip requirements files.
from_string(toml_string)	Create object from string.
from_path(path)	Create object from path.

Attributes:

package_name	Clean name of package.
dependencies
build_system_requires	build-system.requires
optional_dependencies	project.optional-dependencies
dependency_groups	dependency-groups
override_table	tool.pyproject2conda.dependencies
channels
extras	Available extras
groups	Available groups
requirements_base	Base requirements
requirements_extras	Extras requirements
requirements_groups	Groups requirements

get_in(*keys: str, default: Any = None, factory: Callable[[], Any] | None = None) → Any

Generic getter.

property package_name

Clean name of package.

property dependencies

property build_system_requires

build-system.requires

property optional_dependencies

project.optional-dependencies

property dependency_groups

dependency-groups

property override_table

tool.pyproject2conda.dependencies

Mapping from requirement name to OverrideDeps instance

property channels

property extras

Available extras

property groups

Available groups

property requirements_base

Base requirements

property requirements_extras

Extras requirements

property requirements_groups

Groups requirements

pip_requirements(*, extras: str | Iterable[str] | None = None, groups: str | Iterable[str] | None = None, extras_or_groups: str | Iterable[str] | None = None, skip_package: bool = False, pip_deps: str | Iterable[str] | None = None, unique: bool = True, remove_whitespace: bool = True, sort: bool = True) → list[str]

Pip dependencies.

conda_and_pip_requirements(*, extras: str | Iterable[str] | None = None, groups: str | Iterable[str] | None = None, extras_or_groups: str | Iterable[str] | None = None, skip_package: bool = False, pip_only: bool = False, pip_deps: str | Iterable[str] | None = None, conda_deps: str | Iterable[str] | None = None, unique: bool = True, remove_whitespace: bool = True, sort: bool = True, python_version: str | None = None, python_include: str | None = None) → tuple[list[str], list[str]]

Conda and pip requirements.

to_conda_yaml(*, extras: str | Iterable[str] | None = None, groups: str | Iterable[str] | None = None, extras_or_groups: str | Iterable[str] | None = None, pip_deps: str | Iterable[str] | None = None, conda_deps: str | Iterable[str] | None = None, name: str | None = None, channels: str | Iterable[str] | None = None, python_include: str | None = None, python_version: str | None = None, skip_package: bool = False, pip_only: bool = False, header_cmd: str | None = None, output: str | Path | None = None, sort: bool = True, remove_whitespace: bool = True, unique: bool = True, allow_empty: bool = False) → str

Create yaml string.

to_requirements(*, extras: str | Iterable[str] | None = None, groups: str | Iterable[str] | None = None, extras_or_groups: str | Iterable[str] | None = None, skip_package: bool = False, header_cmd: str | None = None, output: str | Path | None = None, sort: bool = True, pip_deps: Sequence[str] | None = None, allow_empty: bool = False, remove_whitespace: bool = True) → str

Create requirements string.

to_conda_requirements(*, extras: str | Iterable[str] | None = None, groups: str | Iterable[str] | None = None, extras_or_groups: str | Iterable[str] | None = None, channels: str | Iterable[str] | None = None, python_include: str | None = None, python_version: str | None = None, prepend_channel: bool = False, output_conda: str | Path | None = None, output_pip: str | Path | None = None, skip_package: bool = False, header_cmd: str | None = None, sort: bool = True, unique: bool = True, conda_deps: str | Iterable[str] | None = None, pip_deps: str | Iterable[str] | None = None, remove_whitespace: bool = True) → tuple[str, str]

Create conda and pip requirements files.

classmethod from_string(toml_string: str) → Self

Create object from string.

classmethod from_path(path: str | Path) → Self

Create object from path.