xaal.lib 0.7.8__py3-none-any.whl → 0.7.10__py3-none-any.whl

xaal/lib/__init__.py

@@ -1,5 +1,3 @@
-
-
 # Load main class & modules.
 
 
@@ -8,7 +6,7 @@ from . import tools
 from . import bindings
 from . import aiohelpers as helpers
 
-from .core  import Timer
+from .core import Timer
 
 # sync engine
 from .engine import Engine
@@ -19,5 +17,5 @@ from .aioengine import AsyncEngine
 from .aionetwork import AsyncNetworkConnector
 
 from .devices import Device, Attribute, Attributes
-from .messages import Message,MessageFactory,MessageType
+from .messages import Message, MessageFactory, MessageType, MessageAction
 from .exceptions import *

xaal/lib/aioengine.py

@@ -36,7 +36,7 @@ class HookType(Enum):
 class Hook(object):
     __slots__ = ['type', 'func', 'args', 'kwargs']
 
-    def __init__(self, type_:HookType, func: core.FuncT, *args, **kwargs):
+    def __init__(self, type_: HookType, func: core.FuncT, *args, **kwargs):
         # func has to be a callable, but it can be a coroutine or a function
         self.type = type_
         self.func = func
@@ -58,7 +58,8 @@ class AsyncEngine(core.EngineMixin):
     ]
 
     def __init__(
-        self, address: str = config.address, port: int = config.port, hops: int = config.hops, key: bytes = config.key):
+        self, address: str = config.address, port: int = config.port, hops: int = config.hops, key: bytes = config.key
+    ):
         core.EngineMixin.__init__(self, address, port, hops, key)
 
         self.__txFifo = asyncio.Queue()  # tx msg fifo
@@ -167,7 +168,7 @@ class AsyncEngine(core.EngineMixin):
 
     async def handle_action_request(self, msg: 'Message', target: 'Device'):
         if msg.action is None:
-            return # should not happen, but pyright need this check
+            return  # should not happen, but pyright need this check
 
         try:
             result = await run_action(msg, target)
@@ -250,7 +251,8 @@ class AsyncEngine(core.EngineMixin):
         self.new_task(self.receive_task(), name='RecvQ')
         self.new_task(self.send_task(), name='SendQ')
         self.new_task(self.timer_task(), name='Timers')
-        self.new_task(console(locals()), name='Console')
+        if config.remote_console:
+            self.new_task(console(locals()), name='Console')
 
     def setup_alives_timer(self):
         # needed on stop-start sequence
@@ -259,7 +261,7 @@ class AsyncEngine(core.EngineMixin):
         # process alives every 10 seconds
         self.add_timer(self.process_alives, 10)
 
-    async def stop(self): # pyright: ignore
+    async def stop(self):  # pyright: ignore
         logger.info("Stopping engine")
         await self.run_hooks(HookType.stop)
         self.running_event.clear()
@@ -340,7 +342,7 @@ class AsyncEngine(core.EngineMixin):
         self.dump_hooks()
 
     def get_device(self, uuid: UUID) -> Optional['Device']:
-        # TODO:Check if this method is usefull 
+        # TODO:Check if this method is usefull
         for dev in self.devices:
             if dev.address == uuid:
                 return dev
@@ -391,7 +393,8 @@ async def console(locals=locals(), port: Optional[int] = None):
         # let's find a free port if not specified
         def find_free_port():
             import socketserver
-            with socketserver.TCPServer(('localhost', 0), None) as s: # pyright: ignore pyright reject the None here
+
+            with socketserver.TCPServer(('localhost', 0), None) as s:  # pyright: ignore pyright reject the None here
                 return s.server_address[1]
 
         port = find_free_port()
@@ -407,6 +410,8 @@ async def console(locals=locals(), port: Optional[int] = None):
     # start the console
     try:
         # debian with ipv6 disabled still state that localhost is ::1, which broke aioconsole
-        await aioconsole.start_interactive_server(host="127.0.0.1", port=port, factory=factory, banner=banner) # pyright: ignore
+        await aioconsole.start_interactive_server(
+            host="127.0.0.1", port=port, factory=factory, banner=banner
+        )  # pyright: ignore
     except OSError:
         logger.warning("Unable to run console")

xaal/lib/config.py

@@ -1,4 +1,3 @@
-
 # Default configuration
 
 import os
@@ -7,20 +6,23 @@ import binascii
 from configobj import ConfigObj
 
 # Default settings
