python-materialsdb 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

materialsdb/cache.py

@@ -2,6 +2,7 @@ import os
 import pathlib
 import urllib.request
 from collections import namedtuple
+from concurrent.futures import FIRST_COMPLETED, ThreadPoolExecutor, wait
 
 from lxml import etree
 
@@ -85,25 +86,77 @@ def _plan_index(index):
     return _IndexPlan(index, new_index, unchanged, todos)
 
 
-def update_producers_data(url_list=MATERIALSDBINDEXURLLIST, on_progress=None):
-    """on_progress(done, total, name) is called after each producer download
-    with a global running total; returning a truthy value stops the update
-    between two downloads (the partial Report is returned as-is)."""
+def update_producers_data(url_list=MATERIALSDBINDEXURLLIST, on_progress=None, max_workers: int = 8):
+    """Update the cached producer files from the index URLs.
+
+    Downloads run on a bounded thread pool (max_workers). on_progress(done,
+    total, name) is called once per completed download from the calling
+    thread with a monotonic running total; returning a truthy value stops
+    NEW submissions (queued jobs are abandoned, in-flight ones finish but
+    no longer count toward the partial Report). A download error stops the
+    run and the first exception is re-raised after the pool drains.
+    """
     plans = [_plan_index(index) for index in url_list]
-    total = sum(len(plan.todos) for plan in plans)
-    existing, updated, deleted = [], [], []
+    jobs = [
+        (plan, company, cached_producer, producer_path)
+        for plan in plans
+        for (company, cached_producer, producer_path) in plan.todos
+    ]
+    total = len(jobs)
+    workers = max(1, min(int(max_workers), total or 1))
+
+    existing: list = []
+    updated: list = []
+    deleted: list = []
     done = 0
+    cancel_requested = False
+    failure = None
+
+    def _download(job):
+        _, company, cached_producer, producer_path = job
+        deleted_path = None
+        if cached_producer is not None:
+            deleted_path = get_producers_dir() / pathlib.Path(cached_producer.get("href")).name
+            deleted_path.unlink(True)
+        urllib.request.urlretrieve(company.get("href"), producer_path)
+        return deleted_path
+
+    pool = ThreadPoolExecutor(max_workers=workers)
+    pending = list(jobs)  # pops from the FRONT, submission order preserved
+    futures: dict = {}
+    try:
+        while futures or pending:
+            while pending and len(futures) < workers:
+                job = pending.pop(0)
+                futures[pool.submit(_download, job)] = job
+            if not futures:
+                break
+            ready, _ = wait(set(futures), return_when=FIRST_COMPLETED)
+            for future in ready:
+                job = futures.pop(future)
+                try:
+                    deleted_path = future.result()
+                except Exception as err:  # noqa: BLE001 - re-raised below, caller decides
+                    if failure is None:
+                        failure = err
+                    break
+                if deleted_path is not None:
+                    deleted.append(deleted_path)
+                updated.append(job[3])
+                done += 1
+                if on_progress is not None and on_progress(done, total, pathlib.Path(job[3]).name):
+                    cancel_requested = True
+                    break
+            if cancel_requested or failure is not None:
+                break
+    finally:
+        pool.shutdown(wait=True, cancel_futures=True)
+
+    if failure is not None:
+        raise failure
+    if cancel_requested:
+        return Report(existing, updated, deleted)
     for plan in plans:
-        for company, cached_producer, producer_path in plan.todos:
-            if cached_producer is not None:
-                cached_path = get_producers_dir() / pathlib.Path(cached_producer.get("href")).name
-                deleted.append(cached_path)
-                cached_path.unlink(True)
-            urllib.request.urlretrieve(company.get("href"), producer_path)
-            updated.append(producer_path)
-            done += 1
-            if on_progress is not None and on_progress(done, total, pathlib.Path(company.get("href")).name):
-                return Report(existing, updated, deleted)
         if plan.todos:
             plan.new_index.write(str(get_cached_index_path(plan.index)))
         existing.extend(plan.unchanged)

materialsdb/gui/listener.py

