liminal-orm 2.0.0__tar.gz → 2.0.2__tar.gz

{liminal_orm-2.0.0 → liminal_orm-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: liminal-orm
-Version: 2.0.0
+Version: 2.0.2
 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
@@ -88,7 +88,7 @@ With your schemas defined in code, you can now take advantage of the additional
     class Pizza(BaseModel, CustomEntityMixin):
         ...
 
-        @liminal_validator(ValidationSeverity.MED)
+        @liminal_validator
         def cook_time_and_temp_validator(self) -> None:
             if self.cook_time is not None and self.cook_temp is None:
                 raise ValueError("Cook temp is required if cook time is set")

{liminal_orm-2.0.0 → liminal_orm-2.0.2}/README.md

@@ -57,7 +57,7 @@ With your schemas defined in code, you can now take advantage of the additional
     class Pizza(BaseModel, CustomEntityMixin):
         ...
 
-        @liminal_validator(ValidationSeverity.MED)
+        @liminal_validator
         def cook_time_and_temp_validator(self) -> None:
             if self.cook_time is not None and self.cook_temp is None:
                 raise ValueError("Cook temp is required if cook time is set")

liminal_orm-2.0.2/liminal/base/name_template_parts.py

@@ -0,0 +1,9 @@
+import warnings
+
+from liminal.orm.name_template_parts import *  # noqa: F403
+
+warnings.warn(
+    "Importing from 'liminal.base.name_template_parts' is deprecated. Please import from 'liminal.orm.name_template_parts' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)

{liminal_orm-2.0.0 → liminal_orm-2.0.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_orm-2.0.0 → liminal_orm-2.0.2}/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_orm-2.0.0 → liminal_orm-2.0.2}/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_orm-2.0.0 → liminal_orm-2.0.2}/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-2.0.0 → liminal_orm-2.0.2}/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-2.0.0 → liminal_orm-2.0.2}/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-2.0.0 → liminal_orm-2.0.2}/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 → liminal_orm-2.0.2}/liminal/validation/__init__.py

@@ -1,7 +1,7 @@
 import inspect
 from datetime import datetime
-from functools import wraps
-from typing import TYPE_CHECKING, Callable
+from functools import partial, wraps
+from typing import TYPE_CHECKING, Any, Callable
 
 from pydantic import BaseModel, ConfigDict
 
@@ -67,6 +67,7 @@ class BenchlingValidatorReport(BaseModel):
         entity: type["BenchlingBaseModel"],
         validator_name: str,
         message: str | None = None,
+        **kwargs: Any,
     ) -> "BenchlingValidatorReport":
         """Creates a BenchlingValidatorReport with the given parameters.
 
@@ -96,59 +97,68 @@ class BenchlingValidatorReport(BaseModel):
             creator_email=entity.creator.email if entity.creator else None,
             updated_date=entity.modified_at,
             message=message,
+            **kwargs,
         )
 
 
-def liminal_validator(
-    validator_level: ValidationSeverity = ValidationSeverity.LOW,
-    validator_name: str | None = None,
+def _liminal_decorator(
+    func: Callable[[type["BenchlingBaseModel"]], BenchlingValidatorReport | None],
+    validator_level: ValidationSeverity,
+    validator_name: str | None,
 ) -> Callable:
-    """A decorator that validates a function that takes a Benchling entity as an argument and returns None.
-
-    Parameters:
-        validator_level: ValidationSeverity
-            The level of the validator.
-        validator_name: str | None
-            The name of the validator. Defaults to the pascalized name of the function.
-    """
-
-    def decorator(func: Callable[[type["BenchlingBaseModel"]], None]) -> Callable:
-        """Decorator that validates a function that takes a Benchling entity as an argument and returns None."""
-        sig = inspect.signature(func)
-        params = list(sig.parameters.values())
-        if not params or params[0].name != "self" or len(params) > 1:
-            raise TypeError(
-                "Validator must defined in a schema class, where the only argument to this validator must be 'self'."
-            )
+    """Core decorator logic for liminal_validator."""
+    sig = inspect.signature(func)
+    params = list(sig.parameters.values())
+    if not params or params[0].name != "self" or len(params) > 1:
+        raise TypeError(
+            "Validator must be defined in a schema class, where the only argument to this validator must be 'self'."
+        )
 
-        if sig.return_annotation is not None:
-            raise TypeError("The return type must be None.")
-
-        nonlocal validator_name
-        if validator_name is None:
-            validator_name = pascalize(func.__name__)
-
-        @wraps(func)
-        def wrapper(self: type["BenchlingBaseModel"]) -> BenchlingValidatorReport:
-            """Wrapper that runs the validator function and returns a BenchlingValidatorReport."""
-            try:
-                func(self)
-            except Exception as e:
-                return BenchlingValidatorReport.create_validation_report(
-                    valid=False,
-                    level=validator_level,
-                    entity=self,
-                    validator_name=validator_name,
-                    message=str(e),
-                )
+    if validator_name is None:
+        validator_name = pascalize(func.__name__)
+
+    @wraps(func)
+    def wrapper(self: type["BenchlingBaseModel"]) -> BenchlingValidatorReport:
+        """Wrapper that runs the validator function and returns a BenchlingValidatorReport."""
+        try:
+            ret_val = func(self)
+            if type(ret_val) is BenchlingValidatorReport:
+                return ret_val
+        except Exception as e:
             return BenchlingValidatorReport.create_validation_report(
-                valid=True,
+                valid=False,
                 level=validator_level,
                 entity=self,
                 validator_name=validator_name,
+                message=str(e),
             )
+        return BenchlingValidatorReport.create_validation_report(
+            valid=True,
+            level=validator_level,
+            entity=self,
+            validator_name=validator_name,
+        )
+
+    setattr(wrapper, "_is_liminal_validator", True)
+    return wrapper
 
-        setattr(wrapper, "_is_liminal_validator", True)
-        return wrapper
 
-    return decorator
+def liminal_validator(
+    validator_level: ValidationSeverity = ValidationSeverity.LOW,
+    validator_name: str | None = None,
+) -> Callable:
+    """A decorator for a function that validates a Benchling entity, defined on a schema class.
+    Wraps around any exceptions raised by the validator function, and returns a BenchlingValidatorReport.
+
+    Parameters
+    ----------
+    validator_level: ValidationSeverity
+        The severity level of the validation report. Defaults to ValidationSeverity.LOW.
+    validator_name: str | None =
+        The name of the validator. Defaults to the PascalCase version of the function name.
+    """
+    return partial(
+        _liminal_decorator,
+        validator_level=validator_level,
+        validator_name=validator_name,
+    )

{liminal_orm-2.0.0 → liminal_orm-2.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "liminal-orm"
-version = "2.0.0"
+version = "2.0.2"
 description = "An ORM and toolkit that builds on top of Benchling's platform to keep your schemas and downstream code dependencies in sync."
 authors = ["DynoTx Open Source <opensource@dynotx.com>"]
 readme = "README.md"