discovery.discover_checks

discovery.discover_checks()

Discover all registered checks via entry points.

Scans the pycmdcheck.checks entry point group and loads all registered check classes. Built-in checks are registered in the package’s pyproject.toml, and third-party packages can register additional checks.

If a check fails to load (e.g., due to an import error), a UserWarning is issued but discovery continues with other checks.

Returns

: dict[str, type[Check]]: A dictionary mapping check names (strings) to check classes.
: dict[str, type[Check]]: The check classes implement the Check protocol from
: dict[str, type[Check]]: pycmdcheck.checks.base.

Examples

Discover all available checks:

>>> checks = discover_checks()
>>> "metadata" in checks
True
>>> "tests" in checks
True

Get a specific check class:

>>> checks = discover_checks()
>>> MetadataCheck = checks["metadata"]
>>> instance = MetadataCheck()
>>> instance.name
'metadata'