@@ -5,7 +5,7 @@ MaterialBuilder would create (one entry per IfcMaterial); the Bonsai add-on
 maps the payload onto its open file without importing this library."""
 
 from materialsdb import config, utils
-from materialsdb.ifc.material_builder import PSETS, get_value
+from materialsdb.ifc.material_builder import PSETS, get_value, style_for
 
 
 def _resolved_psets(layer, country) -> dict:
@@ -50,6 +50,10 @@ def build_add_materials_payload(store_, items, country=None, lang=None):
         description = str(utils.get_material_description(material, lang))
         category = str(getattr(material.information, "group", "") or "")
         color = getattr(material.information, "color", None)
+        color = int(color) if color else None
+        # Resolve the surface style server-side: the add-on runs in Blender's
+        # interpreter without access to the materialsdb colour scheme.
+        style_name, style_rgb = style_for(color, category)
         entries = []
         for layer in utils.get_material_layers(material):
             if wanted is not None and str(layer.id) not in wanted:
@@ -63,7 +67,9 @@ def build_add_materials_payload(store_, items, country=None, lang=None):
                     "name": name,
                     "description": description,
                     "category": category,
-                    "color": int(color) if color else None,
+                    "color": color,
+                    "style_name": style_name,
+                    "style_color": [round(component, 6) for component in style_rgb],
                     "identity": {
                         "material_id": material_id,
                         "company_id": str(summary.company_id or ""),
@@ -120,6 +126,9 @@ def build_add_construction_payload(store_, body, country=None, lang=None):
             problems.append(f"unknown material id: {layer.material_id}")
             continue
         color = getattr(material.information, "color", None)
+        color = int(color) if color else None
+        category = str(getattr(material.information, "group", "") or "")
+        style_name, style_rgb = style_for(color, category)
         layers.append(
             {
                 "material_id": layer.material_id,
@@ -128,8 +137,10 @@ def build_add_construction_payload(store_, body, country=None, lang=None):
                     "source_id": layer.material_id,
                     "name": str(utils.get_material_name(material, lang)),
                     "description": str(utils.get_material_description(material, lang)),
-                    "category": str(getattr(material.information, "group", "") or ""),
-                    "color": int(color) if color else None,
+                    "category": category,
+                    "color": color,
+                    "style_name": style_name,
+                    "style_color": [round(component, 6) for component in style_rgb],
                     "identity": {
                         "material_id": layer.material_id,
                         "company_id": str(summary.company_id or ""),

materialsdb/ifc/material_builder.py

@@ -2,12 +2,21 @@
 
 import json
 from pathlib import Path
+from typing import TypedDict
 
 from materialsdb import config, utils
 
 MATERIALSDB_PSET = "materialsdb"
 
-CATEGORIES = {
+
+class CategoryStyle(TypedDict):
+    """One palette entry. `hatch` is reserved for future pattern support."""
+
+    hatch: str
+    color: tuple[int, int, int]
+
+
+CATEGORIES: dict[str, CategoryStyle] = {
     "Others": {"hatch": "", "color": (255, 255, 255)},
     "Water_Proof": {"hatch": "", "color": (255, 255, 255)},
     "Vapour_Proof": {"hatch": "", "color": (0, 0, 0)},
@@ -27,6 +36,29 @@ CATEGORIES = {
     "Soil": {"hatch": "", "color": (142, 84, 52)},
 }
 
+# Named colour schemes: a category -> palette. Only the default ships today;
+# more schemes (and a GUI selector) are planned.
+SCHEMES: dict[str, dict[str, CategoryStyle]] = {"Lesosai": CATEGORIES}
+DEFAULT_SCHEME = "Lesosai"
+
+
+def _rgb_int_components(color: int) -> tuple[float, float, float]:
+    """Decimal 0xRRGGBB -> normalised (r, g, b) in 0..1 (IfcColourRgb units)."""
+    return (((color >> 16) & 255) / 255, ((color >> 8) & 255) / 255, (color & 255) / 255)
+
+
+def style_for(color, category, scheme=None):
+    """Resolve a material's (IfcSurfaceStyle.Name, (r, g, b) in 0..1).
+
+    The producer colour wins when present; otherwise the category colour from
+    the scheme (default 'Lesosai' = CATEGORIES). Unknown categories fall back
+    to 'Others'."""
+    if color:
+        return f"color {int(color)}", _rgb_int_components(int(color))
+    palette = SCHEMES.get(scheme or DEFAULT_SCHEME, CATEGORIES)
+    category = category if category in palette else "Others"
+    return f"category {category}", tuple(component / 255 for component in palette[category]["color"])
+
 
 def clean_psets(psets):
     new_dict = {}
@@ -71,6 +103,7 @@ class MaterialBuilder:
         name = utils.get_material_name(material, self.lang)
         description = utils.get_material_description(material, self.lang)
         category = str(material.information.group or "")
+        color = material.information.color
         if not with_layers:
             # reuse an already-present material instead of duplicating it;
             # its identity pset is already in place
@@ -79,15 +112,9 @@ class MaterialBuilder:
                 return [existing]
             ifc_material = self.file.createIfcMaterial(name, str(description), str(category))
             self._create_identity_pset(ifc_material, material, company_id, company, verxml)
+            self._add_style_chain(color, category)
             return [ifc_material]
-        color = material.information.color
-        surface_style = self.get_surface_style(color, category)
-        styled_item = self.file.createIfcStyledItem(Styles=[surface_style])
-        self.file.createIfcStyledRepresentation(
-            ContextOfItems=self._get_context(),
-            RepresentationIdentifier="Body",
-            Items=[styled_item],
-        )
+        self._add_style_chain(color, category)
         created = []
         wanted = {str(g) for g in layer_ids} if layer_ids is not None else None
         for layer in utils.get_material_layers(material):
@@ -191,29 +218,32 @@ class MaterialBuilder:
                 Material=ifc_material,
             )
 
-    def get_surface_style(self, color, category):
-        if color:
-            name = f"color {color}"
-        else:
-            if not category or category not in CATEGORIES:
-                category = "Others"
-            name = f"category {category}"
+    def _add_style_chain(self, color, category, scheme=None):
+        """Create the floating styled chain MaterialBuilder uses for a
+        material's colour (shared style + one styled item per build)."""
+        surface_style = self.get_surface_style(color, category, scheme=scheme)
+        styled_item = self.file.createIfcStyledItem(Styles=[surface_style])
+        self.file.createIfcStyledRepresentation(
+            ContextOfItems=self._get_context(),
+            RepresentationIdentifier="Body",
+            Items=[styled_item],
+        )
+
+    def get_surface_style(self, color, category, scheme=None):
+        name, rgb = style_for(color, category, scheme=scheme)
         if name in self._styles and self._styles[name] in self.file:
             return self._styles[name]
