Module signals_notebook.materials.field

Classes

class AssetConfig (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class AssetConfig(BaseModel):
    numbering: Numbering
    fields: List[GenericFieldDefinition]
    display_name: str = Field(alias='displayName')
    asset_name_field_id: Optional[str] = Field(alias='assetNameFieldId', default=None)

    class Config:
        frozen = True
        allow_population_by_field_name = True

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Config

var asset_name_field_id : Optional[str]

var display_name : str

var fields : List[Union[AttachedFileFieldDefinition, AttributeFieldDefinition, BooleanFieldDefinition, CASNumberFieldDefinition, ChemicalDrawingFieldDefinition, DecimalFieldDefinition, DensityFieldDefinition, IntegerFieldDefinition, LinkFieldDefinition, MolecularFormulaFieldDefinition, MolecularMassFieldDefinition, SequenceFieldDefinition, TemperatureFieldDefinition, TextFieldDefinition, BaseFieldDefinition]]

var numbering : Numbering

class AttachedFileFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class AttachedFileFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.ATTACHED_FILE] = Field(
        alias='dataType', default=MaterialFieldType.ATTACHED_FILE
    )

    def to_representation(self, value: Any, material: 'Material', **kwargs) -> Any:
        """Get Material field attachment

        Args:
            value: field value
            material: material
            **kwargs:

        Returns:
            One of the Materials
        """
        return material.get_attachment(self.id)

    def to_internal_value(self, value: Any) -> Any:
        """Get field value as dictionary

        Args:
            value: field value

        Returns:
            field value as dictionary
        """
        if not isinstance(value, File):
            log.exception('File expected')
            raise TypeError('File expected')

        return {'filename': value.name, 'base64': value.base64.decode('utf-8')}

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.ATTACHED_FILE: 'ATTACHED_FILE'>]

Methods

def to_internal_value(self, value: Any) ‑> Any

Get field value as dictionary

Args

value

field value

Returns

field value as dictionary

Expand source code

def to_internal_value(self, value: Any) -> Any:
    """Get field value as dictionary

    Args:
        value: field value

    Returns:
        field value as dictionary
    """
    if not isinstance(value, File):
        log.exception('File expected')
        raise TypeError('File expected')

    return {'filename': value.name, 'base64': value.base64.decode('utf-8')}

def to_representation(self, value: Any, material: Material, **kwargs) ‑> Any

Get Material field attachment

Args

value

field value

material

material

**kwargs:

Returns

One of the Materials

Expand source code

def to_representation(self, value: Any, material: 'Material', **kwargs) -> Any:
    """Get Material field attachment

    Args:
        value: field value
        material: material
        **kwargs:

    Returns:
        One of the Materials
    """
    return material.get_attachment(self.id)

class AttributeFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class AttributeFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.ATTRIBUTE] = Field(alias='dataType', default=MaterialFieldType.ATTRIBUTE)
    multi_select: bool = Field(alias='multiSelect', default=False)
    attribute_id: AttrID = Field(alias='attribute')

    @property
    def attribute(self) -> Attribute:
        """Get Attribute object by id

        Returns:
            Attribute
        """
        return Attribute.get(self.attribute_id)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var attribute_id : AttrID

var data_type : Literal[<MaterialFieldType.ATTRIBUTE: 'ATTRIBUTE'>]

var multi_select : bool

Instance variables

var attribute : Attribute

Get Attribute object by id

Returns

Attribute

Expand source code

@property
def attribute(self) -> Attribute:
    """Get Attribute object by id

    Returns:
        Attribute
    """
    return Attribute.get(self.attribute_id)

class BaseFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class BaseFieldDefinition(BaseModel):
    id: str
    name: str
    mandatory: bool
    hidden: bool
    calculated: bool = Field(default=False)
    read_only: bool = Field(alias='readOnly', default=False)
    data_type: Union[MaterialFieldType, str] = Field(alias='dataType')
    defined_by: str = Field(alias='definedBy', default='SYSTEM_DEFAULT')

    def to_internal_value(self, value: Any) -> Any:
        return value

    def to_representation(self, value: Any, material: 'Material', **kwargs) -> Any:
        return value

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Subclasses

• AttachedFileFieldDefinition
• AttributeFieldDefinition
• BooleanFieldDefinition
• CASNumberFieldDefinition
• ChemicalDrawingFieldDefinition
• DecimalFieldDefinition
• DensityFieldDefinition
• IntegerFieldDefinition
• LinkFieldDefinition
• MolecularFormulaFieldDefinition
• MolecularMassFieldDefinition
• SequenceFieldDefinition
• TemperatureFieldDefinition
• TextFieldDefinition

Class variables

var calculated : bool

var data_type : Union[MaterialFieldType, str]

var defined_by : str

var hidden : bool

var id : str

var mandatory : bool

var name : str

var read_only : bool

Methods

def to_internal_value(self, value: Any) ‑> Any

Expand source code

def to_internal_value(self, value: Any) -> Any:
    return value

