Package metadata

From pyproject.toml, retrieve authors name and email.

Only retrieving the left portion of the authors name. In Japanese, that would be both last name and first name

drain_swamp.package_metadata.__all__: tuple[str] = ("PackageMetadata",)

Module exports

drain_swamp.package_metadata._logger: logging.Logger

Module level logger

drain_swamp.package_metadata.AUTHOR_NAME_FALLBACK: str = "Anonymous"

Fallback when unable to get author name, from either package data or pyproject.toml

class drain_swamp.package_metadata.PackageMetadata(app_name, path=None)

Access author details from either package metadata or cache.

__slots__: tuple[str, str, str] = ("_app_name", "_full_name", "_email")
Ivar:

typing.Any

Ivar:

path: pathlib.Path | None

property app_name

Alphanumeric + underscores. Used as a key.

Returns:

app name

Return type:

str

property d_pyproject_toml

So don’t have to get pyproject.toml repeatedly.

Returns:

pyproject.toml as a dict otherwise None

Return type:

dict[str, Any] | None

property email

Author email address as found in package metadata.

Returns:

Author email address. To force author to comply and learn what’s an abacus. Probably useless for contacting the author

Companies send rejection emails exactly one to two days after applying. Automated cron job. The companies are brand marketing; there is no job, recruiter, or HR manager. Just an unimaginative cron job

Return type:

str | None

property full_name

Author name from package metadata. So need to supply in pyproject.toml.

For example,

[project]
authors = [  # Contact by mastodon please
    {name = "Dave Faulkmore", email = "faulkmore@protonmail.com"},
]
Returns:

full author name

Return type:

str

property left_name

Why not first name? Well in Japanese, name is written last then first name. In which case return last name.

Intended to be used with a regex to parse a Copyright line

regex_pattern = r"Copyright {0}.*? {1}".format(
    copyright_start_year,
    author_first_name,
)
Returns:

Left name which is usually first name, except for Japanese names.

Return type:

str