mxcubecore.model.procedure_model

Classes

BaseModel(*args)
MockDataModel(*args[, transmission, energy, ...])	Example DataModel used by the MockProcedure (for testing)

Exceptions

ValidationError

class mxcubecore.model.procedure_model.BaseModel(*args)

Bases: BaseModel

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubecore.model.procedure_model.MockDataModel(*args, transmission: float = 0, energy: float = 0, resolution: float = 0, exposure_time: float = 0, number_of_images: float = 0)

Bases: BaseModel

Example DataModel used by the MockProcedure (for testing)

Parameters:

• transmission (float) –

• energy (float) –

• resolution (float) –

• exposure_time (float) –

• number_of_images (float) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'energy': FieldInfo(annotation=float, required=False, default=0), 'exposure_time': FieldInfo(annotation=float, required=False, default=0), 'number_of_images': FieldInfo(annotation=float, required=False, default=0), 'resolution': FieldInfo(annotation=float, required=False, default=0), 'transmission': FieldInfo(annotation=float, required=False, default=0)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

exception mxcubecore.model.procedure_model.ValidationError

Bases: Exception