setters#

Setter functions for a pyproject.toml config file.

add_dependency(pyproject: PyprojectTOML, /, requirement: str, *, extra: str | OrderedCollection[str] | None = None, group: str | OrderedCollection[str] | None = None) → bool[source]#
create_sub_table(config: Mapping[str, Any], /, dotted_header: str) → Table[source]#

Create a TOML sub-table through a dotted header key.

get_sub_table(config: Mapping[str, Any], /, dotted_header: str) → MutableMapping[str, Any][source]#
remove_dependency(pyproject: PyprojectTOML, /, package: str, ignored_sections: ExplicitCollection[str] | None = None) → bool[source]#
remove_empty_dependency_groups(pyproject: PyprojectTOML, /) → list[str][source]#

Remove empty dependency groups and the include-group entries to them.

Removing an include-group entry can leave another group empty, so this repeats until no empty group remains. Returns the names of the removed groups.

>>> import tomlkit
>>> pyproject = tomlkit.parse(
...     '''
... [dependency-groups]
... dev = ["ruff", {include-group = "doc"}, {include-group = "style"}]
... doc = [{include-group = "style"}]
... style = []
... '''
... )
>>> remove_empty_dependency_groups(pyproject)
['style', 'doc']
>>> pyproject["dependency-groups"].unwrap()
{'dev': ['ruff']}
split_dependency_definition(requirement: str) → tuple[str, str, str][source]#

Get the package name, operator, and version from a PyPI dependency requirement.

>>> split_dependency_definition("julia")
('julia', '', '')
>>> split_dependency_definition("python==3.9.*")
('python', '==', '3.9.*')
>>> split_dependency_definition("graphviz  # for binder")
('graphviz', '', '')
>>> split_dependency_definition("pip > 19  # needed")
('pip', '>', '19')
>>> split_dependency_definition("compwa-policy!= 3.14")
('compwa-policy', '!=', '3.14')
>>> split_dependency_definition("my_package~=1.2")
('my_package', '~=', '1.2')
>>> split_dependency_definition("any_version_package==*")
('any_version_package', '==', '*')
>>> split_dependency_definition("python-lsp-server[rope]")
('python-lsp-server[rope]', '', '')