Overrides

Module to construct setuptools-scm PRETEND_VERSION environment variable string

drain_swamp.version_file._overrides.PRETEND_KEY: str = "SETUPTOOLS_SCM_PRETEND_VERSION"

drain_swamp.version_file._overrides.PRETEND_KEY_NAMED: str = "SETUPTOOLS_SCM_PRETEND_VERSION_for_{name}"

Get environmental variable key for forcing setuptools-scm to use a particular semantic version

drain_swamp.version_file._overrides.__all__: tuple[str] = ("normalize_dist_name")

Module exports

See also

[Source] [LICENSE:MIT]

drain_swamp.version_file._overrides.normalize_dist_name(dist_name)

Normalize the dist name as per PEP 503

Parameters:

dist_name (str) – May contain period(s), hyphen(s), and/or underscore(s)

Returns:

dist name normalized and uppercase

Return type:

str

drain_swamp.version_file._overrides.read_named_env(*, tool='SETUPTOOLS_SCM', name, dist_name)

From environment, get variable value. Will contain the version

Parameters:

• tool (str) – Default “SETUPTOOLS_SCM”. Hardcoded tool name

• name (str) – Can be PRETEND_VERSION or OVERRIDES

• dist_name (str | None) – target package name

Returns:

version str

Return type:

str | None