U <c @sZdZddlmZddlmZmZddlmZddlm Z m Z ddl m Z GdddZd S) z#A diagnostic engine based on SARIF.) annotations)ListOptional)infra) formattersarif)versionc@seZdZUdZded<ddddZddd d Zd dd d Zd dddZd dddZ ddddZ dddddddZ dS)DiagnosticEngineaA generic diagnostic engine based on SARIF. This class is the main interface for diagnostics. It manages the creation of diagnostic contexts. A DiagnosticContext provides the entry point for recording Diagnostics. Each DiagnosticContext is powered by a DiagnosticTool, which can be customized with custom RuleCollection and Diagnostic type. See infra.DiagnosticContext and infra.DiagnosticTool for more details. Examples: Step 1: Create a set of rules. >>> rules = infra.RuleCollection.from_list( ... "CustomRuleCollection", ... [ ... infra.Rule( ... id="r1", ... name="rule-1", ... message_default_template="Mising xxx", ... ), ... ], ... ) Step 2: Create a diagnostic tool. >>> tool = infra.DiagnosticTool( ... name="tool", ... version="1.0.0", ... rules=rules, ... ) Step 3: Create a diagnostic engine. >>> engine = DiagnosticEngine() Step 4: Start a new diagnostic context. >>> with engine.start_diagnostic_context(tool) as context: Step 5: Add diagnostics in your code. ... context.diagnose(rules.rule1, infra.Level.ERROR) Step 6: Afterwards, get the SARIF log. >>> sarif_log = engine.sarif_log() zList[infra.DiagnosticContext] _contextsNone)returncCs g|_dSN)r selfrQ/tmp/pip-unpacked-wheel-gikjz4vx/torch/onnx/_internal/diagnostics/infra/engine.py__init__8szDiagnosticEngine.__init__zsarif.SarifLogcCs tjtjtjdd|jDdS)NcSsg|] }|qSr)r).0contextrrr ?sz.DiagnosticEngine.sarif_log..)rZ schema_uriruns)rZSarifLog sarif_versionZ SARIF_VERSIONZSARIF_SCHEMA_LINKr rrrr sarif_log;s zDiagnosticEngine.sarif_logstrcCs|Sr to_jsonrrrr__str__BszDiagnosticEngine.__str__cCs|Sr rrrrr__repr__FszDiagnosticEngine.__repr__cCst|Sr )rZ sarif_to_jsonrrrrrrIszDiagnosticEngine.to_jsoncCs|jdS)zClears all diagnostic contexts.N)r clearrrrrrLszDiagnosticEngine.clearNzinfra.DiagnosticToolz!Optional[infra.DiagnosticOptions]zinfra.DiagnosticContext)tooloptionsr cCst||}|j||Sr )rZDiagnosticContextr append)rrr rrrrcreate_diagnostic_contextPs  z*DiagnosticEngine.create_diagnostic_context)N) __name__ __module__ __qualname____doc____annotations__rrrrrrr"rrrrr s )r N)r& __future__rtypingrrZ torch.onnx._internal.diagnosticsrZ&torch.onnx._internal.diagnostics.infrarrZ,torch.onnx._internal.diagnostics.infra.sarifrrr rrrrs