mat3ra-esse 2024.4.8.post0__py3-none-any.whl → 2024.4.8.post2__py3-none-any.whl

mat3ra/esse/models/system/_parent_job.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  system/_parent_job.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class Cls(Enum):
+    Job = "Job"
+
+
+class ParentJobEntityReferenceSchema(BaseModel):
+    cls: Optional[Cls] = None
+    """
+    Job class
+    """
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """

mat3ra/esse/models/system/_project.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  system/_project.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class Cls(Enum):
+    Project = "Project"
+
+
+class ProjectEntityReferenceSchema(BaseModel):
+    cls: Optional[Cls] = None
+    """
+    Project class
+    """
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """

mat3ra/esse/models/system/bankable.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  system/bankable.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class BankableSchema(BaseModel):
+    exabyteId: Optional[str] = None
+    """
+    Identity of the corresponding bank entity
+    """
+    hash: Optional[str] = None
+    """
+    Hash string which is calculated based on the meaningful fields of the entity. Used to identify equal entities.
+    """

mat3ra/esse/models/system/consistency_check.py

@@ -0,0 +1,40 @@
+# generated by datamodel-codegen:
+#   filename:  system/consistency_check.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import BaseModel
+
+
+class Name(Enum):
+    default = "default"
+    atomsTooClose = "atomsTooClose"
+    atomsOverlap = "atomsOverlap"
+
+
+class Severity(Enum):
+    info = "info"
+    warning = "warning"
+    error = "error"
+
+
+class ConsistencyCheck(BaseModel):
+    key: str
+    """
+    Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'
+    """
+    name: Name
+    """
+    Name of the consistency check that is performed, which is listed in an enum.
+    """
+    severity: Severity
+    """
+    Severity level of the problem, which is used in UI to differentiate.
+    """
+    message: str
+    """
+    Message generated by the consistency check describing the problem.
+    """

