liminal-orm 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

liminal/base/name_template_parts.py

@@ -1,96 +1,9 @@
-from typing import Any, ClassVar
+import warnings
 
-from pydantic import BaseModel, ConfigDict, field_validator
+from liminal.orm.name_template_parts import *  # noqa: F403
 
-from liminal.enums.name_template_part_type import NameTemplatePartType
-
-
-class NameTemplatePart(BaseModel):
-    """Base class for all name template parts. These are put together in a list (where order matters) to form a name template.
-
-    Parameters
-    ----------
-    component_type : NameTemplatePartType
-        The type of the component. One of the values in the NameTemplatePartType enum.
-
-    """
-
-    component_type: ClassVar[NameTemplatePartType]
-
-    _type_map: ClassVar[dict[NameTemplatePartType, type["NameTemplatePart"]]] = {}
-
-    model_config = ConfigDict(arbitrary_types_allowed=True)
-
-    def __init_subclass__(cls, **kwargs: Any) -> None:
-        super().__init_subclass__(**kwargs)
-        cls._type_map[cls.component_type] = cls
-
-    @classmethod
-    def resolve_type(cls, type: NameTemplatePartType) -> type["NameTemplatePart"]:
-        if type not in cls._type_map:
-            raise ValueError(f"Invalid name template part type: {type}")
-        return cls._type_map[type]
-
-
-class SeparatorPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.SEPARATOR
-    value: str
-
-    @field_validator("value")
-    def validate_value(cls, v: str) -> str:
-        if not v:
-            raise ValueError("value cannot be empty")
-        return v
-
-
-class TextPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.TEXT
-    value: str
-
-    @field_validator("value")
-    def validate_value(cls, v: str) -> str:
-        if not v:
-            raise ValueError("value cannot be empty")
-        return v
-
-
-class CreationYearPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.CREATION_YEAR
-
-
-class CreationDatePart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.CREATION_DATE
-
-
-class FieldPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.FIELD
-    wh_field_name: str
-
-
-class ParentLotNumberPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = (
-        NameTemplatePartType.CHILD_ENTITY_LOT_NUMBER
-    )
-    wh_field_name: str
-
-
-class RegistryIdentifierNumberPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = (
-        NameTemplatePartType.REGISTRY_IDENTIFIER_NUMBER
-    )
-
-
-class ProjectPart(NameTemplatePart):
-    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.PROJECT
-
-
-NameTemplateParts = (
-    SeparatorPart
-    | TextPart
-    | CreationYearPart
-    | CreationDatePart
-    | FieldPart
-    | RegistryIdentifierNumberPart
-    | ProjectPart
-    | ParentLotNumberPart
+warnings.warn(
+    "Importing from 'liminal.base.name_template_parts' is deprecated. Please import from 'liminal.orm.name_template_parts' instead.",
+    DeprecationWarning,
+    stacklevel=2,
 )

liminal/base/properties/base_name_template.py

@@ -4,7 +4,7 @@ from typing import Any
 
 from pydantic import BaseModel, ConfigDict
 
-from liminal.base.name_template_parts import NameTemplateParts
+from liminal.orm.name_template_parts import NameTemplateParts
 
 
 class BaseNameTemplate(BaseModel):

liminal/entity_schemas/generate_files.py

@@ -135,7 +135,7 @@ def generate_all_entity_schema_files(
         if name_template != NameTemplate():
             import_strings.append("from liminal.orm.name_template import NameTemplate")
             parts_imports = [
-                f"from liminal.base.name_template_parts import {', '.join(set([part.__class__.__name__ for part in name_template.parts]))}"
+                f"from liminal.orm.name_template_parts import {', '.join(set([part.__class__.__name__ for part in name_template.parts]))}"
             ]
             import_strings.extend(parts_imports)
         for col_name, col in columns.items():

liminal/entity_schemas/tag_schema_models.py

@@ -5,9 +5,6 @@ from typing import Any
 import requests
 from pydantic import BaseModel
 
-from liminal.base.name_template_parts import (
-    NameTemplatePart,
-)
 from liminal.base.properties.base_field_properties import BaseFieldProperties
 from liminal.base.properties.base_name_template import BaseNameTemplate
 from liminal.base.properties.base_schema_properties import BaseSchemaProperties
@@ -24,6 +21,9 @@ from liminal.mappers import (
     convert_entity_type_to_api_entity_type,
     convert_field_type_to_api_field_type,
 )
+from liminal.orm.name_template_parts import (
+    NameTemplatePart,
+)
 from liminal.orm.schema_properties import MixtureSchemaConfig
 
 

liminal/external/__init__.py

@@ -1,14 +1,5 @@
 # flake8: noqa: F401
 from liminal.base.base_operation import BaseOperation
-from liminal.base.name_template_parts import (
-    CreationDatePart,
-    CreationYearPart,
-    FieldPart,
-    ProjectPart,
-    RegistryIdentifierNumberPart,
-    SeparatorPart,
-    TextPart,
-)
 from liminal.base.properties.base_field_properties import BaseFieldProperties
 from liminal.base.properties.base_name_template import BaseNameTemplate
 from liminal.base.properties.base_schema_properties import BaseSchemaProperties
@@ -42,3 +33,12 @@ from liminal.enums import (
     BenchlingNamingStrategy,
     BenchlingSequenceType,
 )
+from liminal.orm.name_template_parts import (
+    CreationDatePart,
+    CreationYearPart,
+    FieldPart,
+    ProjectPart,
+    RegistryIdentifierNumberPart,
+    SeparatorPart,
+    TextPart,
+)

liminal/orm/base_model.py

@@ -12,11 +12,11 @@ from sqlalchemy.orm import Query, RelationshipProperty, Session, relationship
 from sqlalchemy.orm.decl_api import declared_attr
 
 from liminal.base.base_validation_filters import BaseValidatorFilters
-from liminal.base.name_template_parts import FieldPart
 from liminal.enums import BenchlingNamingStrategy
 from liminal.orm.base import Base
 from liminal.orm.base_tables.user import User
 from liminal.orm.name_template import NameTemplate
+from liminal.orm.name_template_parts import FieldPart
 from liminal.orm.schema_properties import SchemaProperties
 from liminal.validation import BenchlingValidatorReport
 

liminal/orm/name_template.py

@@ -4,8 +4,8 @@ from typing import Any
 
 from pydantic import ConfigDict, field_validator
 
-from liminal.base.name_template_parts import NameTemplateParts, SeparatorPart
 from liminal.base.properties.base_name_template import BaseNameTemplate
+from liminal.orm.name_template_parts import NameTemplateParts, SeparatorPart
 
 
 class NameTemplate(BaseNameTemplate):
@@ -19,7 +19,7 @@ class NameTemplate(BaseNameTemplate):
         The list of name template parts that make up the name template (order matters). Defaults to no parts, an empty list.
     order_name_parts_by_sequence : bool = False
         Whether to order the name parts by sequence. This can only be set to True for sequence enity types. If one or many part link fields are included in the name template,
-        list parts in the order they appear on the sequence map, sorted by start position and then end position.Defaults to False.
+        list parts in the order they appear on the sequence map, sorted by start position and then end position. Defaults to False.
     """
 
     parts: list[NameTemplateParts] = []

liminal/orm/name_template_parts.py

@@ -0,0 +1,96 @@
+from typing import Any, ClassVar
+
+from pydantic import BaseModel, ConfigDict, field_validator
+
+from liminal.enums.name_template_part_type import NameTemplatePartType
+
+
+class NameTemplatePart(BaseModel):
+    """Base class for all name template parts. These are put together in a list (where order matters) to form a name template.
+
+    Parameters
+    ----------
+    component_type : NameTemplatePartType
+        The type of the component. One of the values in the NameTemplatePartType enum.
+
+    """
+
+    component_type: ClassVar[NameTemplatePartType]
+
+    _type_map: ClassVar[dict[NameTemplatePartType, type["NameTemplatePart"]]] = {}
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    def __init_subclass__(cls, **kwargs: Any) -> None:
+        super().__init_subclass__(**kwargs)
+        cls._type_map[cls.component_type] = cls
+
+    @classmethod
+    def resolve_type(cls, type: NameTemplatePartType) -> type["NameTemplatePart"]:
+        if type not in cls._type_map:
+            raise ValueError(f"Invalid name template part type: {type}")
+        return cls._type_map[type]
+
+
+class SeparatorPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.SEPARATOR
+    value: str
+
+    @field_validator("value")
+    def validate_value(cls, v: str) -> str:
+        if not v:
+            raise ValueError("value cannot be empty")
+        return v
+
+
+class TextPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.TEXT
+    value: str
+
+    @field_validator("value")
+    def validate_value(cls, v: str) -> str:
+        if not v:
+            raise ValueError("value cannot be empty")
+        return v
+
+
+class CreationYearPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.CREATION_YEAR
+
+
+class CreationDatePart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.CREATION_DATE
+
+
+class FieldPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.FIELD
+    wh_field_name: str
+
+
+class ParentLotNumberPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = (
+        NameTemplatePartType.CHILD_ENTITY_LOT_NUMBER
+    )
+    wh_field_name: str
+
+
+class RegistryIdentifierNumberPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = (
+        NameTemplatePartType.REGISTRY_IDENTIFIER_NUMBER
+    )
+
+
+class ProjectPart(NameTemplatePart):
+    component_type: ClassVar[NameTemplatePartType] = NameTemplatePartType.PROJECT
+
+
+NameTemplateParts = (
+    SeparatorPart
+    | TextPart
+    | CreationYearPart
+    | CreationDatePart
+    | FieldPart
+    | RegistryIdentifierNumberPart
+    | ProjectPart
+    | ParentLotNumberPart
+)

liminal/tests/test_entity_schema_compare.py

@@ -1,7 +1,6 @@
 import copy
 from unittest.mock import Mock, patch
 
-from liminal.base.name_template_parts import TextPart
 from liminal.base.properties.base_field_properties import BaseFieldProperties
 from liminal.entity_schemas.compare import compare_entity_schemas
 from liminal.entity_schemas.operations import (
@@ -18,6 +17,7 @@ from liminal.entity_schemas.operations import (
 )
 from liminal.enums import BenchlingFieldType
 from liminal.orm.name_template import NameTemplate
+from liminal.orm.name_template_parts import TextPart
 
 
 class TestCompareEntitySchemas:

{liminal_orm-2.0.0.dist-info → liminal_orm-2.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: liminal-orm
-Version: 2.0.0
+Version: 2.0.1
 Summary: An ORM and toolkit that builds on top of Benchling's platform to keep your schemas and downstream code dependencies in sync.
 Home-page: https://github.com/dynotx/liminal-orm
 Author: DynoTx Open Source

{liminal_orm-2.0.0.dist-info → liminal_orm-2.0.1.dist-info}/RECORD

@@ -3,9 +3,9 @@ liminal/base/base_dropdown.py,sha256=Unk4l_5Y8rj_eSWYqzFi2BAFSQToQDWW2qdXwiCHTg8
 liminal/base/base_operation.py,sha256=RjGRaCTNQ5oVI4PAQ5D3svymw_HAcGvzBXWWrMRo29k,3128
 liminal/base/base_validation_filters.py,sha256=kHG3G5gXkuNHQosMTrxRc57OTmczcaoSx0DmkrScIr4,1043
 liminal/base/compare_operation.py,sha256=hkpv4ewHhxy4dlTPKgJuzBjsAqO6Km7OrrKB44pRA_o,352
-liminal/base/name_template_parts.py,sha256=KCGXAcCuOqCjlgYn-mw1K7fwDI92D20l-FnlpEVrbM8,2771
+liminal/base/name_template_parts.py,sha256=dJeyrhhhZHDwKXe_p7AtgDlbZlzsnYQ8FoM8FXVF7q0,271
 liminal/base/properties/base_field_properties.py,sha256=NvuQjYZ5U_2363P2c8FXmmLfOtdzUqTuZTjDDfXnO-E,4922
-liminal/base/properties/base_name_template.py,sha256=EHytur3jcPSRx-it_2elYSjdgx7OOr206qyf2bFcweg,3151
+liminal/base/properties/base_name_template.py,sha256=AOtaW4QEDRC-mjZOZk6jgc_mopUMsHS2Fj6VVsO07WY,3150
 liminal/base/properties/base_schema_properties.py,sha256=pVeIVHea-3Wt0fde9CsOvluwVmYMbsMhGeSncRL2Ats,5351
 liminal/base/str_enum.py,sha256=jF3d-Lo8zsHUe6GsctX2L-TSj92Y3qCYDrTD-saeJoc,210
 liminal/cli/cli.py,sha256=JxWHLO9KMeMaOnOYwzdH0w71l0477ScFOkWNtTlc97Y,9045
@@ -23,9 +23,9 @@ liminal/dropdowns/utils.py,sha256=1-H7bTszCUeqeRBpiYXjRjreDzhn1Fd1MFwIsrEI-o4,41
 liminal/entity_schemas/api.py,sha256=Emn_Y95cAG9Wis6tpchw6QBVKQh4If86LOdgKk0Ndjw,3575
 liminal/entity_schemas/compare.py,sha256=CIYglq1F-g9jGc1eRRD4LnNErrH2n__pPIJc4EB1hkM,16570
 liminal/entity_schemas/entity_schema_models.py,sha256=YDpz1XkNc9e51zah8Z6qCk30gAuXP6xLEYv1Lb3ECpA,6838
-liminal/entity_schemas/generate_files.py,sha256=ujzofsGlr76z5YadOar0_6ufkjBYZjz0aawBUupIvnU,8878
+liminal/entity_schemas/generate_files.py,sha256=oYx0t76oRa36gWwVl1W5jHryh-POIyZPDMbGNjT5bfY,8877
 liminal/entity_schemas/operations.py,sha256=rs9EXmHDgnUad2SSfZ3tnDPFA6L-2wvllAGqBwBurMs,24020
-liminal/entity_schemas/tag_schema_models.py,sha256=BGvfQwjfIcRl3yHmYUM6sQpkbFTUMaeT6ix62fjKp2A,22017
+liminal/entity_schemas/tag_schema_models.py,sha256=h6Zf_zXYG_gTh2eQh_lEGZKUAmvzdnnArlmAhIeX1bM,22016
 liminal/entity_schemas/utils.py,sha256=iZ1_M2r8zKOCFj9QSMdrv-_4XznDn_znAOfoP4Mh1jA,4943
 liminal/enums/__init__.py,sha256=Ue_3QtElW-JMSWtu4vGsAOFQbYnzHHZUdkWpdkzkKA4,453
 liminal/enums/benchling_api_field_type.py,sha256=0QamSWEMnxZtedZXlh6zNhSRogS9ZqvWskdHHN19xJo,633
@@ -35,20 +35,21 @@ liminal/enums/benchling_folder_item_type.py,sha256=Jb-YxCvB8O86_qTsfwtLQOkKGjTWG
 liminal/enums/benchling_naming_strategy.py,sha256=wG3AfnPOui5Qfc0Fihszm5uKWjuc7gdpI8jptNB5A-w,1201
 liminal/enums/benchling_sequence_type.py,sha256=TBI4C5c1XKE4ZXqsz1ApDUzy2wR-04u-M3VO_zLikjM,202
 liminal/enums/name_template_part_type.py,sha256=Kv0phZIO_dPN3tLHM0lT2tjUd3zBGqpJQGahEpGjNcU,365
-liminal/external/__init__.py,sha256=rYg51-fI6FO7H2iZkbIPUzWpSW8MTBKfiTNwLZt3yvY,1265
+liminal/external/__init__.py,sha256=nMpyzpBXpYhTvN3R3HQEiYb24_U2AYjz_20seAUUK9s,1264
 liminal/mappers.py,sha256=O9gc95b7JvfaR8xVrn0X1d0Tcs6Iwh-yhBHXhWSX8i0,9616
 liminal/migrate/components.py,sha256=2HuFp5KDNhofROMRI-BioUoA4CCjhQ_v_F0QmGJzUBU,3480
 liminal/migrate/revision.py,sha256=KppU0u-d0JsfPsXsmncxy9Q_XBJyf-o4e16wNZAJODM,7774
 liminal/migrate/revisions_timeline.py,sha256=G9VwxPrLhLqKOrIXyxrXyHpujc-72m7omsZjI5-0D0M,14520
 liminal/migrate/utils.py,sha256=HdSr3N2WN_1S-PLRGVWSMYl-4gIcP-Ph2wPycGi2cGg,3404
 liminal/orm/base.py,sha256=fFSpiNRYgK5UG7lbXdQGV8KgO8pwjMqt0pycM3rWJ2o,615
-liminal/orm/base_model.py,sha256=RYVQ2kFaxMDGYWL2Lv63KMUZljSyIkdkjoSHoHLU8UU,13892
+liminal/orm/base_model.py,sha256=Nf4gSEwvORRdnY5ODW79ddJWxnshLLvrPo8xcimHH6c,13891
 liminal/orm/base_tables/registry_entity.py,sha256=4ET1cepTGjZ3AMFI5q-iMYxMObzXwuUDBD0jNNqCipE,2126
 liminal/orm/base_tables/schema.py,sha256=7_btCVSUJxjVdGcKVRKL8sKcNw7-_gazTpfEh1jru3o,921
 liminal/orm/base_tables/user.py,sha256=elRAHj7HgO3iVLK_pNCIwf_9Rl_9k6vkBgaYazoJSQc,818
 liminal/orm/column.py,sha256=e4JWn97s_4EVJ1LOO5l6iucHQUd39Vl0stqMEj0uet8,5114
 liminal/orm/mixins.py,sha256=yEeUDF1qEBLP523q8bZra4KtNVK0gwZN9mXJSNe3GEE,4802
-liminal/orm/name_template.py,sha256=qsppCDPCVBhVZs3Uz-x4QdJbElH6VPlwfRD1BX_pAwE,1739
+liminal/orm/name_template.py,sha256=ftXZOiRR6gGGvGaZkFVDXKOboIHFWauhQENRguBGWMI,1739
+liminal/orm/name_template_parts.py,sha256=KCGXAcCuOqCjlgYn-mw1K7fwDI92D20l-FnlpEVrbM8,2771
 liminal/orm/relationship.py,sha256=Zl4bMHbtDSPx1psGHYnojGGJpA8B8hwcPJdgjB1lmW0,2490
 liminal/orm/schema_properties.py,sha256=yv6MOsE_16OWJnGDh2K8wI_054PJwafYmHgY_Awr3XA,3420
 liminal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -56,12 +57,12 @@ liminal/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 liminal/tests/conftest.py,sha256=B463eOfe1uCHDJsUNvG-6tY8Qx8FJMByGDOtuyM87lA,17669
 liminal/tests/from benchling_sdk.py,sha256=CjRUHFB3iaa4rUPLGOqDiBq5EPKldm-Fd8aQQr92zF4,147
 liminal/tests/test_dropdown_compare.py,sha256=yHB0ovQlBLRu8-qYkqIPd8VtYEOmOft_93FQM86g_z8,8198
-liminal/tests/test_entity_schema_compare.py,sha256=JfvrdRfnm77dchHL5mwTLXfrKYW47wANacFJlS5Iw80,18953
+liminal/tests/test_entity_schema_compare.py,sha256=-26Bu5eYIuHRswB5kYjGDo5Wed5LUWjm1e6IRI1Q-lE,18952
 liminal/utils.py,sha256=radRtRsZmCiNblMvxOX1DH0rcO5TR09kFlp6OONIPBU,2951
 liminal/validation/__init__.py,sha256=HOjBHCwxvQao6SN_Q5B-JbabG7Z6ff44JIDKLeK96l8,5458
 liminal/validation/validation_severity.py,sha256=ib03PTZCQHcbBDc01v4gJF53YtA-ANY6QSFnhTV-FbU,259
-liminal_orm-2.0.0.dist-info/LICENSE.md,sha256=oVA877F_D1AV44dpjsv4f-4k690uNGApX1EtzOo3T8U,11353
-liminal_orm-2.0.0.dist-info/METADATA,sha256=_ioXetNNEIXfaO4Zmgis49Y86FfiUyGbmpCqy5SJI3E,11056
-liminal_orm-2.0.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-liminal_orm-2.0.0.dist-info/entry_points.txt,sha256=atIrU63rrzH81dWC2sjUbFLlc5FWMmYRdMxXEWexIZA,47
-liminal_orm-2.0.0.dist-info/RECORD,,
+liminal_orm-2.0.1.dist-info/LICENSE.md,sha256=oVA877F_D1AV44dpjsv4f-4k690uNGApX1EtzOo3T8U,11353
+liminal_orm-2.0.1.dist-info/METADATA,sha256=axM6tXYgSWVWjPGQ_dYDOhNkPEtECVvcB6UHPaB_h8o,11056
+liminal_orm-2.0.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+liminal_orm-2.0.1.dist-info/entry_points.txt,sha256=atIrU63rrzH81dWC2sjUbFLlc5FWMmYRdMxXEWexIZA,47
+liminal_orm-2.0.1.dist-info/RECORD,,