Read/use config/pyproject.toml file (config)

Read/use config/pyproject.toml file (`config`)#

Classes:

Config(data[, default_pythons, all_pythons])

Class to parse toml file with [tool.pyproject2conda] section

class pyproject2conda.config.Config(data: dict[str, Any], default_pythons: list[str] | None = None, all_pythons: list[str] | None = None) → None[source]#

Bases: object

Class to parse toml file with [tool.pyproject2conda] section

Methods:

`get_in`(*keys[, default])	Utility to extract from nested dict.
`channels`([env_name, inherit])	Channels getter
`python`(env_name, inherit, default)	Python getter
`pip_only`([env_name, inherit, default])	If True, use pip only
`extras`(env_name[, inherit])	Extras getter
`groups`(env_name[, inherit])	Groups getter.
`extras_or_groups`(env_name[, inherit])	Extras_or_Groups getter.
`output`([env_name])	Output getter
`sort`([env_name, inherit, default])	Sort getter
`skip_package`(env_name[, default])	skip_package getter.
`name`(env_name)	Name option.
`header`(env_name)	Header getter
`custom_command`(env_name)	Custom command to place in the header
`style`([env_name, default])	Style getter.
`python_include`([env_name])	Flag python_include
`python_version`([env_name])	Flag python_version
`overwrite`([env_name, default])	Flag overwrite
`verbose`([env_name, default])	Flag verbose
`template`(env_name[, default])	Flag for template
`template_python`(env_name[, default])	Flag for template_python.
`reqs_ext`(env_name[, default])	Requirements extension
`yaml_ext`(env_name[, default])	Conda yaml extension
`deps`(env_name[, default])	Conda dependencies option.
`reqs`(env_name[, default])	Pip dependencies option.
`user_config`([env_name])	Flag user_config
`allow_empty`([env_name, default])	Allow empty option.
`remove_whitespace`([env_name, default])	Remove whitespace option.
`assign_user_config`(user)	Assign user_config to self.
`iter_envs`([envs])	Iterate over configs.
`from_toml_dict`(data_toml[, user_config])	Create from toml dictionaries.
`from_string`(s[, user_config])	Create from string representation of toml file.
`from_file`(path[, user_config])	Create from toml file(s).

Attributes:

`overrides`	All overrides sections from [[tool.pyproject2conda.overrides]]
`envs`	All environments

get_in(*keys: str, default: Any = None) → Any[source]#: Utility to extract from nested dict.

property overrides#: All overrides sections from [[tool.pyproject2conda.overrides]]

property envs#: All environments

channels(env_name: str | None = None, inherit: bool = True) → list[str] | None[source]#: Channels getter

python(env_name: str | None = None, inherit: bool = True, default: ~typing.Any = <class 'list'>) → list[str][source]#: Python getter

pip_only(env_name: str | None = None, inherit: bool = True, default: bool = False) → bool[source]#: If True, use pip only

extras(env_name: str, inherit: bool = True) → list[str][source]#

Extras getter

If value is True (default), then return [env_name]
If value is False, return []
else return list of extras

groups(env_name: str, inherit: bool = True) → list[str][source]#

Groups getter.

Same style as self.extras

extras_or_groups(env_name: str, inherit: bool = True) → list[str][source]#

Extras_or_Groups getter.

These will need to be resolved after the fact.

output(env_name: str | None = None) → str | None[source]#: Output getter

sort(env_name: str | None = None, inherit: bool = True, default: bool = True) → bool[source]#: Sort getter

skip_package(env_name: str, default: bool = False) → bool[source]#: skip_package getter.

name(env_name: str) → str | None[source]#: Name option.

header(env_name: str) → bool[source]#: Header getter

custom_command(env_name: str) → bool[source]#: Custom command to place in the header

style(env_name: str | None = None, default: str = 'yaml') → str[source]#: Style getter. One of yaml, requirements

python_include(env_name: str | None = None) → str | None[source]#: Flag python_include

python_version(env_name: str | None = None) → str | None[source]#: Flag python_version

overwrite(env_name: str | None = None, default: str = 'check') → str[source]#: Flag overwrite

verbose(env_name: str | None = None, default: int | None = None) → int | None[source]#: Flag verbose

template(env_name: str, default: str = '{env}') → str[source]#: Flag for template

template_python(env_name: str, default: str = 'py{py}-{env}') → str[source]#: Flag for template_python.

reqs_ext(env_name: str, default: str = '.txt') → str[source]#: Requirements extension

yaml_ext(env_name: str, default: str = '.yaml') → str[source]#: Conda yaml extension

deps(env_name: str, default: Any = None) → list[str][source]#: Conda dependencies option.

reqs(env_name: str, default: Any = None) → list[str][source]#: Pip dependencies option.

user_config(env_name: str | None = None) → str | None[source]#: Flag user_config

allow_empty(env_name: str | None = None, default: bool = False) → bool[source]#: Allow empty option.

remove_whitespace(env_name: str | None = None, default: bool = True) → bool[source]#: Remove whitespace option.

assign_user_config(user: Self) → Self[source]#: Assign user_config to self.

iter_envs(envs: Sequence[str] | None = None, **defaults: Any) → Iterator[tuple[str, dict[str, Any]]][source]#: Iterate over configs.

classmethod from_toml_dict(data_toml: dict[str, Any], user_config: dict[str, Any] | None = None) → Self[source]#: Create from toml dictionaries.

classmethod from_string(s: str, user_config: str | None = None) → Self[source]#: Create from string representation of toml file.

classmethod from_file(path: str | Path, user_config: str | Path | None = 'infer') → Self[source]#: Create from toml file(s).

Read/use config/pyproject.toml file (config)

Contents

Read/use config/pyproject.toml file (config)#

Read/use config/pyproject.toml file (`config`)#