labfreed 0.0.3__py2.py3-none-any.whl

labfreed/validation.py

@@ -0,0 +1,149 @@
+from pydantic import BaseModel, Field, PrivateAttr
+from typing import List, Set, Tuple
+
+from rich import print
+from rich.text import Text
+
+
+domain_name_pattern = r"(?!-)([A-Za-z0-9-]{1,63}(?<!-)\.)+[A-Za-z]{2,63}"
+hsegment_pattern = r"[A-Za-z0-9_\-\.~!$&'()+,:;=@]|%[0-9A-Fa-f]{2}"
+
+
+class ValidationMessage(BaseModel):
+    source:str 
+    type: str
+    problem_msg:str
+    recommendation_msg: str = ""
+    highlight:str = "" #this can be used to highlight problematic parts
+    highlight_sub:list[str] = Field(default_factory=list())
+        
+    @property
+    def emphazised_highlight(self):
+        fmt = lambda s: f'[emph]{s}[/emph]'
+        
+        if not self.highlight_sub:
+            return fmt(self.highlight)
+          
+        result = []
+        for c in self.highlight:
+            if c in self.highlight_sub:
+                result.append(fmt(c))
+            else:
+                result.append(c)
+
+        return ''.join(result)
+
+    
+class LabFREEDValidationError(ValueError):
+    def __init__(self, message=None, validation_msgs=None):
+        super().__init__(message)
+        self._validation_msgs = validation_msgs
+
+    @property
+    def validation_msgs(self):
+        return self._validation_msgs
+    
+    
+
+
+class BaseModelWithValidationMessages(BaseModel):
+    """ Extension of Pydantic BaseModel, so that validator can issue warnings.
+    The purpose of that is to allow only minimal validation but on top check for stricter recommendations"""
+    _validation_messages: list[ValidationMessage] = PrivateAttr(default_factory=list)
+
+    def add_validation_message(self, *, msg: str, type:str, recommendation:str="", source:str="", highlight_pattern="", highlight_sub=None):
+        if not highlight_sub:
+            highlight_sub = []
+        w = ValidationMessage(problem_msg=msg, recommendation_msg=recommendation, source=source, type=type, highlight=highlight_pattern, highlight_sub=highlight_sub)
+
+        if not w in self._validation_messages:
+            self._validation_messages.append(w)
+
+    def get_validation_messages(self) -> list[ValidationMessage]:
+        return self._validation_messages
+    
+    def get_errors(self) -> list[ValidationMessage]: 
+        return filter_errors(self._validation_messages)
+    
+    def get_warnings(self) -> list[ValidationMessage]: 
+        return filter_warnings(self._validation_messages)
+    
+    def is_valid(self) -> bool:
+        return len(filter_errors(self.get_nested_validation_messages())) == 0
+
+    # Function to extract warnings from a model and its nested models
+    def get_nested_validation_messages(self, parent_name: str = "", visited: Set[int] = None) -> List[ValidationMessage]:
+        """
+        Recursively extract warnings from a Pydantic model and its nested fields.
+        
+        :param model: The Pydantic model instance to inspect.
+        :param parent_name: The name of the parent model to track the path.
+        :return: List of tuples containing (model name, warning message).
+        """                   
+        if visited is None:
+            visited = set()
+
+        model_id = id(self)
+        if model_id in visited:
+            return []
+        visited.add(model_id)
+        
+        warnings_list = [warning for warning in self.get_validation_messages()]
+        # warnings_list = [(parent_name or self.__class__.__name__, model_id,  warning) for warning in self.get_validation_messages()]
+
+
+        for field_name, field in self.__fields__.items():
+            full_path = f"{parent_name}.{field_name}" if parent_name else field_name
+            value = getattr(self, field_name)
+
+            if isinstance(value, BaseModelWithValidationMessages):
+                warnings_list.extend(value.get_nested_validation_messages(full_path, visited))
+            elif isinstance(value, list):
+                for index, item in enumerate(value):
+                    if isinstance(item, BaseModelWithValidationMessages):
+                        list_path = f"{full_path}[{index}]"
+                        warnings_list.extend(item.get_nested_validation_messages(list_path, visited))
+        return warnings_list
+    
+    
+    def get_nested_errors(self) -> list[ValidationMessage]: 
+        return filter_errors(self.get_nested_validation_messages())
+    
+    def get_nested_warnings(self) -> list[ValidationMessage]: 
+        return filter_warnings(self.get_nested_validation_messages())
+    
+    
+    def print_validation_messages(self, str_to_highlight_in=None):
+        if not str_to_highlight_in:
+            str_to_highlight_in = str(self)
+        msgs = self.get_nested_validation_messages()
+        print('\n'.join(['\n',
+                         '=======================================',
+                         'Validation Results',
+                         '---------------------------------------'
+                        ]
+                        )
+        )
+
+        for m in msgs:
+            if m.type.casefold() == "error":
+                color = 'red'
+            else:
+                color = 'yellow'
+                
+            text = Text.from_markup(f'\n [bold {color}]{m.type} [/bold {color}] in \t {m.source}' )
+            print(text)
+            formatted_highlight = m.emphazised_highlight.replace('emph', f'bold {color}')
+            fmtd = str_to_highlight_in.replace(m.highlight, formatted_highlight)
+            fmtd = Text.from_markup(fmtd)
+            print(fmtd)
+            print(Text.from_markup(f'{m.problem_msg}'))
+        
+    
+    
+def filter_errors(val_msg:list[ValidationMessage]) -> list[ValidationMessage]:
+    return [ m for m in val_msg if m.type.casefold() == "error" ]
+
+def filter_warnings(val_msg:list[ValidationMessage]) -> list[ValidationMessage]:
+    return [ m for m in val_msg if m.type.casefold() != "error" ]     
+

