__init__.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# oct/mutation/__init__.py
 
"""
Purpose
-------
Expose the stdlib-only mutation engine used by ``oct mutate``.
 
Responsibilities
----------------
- Export the enumeration records and functions that define a mutant's identity.
- Keep the runner, report, and Click adapters out of package-root imports.
 
Diagnostics
-----------
Domain: OCT-MUTATION
Levels:
    L2 - lifecycle
    L3 - enumeration details
    L4 - deep tracing
 
Contracts
---------
- Importing this package must require only the Python standard library.
- v1 measures and reports; it never gates and never sets an outcome exit code.
 
Dependencies
------------
- oct.mutation.engine (stdlib-only AST enumeration and application)
"""
 
# OCT-LINT: disable-file=dbg_usage reason="Plan 227 P1 requires the package root to import with every third-party package blocked"
# OCT-LINT: disable-file=dbg_import reason="Plan 227 P1 forbids third-party imports at the package root"
 
from oct.mutation.engine import (
    Mutant,
    MutantNotFoundError,
    apply_mutant,
    enumerate_file,
    enumerate_source,
    relative_id,
)
 
__all__ = [
    "Mutant",
    "MutantNotFoundError",
    "apply_mutant",
    "enumerate_file",
    "enumerate_source",
    "relative_id",
]