-        if color:
-            style = self.file.createIfcSurfaceStyleShading(SurfaceColour=self.color_xml_to_ifc(color))
-        else:
-            style = self.file.createIfcSurfaceStyleShading(
-                SurfaceColour=self.file.createIfcColourRgb(None, *CATEGORIES[category]["color"]),
-            )
-        surface_style = self.file.createIfcSurfaceStyle(Name=name, Side="BOTH", Styles=[style])
+        shading = self.file.createIfcSurfaceStyleShading(
+            SurfaceColour=self.file.createIfcColourRgb(None, *rgb),
+        )
+        surface_style = self.file.createIfcSurfaceStyle(Name=name, Side="BOTH", Styles=[shading])
         self._styles[name] = surface_style
         return surface_style
 
     def color_xml_to_ifc(self, color: int):
         """Color definition in xml is obscur. We assume that it is a decimal color.
         See: https://stackoverflow.com/a/2262152/4098083"""
-        return self.file.createIfcColourRgb(Blue=color & 255, Green=(color >> 8) & 255, Red=(color >> 16) & 255)
+        return self.file.createIfcColourRgb(None, *_rgb_int_components(int(color)))
 
 
 def _materials_of(pset):

materialsdb/serialiser.py

@@ -25,9 +25,31 @@ def get_xml_schema() -> str:
     return str(Path(__file__).parent / "schema/materialsdb103.xsd")
 
 
+@cache
+def cached_type_hints(cls) -> dict:
+    return typing.get_type_hints(cls)
+
+
+@cache
+def _tag_local_name(tag: str) -> str:
+    m = re.search("{.*}(.*)", tag)
+    return m.group(1) if m else tag
+
+
 def get_element_name(element: objectify.ObjectifiedElement) -> str:
-    m = re.search("{.*}(.*)", element.tag)
-    return m.group(1) if m else element.tag
+    return _tag_local_name(element.tag)
+
+
+@cache
+def _is_optional(type_hint):
+    return typing.get_origin(type_hint) is typing.Union and typing.get_args(type_hint)[1] is type(None)
+
+
+@cache
+def _strip_optional(type_hint):
+    if _is_optional(type_hint):
+        return typing.get_args(type_hint)[0]
+    return type_hint
 
 
 def create_element_maker():
@@ -49,11 +71,6 @@ def get_valid_root(tree: objectify.ObjectifiedElement) -> objectify.ObjectifiedE
     return root
 
 
-@cache
-def cached_type_hints(cls) -> dict:
-    return typing.get_type_hints(cls)
-
-
 class XmlDeserialiser:
     def __init__(self):
         self.schema = etree.XMLSchema(file=get_xml_schema())
@@ -93,7 +110,7 @@ class XmlDeserialiser:
             value = element.get(attrib)
             if value is None:
                 continue
-            base_class = self.strip_optional(type_hints[attrib])
+            base_class = _strip_optional(type_hints[attrib])
 
             kwargs[attrib] = base_class(value)
         for child_name in getattr(element_class, "xml_elements", ()):
@@ -127,12 +144,10 @@ class XmlDeserialiser:
         return instance
 
     def strip_optional(self, type_hint):
-        if self.is_optional(type_hint):
-            return typing.get_args(type_hint)[0]
-        return type_hint
+        return _strip_optional(type_hint)
 
     def is_optional(self, type_hint):
-        return typing.get_origin(type_hint) is typing.Union and typing.get_args(type_hint)[1] is type(None)
+        return _is_optional(type_hint)
 
     def cls_name(self, name: str) -> str:
         return name if name[0].isupper() else name.title()

