haive.core.schema.compatibility.reports

Compatibility reporting and debugging tools.

Classes

CompatibilityReport	Comprehensive compatibility analysis report.
FieldAnalysis	Detailed analysis of field compatibility.
ReportGenerator	Generate detailed compatibility reports.
VisualDiffer	Generate visual diffs between schemas.

Functions

generate_report(source_schema, target_schema[, mode])	Generate a compatibility report between schemas.
print_compatibility_report(source, target[, format])	Print a compatibility report to console.

Module Contents

class haive.core.schema.compatibility.reports.CompatibilityReport

Comprehensive compatibility analysis report.

to_dict()

Convert report to dictionary.

Return type:

dict[str, Any]

to_json(indent=2)

Convert report to JSON.

Parameters:

indent (int)

Return type:

str

to_markdown()

Generate markdown report.

Return type:

str

class haive.core.schema.compatibility.reports.FieldAnalysis

Detailed analysis of field compatibility.

class haive.core.schema.compatibility.reports.ReportGenerator

Generate detailed compatibility reports.

generate_report(source_schema, target_schema, compatibility_result, conversion_registry=None, analysis_time_ms=None)

Generate a comprehensive compatibility report.

Parameters:

• source_schema (haive.core.schema.compatibility.types.SchemaInfo)

• target_schema (haive.core.schema.compatibility.types.SchemaInfo)

• compatibility_result (haive.core.schema.compatibility.compatibility.SchemaCompatibility)

• conversion_registry (Any | None)

• analysis_time_ms (float | None)

Return type:

CompatibilityReport

class haive.core.schema.compatibility.reports.VisualDiffer

Generate visual diffs between schemas.

generate_diff(source_schema, target_schema, result)

Generate a visual diff.

Parameters:

• source_schema (haive.core.schema.compatibility.types.SchemaInfo)

• target_schema (haive.core.schema.compatibility.types.SchemaInfo)

• result (haive.core.schema.compatibility.compatibility.SchemaCompatibility)

Return type:

str

haive.core.schema.compatibility.reports.generate_report(source_schema, target_schema, mode='subset')

Generate a compatibility report between schemas.

Parameters:

• source_schema (type[pydantic.BaseModel] | haive.core.schema.compatibility.types.SchemaInfo)

• target_schema (type[pydantic.BaseModel] | haive.core.schema.compatibility.types.SchemaInfo)

• mode (str)

Return type:

CompatibilityReport

haive.core.schema.compatibility.reports.print_compatibility_report(source, target, format='markdown')

Print a compatibility report to console.

Parameters:

• source (type[pydantic.BaseModel] | haive.core.schema.compatibility.types.SchemaInfo)

• target (type[pydantic.BaseModel] | haive.core.schema.compatibility.types.SchemaInfo)

• format (str)

Return type:

None