API Reference

Main API

Primary functions for checking Python packages

check	Check a Python package for issues.
check_async	Check a Python package for issues (async version).

Results

Classes for check results and aggregation

Results	Aggregated results for all check groups.
GroupResult	Results for a single check group.
CheckResult	Result of running a single check.

Core Types

Enumerations and data classes

CheckStatus	Status of a check result.
Severity	Severity level for check results.
Location	A location in source code.

Configuration

Configuration loading and management

config.Config	Configuration options for pycmdcheck.
config.load_config	Load configuration from pyproject.toml [tool.pycmdcheck].
config.merge_config	Merge file config with CLI config, CLI takes precedence.

Registry

Check and fixture registries

core.registry.CheckRegistry	Registry for storing and filtering check classes.
core.registry.FixableCheckProtocol	Protocol for checks that can automatically fix issues.
core.registry.is_fixable	Check if a check class has a callable fix() method.
core.fixtures.FixtureRegistry	Registry for fixtures with dependency resolution.

Autofix

Automatic fix system

core.fixer.FixRunner	Orchestrates automatic fixing of check failures.
core.fixer.FixResult	Result of running fixes.

Profiles

Check profile system

profiles.Profile	A check profile that bundles configuration settings.
profiles.get_profile	Get a profile by name.
profiles.list_profiles	List all available profiles.
profiles.apply_profile	Apply a profile to a configuration, with config taking precedence.

Plugins

Plugin discovery system

plugins.discover_plugins	Discover and load check plugins.
plugins.ENTRY_POINT_GROUP