Plugin and IR API (autodoc)¶

Symbols for dialect plugins and advanced two-phase compile. Prefer Application API (autodoc) for application code. Contract: IR contract (Plugin API v1) · Public API.

class sqlrules.CompilationContext(on_unsupported: 'OnUnsupported' = 'raise', collector: 'DiagnosticsCollector | None' = None, dialect: 'str | None' = None)[source]

Parameters:

on_unsupported (Literal['raise', 'warn', 'ignore'])
collector (DiagnosticsCollector | None)
dialect (str | None)

class sqlrules.Constraint(field: 'str', operator: 'str', value: 'Any')[source]

Parameters:

field (str)
operator (str)
value (Any)

class sqlrules.Diagnostic(severity: 'DiagnosticSeverity', field: 'str', operator: 'str', value: 'Any' = None, message: 'str' = '', code: 'str' = '')[source]

Parameters:

severity (Literal['warning', 'info'])
field (str)
operator (str)
value (Any)
message (str)
code (str)

class sqlrules.FieldDescriptor(name: 'str', alias: 'str | None', annotation: 'Any', metadata: 'tuple[Any, ...]' = (), aliases: 'tuple[str, ...]' = ())[source]

Parameters:

name (str)
alias (str | None)
annotation (Any)
metadata (tuple[Any, ...])
aliases (tuple[str, ...])

class sqlrules.FieldIR(descriptor: 'FieldDescriptor', constraints: 'tuple[Constraint, ...]')[source]

Parameters:

descriptor (FieldDescriptor)
constraints (tuple[Constraint, ...])

exception sqlrules.InternalCompilerError[source]: Unexpected internal compiler failure.

exception sqlrules.InvalidTranslatorError(operator: 'str', translator: 'Any')[source]

Parameters:

operator (str)
translator (Any)

Return type:

None

class sqlrules.ModelIR(model: 'type[Any]', fields: 'tuple[FieldIR, ...]')[source]

Parameters:

model (type[Any])
fields (tuple[FieldIR, ...])

class sqlrules.PatternSpec(pattern, ignore_case=False)[source]

Normalized pattern constraint value (preserves case-folding intent).

Parameters:

pattern (str)
ignore_case (bool)

exception sqlrules.PluginError(message, plugin=None)[source]

Raised when a plugin fails validation or registration.

Parameters:

message (str)
plugin (Any)

Return type:

None

exception sqlrules.RegistryError(message: 'str')[source]

Parameters:: message (str)
Return type:: None

class sqlrules.SQLRulesPlugin(*args, **kwargs)[source]

Explicit extension that registers translators onto a registry.

register(registry)[source]

Parameters:: registry (TranslatorRegistry)
Return type:: None

exception sqlrules.TranslatorError(field: 'str', operator: 'str', message: 'str')[source]

Parameters:

field (str)
operator (str)
message (str)

Return type:

None

class sqlrules.TypeSpec(python_type, strict=False, allow_none=False)[source]

Normalized type_check constraint value (Pydantic type + strictness).

Parameters:

python_type (type)
strict (bool)
allow_none (bool)

sqlrules.default_registry()[source]

Return a copy of the built-in portable translator registry.

The builtin template is built once per process. Callers may mutate the returned registry without affecting other callers or Compiler.

Return type:: TranslatorRegistry

sqlrules.pattern_text(value)[source]

Return (pattern, ignore_case) from a pattern constraint value.

Parameters:: value (Any)
Return type:: tuple[str, bool]

sqlrules.type_spec(value)[source]

Return a TypeSpec from a type_check constraint value.

Parameters:: value (Any)
Return type:: TypeSpec