equiframe 0.12.4__py3-none-any.whl

equiframe/__init__.py

@@ -0,0 +1,832 @@
+"""Semantic comparison and reviewable evidence, with optional native execution.
+
+Start small: ``diff(candidate, expected, keys=["id"])`` compares eager frames;
+``assert_equivalent(result)`` is the acceptance gate; ``comparison_report(result)``
+explains it with minimized data. Use ``compare`` for already captured artifacts
+and an explicit contract. Inspect ``read_diff_contract(result)`` for the policy.
+
+Advanced entry points remain separate: ``capture_duckdb`` captures trusted SQL;
+``execute`` runs registered native code; ``migrate`` compares supported native
+plans; ``verify`` checks outputs against a declared expected; ``ingest_file`` and
+``run_workflow`` compose local ETL. ``SnapshotDataSource`` accepts injected clients.
+
+An execution being completed, two outputs being equivalent, and matching an
+independent expected are distinct claims. Never use ``bool(result)`` for approval.
+The installed handbook starts at ``equiframe/docs/inicio.md`` (Spanish) or
+``equiframe/docs/index.md`` (English). Import does not load optional engines/ML.
+"""
+
+from importlib.metadata import version as _distribution_version
+
+from equiframe._dataset_provenance import DatasetProvenance, DatasetSource
+from equiframe._diff_capture import DiffCaptureOptions
+from equiframe.adapters import DuckDBAdapter, PandasAdapter, PolarsAdapter
+from equiframe.assertion_types import EquivalenceDecision, EquivalencePolicy
+from equiframe.assertions import (
+    EquivalenceAssertionError,
+    EquivalenceDifferentError,
+    EquivalenceEvidenceError,
+    EquivalenceGuaranteeError,
+    EquivalenceInputError,
+    EquivalenceNotEvaluableError,
+    assert_equivalent,
+    equivalence_decision,
+)
+from equiframe.bundle import (
+    BundleReference,
+    EvidenceBundle,
+    export_bundle,
+    import_bundle,
+    inspect_bundle,
+    read_bundle,
+)
+from equiframe.comparison import (
+    ComparisonInput,
+    compare,
+    comparison_fingerprint,
+    iter_differences,
+    read_comparison,
+)
+from equiframe.comparison_report import (
+    comparison_report,
+    read_comparison_report,
+    write_comparison_report,
+)
+from equiframe.comparison_types import (
+    AppliedPolicy,
+    ComparisonCounts,
+    ComparisonDiagnostic,
+    ComparisonDifference,
+    ComparisonOptions,
+    ComparisonPolicy,
+    ComparisonResult,
+    ComparisonSource,
+    ComparisonSpec,
+    ComparisonValue,
+)
+from equiframe.compatibility import (
+    AdapterCapability,
+    CapabilityStage,
+    CompatibilityPolicy,
+    StabilityRecord,
+    get_adapter_capabilities,
+    get_compatibility_policy,
+    get_stability_register,
+)
+from equiframe.contracts import (
+    SCHEMA_VERSION,
+    AggregateCheck,
+    BooleanType,
+    CardinalityCheck,
+    ColumnKeyScope,
+    ColumnSpec,
+    Contract,
+    DatePolicy,
+    DateType,
+    DecimalType,
+    Family,
+    FloatType,
+    GlobalKeyScope,
+    IgnoredOrder,
+    IntegerType,
+    JoinCheck,
+    KeyCheck,
+    KeyScope,
+    KeySpec,
+    LogicalType,
+    Multiplicity,
+    NaNPolicy,
+    NullPolicy,
+    NumericPolicy,
+    OrderCheck,
+    OrderPolicy,
+    PreconditionSpec,
+    RuleDefinition,
+    RuleSpec,
+    SchemaCheck,
+    SignificantOrder,
+    SortSpec,
+    StringType,
+    TableKeyScope,
+    TableSchema,
+    TableSpec,
+    TemporalPolicy,
+    TimestampPolicy,
+    TimestampType,
+    Tolerance,
+)
+from equiframe.datasets import (
+    DatasetChoiceRequired,
+    DatasetColumn,
+    DatasetFormat,
+    DatasetInfo,
+    DatasetReadError,
+    DatasetReadOptions,
+    DatasetResult,
+    DatasetTarget,
+    convert_dataset,
+    inspect_dataset,
+    load_dataset,
+)
+from equiframe.decision import combine_decisions
+from equiframe.destinations import Destination, LoadReceipt, ParquetDestination, PublishedTable
+from equiframe.detector_types import (
+    ComponentDecision,
+    ComponentDetectionResult,
+    DetectionResult,
+    DetectorBundle,
+    DetectorCalibration,
+    DetectorDecision,
+    DetectorFit,
+    DetectorModel,
+    DetectorScoreResult,
+    DetectorScores,
+    DetectorSupport,
+    DetectorVersions,
+    HybridDecision,
+    IsolationForestConfig,
+    NormalCalibrationProfiles,
+    detector_fingerprint,
+)
+from equiframe.detectors import (
+    calibrate_detectors,
+    detect,
+    detect_component,
+    fit_detectors,
+    read_detector_bundle,
+    score_detectors,
+    write_detector_bundle,
+)
+from equiframe.diff import DiffInput, diff, read_diff_contract
+from equiframe.diff_contracts import (
+    DiffContract,
+    PolicyProvenance,
+    bag_contract,
+    infer_diff_contract,
+    keyed_contract,
+    sequence_contract,
+)
+from equiframe.duckdb_capture import DuckDBCaptureOptions, capture_duckdb
+from equiframe.errors import (
+    ArtifactIntegrityError,
+    ArtifactIOError,
+    CapabilityError,
+    ContractIOError,
+    ContractParseError,
+    ContractValidationError,
+    EquiFrameError,
+    ExecutionCancelled,
+    ExecutionTimeout,
+    InvalidExecutionInput,
+    MissingDependencyError,
+    NativeEngineError,
+    ResourceLimitError,
+    SchemaVersionError,
+    ValidationIssue,
+)
+from equiframe.evidence import EvidenceEvent, inspect_evidence, read_pipeline, verify_events
+from equiframe.execution import CancellationToken, RunContext, execute
+from equiframe.execution_types import (
+    EngineCapabilities,
+    ExecutionOptions,
+    ExecutionPlan,
+    ExecutionProblem,
+    ExecutionResult,
+    Parameter,
+    PhysicalColumn,
+    StageTiming,
+    TableArtifact,
+    VersionInfo,
+)
+from equiframe.ingestion import (
+    ConversionReceipt as IngestionConversionReceipt,
+)
+from equiframe.ingestion import (
+    FieldMapping,
+    FileInput,
+    IngestionResult,
+    IngestionSpec,
+    QuarantinedRecord,
+    SourceReceipt,
+    ingest_file,
+)
+from equiframe.local import LocalArtifactStore
+from equiframe.migration import (
+    Aggregate,
+    Boolean,
+    Cast,
+    CastColumn,
+    Column,
+    Compare,
+    CompilationCheck,
+    CompilationDiagnostic,
+    CompiledPlan,
+    CompilerRecord,
+    CompilerRegistry,
+    EquiJoin,
+    Filter,
+    IRColumn,
+    IsNaN,
+    IsNull,
+    JoinKey,
+    LiteralExpression,
+    Measure,
+    MigrationOptions,
+    MigrationRequest,
+    MigrationResult,
+    MigrationSpec,
+    MigrationStage,
+    NamedExpression,
+    NodeSchema,
+    Not,
+    PlanCompiler,
+    Project,
+    RelationalPlan,
+    Scan,
+    Sort,
+    SortKey,
+    ValidatedIR,
+    Window,
+    WindowMeasure,
+    check_migration,
+    ir_fingerprint,
+    migrate,
+    migration_summary,
+    native_compiler_registry,
+    read_migration,
+    render_migration_report,
+    validate_ir,
+)
+from equiframe.migration.types import (
+    Arithmetic,
+    Coalesce,
+    Concatenate,
+    Conditional,
+    DecimalRound,
+    Deduplicate,
+    LocalizeTimestamp,
+)
+from equiframe.pipeline import run_pipeline
+from equiframe.pipeline_types import (
+    EvidenceFile,
+    PipelineInput,
+    PipelineRequest,
+    PipelineResult,
+    PipelineSpec,
+    StageRecord,
+)
+from equiframe.ports import ArtifactStore, DataSource, EngineAdapter
+from equiframe.preprocessing import (
+    fit_preprocessor,
+    read_preprocessor,
+    transform_profiles,
+    write_preprocessor,
+)
+from equiframe.profile_types import (
+    ConversionReceipt,
+    FeatureFit,
+    FeatureMatrix,
+    FeatureObservation,
+    FeatureState,
+    FeatureSupport,
+    NormalTrainingProfiles,
+    PreprocessorBundle,
+    ProfileFeature,
+    ProfileMetadata,
+    ProfileMetric,
+    ProfileOptions,
+    ProfileResult,
+    ProfileSpec,
+    ProfileVector,
+    profile_spec_fingerprint,
+)
+from equiframe.profiles import profile_execution, read_profile
+from equiframe.r_review import (
+    ReviewedDecision,
+    RExecutionBinding,
+    RReviewBinding,
+    RReviewOptions,
+    RReviewResult,
+    finalize_execution_with_r,
+    finalize_with_r,
+    review_with_r,
+)
+from equiframe.reduction import (
+    ReducedTable,
+    ReductionObservation,
+    ReductionOptions,
+    ReductionResult,
+    read_reduction,
+    reduce_case,
+)
+from equiframe.registry import (
+    DuckDBTransformation,
+    PandasTransformation,
+    PolarsTransformation,
+    Transformation,
+    TransformationRegistry,
+)
+from equiframe.report_rendering import (
+    render_comparison_html,
+    render_comparison_notebook,
+    render_comparison_text,
+)
+from equiframe.report_types import (
+    ComparisonReport,
+    ReportCount,
+    ReportEvidenceManifest,
+    ReportOptions,
+    ReportPolicy,
+    ReportPublicationManifest,
+    ReportValue,
+    ReportViewPolicy,
+    ReportWitness,
+)
+from equiframe.reporting import pipeline_summary, render_report, write_report
+from equiframe.rule_types import (
+    CheckResult,
+    CheckState,
+    RuleCoverage,
+    RuleEvaluation,
+    RuleFinding,
+    RuleOptions,
+)
+from equiframe.rules import (
+    RuleContext,
+    RuleImplementation,
+    RuleRegistry,
+    default_rule_registry,
+    evaluate_rules,
+    iter_rule_findings,
+    read_rule_evaluation,
+    rule_set_fingerprint,
+)
+from equiframe.serialization import (
+    CANONICALIZATION,
+    canonical_contract_bytes,
+    contract_fingerprint,
+    contract_json_schema,
+    read_contract,
+    validate_contract,
+    write_contract,
+)
+from equiframe.snapshot import (
+    SnapshotClient,
+    SnapshotColumn,
+    SnapshotDataSource,
+    SnapshotManifest,
+    SnapshotTable,
+    snapshot_fingerprint,
+)
+from equiframe.sources import CompositeDataSource, RecordBatchInput, SQLiteInput, StreamInput
+from equiframe.tables import (
+    ArrowInput,
+    ArtifactInput,
+    LoadedTable,
+    LocalDataSource,
+    PandasInput,
+    PolarsInput,
+    read_table,
+)
+from equiframe.types import (
+    ArtifactRef,
+    ComparisonState,
+    DecisionState,
+    ExecutionState,
+    FitState,
+    JobState,
+    OracleState,
+    SchemaRef,
+    Sha256,
+)
+from equiframe.values import (
+    BooleanValue,
+    DateValue,
+    DecimalValue,
+    ExactDecimal,
+    FloatValue,
+    InfinityValue,
+    IntegerValue,
+    NaNValue,
+    NullValue,
+    ScalarValue,
+    StringValue,
+    TimestampValue,
+    TimeUnit,
+    TimeZone,
+)
+from equiframe.verification_request import VerificationRequest
+from equiframe.verify import (
+    VerificationInput,
+    read_verification,
+    verification_summary,
+    verify,
+    verify_migration,
+)
+from equiframe.verify_types import (
+    ExpectedProvenance,
+    IndependentReviewEvidence,
+    VerificationBinding,
+    VerificationCheck,
+    VerificationCoverage,
+    VerificationResult,
+    VerificationReview,
+    VerificationState,
+)
+from equiframe.workflow import (
+    InputBinding as WorkflowInputBinding,
+)
+from equiframe.workflow import (
+    WorkflowCheckpoint,
+    WorkflowResult,
+    WorkflowSpec,
+    WorkflowStage,
+    read_workflow,
+    run_workflow,
+)
+from equiframe.workflow_request import WorkflowExpected, WorkflowRequest
+
+__version__ = _distribution_version("equiframe")
+
+__all__ = [
+    "CANONICALIZATION",
+    "SCHEMA_VERSION",
+    "AdapterCapability",
+    "Aggregate",
+    "AggregateCheck",
+    "AppliedPolicy",
+    "Arithmetic",
+    "ArrowInput",
+    "ArtifactIOError",
+    "ArtifactInput",
+    "ArtifactIntegrityError",
+    "ArtifactRef",
+    "ArtifactStore",
+    "Boolean",
+    "BooleanType",
+    "BooleanValue",
+    "BundleReference",
+    "CancellationToken",
+    "CapabilityError",
+    "CapabilityStage",
+    "CardinalityCheck",
+    "Cast",
+    "CastColumn",
+    "CheckResult",
+    "CheckState",
+    "Coalesce",
+    "Column",
+    "ColumnKeyScope",
+    "ColumnSpec",
+    "Compare",
+    "ComparisonCounts",
+    "ComparisonDiagnostic",
+    "ComparisonDifference",
+    "ComparisonInput",
+    "ComparisonOptions",
+    "ComparisonPolicy",
+    "ComparisonReport",
+    "ComparisonResult",
+    "ComparisonSource",
+    "ComparisonSpec",
+    "ComparisonState",
+    "ComparisonValue",
+    "CompatibilityPolicy",
+    "CompilationCheck",
+    "CompilationDiagnostic",
+    "CompiledPlan",
+    "CompilerRecord",
+    "CompilerRegistry",
+    "ComponentDecision",
+    "ComponentDetectionResult",
+    "CompositeDataSource",
+    "Concatenate",
+    "Conditional",
+    "Contract",
+    "ContractIOError",
+    "ContractParseError",
+    "ContractValidationError",
+    "ConversionReceipt",
+    "DataSource",
+    "DatasetChoiceRequired",
+    "DatasetColumn",
+    "DatasetFormat",
+    "DatasetInfo",
+    "DatasetProvenance",
+    "DatasetReadError",
+    "DatasetReadOptions",
+    "DatasetResult",
+    "DatasetSource",
+    "DatasetTarget",
+    "DatePolicy",
+    "DateType",
+    "DateValue",
+    "DecimalRound",
+    "DecimalType",
+    "DecimalValue",
+    "DecisionState",
+    "Deduplicate",
+    "Destination",
+    "DetectionResult",
+    "DetectorBundle",
+    "DetectorCalibration",
+    "DetectorDecision",
+    "DetectorFit",
+    "DetectorModel",
+    "DetectorScoreResult",
+    "DetectorScores",
+    "DetectorSupport",
+    "DetectorVersions",
+    "DiffCaptureOptions",
+    "DiffContract",
+    "DiffInput",
+    "DuckDBAdapter",
+    "DuckDBCaptureOptions",
+    "DuckDBTransformation",
+    "EngineAdapter",
+    "EngineCapabilities",
+    "EquiFrameError",
+    "EquiJoin",
+    "EquivalenceAssertionError",
+    "EquivalenceDecision",
+    "EquivalenceDifferentError",
+    "EquivalenceEvidenceError",
+    "EquivalenceGuaranteeError",
+    "EquivalenceInputError",
+    "EquivalenceNotEvaluableError",
+    "EquivalencePolicy",
+    "EvidenceBundle",
+    "EvidenceEvent",
+    "EvidenceFile",
+    "ExactDecimal",
+    "ExecutionCancelled",
+    "ExecutionOptions",
+    "ExecutionPlan",
+    "ExecutionProblem",
+    "ExecutionResult",
+    "ExecutionState",
+    "ExecutionTimeout",
+    "ExpectedProvenance",
+    "Family",
+    "FeatureFit",
+    "FeatureMatrix",
+    "FeatureObservation",
+    "FeatureState",
+    "FeatureSupport",
+    "FieldMapping",
+    "FileInput",
+    "Filter",
+    "FitState",
+    "FloatType",
+    "FloatValue",
+    "GlobalKeyScope",
+    "HybridDecision",
+    "IRColumn",
+    "IgnoredOrder",
+    "IndependentReviewEvidence",
+    "InfinityValue",
+    "IngestionConversionReceipt",
+    "IngestionResult",
+    "IngestionSpec",
+    "IntegerType",
+    "IntegerValue",
+    "InvalidExecutionInput",
+    "IsNaN",
+    "IsNull",
+    "IsolationForestConfig",
+    "JobState",
+    "JoinCheck",
+    "JoinKey",
+    "KeyCheck",
+    "KeyScope",
+    "KeySpec",
+    "LiteralExpression",
+    "LoadReceipt",
+    "LoadedTable",
+    "LocalArtifactStore",
+    "LocalDataSource",
+    "LocalizeTimestamp",
+    "LogicalType",
+    "Measure",
+    "MigrationOptions",
+    "MigrationRequest",
+    "MigrationResult",
+    "MigrationSpec",
+    "MigrationStage",
+    "MissingDependencyError",
+    "Multiplicity",
+    "NaNPolicy",
+    "NaNValue",
+    "NamedExpression",
+    "NativeEngineError",
+    "NodeSchema",
+    "NormalCalibrationProfiles",
+    "NormalTrainingProfiles",
+    "Not",
+    "NullPolicy",
+    "NullValue",
+    "NumericPolicy",
+    "OracleState",
+    "OrderCheck",
+    "OrderPolicy",
+    "PandasAdapter",
+    "PandasInput",
+    "PandasTransformation",
+    "Parameter",
+    "ParquetDestination",
+    "PhysicalColumn",
+    "PipelineInput",
+    "PipelineRequest",
+    "PipelineResult",
+    "PipelineSpec",
+    "PlanCompiler",
+    "PolarsAdapter",
+    "PolarsInput",
+    "PolarsTransformation",
+    "PolicyProvenance",
+    "PreconditionSpec",
+    "PreprocessorBundle",
+    "ProfileFeature",
+    "ProfileMetadata",
+    "ProfileMetric",
+    "ProfileOptions",
+    "ProfileResult",
+    "ProfileSpec",
+    "ProfileVector",
+    "Project",
+    "PublishedTable",
+    "QuarantinedRecord",
+    "RExecutionBinding",
+    "RReviewBinding",
+    "RReviewOptions",
+    "RReviewResult",
+    "RecordBatchInput",
+    "ReducedTable",
+    "ReductionObservation",
+    "ReductionOptions",
+    "ReductionResult",
+    "RelationalPlan",
+    "ReportCount",
+    "ReportEvidenceManifest",
+    "ReportOptions",
+    "ReportPolicy",
+    "ReportPublicationManifest",
+    "ReportValue",
+    "ReportViewPolicy",
+    "ReportWitness",
+    "ResourceLimitError",
+    "ReviewedDecision",
+    "RuleContext",
+    "RuleCoverage",
+    "RuleDefinition",
+    "RuleEvaluation",
+    "RuleFinding",
+    "RuleImplementation",
+    "RuleOptions",
+    "RuleRegistry",
+    "RuleSpec",
+    "RunContext",
+    "SQLiteInput",
+    "ScalarValue",
+    "Scan",
+    "SchemaCheck",
+    "SchemaRef",
+    "SchemaVersionError",
+    "Sha256",
+    "SignificantOrder",
+    "SnapshotClient",
+    "SnapshotColumn",
+    "SnapshotDataSource",
+    "SnapshotManifest",
+    "SnapshotTable",
+    "Sort",
+    "SortKey",
+    "SortSpec",
+    "SourceReceipt",
+    "StabilityRecord",
+    "StageRecord",
+    "StageTiming",
+    "StreamInput",
+    "StringType",
+    "StringValue",
+    "TableArtifact",
+    "TableKeyScope",
+    "TableSchema",
+    "TableSpec",
+    "TemporalPolicy",
+    "TimeUnit",
+    "TimeZone",
+    "TimestampPolicy",
+    "TimestampType",
+    "TimestampValue",
+    "Tolerance",
+    "Transformation",
+    "TransformationRegistry",
+    "ValidatedIR",
+    "ValidationIssue",
+    "VerificationBinding",
+    "VerificationCheck",
+    "VerificationCoverage",
+    "VerificationInput",
+    "VerificationRequest",
+    "VerificationResult",
+    "VerificationReview",
+    "VerificationState",
+    "VersionInfo",
+    "Window",
+    "WindowMeasure",
+    "WorkflowCheckpoint",
+    "WorkflowExpected",
+    "WorkflowInputBinding",
+    "WorkflowRequest",
+    "WorkflowResult",
+    "WorkflowSpec",
+    "WorkflowStage",
+    "__version__",
+    "assert_equivalent",
+    "bag_contract",
+    "calibrate_detectors",
+    "canonical_contract_bytes",
+    "capture_duckdb",
+    "check_migration",
+    "combine_decisions",
+    "compare",
+    "comparison_fingerprint",
+    "comparison_report",
+    "contract_fingerprint",
+    "contract_json_schema",
+    "convert_dataset",
+    "default_rule_registry",
+    "detect",
+    "detect_component",
+    "detector_fingerprint",
+    "diff",
+    "equivalence_decision",
+    "evaluate_rules",
+    "execute",
+    "export_bundle",
+    "finalize_execution_with_r",
+    "finalize_with_r",
+    "fit_detectors",
+    "fit_preprocessor",
+    "get_adapter_capabilities",
+    "get_compatibility_policy",
+    "get_stability_register",
+    "import_bundle",
+    "infer_diff_contract",
+    "ingest_file",
+    "inspect_bundle",
+    "inspect_dataset",
+    "inspect_evidence",
+    "ir_fingerprint",
+    "iter_differences",
+    "iter_rule_findings",
+    "keyed_contract",
+    "load_dataset",
+    "migrate",
+    "migration_summary",
+    "native_compiler_registry",
+    "pipeline_summary",
+    "profile_execution",
+    "profile_spec_fingerprint",
+    "read_bundle",
+    "read_comparison",
+    "read_comparison_report",
+    "read_contract",
+    "read_detector_bundle",
+    "read_diff_contract",
+    "read_migration",
+    "read_pipeline",
+    "read_preprocessor",
+    "read_profile",
+    "read_reduction",
+    "read_rule_evaluation",
+    "read_table",
+    "read_verification",
+    "read_workflow",
+    "reduce_case",
+    "render_comparison_html",
+    "render_comparison_notebook",
+    "render_comparison_text",
+    "render_migration_report",
+    "render_report",
+    "review_with_r",
+    "rule_set_fingerprint",
+    "run_pipeline",
+    "run_workflow",
+    "score_detectors",
+    "sequence_contract",
+    "snapshot_fingerprint",
+    "transform_profiles",
+    "validate_contract",
+    "validate_ir",
+    "verification_summary",
+    "verify",
+    "verify_events",
+    "verify_migration",
+    "write_comparison_report",
+    "write_contract",
+    "write_detector_bundle",
+    "write_preprocessor",
+    "write_report",
+]