ghtest.param_suggestor module

class ghtest.param_suggestor.CrudScenario(resource: str, identifier: str, steps: List[ghtest.param_suggestor.ScenarioStep], note: str | None = None)

Bases: object

identifier: str

note: str | None = None

resource: str

steps: List[ScenarioStep]

class ghtest.param_suggestor.ScenarioStep(module: str, filepath: str, qualname: str, params: Dict[str, Any], expect: str | None = None, cleanup: bool = False, description: str | None = None)

Bases: object

cleanup: bool = False

description: str | None = None

expect: str | None = None

filepath: str

module: str

params: Dict[str, Any]

qualname: str

class ghtest.param_suggestor.SuggestedFunctionTests(module: str, filepath: str, qualname: str, docstring: str | None, param_sets: List[Dict[str, Any]], scenario: ghtest.param_suggestor.CrudScenario | None = None)

Bases: object

docstring: str | None

filepath: str

module: str

param_sets: List[Dict[str, Any]]

qualname: str

scenario: CrudScenario | None = None

ghtest.param_suggestor.suggest_params(func: FunctionInfo, test_functions: List[FunctionInfo] | None = None, *, literal_only: bool = False, coverage_data: Any | None = None) → SuggestedFunctionTests

Suggest parameter sets for tests of a single FunctionInfo.

Uses three sources, in order of preference: 1) Existing test functions (from a tests folder) that call the function. 2) A minimal set using only required parameters (skipping self/cls). 3) Additional sets where defaulted parameters are given alternative values.

test_functions should be the scanner results from the tests directory.