openepd 4.1.0__tar.gz → 4.3.0__tar.gz

{openepd-4.1.0 → openepd-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 4.1.0
+Version: 4.3.0
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0
@@ -144,6 +144,13 @@ with DefaultBundleWriter("my-bundle.epb") as writer, open("test-pcr.pdf", "rb")
     writer.write_blob_asset(pcr_pdf_file, "application/pdf", pcr_asset, RelType.Pdf)
 ```
 
+### Mypy
+
+OpenEPD uses a small modification to standard pydantic models (see PydanticClassAttributeExposeModelMetaclass). Mypy,
+in order to work correctly, requires a modified pydantic plugin. To enable it, add an 
+`openepd.mypy.custom_pydantic_plugin` to list of mypy plugins in your `pyproject.toml` or other mypy-related config
+file. See [Mypy configuration](https://mypy.readthedocs.io/en/stable/extending_mypy.html)
+
 # Credits
 
 This library has been written and maintained by [C-Change Labs](https://c-change-labs.com/).

{openepd-4.1.0 → openepd-4.3.0}/README.md

@@ -118,6 +118,13 @@ with DefaultBundleWriter("my-bundle.epb") as writer, open("test-pcr.pdf", "rb")
     writer.write_blob_asset(pcr_pdf_file, "application/pdf", pcr_asset, RelType.Pdf)
 ```
 
+### Mypy
+
+OpenEPD uses a small modification to standard pydantic models (see PydanticClassAttributeExposeModelMetaclass). Mypy,
+in order to work correctly, requires a modified pydantic plugin. To enable it, add an 
+`openepd.mypy.custom_pydantic_plugin` to list of mypy plugins in your `pyproject.toml` or other mypy-related config
+file. See [Mypy configuration](https://mypy.readthedocs.io/en/stable/extending_mypy.html)
+
 # Credits
 
 This library has been written and maintained by [C-Change Labs](https://c-change-labs.com/).

{openepd-4.1.0 → openepd-4.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openepd"
-version = "4.1.0"
+version = "4.3.0"
 license = "Apache-2.0"
 description = "Python library to work with OpenEPD format"
 authors = ["C-Change Labs <support@c-change-labs.com>"]

{openepd-4.1.0 → openepd-4.3.0}/src/openepd/__version__.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
-VERSION = "4.1.0"
+VERSION = "4.3.0"

{openepd-4.1.0 → openepd-4.3.0}/src/openepd/model/base.py

@@ -56,7 +56,28 @@ def modify_pydantic_schema(schema_dict: dict, cls: type) -> dict:
     return schema_dict
 
 
-class BaseOpenEpdSchema(pyd.BaseModel):
+class PydanticClassAttributeExposeModelMetaclass(pyd.main.ModelMetaclass):
+    """
+    Extension of the pydantic's ModelMetaclass which restores class attribute lookup for fields.
+
+    In pydantic, while the model fields are defined in the model as class-level attributes, in runtime they disappear
+    due to ModelMetaclass logic. ModelMetaclass takes the defined attributes, removes them from class dict and puts
+    into a special __fields__ attribute to avoid naming conflict.
+
+    We would like to be able to access the attributes via dot notation in the runtimes, since it makes refactoring
+    easier.
+
+    This class exposes the original fields when accessed via class name. For example, one can call `Pcr.name` and get
+    `ModelField`, in addition to calling `pcr.__fields__` on an instance.
+    """
+
+    def __getattr__(cls, name: str) -> Any:
+        if name in cls.__fields__:
+            return cls.__fields__[name]
+        return getattr(super, name)
+
+
+class BaseOpenEpdSchema(pyd.BaseModel, metaclass=PydanticClassAttributeExposeModelMetaclass):
     """Base class for all OpenEPD models."""
 
     ext: dict[str, AnySerializable] | None = pyd.Field(alias="ext", default=None)

{openepd-4.1.0 → openepd-4.3.0}/src/openepd/model/specs/generated/common.py

@@ -13,6 +13,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseOpenEpdSchema
 from openepd.model.org import OrgRef
 
@@ -20,4 +21,6 @@ from openepd.model.org import OrgRef
 class HasForestPracticesCertifiers(BaseOpenEpdSchema):
     """An interface for models which are linked to forest practices certifiers."""
 
-    forest_practices_certifiers: list[OrgRef] | None
+    forest_practices_certifiers: list[OrgRef] | None = pyd.Field(
+        default=None, description="List of organizations that certify forest practices."
+    )

{openepd-4.1.0 → openepd-4.3.0}/src/openepd/model/specs/generated/finishes.py

@@ -14,7 +14,6 @@
 #  limitations under the License.
 #
 from openepd.compat.pydantic import pyd
-from openepd.model.org import OrgRef
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.generated.common import HasForestPracticesCertifiers
 from openepd.model.specs.generated.enums import (
@@ -179,7 +178,6 @@ class WoodFlooringV1(BaseOpenEpdHierarchicalSpec, HasForestPracticesCertifiers):
     thickness: LengthMmStr | None = pyd.Field(default=None, description="", example="10 mm")
     timber_species: WoodFlooringTimberSpecies | None = pyd.Field(default=None, description="", example="Oak")
     fabrication: WoodFlooringFabrication | None = pyd.Field(default=None, description="", example="Solid hardwood")
-    forest_practices_certifiers: list[OrgRef] | None = pyd.Field(default=None, description="")
 
 
 class AcousticalCeilingsV1(BaseOpenEpdHierarchicalSpec):
@@ -425,7 +423,6 @@ class DeckingBoardsV1(BaseOpenEpdHierarchicalSpec, HasForestPracticesCertifiers)
     # Own fields:
     timber_species: SawnTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
     fabrication: AllFabrication | None = pyd.Field(default=None, description="", example="LVL")
-    forest_practices_certifiers: list[OrgRef] | None = pyd.Field(default=None, description="")
     weather_exposed: bool | None = pyd.Field(default=None, description="", example=True)
     fire_retardant: bool | None = pyd.Field(default=None, description="", example=True)
     decay_resistant: bool | None = pyd.Field(default=None, description="", example=True)

{openepd-4.1.0 → openepd-4.3.0}/src/openepd/model/specs/generated/wood.py

@@ -14,7 +14,6 @@
 #  limitations under the License.
 #
 from openepd.compat.pydantic import pyd
-from openepd.model.org import OrgRef
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.generated.common import HasForestPracticesCertifiers
 from openepd.model.specs.generated.enums import (
@@ -154,9 +153,6 @@ class WoodV1(BaseOpenEpdHierarchicalSpec, HasForestPracticesCertifiers):
         default=None, description="Timber species", example="Alaska Cedar"
     )
     fabrication: AllFabrication | None = pyd.Field(default=None, description="Timber fabrication", example="LVL")
-    forest_practices_certifiers: list[OrgRef] | None = pyd.Field(
-        default=None, description="List of organizations that certify forest practices."
-    )
     weather_exposed: bool | None = pyd.Field(default=None, description="Weather exposed", example=True)
     fire_retardant: bool | None = pyd.Field(default=None, description="Fire retardant", example=True)
     decay_resistant: bool | None = pyd.Field(default=None, description="Decay resistant", example=True)

{openepd-4.1.0 → openepd-4.3.0}/src/openepd/model/specs/generated/wood_joists.py

@@ -14,7 +14,6 @@
 #  limitations under the License.
 #
 from openepd.compat.pydantic import pyd
-from openepd.model.org import OrgRef
 from openepd.model.specs.base import BaseOpenEpdHierarchicalSpec
 from openepd.model.specs.generated.common import HasForestPracticesCertifiers
 from openepd.model.specs.generated.enums import AllFabrication, AllTimberSpecies
@@ -33,7 +32,6 @@ class WoodJoistsV1(BaseOpenEpdHierarchicalSpec, HasForestPracticesCertifiers):
     # Own fields:
     timber_species: AllTimberSpecies | None = pyd.Field(default=None, description="", example="Alaska Cedar")
     fabrication: AllFabrication | None = pyd.Field(default=None, description="", example="LVL")
-    forest_practices_certifiers: list[OrgRef] | None = pyd.Field(default=None, description="")
     weather_exposed: bool | None = pyd.Field(default=None, description="", example=True)
     fire_retardant: bool | None = pyd.Field(default=None, description="", example=True)
     decay_resistant: bool | None = pyd.Field(default=None, description="", example=True)

openepd-4.3.0/src/openepd/mypy/__init__.py

@@ -0,0 +1,15 @@
+#
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#

openepd-4.3.0/src/openepd/mypy/custom_pydantic_plugin.py

@@ -0,0 +1,91 @@
+#
+#  Copyright 2024 by C Change Labs Inc. www.c-change-labs.com
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+from collections.abc import Callable
+
+from mypy.nodes import AssignmentStmt, CallExpr, MemberExpr, TypeInfo
+from mypy.plugin import ClassDefContext
+import pydantic.mypy
+from pydantic.mypy import (
+    MODEL_METACLASS_FULLNAME,
+    ModelConfigData,
+    PydanticModelClassVar,
+    PydanticModelField,
+    PydanticModelTransformer,
+    PydanticPlugin,
+)
+
+# Using this plugin fixes the issue.
+
+CUSTOM_OPENEPD_MODEL_METACLASS_FULLNAME = "openepd.model.base.PydanticClassAttributeExposeModelMetaclass"
+MODEL_METACLASSES_FULL_NAMES = (MODEL_METACLASS_FULLNAME, CUSTOM_OPENEPD_MODEL_METACLASS_FULLNAME)
+
+DECORATOR_FULLNAMES = pydantic.mypy.DECORATOR_FULLNAMES | {
+    "pydantic.v1.class_validators.validator",
+}
+
+
+class CustomPydanticModelTransformer(PydanticModelTransformer):
+    """Extension of the mypy/pydantic model transformer which also understands validator definitions via v1 compat."""
+
+    def collect_field_or_class_var_from_stmt(
+        self, stmt: AssignmentStmt, model_config: ModelConfigData, class_vars: dict[str, PydanticModelClassVar]
+    ) -> PydanticModelField | PydanticModelClassVar | None:
+        """Extend implementation of the original Pydantic method with one more case for validator."""
+        if not stmt.new_syntax and (
+            isinstance(stmt.rvalue, CallExpr)
+            and isinstance(stmt.rvalue.callee, CallExpr)
+            and isinstance(stmt.rvalue.callee.callee, MemberExpr)
+            and stmt.rvalue.callee.callee.fullname in DECORATOR_FULLNAMES
+        ):
+            # Required to detect compat-imported v1 validators and not treat them as fields.
+            return None
+        return super().collect_field_or_class_var_from_stmt(stmt, model_config, class_vars)
+
+
+class CustomMetaclassPydanticPlugin(PydanticPlugin):
+    """
+    Custom metaclass pydantic plugin.
+
+    Extends a standard pydantic mypy plugin, and adds certain behaviours required for us:
+    1. Support for a non-standard metaclass for pydantic models. We use it allow for access via Class.field notation
+    2. Support for our modified compat import of pydantic v1 when using this metaclass.
+    """
+
+    def get_metaclass_hook(self, fullname: str) -> Callable[[ClassDefContext], None] | None:
+        """Update Pydantic `ModelMetaclass` definition."""
+        if fullname in MODEL_METACLASSES_FULL_NAMES:
+            return self._pydantic_model_metaclass_marker_callback
+        return None
+
+    def get_base_class_hook(self, fullname: str) -> Callable[[ClassDefContext], bool] | None:  # type: ignore
+        """Update Pydantic model class."""
+        sym = self.lookup_fully_qualified(fullname)
+        if sym and isinstance(sym.node, TypeInfo):  # pragma: no branch
+            # No branching may occur if the mypy cache has not been cleared
+            if any(base.fullname in ["pydantic.main.BaseModel", "pydantic.v1.main.BaseModel"] for base in sym.node.mro):
+                return self._pydantic_model_class_maker_callback
+        return None
+
+    def _pydantic_model_class_maker_callback(self, ctx: ClassDefContext) -> bool:
+        # extended to replace the mypy-pydantic transformer with our custom transformer - see validator note.
+        transformer = CustomPydanticModelTransformer(ctx.cls, ctx.reason, ctx.api, self.plugin_config)
+        return transformer.transform()
+
+
+def plugin(version: str):
+    """Entry point to the mypy plugin."""
+    return CustomMetaclassPydanticPlugin