labfreed-0.0.3.dist-info/METADATA

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: labfreed
+Version: 0.0.3
+Summary: Python implementation of LabFREED building blocks
+Author-email: Reto Thürer <thuerer.r@buchi.com>
+License-Expression: MIT
+License-File: LICENSE

labfreed-0.0.3.dist-info/RECORD

@@ -0,0 +1,22 @@
+labfreed/__init__.py,sha256=ToYkbhG_8yX4YOS9mieyjvGLG2M8raraqRFDbU71d3A,87
+labfreed/parse_pac.py,sha256=HA3-jAnw2crsXMW_D7Tw-z99qnUWL5MBQVXEzdYP2m4,6287
+labfreed/validation.py,sha256=QwkZWJhAjWbPUZtJJwjVYsw9TxeFhdbZaKjrPPIpuAA,5937
+labfreed/DisplayNameExtension/DisplayNameExtension.py,sha256=l9JZY2eRS0V-H5h3-WXIHiiBJuljns-_e_t9Bp84_CU,1155
+labfreed/PAC_CAT/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+labfreed/PAC_CAT/data_model copy.py,sha256=JWMVkwkX9vWZayOLOzdTHk3VZVYBuyupumNqL-cWCxU,9611
+labfreed/PAC_CAT/data_model.py,sha256=pcib1lEQuqejWP7dfmPUtLakz-y-zeDb9CIe94Jmz0A,13677
+labfreed/PAC_ID/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+labfreed/PAC_ID/data_model.py,sha256=g09qgC-TV6fjJw9VyDF6mTJ6co2i2RKZc0Z-BmiiUIQ,7483
+labfreed/PAC_ID/extensions.py,sha256=bvuZnlNKUdwsDLrPm8fyifqPn_PR4wCVkkScFnvRiuM,1158
+labfreed/TREX/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
+labfreed/TREX/data_model.py,sha256=_xhnYGMcMPa0uf_020epq88zqHT1wdsUPC2ELJcSRWE,29684
+labfreed/TREX/parse.py,sha256=86962VEJpkrTcT436iFIB5dNed5WHABzpjxRjkA3PXo,2043
+labfreed/TREX/unece_units.py,sha256=scPKdsPzY1neAdFOhA08_tRZaR-yplM8mBhIzzDqZBk,3006
+labfreed/utilities/base36.py,sha256=_yX8aQ1OwrK5tnJU1NUEzQSFGr9xAVnNvPObpNzCPYs,2895
+labfreed/utilities/extension_intertpreters.py,sha256=B3IFJLfVMJQuPfBBtX6ywlDUZEi7_x6tY4g8V7SpWSs,124
+labfreed/utilities/utility_types.py,sha256=Zhk8Mu4hHjkn1gs8oh7vOxxaT7L7wLMVG40ZOWCKGK4,2865
+labfreed/utilities/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-xQbBglS8F_NoWsGkfOVITFN0,331
+labfreed-0.0.3.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.0.3.dist-info/WHEEL,sha256=BXjIu84EnBiZ4HkNUBN93Hamt5EPQMQ6VkF7-VZ_Pu0,100
+labfreed-0.0.3.dist-info/METADATA,sha256=c8F4fZqnmeO2IQFSaVItImF2GiT2FPBqWaoRk51EnfM,206
+labfreed-0.0.3.dist-info/RECORD,,

labfreed-0.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: flit 3.11.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

labfreed-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Reto Thürer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.