holado 0.2.3__tar.gz → 0.2.4__tar.gz

{holado-0.2.3 → holado-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: holado
-Version: 0.2.3
+Version: 0.2.4
 Summary: HolAdo framework
 Project-URL: Homepage, https://gitlab.com/holado_framework/python
 Project-URL: Issues, https://gitlab.com/holado_framework/python/-/issues

holado-0.2.4/packaging/VERSION

@@ -0,0 +1 @@
+0.2.4

{holado-0.2.3 → holado-0.2.4}/src/holado/__init__.py

@@ -67,7 +67,12 @@ def change_logging_config(log_level=None, log_on_console=False, log_in_file=True
     SessionContext.instance().log_manager.on_console = log_on_console
     SessionContext.instance().log_manager.in_file = log_in_file
     SessionContext.instance().log_manager.set_config()
-    
+
+
+def initialize_minimal():
+    _initialize_logging(initialize_logging=False, logging_config_file=None,
+                        log_level=None, log_on_console=True, log_in_file=False)
+
 def initialize(TSessionContext=None, initialize_logging=True, logging_config_file=None, 
                log_level=None, log_on_console=False, log_in_file=True, session_kwargs=None,
                garbage_collector_periodicity=default_value):
@@ -265,3 +270,8 @@ def print_imported_modules(prefix):
     # print(f"{prefix} globals modules: {globals_modules}")
     
     
+
+# Process minimal initialization of HolAdo
+initialize_minimal()
+
+

holado-0.2.4/src/holado_ais/ais/ais_messages.py

@@ -0,0 +1,204 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# 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.
+#################################################
+
+import logging
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_value.common.tables.value_table_manager import ValueTableManager
+from holado_value.common.tables.converters.value_table_converter import ValueTableConverter
+from typing import Union
+from holado_core.common.tables.table_with_header import TableWithHeader
+from holado_core.common.tools.string_tools import StrTools
+from holado_binary.ipc.binary import Binary
+from holado_core.common.tools.tools import Tools
+from holado_python.standard_library.typing import Typing
+import copy
+
+logger = logging.getLogger(__name__)
+
+try:
+    import pyais
+    from bitarray import bitarray
+    from holado_ais.ais.patch_pyais import HATagBlock, HA_ais_to_nmea_0183
+    with_pyais = True
+    
+    # Patch pyais with some fixes
+    import holado_ais.ais.patch_pyais  # @UnusedImport
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"AIS is not available. Initialization failed on error: {exc}")
+    with_pyais = False
+
+
+
+class AISMessages(object):
+    
+    @classmethod
+    def is_available(cls):
+        return with_pyais
+    
+    if with_pyais:
+        
+        def __init__(self):
+            self.__tag_block_group_id = 0
+        
+        def default_message_data(self, msg_type:int):
+            """Return default data values for required data by pyais but not functionnaly required.
+            It is useful when generating custom messages, for example for tests.
+            """
+            return {}
+        
+        def new_message_as_bitarray_bytes(self, msg_type:int, data:Union[dict,TableWithHeader]):
+            msg = self.new_message(msg_type, data)
+            res = self.convert_message_to_bytes(msg)
+            return res
+        
+        def new_message(self, msg_type:int, data:Union[dict,TableWithHeader]):
+            if isinstance(data, TableWithHeader):
+                data = self.__convert_table_to_dict(data)
+            if not isinstance(data, dict):
+                raise TechnicalException(f"Unexpected data type '{Typing.get_object_class_fullname(data)}'")
+            
+            message_type = self.__get_message_type(msg_type)
+            res = message_type.create(**data)
+            return res
+    
+        def decode(self, *args, encoded_msg=None, parts_separator=b'\n'):
+            if encoded_msg is not None:
+                if isinstance(encoded_msg, str):
+                    encoded_bytes = encoded_msg.encode("utf-8")
+                elif isinstance(encoded_msg, bytes):
+                    encoded_bytes = encoded_msg
+                else:
+                    raise TechnicalException(f"Parameter 'encoded_msg' must be of type str or bytes")
+                args = encoded_bytes.split(parts_separator)
+            return pyais.decode(*args, error_if_checksum_invalid=True)
+        
+        def decode_message(self, msg_type:int, bit_array:Union[str,bitarray]):
+            if isinstance(bit_array, str):
+                if StrTools.is_hex(bit_array) and not StrTools.is_bitarray(bit_array):
+                    bit_array = Binary.convert_hex_str_to_bin_str(bit_array)
+                bit_array = bitarray(bit_array)
+            if not isinstance(bit_array, bitarray):
+                raise TechnicalException(f"Bad parameter 'bit_array' (accepted types: bitarray, str)")
+                
+            message_type = self.__get_message_type(msg_type)
+            return message_type.from_bitarray(bit_array)
+        
+        def encode_raw_payload(self, payload_hex: str, tag_block: HATagBlock = None, with_tag_block=True, talker_id: str = "AIVDM", **kwargs):
+            from pyais.util import encode_ascii_6
+            
+            payload_bitarray = bitarray()
+            payload_bitarray.frombytes(bytes.fromhex(payload_hex))
+            payload_ascii6, fill_bits = encode_ascii_6(payload_bitarray)
+            
+            seq_id = kwargs.pop('seq_id') if 'seq_id' in kwargs else self.__tag_block_group_id % 10
+            radio_channel = kwargs['radio_channel'] if 'radio_channel' in kwargs else 'A'
+            group_id = kwargs.pop('group_id') if 'group_id' in kwargs else None
+            
+            sentences = HA_ais_to_nmea_0183(payload_ascii6, talker_id, radio_channel, fill_bits, seq_id)
+            return self.__encode_add_tag_block(sentences, tag_block, with_tag_block=with_tag_block, group_id=group_id)
+            
+        def encode(self, data, tag_block: HATagBlock = None, with_tag_block=True, talker_id: str = "AIVDM", **kwargs):
+            if isinstance(data, pyais.messages.Payload):
+                return self.encode_msg(data, tag_block=tag_block, with_tag_block=with_tag_block, talker_id=talker_id, **kwargs)
+            elif isinstance(data, dict):
+                return self.encode_data(data, tag_block=tag_block, with_tag_block=with_tag_block, talker_id=talker_id, **kwargs)
+            elif isinstance(data, TableWithHeader):
+                return self.encode_table(data, tag_block=tag_block, with_tag_block=with_tag_block, talker_id=talker_id, **kwargs)
+            else:
+                raise TechnicalException(f"Unexpected data type '{Typing.get_object_class_fullname(data)}'")
+        
+        def encode_msg(self, msg, tag_block: HATagBlock = None, with_tag_block=True, talker_id: str = "AIVDM", **kwargs):
+            if not isinstance(msg, pyais.messages.Payload):
+                raise TechnicalException(f"Parameter 'msg' is not an AIS message (obtained type: {Typing.get_object_class_fullname(msg)})")
+            
+            seq_id = kwargs.pop('seq_id') if 'seq_id' in kwargs else self.__tag_block_group_id % 10
+            group_id = kwargs.pop('group_id') if 'group_id' in kwargs else None
+            
+            sentences = pyais.encode_msg(msg, seq_id=seq_id, talker_id=talker_id, **kwargs)
+            return self.__encode_add_tag_block(sentences, tag_block, with_tag_block=with_tag_block, group_id=group_id)
+        
+        def encode_data(self, data, tag_block: HATagBlock = None, with_tag_block=True, talker_id: str = "AIVDM", **kwargs):
+            if not isinstance(data, dict):
+                raise TechnicalException(f"Parameter 'data' is not a dict (obtained type: {Typing.get_object_class_fullname(data)})")
+            
+            seq_id = kwargs.pop('seq_id') if 'seq_id' in kwargs else self.__tag_block_group_id % 10
+            group_id = kwargs.pop('group_id') if 'group_id' in kwargs else None
+            
+            sentences = pyais.encode_dict(data, seq_id=seq_id, talker_id=talker_id, **kwargs)
+            return self.__encode_add_tag_block(sentences, tag_block, with_tag_block=with_tag_block, group_id=group_id)
+        
+        def encode_table(self, table, tag_block: HATagBlock = None, with_tag_block=True, talker_id: str = "AIVDM", **kwargs):
+            data = self.__convert_table_to_dict(table)
+            return self.encode_data(data, tag_block=tag_block, with_tag_block=with_tag_block, talker_id=talker_id, **kwargs)
+        
+        def __encode_add_tag_block(self, encoded_sentences, tag_block: HATagBlock = None, with_tag_block=True, group_id=None):
+            from pyais.messages import TagBlockGroup
+            
+            if not with_tag_block:
+                return encoded_sentences
+            
+            res = []
+            nb_sentences = len(encoded_sentences)
+            if nb_sentences > 1 and group_id is None:
+                group_id = self.__tag_block_group_id
+                # Increment group_id for next message needing a group_id
+                self.__new_tag_block_group_id()
+            elif nb_sentences == 1:
+                # No group tag block is needed
+                group_id = None
+            
+            for index, sentence in enumerate(encoded_sentences):
+                sentence_tag_block = copy.deepcopy(tag_block) if index == 0 else None
+                if group_id is not None:
+                    if sentence_tag_block is None:
+                        sentence_tag_block = HATagBlock()
+                    sentence_tag_block._group = TagBlockGroup(msg_id=index+1, total=nb_sentences, group_id=group_id)
+                
+                if sentence_tag_block is not None:
+                    res.append('\\' + sentence_tag_block.to_raw().decode() + '\\' + sentence)
+                else:
+                    res.append(sentence)
+            
+            return res
+        
+        def __new_tag_block_group_id(self):
+            self.__tag_block_group_id += 1
+            if self.__tag_block_group_id > 9999:
+                self.__tag_block_group_id = 0
+            return self.__tag_block_group_id
+        
+        def convert_message_to_binary_str(self, msg):
+            return msg.to_bitarray().to01()
+        
+        def convert_message_to_bytes(self, msg):
+            return msg.to_bitarray().tobytes()
+        
+        def __get_message_type(self, msg_type:int):
+            import importlib
+            module = importlib.import_module('pyais.messages')
+            res = getattr(module, f"MessageType{msg_type}")
+            return res
+            
+        def __convert_table_to_dict(self, table):
+            if not ValueTableManager.is_table_with_header(table):
+                raise TechnicalException(f"Parameter 'table' is not a table with header (obtained type: {Typing.get_object_class_fullname(table)})")
+            
+            if ValueTableManager.verify_table_is_name_value_table(table, raise_exception=False):
+                res = ValueTableConverter.convert_name_value_table_2_dict(table)
+            else:
+                res = ValueTableConverter.convert_table_with_header_to_dict(table)
+            return res
+        
+    
+    

holado-0.2.4/src/holado_examples/scripts/script_initialization.py

@@ -0,0 +1,18 @@
+import holado
+
+
+# Minimal HolAdo initialization
+
+import logging
+logging.print("After 'import holado', HolAdo is initialized minimally with logging levels 'trace' and 'print'")
+
+
+# Initialize HolAdo with default behaviours
+
+holado.initialize(log_on_console=True, log_in_file=False)
+logging.print("After 'holado.initialize(log_on_console=True, log_in_file=False)', HolAdo is initialized:")
+logging.print("  - to log on console but not in file")
+logging.print("  - launch garbage collector periodically (without specifying garbage_collector_periodicity, default periodicity is 10 s)")
+
+
+

{holado-0.2.3 → holado-0.2.4}/src/holado_logging/__init__.py

@@ -32,5 +32,6 @@ def register():
     log_manager = LogManager()
     log_manager.initialize(log_on_console=True)
     
-    SessionContext.instance().services.register_service_instance("log_manager", log_manager, SessionContext.instance())
+    SessionContext.instance().services.register_service_instance("log_manager", log_manager, SessionContext.instance(), 
+                                                                 raise_if_service_exist=False, raise_if_object_exist=False)
 

{holado-0.2.3 → holado-0.2.4}/src/holado_logging/common/logging/log_config.py

@@ -1,128 +1,128 @@
-
-#################################################
-# HolAdo (Holistic Automation do)
-#
-# (C) Copyright 2021-2025 by Eric Klumpp
-# 
-# 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.
-#################################################
-
-import logging
-
-
-# logger = logging.getLogger(__name__)
-
-
-class LogConfig(object):
-    TLogger = None
-    TManager = None
-    default_level = logging.INFO
-    
-    @classmethod
-    def configure(cls, initialize_logging=True, log_level=None):
-        # HolAdo needs at least to add logging level TRACE and PRINT
-        cls.add_logging_level_trace()
-        cls.add_logging_level_print()
-        
-        if log_level:
-            if isinstance(log_level, str):
-                cls.default_level = logging._nameToLevel[log_level]
-            else:
-                cls.default_level = log_level
-        
-        if initialize_logging:
-            from holado_logging.common.logging.holado_logger import HALogger
-            
-            HALogger.default_message_size_limit = 10000
-            cls.TLogger = HALogger
-            cls.TManager = logging.Manager
-            
-            # Configure logging
-            cls.configure_logging()
-    
-    @classmethod
-    def configure_logging(cls):
-        #TODO EKL: make loggers configuration optional
-        # Configure loggers
-        from holado_logging.common.logging.holado_logger import TestRootLogger
-        logging.root = TestRootLogger(cls.default_level)
-        logging.Logger.root = logging.root
-        logging.Logger.manager = cls.TManager(cls.TLogger.root)
-        
-        logging.setLoggerClass(cls.TLogger)
-        
-    
-    @classmethod
-    def add_logging_level_print(cls):
-        if not cls.has_logging_level("PRINT"):
-            cls.add_logging_level("PRINT", 45, None)
-    
-    @classmethod
-    def add_logging_level_trace(cls):
-        if not cls.has_logging_level("TRACE"):
-            cls.add_logging_level("TRACE", 5, None)
-        
-    
-    @classmethod
-    def has_logging_level(cls, levelName):
-        return hasattr(logging, levelName)
-    
-    @classmethod
-    def add_logging_level(cls, levelName, levelNum, methodName=None):
-        """
-        This method was implemented and shared by the author of library haggis (https://haggis.readthedocs.io).
-        
-        Comprehensively adds a new logging level to the `logging` module and the
-        currently configured logging class.
-    
-        `levelName` becomes an attribute of the `logging` module with the value
-        `levelNum`. `methodName` becomes a convenience method for both `logging`
-        itself and the class returned by `logging.getLoggerClass()` (usually just
-        `logging.Logger`). If `methodName` is not specified, `levelName.lower()` is
-        used.
-    
-        To avoid accidental clobberings of existing attributes, this method will
-        raise an `AttributeError` if the level name is already an attribute of the
-        `logging` module or if the method name is already present 
-    
-        Example
-        -------
-        >>> addLoggingLevel('TRACE', logging.DEBUG - 5)
-        >>> logging.getLogger(__name__).setLevel("TRACE")
-        >>> logging.getLogger(__name__).trace('that worked')
-        >>> logging.trace('so did this')
-        >>> logging.TRACE
-        5
-    
-        """
-        if not methodName:
-            methodName = levelName.lower()
-    
-        if hasattr(logging, levelName):
-            raise AttributeError('{} already defined in logging module'.format(levelName))
-        if hasattr(logging, methodName):
-            raise AttributeError('{} already defined in logging module'.format(methodName))
-        if hasattr(logging.getLoggerClass(), methodName):
-            raise AttributeError('{} already defined in logger class'.format(methodName))
-    
-        # This method was inspired by the answers to Stack Overflow post
-        # http://stackoverflow.com/q/2183233/2988730, especially
-        # http://stackoverflow.com/a/13638084/2988730
-        def logForLevel(self, message, *args, **kwargs):
-            if self.isEnabledFor(levelNum):
-                self._log(levelNum, message, args, **kwargs)
-        def logToRoot(message, *args, **kwargs):
-            logging.log(levelNum, message, *args, **kwargs)
-    
-        logging.addLevelName(levelNum, levelName)
-        setattr(logging, levelName, levelNum)
-        setattr(logging.getLoggerClass(), methodName, logForLevel)
-        setattr(logging, methodName, logToRoot)
-    
-    
-    
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# 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.
+#################################################
+
+import logging
+
+
+# logger = logging.getLogger(__name__)
+
+
+class LogConfig(object):
+    TLogger = None
+    TManager = None
+    default_level = logging.INFO
+    
+    @classmethod
+    def configure(cls, initialize_logging=True, log_level=None):
+        # HolAdo needs at least to add logging level TRACE and PRINT
+        cls.add_logging_level_trace()
+        cls.add_logging_level_print()
+        
+        if log_level:
+            if isinstance(log_level, str):
+                cls.default_level = logging._nameToLevel[log_level]
+            else:
+                cls.default_level = log_level
+        
+        if initialize_logging:
+            from holado_logging.common.logging.holado_logger import HALogger
+            
+            HALogger.default_message_size_limit = 10000
+            cls.TLogger = HALogger
+            cls.TManager = logging.Manager
+            
+            # Configure logging
+            cls.configure_logging()
+    
+    @classmethod
+    def configure_logging(cls):
+        #TODO EKL: make loggers configuration optional
+        # Configure loggers
+        from holado_logging.common.logging.holado_logger import TestRootLogger
+        logging.root = TestRootLogger(cls.default_level)
+        logging.Logger.root = logging.root
+        logging.Logger.manager = cls.TManager(cls.TLogger.root)
+        
+        logging.setLoggerClass(cls.TLogger)
+        
+    
+    @classmethod
+    def add_logging_level_print(cls):
+        if not cls.has_logging_level("PRINT"):
+            cls.add_logging_level("PRINT", 45, None)
+    
+    @classmethod
+    def add_logging_level_trace(cls):
+        if not cls.has_logging_level("TRACE"):
+            cls.add_logging_level("TRACE", 5, None)
+        
+    
+    @classmethod
+    def has_logging_level(cls, levelName):
+        return hasattr(logging, levelName)
+    
+    @classmethod
+    def add_logging_level(cls, levelName, levelNum, methodName=None):
+        """
+        This method was implemented and shared by the author of library haggis (https://haggis.readthedocs.io).
+        
+        Comprehensively adds a new logging level to the `logging` module and the
+        currently configured logging class.
+    
+        `levelName` becomes an attribute of the `logging` module with the value
+        `levelNum`. `methodName` becomes a convenience method for both `logging`
+        itself and the class returned by `logging.getLoggerClass()` (usually just
+        `logging.Logger`). If `methodName` is not specified, `levelName.lower()` is
+        used.
+    
+        To avoid accidental clobberings of existing attributes, this method will
+        raise an `AttributeError` if the level name is already an attribute of the
+        `logging` module or if the method name is already present 
+    
+        Example
+        -------
+        >>> addLoggingLevel('TRACE', logging.DEBUG - 5)
+        >>> logging.getLogger(__name__).setLevel("TRACE")
+        >>> logging.getLogger(__name__).trace('that worked')
+        >>> logging.trace('so did this')
+        >>> logging.TRACE
+        5
+    
+        """
+        if not methodName:
+            methodName = levelName.lower()
+    
+        if hasattr(logging, levelName):
+            raise AttributeError('{} already defined in logging module'.format(levelName))
+        if hasattr(logging, methodName):
+            raise AttributeError('{} already defined in logging module'.format(methodName))
+        if hasattr(logging.getLoggerClass(), methodName):
+            raise AttributeError('{} already defined in logger class'.format(methodName))
+    
+        # This method was inspired by the answers to Stack Overflow post
+        # http://stackoverflow.com/q/2183233/2988730, especially
+        # http://stackoverflow.com/a/13638084/2988730
+        def logForLevel(self, message, *args, **kwargs):
+            if self.isEnabledFor(levelNum):
+                self._log(levelNum, message, args, **kwargs)
+        def logToRoot(message, *args, **kwargs):
+            logging.log(levelNum, message, *args, **kwargs)
+    
+        logging.addLevelName(levelNum, levelName)
+        setattr(logging, levelName, levelNum)
+        setattr(logging.getLoggerClass(), methodName, logForLevel)
+        setattr(logging, methodName, logToRoot)
+    
+    
+    
     

{holado-0.2.3 → holado-0.2.4}/src/holado_protobuf/__init__.py

@@ -19,7 +19,6 @@ def dependencies():
 
 def register():
     from holado.common.context.session_context import SessionContext
-    from holado_protobuf.ipc.protobuf.types.google.protobuf import Timestamp
     from holado_python.common.tools.comparators.datetime_comparator import DatetimeComparator
     from holado_python.common.tools.datetime import DateTime
     
@@ -51,6 +50,7 @@ def register():
         
         # Register datetime conversion
         
+        from holado_protobuf.ipc.protobuf.types.google.protobuf import Timestamp
         DatetimeComparator.register_resource_for_type_in_class('protobuf.Timestamp', None, 
                                                                lambda o: isinstance(o, Timestamp.protobuf_class()), 
                                                                lambda o: DateTime.seconds_nanos_to_datetime(o.seconds, o.nanos),