-DEF_ADDR = '224.0.29.200'
+DEF_ADDR = "224.0.29.200"
 DEF_PORT = 1236
 DEF_HOPS = 10
 DEF_ALIVE_TIMER = 100
 DEF_CIPHER_WINDOW = 60 * 2
 DEF_QUEUE_SIZE = 10
-DEF_LOG_LEVEL = 'DEBUG'
-DEF_LOG_PATH = '/var/log/xaal'
+DEF_LOG_LEVEL = "DEBUG"
+DEF_LOG_PATH = "/var/log/xaal"
+DEF_REMOTE_CONSOLE = False
+
 
 STACK_VERSION = 7
 
+
 class Config:
     def __init__(self):
-        self.conf_dir = os.environ.get('XAAL_CONF_DIR', os.path.expanduser("~/.xaal"))
+        self.conf_dir = os.environ.get("XAAL_CONF_DIR", os.path.expanduser("~/.xaal"))
         self.address = DEF_ADDR
         self.port = DEF_PORT
         self.hops = DEF_HOPS
@@ -29,10 +31,11 @@ class Config:
         self.queue_size = DEF_QUEUE_SIZE
         self.log_level = DEF_LOG_LEVEL
         self.log_path = DEF_LOG_PATH
+        self.remote_console = DEF_REMOTE_CONSOLE
         self.key = b''
         self.STACK_VERSION = STACK_VERSION
 
-    def load(self, name='xaal.ini'):
+    def load(self, name="xaal.ini"):
         filename = os.path.join(self.conf_dir, name)
         if not os.path.isfile(filename):
             raise FileNotFoundError(f"Unable to load xAAL config file [{filename}]")
@@ -46,6 +49,8 @@ class Config:
         self.queue_size = self.safe_int(cfg.get('queue_size'), DEF_QUEUE_SIZE)
         self.log_level = self.safe_string(cfg.get('log_level'), DEF_LOG_LEVEL)
         self.log_path = self.safe_string(cfg.get('log_path'), DEF_LOG_PATH)
+        self.remote_console = self.safe_bool(cfg.get('remote_console'), DEF_REMOTE_CONSOLE)
+
         key = cfg.get('key', None)
         if key and type(key) is str:
             self.key = binascii.unhexlify(key.encode('utf-8'))
@@ -73,6 +78,14 @@ class Config:
         except (ValueError, TypeError):
             return default
 
+    @staticmethod
+    def safe_bool(value, default):
+        if value is None:
+            return default
+        if value.lower() == "true":
+            return True
+        return False
+
 
 config = Config()
 try:

xaal/lib/core.py

@@ -56,7 +56,7 @@ class EngineMixin(object):
     __slots__ = ['devices', 'timers', 'subscribers', 'msg_filter', '_attributesChange', 'network', 'msg_factory']
 
     def __init__(self, address: str, port: int, hops: int, key: bytes):
-        self.devices:list[Device] = []  # list of devices / use (un)register_devices()
+        self.devices: list[Device] = []  # list of devices / use (un)register_devices()
         self.timers: list[Timer] = []  # functions to call periodic
         self.subscribers: list[SubFuncT] = []  # message receive workflow
         self.msg_filter = None  # message filter
@@ -134,7 +134,7 @@ class EngineMixin(object):
         self.queue_msg(msg)
         dev.update_alive()
 
-    def send_is_alive(self, dev: 'Device', targets: list = [ALIVE_ADDR,], dev_types: list = ["any.any", ] ):
+    def send_is_alive(self, dev: 'Device', targets: list = [ALIVE_ADDR], dev_types: list = ["any.any"]):
         """Send a is_alive message, w/ dev_types filtering"""
         body = {'dev_types': dev_types}
         self.send_request(dev, targets, MessageAction.IS_ALIVE.value, body)

xaal/lib/devices.py

@@ -21,7 +21,7 @@
 import logging
 import time
 import typing
-from typing import Any, Optional, Union, Callable, Awaitable
+from typing import Any, Optional, Union, Callable, Awaitable, Dict
 
 from tabulate import tabulate
 
@@ -133,7 +133,7 @@ class Device(object):
         self.next_alive = 0
         # Default attributes & methods
         self.__attributes = Attributes()
