Skip to content

API Reference

Complete reference for Nyctea's public API.

  • Validation Engine

    ValidationResult, ValidationReport, ColumnValidationStats, ErrorReportConfig.

    Engine

  • Schema Models

    SchemaModel, ColumnSchema, Parser, Check, OnFailureBehavior.

    Schema

  • Validator Registry

    Registry, ValidatorRegistry, ColumnParser, ColumnCheck, FrameParser, FrameCheck.

    Registry

  • Data Ingestion

    Schema-aware readers for CSV and Parquet.

    Ingest

Public exports

Everything importable directly from nyctea:

from nyctea import (
    SchemaModel,          # schema definition
    Registry,       # validator registry
    register_builtins,    # register built-in parsers/checks
    ValidationResult,     # result of a validation run
    ValidationReport,     # per-column statistics
    ErrorReportConfig,    # error reporting mode (summary/rows/cells)
    NycteaError,          # base exception
    ValidationError,      # column/pipeline validation failure
    ValidatorError,          # validator registration or execution failure
    PipelineError,        # pipeline phase failure
)