simdb.database.models package

class simdb.database.models.Base(**kwargs)

Bases: BaseModel

Base model for ORM classes.

metadata = MetaData()

registry = <sqlalchemy.orm.decl_api.registry object>

class simdb.database.models.File(type, uri, ids_list=None, perform_integrity_check=True, config=None)

Bases: Base

Class to represent files in the database ORM.

checksum

data(recurse: bool = False) → Dict[str, str]

Serialise the File.

Parameters:

recurse – If True also serialise any contained models, otherwise only serialise simple fields.

Returns:

The serialised data.

datetime

classmethod from_data(data: Dict) → File

Create a Model from serialised data.

Parameters:

data – Serialised model data.

Returns:

The created model.

generate_checksum(config, ids_list: list)

get_creation_date() -> Column('datetime', DateTime(), table=<files>, nullable=False)

id

type: Type

uri: URI

uuid

class simdb.database.models.MetaData(key, value)

Bases: Base

Class to represent metadata in the database ORM.

data(recurse: bool = False) → Dict[str, str]

Serialise the MetaData.

Parameters:

recurse – If True also serialise any contained models, otherwise only serialise simple fields.

Returns:

The serialised data.

element

classmethod from_data(data: Dict) → MetaData

Create a Model from serialised data.

Parameters:

data – Serialised model data.

Returns:

The created model.

id

sim_id

value

class simdb.database.models.Simulation(manifest, config=None)

Bases: Base

Class to represent simulations in the database ORM.

class Status(value)

Bases: Enum

ACCEPTED = 'accepted'

DELETED = 'deleted'

DEPRECATED = 'deprecated'

FAILED = 'failed'

NOT_VALIDATED = 'not validated'

PASSED = 'passed'

alias: str

data(recurse: bool = False, meta_keys: List[str] | None = None) → Dict[str, str | List]

Serialise the Simulation.

Parameters:

recurse – If True also serialise any contained models, otherwise only serialise simple fields.

Returns:

The serialised data.

datetime: Column('datetime', DateTime(), table=<simulations>, nullable=False)

file_paths() → Set[Path]

find_meta(name: str) → List[MetaData]

classmethod from_data(data: Dict[str, str | Dict | List]) → Simulation

Create a Model from serialised data.

Parameters:

data – Serialised model data.

Returns:

The created model.

id

inputs: List[File]

meta: List[MetaData]

meta_dict() → Dict[str, Dict | Any]

outputs: List[File]

remove_meta(name: str) → None

set_meta(name: str, value: str) → None

property status: Status | None

uuid

validate_meta() → None

Check the metadata elements for duplicates, throwing and exception if found.

Duplicates should not be possible but if there is an issue causing them to arise then at least it will be caught early rather than causing an SQL constraint failure later.

watchers: List[Watcher]

class simdb.database.models.Watcher(username, email, notification)

Bases: Base

Class to represent people watching simulations for updates.

NOTIFICATION_CHOICES = {Notification.ALL: 'A', Notification.OBSOLESCENCE: 'O', Notification.REVISION: 'R', Notification.VALIDATION: 'V'}

data(recurse: bool = False) → Dict[str, str]

Serialise the Watcher.

Parameters:

recurse – If True also serialise any contained models, otherwise only serialise simple fields.

Returns:

The serialised data.

email

classmethod from_data(data: Dict) → Watcher

Create a Model from serialised data.

Parameters:

data – Serialised model data.

Returns:

The created model.

id

notification

username

validate_email(key, address)

Submodules

• simdb.database.models.base module
  • BaseModel
    • BaseModel.data()
    • BaseModel.from_data()
• simdb.database.models.file module
  • File
    • File.checksum
    • File.data()
    • File.datetime
    • File.from_data()
    • File.generate_checksum()
    • File.get_creation_date()
    • File.id
    • File.type
    • File.uri
    • File.uuid
• simdb.database.models.metadata module
  • MetaData
    • MetaData.data()
    • MetaData.element
    • MetaData.from_data()
    • MetaData.id
    • MetaData.sim_id
    • MetaData.value
• simdb.database.models.simulation module
  • Simulation
    • Simulation.Status
      • Simulation.Status.ACCEPTED
      • Simulation.Status.DELETED
      • Simulation.Status.DEPRECATED
      • Simulation.Status.FAILED
      • Simulation.Status.NOT_VALIDATED
      • Simulation.Status.PASSED
    • Simulation.alias
    • Simulation.data()
    • Simulation.datetime
    • Simulation.file_paths()
    • Simulation.find_meta()
    • Simulation.from_data()
    • Simulation.id
    • Simulation.inputs
    • Simulation.meta
    • Simulation.meta_dict()
    • Simulation.outputs
    • Simulation.remove_meta()
    • Simulation.set_meta()
    • Simulation.status
    • Simulation.uuid
    • Simulation.validate_meta()
    • Simulation.watchers
• simdb.database.models.types module
  • ChoiceType
    • ChoiceType.impl
    • ChoiceType.process_bind_param()
    • ChoiceType.process_literal_param()
    • ChoiceType.process_result_value()
    • ChoiceType.python_type
  • URI
    • URI.impl
    • URI.process_bind_param()
    • URI.process_literal_param()
    • URI.process_result_value()
    • URI.python_type
  • UUID
    • UUID.cache_ok
    • UUID.impl
    • UUID.load_dialect_impl()
    • UUID.process_bind_param()
    • UUID.process_literal_param()
    • UUID.process_result_value()
    • UUID.python_type
• simdb.database.models.utils module
  • checked_get()
  • flatten_dict()
  • unflatten_dict()
• simdb.database.models.watcher module
  • Watcher
    • Watcher.NOTIFICATION_CHOICES
    • Watcher.data()
    • Watcher.email
    • Watcher.from_data()
    • Watcher.id
    • Watcher.notification
    • Watcher.username
    • Watcher.validate_email()