db.schemas.schema

Module defining base functions and classes for implementing a schema

Module Contents

Classes

Functions

Data

SaveOptionsType

API

emtellipro.db.schemas.schema.SchemaManifest

1
class emtellipro.db.schemas.schema.SchemaManifest

Representation of a database schema, containing the SQLAlchemy metadata object, and the module implementing it.

Authors of schemas must provide an object that is an instance of this class (or a subclass). This class itself can be instantiated, but if some of the properties need to be overridden, then a subclass will be necessary.

SchemaManifest.name

1
name: str

Value: None

SchemaManifest.models

1
models: typing.Any

Value: None

SchemaManifest.migrations

1
migrations: typing.Any | None

Value: None

SchemaManifest.save

1
save: typing.Callable

Value: None

SchemaManifest.save_options

1
save_options: type | None

Value: None

SchemaManifest.__post_init__

1
__post_init__()

SchemaManifest.metadata

1
metadata

The base SQLAlchemy metadata

SchemaManifest.alembic_config

1
alembic_config: alembic.config.Config

Path to alembic config file.

SchemaManifest.tables

1
tables

The list of tables in the SQLAlchemy metadata object.

emtellipro.db.schemas.schema.SaveDocument

1
class emtellipro.db.schemas.schema.SaveDocument

This stores references to the input document and annotated document pair that should be passed to the save() method in each schema.

SaveDocument.annotated

1
annotated: emtellipro.data.AnnotatedDocument

Value: None

SaveDocument.input

1
input: emtellipro.data.InputDocument | None

Value: None

SaveDocument.text

1
text

emtellipro.db.schemas.schema.SaveOptions

1
class emtellipro.db.schemas.schema.SaveOptions

Base class for the save options for each save function.

emtellipro.db.schemas.schema.SaveOptionsType

1
emtellipro.db.schemas.schema.SaveOptionsType

Value: TypeVar(...)

emtellipro.db.schemas.schema.save_options_replace

1
emtellipro.db.schemas.schema.save_options_replace(
2
    options: emtellipro.db.schemas.schema.SaveOptionsType, **replacements
3
) -> emtellipro.db.schemas.schema.SaveOptionsType

Replace the attributes of options with matching values from replacements.

Parameters:

Returns:

A new instance of the same type as options, with changed attributes.