def to_representation(self, value: Any, material: Material, **kwargs) ‑> Any

Expand source code

def to_representation(self, value: Any, material: 'Material', **kwargs) -> Any:
    return value

class BatchConfig (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class BatchConfig(BaseModel):
    numbering: Numbering
    fields: List[GenericFieldDefinition]
    display_name: str = Field(alias='displayName')

    class Config:
        frozen = True
        allow_population_by_field_name = True

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Config

var display_name : str

var fields : List[Union[AttachedFileFieldDefinition, AttributeFieldDefinition, BooleanFieldDefinition, CASNumberFieldDefinition, ChemicalDrawingFieldDefinition, DecimalFieldDefinition, DensityFieldDefinition, IntegerFieldDefinition, LinkFieldDefinition, MolecularFormulaFieldDefinition, MolecularMassFieldDefinition, SequenceFieldDefinition, TemperatureFieldDefinition, TextFieldDefinition, BaseFieldDefinition]]

var numbering : Numbering

class BooleanFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class BooleanFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.BOOLEAN] = Field(alias='dataType', default=MaterialFieldType.BOOLEAN)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.BOOLEAN: 'BOOLEAN'>]

class CASNumberFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class CASNumberFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.CAS_NUMBER] = Field(alias='dataType', default=MaterialFieldType.CAS_NUMBER)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.CAS_NUMBER: 'CAS_NUMBER'>]

class ChemicalDrawingFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class ChemicalDrawingFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.CHEMICAL_DRAWING] = Field(
        alias='dataType', default=MaterialFieldType.CHEMICAL_DRAWING
    )

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.CHEMICAL_DRAWING: 'CHEMICAL_DRAWING'>]

class CollectionType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class CollectionType(str, Enum):
    LIST = 'LIST'
    MULTI_SELECT = 'MULTI_SELECT'

Ancestors

• builtins.str
• enum.Enum

Class variables

var LIST

var MULTI_SELECT

class DecimalFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class DecimalFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.DECIMAL] = Field(alias='dataType', default=MaterialFieldType.DECIMAL)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.DECIMAL: 'DECIMAL'>]

class DensityFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class DensityFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.DENSITY] = Field(alias='dataType', default=MaterialFieldType.DENSITY)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.DENSITY: 'DENSITY'>]

class FieldContainer (material: Material, field_definitions: List[Union[Annotated[Union[AttachedFileFieldDefinition, AttributeFieldDefinition, BooleanFieldDefinition, CASNumberFieldDefinition, ChemicalDrawingFieldDefinition, DecimalFieldDefinition, DensityFieldDefinition, IntegerFieldDefinition, LinkFieldDefinition, MolecularFormulaFieldDefinition, MolecularMassFieldDefinition, SequenceFieldDefinition, TemperatureFieldDefinition, TextFieldDefinition], FieldInfo(default=PydanticUndefined, discriminator='data_type', extra={})], BaseFieldDefinition]], **data)

Expand source code

class FieldContainer:
    def __init__(self, material: 'Material', field_definitions: List[GenericFieldDefinition], **data):
        self._data: dict[str, MaterialField] = {}
        self._material = material

        for field_definition in field_definitions:
            self._data[field_definition.name] = MaterialField.construct(
                definition=field_definition,
                value=data.get(field_definition.name, {}).get('value'),
                is_changed=False,
            )

    def items(self):
        """Get data items

        Returns:
            A view object that displays a list of data's (key, value) tuple pair.
        """
        return self._data.items()

    def __getitem__(self, key: str) -> Any:
        field = self._data[key]

        return field.definition.to_representation(field.value, self._material)

    def __setitem__(self, key: str, value: Any):
        if key not in self._data:
            raise KeyError()

        field = self._data[key]

        field.value = field.definition.to_internal_value(value)
        field.is_changed = True

Methods

def items(self)

Get data items

Returns

A view object that displays a list of data's (key, value) tuple pair.

Expand source code

def items(self):
    """Get data items

    Returns:
        A view object that displays a list of data's (key, value) tuple pair.
    """
    return self._data.items()

class IntegerFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class IntegerFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.INTEGER] = Field(alias='dataType', default=MaterialFieldType.INTEGER)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.INTEGER: 'INTEGER'>]

class LinkFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class LinkFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.LINK] = Field(alias='dataType', default=MaterialFieldType.LINK)

    def to_representation(self, value: Any, material: 'Material', **kwargs) -> Any:
        """Get Entity by value id

        Args:
            value: field value
            material: material
            **kwargs:

        Returns:
            One of the Entities
        """
        if not value:
            return None

        from signals_notebook.entities.entity_store import EntityStore

        return EntityStore.get(value['eid'])

    def to_internal_value(self, value: Any) -> Any:
        """Get field value as dictionary

        Args:
            value: field value

        Returns:
            field value as dictionary
        """
        from signals_notebook.entities.entity import Entity

        if not isinstance(value, Entity):
            log.exception('Entity expected')
            raise TypeError('Entity expected')

        return {'eid': value.eid, 'name': value.name, 'type': value.type}

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.LINK: 'LINK'>]