mat3ra/esse/models/system/creator.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  system/creator.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class Cls(Enum):
+    User = "User"
+
+
+class CreatorEntityReferenceSchema(BaseModel):
+    cls: Optional[Cls] = None
+    """
+    Creator class
+    """
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """

mat3ra/esse/models/system/creator_account.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  system/creator_account.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class EntityReferenceSchema(BaseModel):
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    cls: Optional[str] = None
+    """
+    entity class
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """
+
+
+class CreatorAccountSchema(BaseModel):
+    creatorAccount: Optional[EntityReferenceSchema] = Field(None, title="entity reference schema")

mat3ra/esse/models/system/database_source.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  system/database_source.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional, Union
+
+from pydantic import BaseModel
+
+
+class DatabaseSourceSchema(BaseModel):
+    id: Union[str, float]
+    """
+    ID string for the materials uploaded from a third party source inside the third party source. For materialsproject.org an example ID is mp-32
+    """
+    source: str
+    """
+    Third party source name, e.g. materials project, 2dmatpedia, ICSD, etc.
+    """
+    origin: bool
+    """
+    Deprecated. To be removed. A flag that is true when material is initially imported from a third party * (as opposed to being independently designed from scratch).
+    """
+    data: Optional[Dict[str, Any]] = None
+    """
+    Original response from external source.
+    """
+    doi: Optional[str] = None
+    """
+    Digital Object Identifier, e.g. 10.1088/0953-8984/25/10/105506
+    """
+    url: Optional[str] = None
+    """
+    The URL of the original record, e.g. https://next-gen.materialsproject.org/materials/mp-48; ToDo: update to use URI type per https://json-schema.org/understanding-json-schema/reference/string#resource-identifiers
+    """

mat3ra/esse/models/system/defaultable.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  system/defaultable.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class DefaultableEntitySchema(BaseModel):
+    isDefault: Optional[bool] = False
+    """
+    Identifies that entity is defaultable
+    """

mat3ra/esse/models/system/description.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  system/description.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel
+
+
+class ExtendedBaseEntitySchema(BaseModel):
+    description: Optional[str] = None
+    """
+    entity description
+    """
+    descriptionObject: Optional[Dict[str, Any]] = None

mat3ra/esse/models/system/entity_reference.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  system/entity_reference.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class EntityReferenceSchema(BaseModel):
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    cls: Optional[str] = None
+    """
+    entity class
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """

mat3ra/esse/models/system/file_source.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  system/file_source.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class FileSourceSchema(BaseModel):
+    extension: Optional[str] = None
+    """
+    file extension
+    """
+    filename: str
+    """
+    file name without extension
+    """
+    text: str
+    """
+    file content as raw text
+    """
+    hash: str
+    """
+    MD5 hash based on file content
+    """

mat3ra/esse/models/system/history.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  system/history.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+
+class HistoryItem(BaseModel):
+    id: str
+    revision: float
+
+
+class HistorySchema(BaseModel):
+    history: Optional[List[HistoryItem]] = None

mat3ra/esse/models/system/iframe_message.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  system/iframe_message.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any, Dict
+
+from pydantic import BaseModel
+
+
+class Type(Enum):
+    from_iframe_to_host = "from-iframe-to-host"
+    from_host_to_iframe = "from-host-to-iframe"
+
+
+class Action(Enum):
+    set_data = "set-data"
+    get_data = "get-data"
+    info = "info"
+
+
+class IframeMessageSchema(BaseModel):
+    type: Type
+    """
+    The type of the message to distinguish the direction of the message.
+    """
+    action: Action
+    """
+    The action to be performed upon receiving the message.
+    """
+    payload: Dict[str, Any]
+    """
+    The content of the message with actual data.
+    """

mat3ra/esse/models/system/in_set.py

@@ -0,0 +1,30 @@
+# generated by datamodel-codegen:
+#   filename:  system/in_set.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class EntityReferenceSchema(BaseModel):
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    cls: Optional[str] = None
+    """
+    entity class
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """
+    type: Optional[str] = None
+    index: Optional[float] = None
+
+
+class SystemInSetSchema(BaseModel):
+    inSet: Optional[List[EntityReferenceSchema]] = None

mat3ra/esse/models/system/is_multi_material.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  system/is_multi_material.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class IsMultiSchema(BaseModel):
+    isMultiMaterial: Optional[bool] = None

mat3ra/esse/models/system/is_outdated.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  system/is_outdated.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class IsOutdatedSchema(BaseModel):
+    isOutdated: Optional[bool] = None

mat3ra/esse/models/system/job_extended.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  system/job_extended.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class EntityReferenceSchema(BaseModel):
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    cls: Optional[str] = None
+    """
+    entity class
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """
+
+
+class ExtendedJobSchema(BaseModel):
+    mode: Optional[str] = None
+    isExternal: Optional[bool] = None
+    field_materials: Optional[List[EntityReferenceSchema]] = Field(None, alias="_materials")
+    field_materialsSet: Optional[EntityReferenceSchema] = Field(
+        None, alias="_materialsSet", title="entity reference schema"
+    )
+    purged: Optional[bool] = None
+    purgedAt: Optional[float] = None
+    dataset: Optional[Dict[str, Any]] = None

mat3ra/esse/models/system/message.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  system/message.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, Field
+
+
+class Name(Enum):
+    job = "job"
+    unit = "unit"
+
+
+class Probe(Enum):
+    monitor = "monitor"
+    postprocessor = "postprocessor"
+
+
+class Entity(BaseModel):
+    field_id: str = Field(..., alias="_id")
+    """
+    job identifier
+    """
+    name: Name
+    """
+    entity name.
+    """
+    flowchartId: Optional[str] = None
+    """
+    unit identifier within the workflow
+    """
+    probe: Optional[Probe] = None
+    """
+    source of the message.
+    """
+
+
+class Header(BaseModel):
+    entity: Entity
+    version: str
+    """
+    Rupy-Webapp communication schema version.
+    """
+    timestamp: float
+    """
+    Timestamp of the message.
+    """
+
+
+class MessageSchema(BaseModel):
+    header: Header
+    payload: Dict[str, Any]
+    """
+    Actual payload of the message.
+    """

mat3ra/esse/models/system/metadata.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  system/metadata.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel
+
+
+class MetadataSchema(BaseModel):
+    metadata: Optional[Dict[str, Any]] = None

mat3ra/esse/models/system/name.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  system/name.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class NameEntitySchema(BaseModel):
+    name: Optional[str] = None
+    """
+    entity name
+    """

mat3ra/esse/models/system/owner.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  system/owner.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class Cls(Enum):
+    Account = "Account"
+
+
+class EntityOwnerReferenceSchema(BaseModel):
+    cls: Optional[Cls] = None
+    """
+    Entity owner class
+    """
+    field_id: Optional[str] = Field(None, alias="_id")
+    """
+    entity identity
+    """
+    slug: Optional[str] = None
+    """
+    entity slug
+    """

mat3ra/esse/models/system/path.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  system/path.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class PathSchema(BaseModel):
+    path: Optional[str] = Field(None, title="category path schema")
+    """
+    TODO: Use regex once schema draft version has been updated
+    """

mat3ra/esse/models/system/path_entity.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  system/path_entity.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class PathEntitySchema(BaseModel):
+    name: Optional[str] = None
+    """
+    entity name
+    """
+    path: Optional[str] = Field(None, title="category path schema")
+    """
+    TODO: Use regex once schema draft version has been updated
+    """

mat3ra/esse/models/system/schema_version.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  system/schema_version.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class SchemaVersion(BaseModel):
+    schemaVersion: Optional[str] = "2022.8.16"
+    """
+    entity's schema version. Used to distinct between different schemas.
+    """

mat3ra/esse/models/system/scope.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  system/scope.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ScopeSchema(BaseModel):
+    scope: Optional[str] = None

mat3ra/esse/models/system/set.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  system/set.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class EntitySetSchema(BaseModel):
+    isEntitySet: Optional[bool] = None
+    entitySetType: Optional[str] = None
+    entityCls: Optional[str] = None

mat3ra/esse/models/system/sharing.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  system/sharing.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ExtendedSharingSchema(BaseModel):
+    sharedCount: Optional[float] = None