pyfcstm.diagnostics

Structured diagnostic codes and design-health reporting for pyfcstm state machines.

This package hosts the contract surface for diagnostics emitted by pyfcstm.model and by inspect-based design-health analyzers. It is not a formal-verification framework — Z3-based reachability and guard-satisfiability live under pyfcstm.solver.

This package currently exposes:

• pyfcstm.diagnostics.codes — the single source of truth for diagnostic codes (codes.yaml + the CODE_REGISTRY loader).

• CodesSchemaError — raised on import-time failure of the loader.

• inspect_model() and the related inspect dataclasses used by pyfcstm / jsfcstm parity checks and design-health diagnostics.

• DiagnosticSink for strict-mode and collect-mode diagnostic emission.

See HansBug/pyfcstm issue #103 for the migration plan and codes.yaml for the authoritative code catalog.

• pyfcstm.diagnostics.analyzers
  • pyfcstm.diagnostics.analyzers.const_fold
    • ConstValue
    • fold_numeric_expression
    • fold_condition_expression
    • collect_const_fold_warnings
  • pyfcstm.diagnostics.analyzers.data_flow
    • collect_data_flow_warnings
  • pyfcstm.diagnostics.analyzers.design_health
    • collect_design_health_warnings
  • pyfcstm.diagnostics.analyzers.naming
    • collect_naming_warnings
  • pyfcstm.diagnostics.analyzers.redundancy
    • collect_redundancy_warnings
  • pyfcstm.diagnostics.analyzers.structural
    • collect_structural_warnings
  • pyfcstm.diagnostics.analyzers.thresholds
    • collect_threshold_warnings
  • pyfcstm.diagnostics.analyzers.transition_info
    • collect_transition_infos
  • pyfcstm.diagnostics.analyzers.type_shape
    • collect_type_warnings
  • pyfcstm.diagnostics.analyzers.use_def
    • UseDefGraph
    • build_use_def_graph
    • collect_expr_variables
  • __all__
    • __all__
• pyfcstm.diagnostics.codes
  • CODE_REGISTRY
    • CODE_REGISTRY
  • CodesSchemaError
    • CodesSchemaError
  • CodeFieldSpec
    • CodeFieldSpec
  • ForLlmSpec
    • ForLlmSpec
  • SuggestedFixSpec
    • SuggestedFixSpec
  • CodeSpec
    • CodeSpec
  • load_codes
    • load_codes()
• pyfcstm.diagnostics.inspect
  • DEFAULT_DEEP_HIERARCHY_THRESHOLD
    • DEFAULT_DEEP_HIERARCHY_THRESHOLD
  • DEFAULT_LARGE_COMPOSITE_THRESHOLD
    • DEFAULT_LARGE_COMPOSITE_THRESHOLD
  • DEFAULT_VAR_TO_LEAF_RATIO_THRESHOLD
    • DEFAULT_VAR_TO_LEAF_RATIO_THRESHOLD
  • KNOWN_SPANLESS_CODES
    • KNOWN_SPANLESS_CODES
  • VERIFY_SHARED_STATIC_CODES
    • VERIFY_SHARED_STATIC_CODES
  • StateInfo
    • StateInfo
  • TransitionInfo
    • TransitionInfo
  • VariableInfo
    • VariableInfo
  • EventInfo
    • EventInfo
  • ActionInfo
    • ActionInfo
  • ForcedTransitionInfo
    • ForcedTransitionInfo
  • ModelMetrics
    • ModelMetrics
  • ModelInspect
    • ModelInspect
  • inspect_model
    • inspect_model()
• pyfcstm.diagnostics.sink
  • DiagnosticSink
    • DiagnosticSink
• pyfcstm.diagnostics.suggested_fix
  • render_suggested_fix
    • render_suggested_fix()
  • refs_with_suggested_fix
    • refs_with_suggested_fix()

__all__

pyfcstm.diagnostics.__all__ = ['CODE_REGISTRY', 'ActionInfo', 'CodeFieldSpec', 'CodeSpec', 'CodesSchemaError', 'DEFAULT_DEEP_HIERARCHY_THRESHOLD', 'DEFAULT_LARGE_COMPOSITE_THRESHOLD', 'DEFAULT_VAR_TO_LEAF_RATIO_THRESHOLD', 'DiagnosticSink', 'EventInfo', 'ForcedTransitionInfo', 'ForLlmSpec', 'ModelInspect', 'ModelMetrics', 'StateInfo', 'SuggestedFixSpec', 'TransitionInfo', 'VariableInfo', 'inspect_model', 'load_codes', 'refs_with_suggested_fix', 'render_suggested_fix']

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.