-        self.methods: dict[str, MethodT] = {
+        self.methods: Dict[str, MethodT] = {
             'get_attributes': self._get_attributes,
             'get_description': self._get_description,
         }
@@ -225,7 +225,7 @@ class Device(object):
         if name in self.methods:
             del self.methods[name]
 
-    def get_methods(self) -> dict[str, MethodT]:
+    def get_methods(self) -> Dict[str, MethodT]:
         return self.methods
 
     def update_alive(self):

xaal/lib/engine.py

@@ -25,8 +25,6 @@ import typing
 from enum import Enum
 from typing import Optional
 
-
-
 from .config import config
 from . import core
 from .exceptions import CallbackError, MessageParserError, XAALError
@@ -135,11 +133,11 @@ class Engine(core.EngineMixin):
                 * error returned on the xAAL bus
         """
         if msg.action is None:
-            return # should not happen, but pyright need this check
+            return  # should not happen, but pyright need this check
 
         try:
             result = run_action(msg, target)
-            if result:
+            if result is not None:
                 self.send_reply(dev=target, targets=[msg.source], action=msg.action, body=result)
         except CallbackError as e:
             self.send_error(target, e.code, e.description)

xaal/lib/messages.py

@@ -342,8 +342,9 @@ def build_nonce(data: tuple) -> bytes:
 
 def build_timestamp() -> tuple:
     """Return array [seconds since epoch, microseconds since last seconds] Time = UTC+0000"""
-    epoch = datetime.datetime.fromtimestamp(0, datetime.UTC)
-    timestamp = datetime.datetime.now(datetime.UTC) - epoch
+    utc = datetime.timezone.utc
+    epoch = datetime.datetime.fromtimestamp(0, utc)
+    timestamp = datetime.datetime.now(utc) - epoch
     return (int(timestamp.total_seconds()), int(timestamp.microseconds))
 
 

{xaal.lib-0.7.8.dist-info → xaal.lib-0.7.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xaal.lib
-Version: 0.7.8
+Version: 0.7.10
 Summary: Official Python stack for xAAL protocol
 Author-email: Jerome Kerdreux <Jerome.Kerdreux@imt-atlantique.fr>
 License: GPL License

xaal.lib-0.7.10.dist-info/RECORD

@@ -0,0 +1,22 @@
+xaal/__init__.py,sha256=jv2YF__bseklT3OWEzlqJ5qE24c4aWd5F4r0TTjOrWQ,65
+xaal/lib/__init__.py,sha256=yI2lG7uSbedjp1h2FCdcAUGzkyuJxYyNbK13SHvwNew,491
+xaal/lib/__main__.py,sha256=xsVqqoIh3UeJIXxeexSfmGSUP4YxUcibdZExjEzk4lE,30
+xaal/lib/aioengine.py,sha256=BHCDfr3yVurQj3ePFHyDoBpqqyMuppxLD7OvG6IWgkI,14029
+xaal/lib/aiohelpers.py,sha256=O1oQX8XHxuvCL1ual509chjoR52AwV_ZGqeAbSlvFrE,1010
+xaal/lib/aionetwork.py,sha256=WSYwxwEHJaQDlfVocX8ow2tAtssWcH9LxPAazx4Qx_o,2547
+xaal/lib/bindings.py,sha256=V77bFfeVFj0GyGuwH8b4k7qSyA7zApZYJ8QTjq_3DwI,2140
+xaal/lib/cbor.py,sha256=XX0zgTU0uwQD9QXctGLT4lEISohi1whMUdyWKMevH8c,1647
+xaal/lib/config.py,sha256=KR28xC8NGyGjvFD9QcAoWfwyf7xcXDEP7aSenNmaRzM,3019
+xaal/lib/core.py,sha256=IBTrCCZhBKKYOuZWImxETbLZ5_upH5MRoIKKBXYEXvU,11982
+xaal/lib/devices.py,sha256=CaUH3i_xTQD0W63fW93glI-Ck2_YVvMpdn8y7BqQqzw,10696
+xaal/lib/engine.py,sha256=oFiBIma5M6Qv0W2wMmWdyCRuu7BwqR-DRUvqWfajh-A,8141
+xaal/lib/exceptions.py,sha256=4cKKkDDcZIPyVrLv3Q19apbn_pIqDGqXb1s1d2sZnpI,573
+xaal/lib/helpers.py,sha256=lPtEwP82Ssd9igmxJGq2UzmPVCyRBMHULBBVyAH4Blg,2827
+xaal/lib/messages.py,sha256=FpdIZ5flzUfgXaVVptv_tirvq5jL__mjUGimExwK9Z0,12388
+xaal/lib/network.py,sha256=oHpyHXkFT31RS6UKMZstC33dgC_sTtYKzfpgugY26oU,3277
+xaal/lib/test.py,sha256=GTjIwdqRupdqO4lNhAnc4iH0azfCCMN9BEpJpgAUors,2944
+xaal/lib/tools.py,sha256=Py_RUmLcOVjYDcm7muQ6jZPJLdOKzBfOKstX73K4Jqg,4157
+xaal.lib-0.7.10.dist-info/METADATA,sha256=wnOQJjes_62vU63PL8hKCKsskwSJr8TbBtHY9XZj-IU,4351
+xaal.lib-0.7.10.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+xaal.lib-0.7.10.dist-info/top_level.txt,sha256=UZ2WDkN02ztkh1OrsjrW8Kmj4n3WqC0BQxaEYOYfWa0,5
+xaal.lib-0.7.10.dist-info/RECORD,,

xaal.lib-0.7.8.dist-info/RECORD

@@ -1,22 +0,0 @@
-xaal/__init__.py,sha256=jv2YF__bseklT3OWEzlqJ5qE24c4aWd5F4r0TTjOrWQ,65
-xaal/lib/__init__.py,sha256=xsA9c2uhC2799fM6P5hK3aQcuvoKE6FCPYQ3WbJOfZ8,477
-xaal/lib/__main__.py,sha256=xsVqqoIh3UeJIXxeexSfmGSUP4YxUcibdZExjEzk4lE,30
-xaal/lib/aioengine.py,sha256=3l5wCRV9ZySfJOpKxDD_yO81NtL1v246mMveR28q9ms,13959
-xaal/lib/aiohelpers.py,sha256=O1oQX8XHxuvCL1ual509chjoR52AwV_ZGqeAbSlvFrE,1010
-xaal/lib/aionetwork.py,sha256=WSYwxwEHJaQDlfVocX8ow2tAtssWcH9LxPAazx4Qx_o,2547
-xaal/lib/bindings.py,sha256=V77bFfeVFj0GyGuwH8b4k7qSyA7zApZYJ8QTjq_3DwI,2140
-xaal/lib/cbor.py,sha256=XX0zgTU0uwQD9QXctGLT4lEISohi1whMUdyWKMevH8c,1647
-xaal/lib/config.py,sha256=Lspz3YAjSl2KhKKHW_Ns79rBNujOr5kGmwRxuMaH4pA,2661
-xaal/lib/core.py,sha256=WUdG1k7H589FpVbTkotHX574KiSYISZ622eWy3Af3B0,11985
-xaal/lib/devices.py,sha256=__wUD-pbpKrNj85_n4nEyexsQamv4CWqUz1Yfz0N5FM,10690
-xaal/lib/engine.py,sha256=mZI9nxW1aLAsbRCJM3QhEeQnmyyeISznJQl0-8S24Ig,8130
-xaal/lib/exceptions.py,sha256=4cKKkDDcZIPyVrLv3Q19apbn_pIqDGqXb1s1d2sZnpI,573
-xaal/lib/helpers.py,sha256=lPtEwP82Ssd9igmxJGq2UzmPVCyRBMHULBBVyAH4Blg,2827
-xaal/lib/messages.py,sha256=cezaFBtdbyQzKwGNh6dDLhmgn5ZkST7u2lAC49Xr8JE,12374
-xaal/lib/network.py,sha256=oHpyHXkFT31RS6UKMZstC33dgC_sTtYKzfpgugY26oU,3277
-xaal/lib/test.py,sha256=GTjIwdqRupdqO4lNhAnc4iH0azfCCMN9BEpJpgAUors,2944
-xaal/lib/tools.py,sha256=Py_RUmLcOVjYDcm7muQ6jZPJLdOKzBfOKstX73K4Jqg,4157
-xaal.lib-0.7.8.dist-info/METADATA,sha256=SgmY8n4kXUyIqRg8gLCJ-NCxwVxeYomlQChEzupZ-S0,4350
-xaal.lib-0.7.8.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-xaal.lib-0.7.8.dist-info/top_level.txt,sha256=UZ2WDkN02ztkh1OrsjrW8Kmj4n3WqC0BQxaEYOYfWa0,5
-xaal.lib-0.7.8.dist-info/RECORD,,