PublicRead-only. Nothing here can be changed.

Docs & rules

se2p/pynguinGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

1 stale name in these docs.

maind4ef0abLast read 16h ago

Documents
Rules
38
5
5
5
33
29
1
1
1
15
3
3
5
5
7
1
1 stale name
1
11
8
8
3
1
1
4
43 docs
se2p/pynguinOpen repository

Stale names in these docs1

Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

  • Gonepynguin.instrumentation.transformer.TransformingImporter
    pynguin.instrumentation.transformer.TransformingImporter

    pynguin.instrumentation.transformer declares nothing by this name.

    View on GitHub

se2p/pynguin — documented rules

38 of 38 rules, printed November 6, 2026.

The sentence in your docs
The :class:pynguin.testcase.execution.TestCaseExecutor class is responsible for executing test cases.
TestCaseExecutor depends on TestCase
Holds
:meth:pynguin.analyses.typesystem.InferredSignature.get_parameter_types methods update guesses based on usage traces
InferredSignature has a get_parameter_types method
Holds
The :class:pynguin.ga.testcasefactory.TestCaseFactory and its subclasses are responsible for creating new test cases during the search process.
TestCaseFactory depends on TestCase
Holdsga testcase
The MasterProcess creates a RunningTask which starts a worker with a WorkerTask as subprocess for the provided configuration.
RunningTask depends on WorkerTask
Holds
Upon completion, the worker sends a WorkerResult back to the RunningTask, which returns it to the MasterProcess.
RunningTask depends on WorkerResult
Holds
analyses/module provides type information to testcase/testfactory
something in src/pynguin/testcase depends on something in src/pynguin/analyses
Holdstestcase analyses
instrumentation/tracer is used by testcase/execution
something in src/pynguin/testcase depends on something in src/pynguin/instrumentation
Holdstestcase instrumentation
ga/ depends on testcase/ for chromosome representation
something in src/pynguin/ga depends on something in src/pynguin/testcase
Holdsga testcase
assertion/ depends on testcase/execution for trace collection
something in src/pynguin/assertion depends on something in src/pynguin/testcase
Holdsassertion testcase
Mutation dataclass for immutable mutation records
Mutation is annotated with dataclass
Holds
Provides fitness/coverage computation caching via ComputationCache
Chromosome depends on ComputationCache
Holds
mutate(), cross_over(), clone()
3 rules from this sentence
Chromosome has a mutate method
checks “mutate()”
Holds
Chromosome has a cross_over method
checks “cross_over()”
Holds
Chromosome has a clone method
checks “clone()”
Holds
before_search_start(), after_search_iteration(), after_search_finish()
3 rules from this sentence
GenerationAlgorithm has a before_search_start method
checks “before_search_start()”
Holds
GenerationAlgorithm has an after_search_iteration method
checks “after_search_iteration()”
Holds
GenerationAlgorithm has an after_search_finish method
checks “after_search_finish()”
Holds
before_search_start(), after_search_iteration(), after_search_finish()
3 rules from this sentence
GenerationAlgorithm has a before_search_start method
checks “before_search_start()”
Holds
GenerationAlgorithm has an after_search_iteration method
checks “after_search_iteration()”
Holds
GenerationAlgorithm has an after_search_finish method
checks “after_search_finish()”
Holds
Requires get_fitness() and get_fitness_for(fitness_function) implementations
2 rules from this sentence
Selectable has a get_fitness method
checks “Requires get_fitness()”
Holds
Selectable has a get_fitness_for method
checks “and get_fitness_for(fitness_function) implementations”
Holds
cross_over(parent_1, parent_2) - mutates parents in place
CrossOverFunction has a cross_over method
Holds
get_number_of_sub_fronts():
RankedFronts has a get_number_of_sub_fronts method
Holds
compute_ranking_assignment(solutions, uncovered_goals) -> RankedFronts
RankingFunction has a compute_ranking_assignment method
Holds
InstrumentationExecutionTracer: Proxy for ExecutionTracer (enables tracer swapping)
InstrumentationExecutionTracer depends on ExecutionTracer
Holds
BaseInferencePrompt -> TypeInferencePrompt and TypeAndSubtypeInferencePrompt
2 rules from this sentence
TypeInferencePrompt extends BaseInferencePrompt
Holds
TypeAndSubtypeInferencePrompt extends BaseInferencePrompt
Holds
Tracks to RuntimeVariable (the call, time and token totals are summed over all LLMAgent instances of a run, each agent adding its usage since its last report):
LLMAgent depends on RuntimeVariable
Holdslarge_language_model utils
FunctionDeserialization (dataclass): one function's outcome — test_case: TestCase, counts: Counter[Disposition].
2 rules from this sentence
FunctionDeserialization has test_case
checks “test_case: TestCase”
Holds
FunctionDeserialization has counts
checks “counts: Counter[Disposition]”
Holds
DeserializationResult (dataclass): the outcome of deserializing a chunk of LLM-emitted source — test_cases: list[TestCase], status: ParseStatus, counts: Counter[Disposition] (aggregated across all functions).
3 rules from this sentence
DeserializationResult has test_cases
checks “test_cases: list[TestCase]”
Holds
DeserializationResult has status
checks “status: ParseStatus”
Holds
DeserializationResult has counts
checks “counts: Counter[Disposition]”
Holds
Runs rewrite_tests() first, then cst.parse_modules the joined result and hands every top-level test_*/seed_test_* FunctionDef to a CstStatementDeserializer. The module-level imports that rewrite_tests surfaces (RewrittenTests.module_imports) are passed as module_level_imports= so each function's referenced imports are hoisted in (mirrors the seeding path).
CstStatementDeserializer depends on GenericFunction
Holdslarge_language_model utils
deserialize_function(fn) -> FunctionDeserialization walks the (already rewriter-normalized and SUT-alias-normalized) function body, tagging each statement with a Disposition. Compound statements (if/for/with/...) are admitted whole as opaque executable blocks (ADMITTED_COMPOUND).
CstStatementDeserializer has a deserialize_function method
Holds
parse_assertion(node: cst.Assert | str, known_vars: Mapping[str, type | None]) -> tuple[str, Assertion] | None: module-level and shared with pynguin.assertion.llmassertiongenerator.
parse_assertion is in src/pynguin/large_language_model/parsing
Holds
Tracks RuntimeVariable + value pairs
_StatisticsTracker depends on RuntimeVariable
Holds
38 rules from 10 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.