{python_materialsdb-0.3.0.dist-info → python_materialsdb-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-materialsdb
-Version: 0.3.0
+Version: 0.3.2
 Summary: A library to work with materialsdb.org open standard for building materials.
 Author-email: Cyril Waechter <cyrwae@hotmail.com>
 License-Expression: GPL-3.0-or-later

{python_materialsdb-0.3.0.dist-info → python_materialsdb-0.3.2.dist-info}/RECORD

@@ -1,17 +1,17 @@
 materialsdb/__init__.py,sha256=lml7ffWFF3-0MD-Z7YbPZNireUpDO7tR9B3KNamrI0k,127
-materialsdb/cache.py,sha256=9XpJ7I5mLNpQZsVZSggIdUwS3votombJ9PfjbVbl-OA,4751
+materialsdb/cache.py,sha256=wPCksig6hidUssjRx_KaPk9V5ZeWbHfbs0Qt2XTuLPk,6594
 materialsdb/classes.py,sha256=WdXNiCqFcevgWrqDZKLR8HPio3BwcmOJ1NyVGArQ0hw,21549
 materialsdb/config.py,sha256=Tp14G_Y_XEkYshwrp4gd9XjGb5e_mO-hxYOevCTVnmI,1291
 materialsdb/construction.py,sha256=29H5gt3EX0LFNJ7ftE0Ob7huQgyZzx3ygW7nNcUSo5s,17817
 materialsdb/query.py,sha256=h9kP3Zc41l4h9bcxjwp-UUb8ezsG0A3ZkraJjaQZVVI,620
-materialsdb/serialiser.py,sha256=GL_e1FW6inuvfLvqQzp81L8XgoByRtVtd7nWtrYKWmY,7056
+materialsdb/serialiser.py,sha256=J6bUc7eKYD569TrOWVAK5ZDeb7cdD2YbF0nD6jf3iPY,7263
 materialsdb/store.py,sha256=_Iu425X7-sYE7A2vvQVrR1R6ju2R63m_BK43c9y3mhM,11000
 materialsdb/summary.py,sha256=vl6LhVIfN4KHN-KZxU6oVBYut0FPA3E_baGp_fegnBU,2558
 materialsdb/utils.py,sha256=2xGwr6b4NgOtjT5lxpFVN9jnOSlDsmZPnelSGEs5MDs,3068
 materialsdb/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 materialsdb/gui/__main__.py,sha256=Rha9z_Lxmf2mnCfLUV8s8ZqMRankDhtRrype1v5cm48,1405
 materialsdb/gui/discovery.py,sha256=au_X0ULkIxjAMV1EWgVAs1aLcl902wi4Kzw6y7M26Ag,792
-materialsdb/gui/listener.py,sha256=45DUK4tJALful0lVWX2x0VtfNVGkZ-pwmaWQwmHN0CE,6495
+materialsdb/gui/listener.py,sha256=tfHjQyvu-YkTfXpFUoKwZZQzfm9y6Jo87LCOZkXbJOk,7107
 materialsdb/gui/server.py,sha256=yMYy_EDPp5Y7kiQiRDc4rGJ_xbSda3RiycWs3CZyN5w,33553
 materialsdb/gui/static/app-constructions.js,sha256=59oO_oo9li6SJacA1XYQHVG3rx37MJG7ySaM8Mpn5s4,31343
 materialsdb/gui/static/app.js,sha256=eDb53OkMhslgp5vVghaDZstSK_ooenu0cGumjaMZcOY,22707
@@ -19,15 +19,15 @@ materialsdb/gui/static/constructions.html,sha256=kozoWdVHWrKTiB08kcchXLMuL6jijGE
 materialsdb/gui/static/index.html,sha256=4pXwmXLIwUIosa7wVBRzVbeuLf_WzlRUs5dxwZsSeNU,3208
 materialsdb/gui/static/picker-core.js,sha256=bK8308VJcrTgEZECblELwtrU3QW1VZHuqtM3pBPTaIg,4145
 materialsdb/ifc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-materialsdb/ifc/material_builder.py,sha256=PESV1ov1BL4aFrurOkI7CMe3i6WEWfK4kgBEDm52-sQ,12245
+materialsdb/ifc/material_builder.py,sha256=PGpznk02_wHcCH4o0jC6jRDoDmugA5kqJO6XL6wL2UY,13523
 materialsdb/ifc/material_psets.json,sha256=lQ0zQgBq3xnxyYItkmu7BzB5KE9ysFof-rrHawb5T-M,10897
 materialsdb/ifc/project_library.py,sha256=hOvirB73ZiTYiP6rOu6eN1dU2ZXFRgSOGpQrH2DY4RM,6324
 materialsdb/schema/MaterialsDBIndex100.xsd,sha256=oK81n2b3_82Mt5G31yEm9vwkMjUmNyM6jglt_zpUQZc,2199
 materialsdb/schema/materialsdb102.xsd,sha256=IaC6E_B3N1VaU9lhrl6ZGwi8m2rk2p7HTEZKN_Yj2AY,32880
 materialsdb/schema/materialsdb103.xsd,sha256=iX7Q1ejWEN_ZSuRVCX40zjYt5UraY3f_JxBzqZUFu7Q,37762
-python_materialsdb-0.3.0.dist-info/licenses/LICENSE.md,sha256=M7wm1EmMGDtwPRdg7kW4d00h1uAXjKOT3HFScYQMeiE,34916
-python_materialsdb-0.3.0.dist-info/METADATA,sha256=dugVsiclmutXpwQj_CI8tkEe0oGNus2Amc8vnZqit_w,7673
-python_materialsdb-0.3.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_materialsdb-0.3.0.dist-info/entry_points.txt,sha256=7bCySVv6oV9hiva7Fn5Dm9oboPRIC6DU6DRlsjCLO6k,66
-python_materialsdb-0.3.0.dist-info/top_level.txt,sha256=5ZHbF8Oj1W24bifG65Fl3hCaivZpkO6EyOHHaRavZxE,12
-python_materialsdb-0.3.0.dist-info/RECORD,,
+python_materialsdb-0.3.2.dist-info/licenses/LICENSE.md,sha256=M7wm1EmMGDtwPRdg7kW4d00h1uAXjKOT3HFScYQMeiE,34916
+python_materialsdb-0.3.2.dist-info/METADATA,sha256=EWVnNfW1XA8YsScGmrwWkLBqKVkvy8dGAvZgX0pk7cw,7673
+python_materialsdb-0.3.2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_materialsdb-0.3.2.dist-info/entry_points.txt,sha256=7bCySVv6oV9hiva7Fn5Dm9oboPRIC6DU6DRlsjCLO6k,66
+python_materialsdb-0.3.2.dist-info/top_level.txt,sha256=5ZHbF8Oj1W24bifG65Fl3hCaivZpkO6EyOHHaRavZxE,12
+python_materialsdb-0.3.2.dist-info/RECORD,,