openepd 6.12.1__py3-none-any.whl → 6.13.1__py3-none-any.whl

openepd/m49/geo_converter.py

@@ -0,0 +1,178 @@
+#
+#  Copyright 2025 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 typing import Collection
+
+from openepd.m49.const import (
+    COUNTRY_VERBOSE_NAME_TO_M49,
+    ISO3166_ALPHA2_TO_M49,
+    M49_TO_COUNTRY_VERBOSE_NAME,
+    M49_TO_ISO3166_ALPHA2,
+    M49_TO_REGION_VERBOSE_NAME,
+    OPENEPD_SPECIAL_REGIONS,
+    REGION_VERBOSE_NAME_TO_M49,
+)
+
+
+def iso_to_m49(regions: Collection[str]) -> set[str]:
+    """
+    Convert ISO3166 alpha2 country codes to M49 region codes.
+
+    :param regions: List of ISO3166 alpha2 country codes (e.g., ["US", "CA", "MX"])
+    :return: Set of M49 region codes (e.g., {"840", "124", "484"})
+    :raises ValueError: If a country code is not found in M49 region codes.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for code in regions:
+        m49_code = ISO3166_ALPHA2_TO_M49.get(code.upper())
+        if m49_code:
+            result.add(m49_code)
+        else:
+            raise ValueError(f"Country code '{code}' not found in M49 region codes.")
+
+    return result
+
+
+def m49_to_iso(regions: Collection[str]) -> set[str]:
+    """
+    Convert M49 region codes to ISO3166 alpha2 country codes.
+
+    :param regions: List of M49 region codes (e.g., ["840", "124", "484"])
+    :return: Set of ISO3166 alpha2 country codes (e.g., {"US", "CA", "MX"})
+    :raises ValueError: If a region code is not found in ISO3166.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for code in regions:
+        iso_code = M49_TO_ISO3166_ALPHA2.get(code.upper())
+        if iso_code:
+            result.add(iso_code)
+        else:
+            raise ValueError(f"Region code '{code}' not found in ISO3166.")
+
+    return result
+
+
+def region_and_country_names_to_m49(regions: Collection[str]) -> set[str]:
+    """
+    Convert user-friendly region and country names to M49 region codes.
+
+    :param regions: List of user-friendly region and country names (e.g., ["Europe",
+        "North America", "Austria", "Germany"])
+    :return: Set of M49 region codes (e.g., {"150", "003", "040", "276"})
+    :raises ValueError: If a region or country name is not found in M49 region codes.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for name in regions:
+        m49_code = REGION_VERBOSE_NAME_TO_M49.get(name.title()) or COUNTRY_VERBOSE_NAME_TO_M49.get(name.title())
+        if not m49_code:
+            raise ValueError(f"Region or country name '{name}' not found in M49 region codes.")
+        result.add(m49_code)
+
+    return result
+
+
+def m49_to_region_and_country_names(regions: Collection[str]) -> set[str]:
+    """
+    Convert M49 region codes to user-friendly region names and country names.
+
+    :param regions: List of M49 region codes (e.g., ["150", "003", "040", "276"])
+    :return: Set of user-friendly region and country names (e.g., {"Europe", "North America", "Austria", "Germany"})
+    :raises ValueError: If a region code is not found in M49 region codes.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for code in regions:
+        if code not in M49_TO_REGION_VERBOSE_NAME and code not in M49_TO_COUNTRY_VERBOSE_NAME:
+            raise ValueError(f"Region code '{code}' not found in M49 region codes.")
+
+        name = M49_TO_REGION_VERBOSE_NAME.get(code) or M49_TO_COUNTRY_VERBOSE_NAME.get(code, code)
+        result.add(name)
+    return result
+
+
+def openepd_to_m49(regions: Collection[str]) -> set[str]:
+    """
+    Convert OpenEPD geography definitions to pure M49 region codes.
+
+    :param regions: list of OpenEPD geography definitions including letter codes and aliases
+        like "EU27" or "NAFTA" (e.g., ["EU27", "NAFTA"], ["US", "CA, MX"])
+    :return: Set of M49 region codes (e.g., {"040", "056", "100", "191", "196", "203", "208", "233", "246", "250",
+        "276", "300", "348", "372", "380", "428", "440", "442", "470", "528", "616", "620", "642", "703", "705", "724",
+        "752", "840", "124", "484"}, {"840", "124", "484"})
+    :raises ValueError: If a region or country name is not found in ISO3166 or OpenEPD special regions.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    for region in regions:
+        if region in OPENEPD_SPECIAL_REGIONS:
+            result.update(OPENEPD_SPECIAL_REGIONS[region].m49_codes)
+        else:
+            m49_code = ISO3166_ALPHA2_TO_M49.get(region.upper())
+            if m49_code:
+                result.add(m49_code)
+            else:
+                raise ValueError(f"Region '{region}' not found in ISO3166 or OpenEPD special regions.")
+    return result
+
+
+def m49_to_openepd(regions: list[str]) -> set[str]:
+    """
+    Convert M49 region codes to OpenEPD geography definitions.
+
+    :param regions: List of M49 region codes (e.g., ["040", "056", "100", "191", "196", "203", "208", "233", "246",
+        "250", "276", "300", "348", "372", "380", "428", "440", "442", "470", "528", "616", "620", "642", "703", "705",
+        "724", "752", "840", "124", "484"], ["840", "124", "484"], ["040", "056", "100"])
+    :return: Set of OpenEPD geography definitions including letter codes and aliases
+        like "EU27" or "NAFTA" (e.g., {"EU27", "NAFTA"}, {"NAFTA"}, {"AT", "BE", "BG"})
+    :raises ValueError: If a region code is not found in ISO3166 or OpenEPD special regions.
+    """
+
+    if not regions:
+        return set()
+
+    result = set()
+    remaining_codes = set(regions)
+    for special_region, special_region_data in OPENEPD_SPECIAL_REGIONS.items():
+        special_region_codes = set(special_region_data.m49_codes)
+        if special_region_codes.issubset(remaining_codes):
+            result.add(special_region)
+            remaining_codes -= special_region_codes
+
+    for code in remaining_codes:
+        iso_code = M49_TO_ISO3166_ALPHA2.get(code)
+        if iso_code:
+            result.add(iso_code)
+        else:
+            raise ValueError(f"Region code '{code}' not found in ISO3166 or OpenEPD special regions.")
+
+    return result

openepd/model/industry_epd.py

@@ -15,8 +15,6 @@
 #
 from typing import Literal
 
-from pydantic.v1 import NonNegativeInt
-
 from openepd.compat.pydantic import pyd
 from openepd.model.base import BaseDocumentFactory, BaseOpenEpdSchema, OpenEpdDoctypes
 from openepd.model.common import WithAltIdsMixin, WithAttachmentsMixin
@@ -36,15 +34,15 @@ from openepd.model.versioning import OpenEpdVersions, Version
 class SampleSize(BaseOpenEpdSchema):
     """Sample size."""
 
-    products: NonNegativeInt | None = pyd.Field(
+    products: pyd.NonNegativeInt | None = pyd.Field(
         default=None,
         description="Count of separate products or results that were included in this industry EPD, "
         "and over which the standard deviation was calculated",
     )
-    plants: NonNegativeInt | None = pyd.Field(
+    plants: pyd.NonNegativeInt | None = pyd.Field(
         default=None, description="Count of unique manufacturing plants that submitted data for this Industry EPD"
     )
-    manufacturers: NonNegativeInt | None = pyd.Field(
+    manufacturers: pyd.NonNegativeInt | None = pyd.Field(
         default=None, description="Count of unique manufacturing companies that submitted data for this Industry EPD"
     )
 

{openepd-6.12.1.dist-info → openepd-6.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openepd
-Version: 6.12.1
+Version: 6.13.1
 Summary: Python library to work with OpenEPD format
 Home-page: https://github.com/cchangelabs/openepd
 License: Apache-2.0

{openepd-6.12.1.dist-info → openepd-6.13.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 openepd/__init__.py,sha256=fhxfEyEurLvSfvQci-vb3njzl_lvhcLXiZrecCOaMU8,794
-openepd/__version__.py,sha256=YzSSIKghgjH_RpO3Tffw6dYJf2wV2WNvVVEA1RJt70c,639
+openepd/__version__.py,sha256=sgmt6cETSc5fqwbwM-ICVdVetdp89fDLgd8mFB7w4go,639
 openepd/api/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/api/average_dataset/generic_estimate_sync_api.py,sha256=KHCmSKMOJTQct6vhdhAatAENoouStc_yVRza5AFNoIo,7953
@@ -32,6 +32,9 @@ openepd/bundle/writer.py,sha256=gHK1D-F-td2C18QFWerg666JUTLaGUkTUSQURJi9o74,8136
 openepd/compat/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/compat/compat_functional_validators.py,sha256=aWg3a80fqT8zjN0S260N-Ad2WFKAaB8ByN7ArBW3NMA,834
 openepd/compat/pydantic.py,sha256=dNwPXK1X5xq9sdkd0kcbKQAUIter1GAfcxXOl6hmITQ,1146
+openepd/m49/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
+openepd/m49/const.py,sha256=O31VJ5_sR4GAOvJnFsi3An2YMaMa96H7XBqaQ0kNwnw,31734
+openepd/m49/geo_converter.py,sha256=mRamQTVwd35kwn5-23N3E8cxqpYG7l9eW787SJYM7nw,6515
 openepd/model/__init__.py,sha256=9THJcV3LT7JDBOMz1px-QFf_sdJ0LOqJ5dmA9Dvvtd4,620
 openepd/model/base.py,sha256=1GeaEDn-ppy94GaOaZI1y6Yew_0eBBho1COaxfzzLCw,9834
 openepd/model/category.py,sha256=reeOVRDuZPYU77EMwG0K5VjnK2H9yOGxT0PJXXqrjEk,1639
@@ -41,7 +44,7 @@ openepd/model/epd.py,sha256=qYYJQKbcFNOU_qS5Ag9CXn7Tx0TkIoUOZQEDGJI-xZw,12290
 openepd/model/factory.py,sha256=doexyqZXJVGd45T1JsbjuyGUjEykW-MerKUq4SQHhRY,2656
 openepd/model/generic_estimate.py,sha256=zLGTyf4Uzmp2C0m-J1ePWItSz2RGdZ0OiGPWC5nhKHk,3992
 openepd/model/geography.py,sha256=Jx7NIDdk_sIvwyh-7YxnIjAwIHW2HCQK7UtFGM2xKtw,42095
-openepd/model/industry_epd.py,sha256=pKt9rtW7iBPvp7zbMX5c6SRrjh3zb7iR6d3OayI_qHc,4039
+openepd/model/industry_epd.py,sha256=QZr7OhgGkzqZ8H5p6dCIVk9zSHEYtK3y9Nk-DvkFMyk,4011
 openepd/model/lcia.py,sha256=gS4WFcw7v8PKKDCBUQXQP5I8Jh_TdyZyIklAjUc5HL4,25507
 openepd/model/org.py,sha256=MtaUrD8IdSbcMJEwL2lnXOIXNfE8wpzrepFSe2qh2uc,5342
 openepd/model/pcr.py,sha256=b8WmeII8MZ3rJFWxugqv_Z0ETan8NMWj9L6mSrhneJk,5494
@@ -136,7 +139,7 @@ openepd/model/validation/quantity.py,sha256=vfSe-3DGQf84bCp_sMIU0ZPAA1wIilodpTjL
 openepd/model/versioning.py,sha256=cm3LaAUODnbbu3W3pC6baJzxKusTQ1kZH-PwwScCj3c,4473
 openepd/patch_pydantic.py,sha256=LVqDMKn723VYYf_V-RgTLxIb1xiUtYOfPYCQP6-7RoM,4122
 openepd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openepd-6.12.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-openepd-6.12.1.dist-info/METADATA,sha256=SX0KqNw2vVhumIUbF9N9ASCXIuTigkSG1foQMtayHwc,9039
-openepd-6.12.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-openepd-6.12.1.dist-info/RECORD,,
+openepd-6.13.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+openepd-6.13.1.dist-info/METADATA,sha256=T7QapSryr1s5pRrcSY-TBnm6HauXRFkEOD-_If1ZfpI,9039
+openepd-6.13.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+openepd-6.13.1.dist-info/RECORD,,