Methods

def to_internal_value(self, value: Any) ‑> Any

Get field value as dictionary

Args

value

field value

Returns

field value as dictionary

Expand source code

def to_internal_value(self, value: Any) -> Any:
    """Get field value as dictionary

    Args:
        value: field value

    Returns:
        field value as dictionary
    """
    from signals_notebook.entities.entity import Entity

    if not isinstance(value, Entity):
        log.exception('Entity expected')
        raise TypeError('Entity expected')

    return {'eid': value.eid, 'name': value.name, 'type': value.type}

def to_representation(self, value: Any, material: Material, **kwargs) ‑> Any

Get Entity by value id

Args

value

field value

material

material

**kwargs:

Returns

One of the Entities

Expand source code

def to_representation(self, value: Any, material: 'Material', **kwargs) -> Any:
    """Get Entity by value id

    Args:
        value: field value
        material: material
        **kwargs:

    Returns:
        One of the Entities
    """
    if not value:
        return None

    from signals_notebook.entities.entity_store import EntityStore

    return EntityStore.get(value['eid'])

class MaterialField (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class MaterialField(BaseModel):
    is_changed: bool = False
    definition: GenericFieldDefinition = Field(allow_mutation=False)
    value: Any

    class Config:
        validate_assignment = True

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var Config

var definition : Union[AttachedFileFieldDefinition, AttributeFieldDefinition, BooleanFieldDefinition, CASNumberFieldDefinition, ChemicalDrawingFieldDefinition, DecimalFieldDefinition, DensityFieldDefinition, IntegerFieldDefinition, LinkFieldDefinition, MolecularFormulaFieldDefinition, MolecularMassFieldDefinition, SequenceFieldDefinition, TemperatureFieldDefinition, TextFieldDefinition, BaseFieldDefinition]

var is_changed : bool

var value : Any

class MaterialFieldType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class MaterialFieldType(str, Enum):
    ATTACHED_FILE = 'ATTACHED_FILE'
    ATTRIBUTE = 'ATTRIBUTE'
    BOOLEAN = 'BOOLEAN'
    CHEMICAL_DRAWING = 'CHEMICAL_DRAWING'
    DATETIME = 'DATETIME'
    DECIMAL = 'DECIMAL'
    EXTERNAL_LINK = 'EXTERNAL_LINK'
    LINK = 'LINK'
    MOLECULAR_FORMULA = 'MOLECULAR_FORMULA'
    MOLECULAR_MASS = 'MOLECULAR_MASS'
    TEMPERATURE = 'TEMPERATURE'
    TEXT = 'TEXT'
    CAS_NUMBER = 'CAS_NUMBER'
    DENSITY = 'DENSITY'
    SEQUENCE = 'SEQUENCE'
    SEQUENCE_FILE = 'SEQUENCE_FILE'
    INTEGER = 'INTEGER'

Ancestors

• builtins.str
• enum.Enum

Class variables

var ATTACHED_FILE

var ATTRIBUTE

var BOOLEAN

var CAS_NUMBER

var CHEMICAL_DRAWING

var DATETIME

var DECIMAL

var DENSITY

var EXTERNAL_LINK

var INTEGER

var LINK

var MOLECULAR_FORMULA

var MOLECULAR_MASS

var SEQUENCE

var SEQUENCE_FILE

var TEMPERATURE

var TEXT

class MolecularFormulaFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class MolecularFormulaFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.MOLECULAR_FORMULA] = Field(
        alias='dataType', default=MaterialFieldType.MOLECULAR_FORMULA
    )

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.MOLECULAR_FORMULA: 'MOLECULAR_FORMULA'>]

class MolecularMassFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class MolecularMassFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.MOLECULAR_MASS] = Field(
        alias='dataType', default=MaterialFieldType.MOLECULAR_MASS
    )

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.MOLECULAR_MASS: 'MOLECULAR_MASS'>]

class Numbering (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class Numbering(BaseModel):
    format: str

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var format : str

class SequenceFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class SequenceFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.SEQUENCE] = Field(alias='dataType', default=MaterialFieldType.SEQUENCE)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.SEQUENCE: 'SEQUENCE'>]

class TemperatureFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class TemperatureFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.TEMPERATURE] = Field(alias='dataType', default=MaterialFieldType.TEMPERATURE)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var data_type : Literal[<MaterialFieldType.TEMPERATURE: 'TEMPERATURE'>]

class TextFieldDefinition (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class TextFieldDefinition(BaseFieldDefinition):
    data_type: Literal[MaterialFieldType.TEXT] = Field(alias='dataType', default=MaterialFieldType.TEXT)
    collection: Optional[CollectionType] = Field(default=None)
    options: Optional[List[str]] = Field(default=None)

Ancestors

• BaseFieldDefinition
• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var collection : Optional[CollectionType]

var data_type : Literal[<MaterialFieldType.TEXT: 'TEXT'>]

var options : Optional[List[str]]