sqlcompyre.config package

Submodules

• sqlcompyre.config.model module
  • Config
    • Config.ignore_table_columns
    • Config.ignore_tables
    • Config.model_config
• sqlcompyre.config.validation module
  • read_config()

Module contents

class sqlcompyre.config.Config(*, ignore_tables: list[str] = <factory>, ignore_table_columns: dict[str, list[str]] = <factory>)

Bases: BaseModel

Attributes:

model_extra

Get extra fields set during validation.

model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Methods

copy(*[, include, exclude, update, deep])	Returns a copy of the model.
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#model_copy
model_dump(*[, mode, include, exclude, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump
model_dump_json(*[, indent, include, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/serialization/#modelmodel_dump_json
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(_BaseModel__context)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	Usage docs: https://docs.pydantic.dev/2.10/concepts/json/#json-parsing
model_validate_strings(obj, *[, strict, context])	Validate the given object with string data against the Pydantic model.

construct
dict
from_orm
json
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

ignore_table_columns: dict[str, list[str]]

ignore_tables: list[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sqlcompyre.config.read_config(file_path: Path) → Config

Reads in the yaml configuration file from the given path and parse it into Config object ensuring the validity of the configuration file.

Args:

file_path: File of the yaml configuration to parse

Returns:

parsed Config object

Raises:

pydantic.ValidationError: If the configuration cannot be validated.