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

xaal/lib/test.py

@@ -7,8 +7,8 @@ from xaal.lib import tools
 import logging
 
 
-ADDR="b8bec7ca-f955-11e6-9031-82ed25e6aaaa"        
-ADDR=tools.get_random_uuid()      
+ADDR='b8bec7ca-f955-11e6-9031-82ed25e6aaaa'
+ADDR=tools.get_random_uuid()
 
 def dump_hex(name,data):
     print("%s : " % name,end='=')
@@ -23,30 +23,30 @@ def test_pysodium():
     from xaal.lib import messages
     import pysodium
 
-    payload = "FooBar".encode("utf-8")
+    payload = 'FooBar'.encode("utf-8")
     ad = '[]'
 
     data  = messages.build_timestamp()
     nonce = messages.build_nonce(data)
     key = tools.pass2key("My Friend Goo")
-    
-    dump_hex("Payload",payload)
-    dump_hex("Key",key)
+
+    dump_hex('Payload',payload)
+    dump_hex('Key',key)
 
     ciph  = pysodium.crypto_aead_chacha20poly1305_encrypt(payload, ad, nonce, key)
-    dump_hex("Ciph",ciph)
-    
+    dump_hex('Ciph',ciph)
+
     pjson = pysodium.crypto_aead_chacha20poly1305_decrypt(ciph, ad, nonce, key)
     print(pjson)
 
-    
+
 def test_device():
     from xaal.lib.devices import Device
     addr = ADDR
     dev = Device("foo.basic",addr)
-    dev.vendor_id = "ACME"
+    dev.vendor_id = 'ACME'
     dev.url="http://acmefactory.blogspot.fr/"
-    dev.hw_id = "0x201"
+    dev.hw_id = '0x201'
     print(dev.getDescription())
     return dev
 
@@ -59,7 +59,7 @@ def test_msg():
 
 def test_encode():
     from xaal.lib.messages import MessageFactory
-    key = tools.pass2key("FooBar")
+    key = tools.pass2key('FooBar')
     factory = MessageFactory(key)
     m2 = factory.build_msg()
     print(factory.decode_msg(m2))
@@ -68,10 +68,10 @@ def test_log():
     logger = logging.getLogger(__name__)
     logger.info("This is an INFO msg")
     logger.debug("This is an DEBUG msg")
-    
+
 
 def test_engine():
-    from xaal.lib.core import Engine
+    from xaal.lib.engine import Engine
     engine = Engine()
     engine.run()
 
@@ -87,7 +87,7 @@ def test_crypto_decoding_error():
     dev = xaal.lib.Device("test.basic",addr)
     eng = xaal.lib.Engine()
     eng.add_devices([dev,])
-    eng.msg_factory.cipher_key = tools.pass2key("FakeKey")
+    eng.msg_factory.cipher_key = tools.pass2key('FakeKey')
     eng.start()
     eng.loop()
 
@@ -95,14 +95,14 @@ def test_crypto_decoding_error():
 def test_attr():
     dev = xaal.lib.Device("test.basic",ADDR)
     dev.url = "http://linux.org"
-    dev.vendor_id = "ACME"
+    dev.vendor_id = 'ACME'
     dev.product_id = "Full Fake Device"
-    dev.info = "FooBar"
-    dev.hw_id = "ffd0001"
+    dev.info = 'FooBar'
+    dev.hw_id = 'ffd0001'
     #dev.alive_period = 100
 
-    attr0 = dev.new_attribute("attr0",10)
-    attr1 = dev.new_attribute("attr1",False)
+    attr0 = dev.new_attribute('attr0',10)
+    attr1 = dev.new_attribute('attr1',False)
 
     eng = xaal.lib.Engine()
     eng.add_devices([dev,])
@@ -111,12 +111,12 @@ def test_attr():
         attr0.value = attr0.value + 1
 
     eng.add_timer(update,60)
-    
+
     #eng.loop()
     eng.run()
-    
 
-    
+
+
 def run():
 
     logger = tools.get_logger(__name__,logging.DEBUG,"%s.log" % __name__)
@@ -128,13 +128,11 @@ def run():
     #test_alive()
     #test_crypto_decoding_error()
     test_attr()
-    
-    
+
+
 
 if __name__ == '__main__':
     try:
         run()
     except KeyboardInterrupt:
         print("Bye bye...")
-        
-    

xaal/lib/tools.py

@@ -18,101 +18,114 @@
 #  along with xAAL. If not, see <http://www.gnu.org/licenses/>.
 #
 
+import functools
 import os
 import re
+import sys
+from typing import Optional, Union
 
 import pysodium
-
-import sys
-import functools
 from configobj import ConfigObj
 
-from . import config
+from .config import config
 from .bindings import UUID
 
-XAAL_DEVTYPE_PATTERN = '^[a-zA-Z][a-zA-Z0-9_-]*\\.[a-zA-Z][a-zA-Z0-9_-]*$'
+XAAL_DEVTYPE_PATTERN = "^[a-zA-Z][a-zA-Z0-9_-]*\\.[a-zA-Z][a-zA-Z0-9_-]*$"
 
-def get_cfg_filename(name, cfg_dir=config.conf_dir):
-    if name.startswith('xaal.'):
+
+def get_cfg_filename(name: str, cfg_dir: str = config.conf_dir) -> str:
+    if name.startswith("xaal."):
         name = name[5:]
-    filename = '%s.ini' % name
+    filename = "%s.ini" % name
     if not os.path.isdir(cfg_dir):
         print("Your configuration directory doesn't exist: [%s]" % cfg_dir)
     return os.path.join(cfg_dir, filename)
 
-def load_cfg_file(filename):
-    """ load .ini file and return it as dict"""
+
+def load_cfg_file(filename: str) -> Optional[ConfigObj]:
+    """load .ini file and return it as dict"""
     if os.path.isfile(filename):
-        return ConfigObj(filename,indent_type='  ',encoding="utf8")
+        return ConfigObj(filename, indent_type="  ", encoding='utf8')
     return None
 
-def load_cfg(app_name):
+
+def load_cfg(app_name: str) -> Optional[ConfigObj]:
     filename = get_cfg_filename(app_name)
     return load_cfg_file(filename)
 
-def load_cfg_or_die(app_name):
+
+def load_cfg_or_die(app_name: str) -> ConfigObj:
     cfg = load_cfg(app_name)
     if not cfg:
         print("Unable to load config file %s" % get_cfg_filename(app_name))
         sys.exit(-1)
     return cfg
 
-def new_cfg(app_name):
+
+def new_cfg(app_name: str) -> ConfigObj:
     filename = get_cfg_filename(app_name)
-    cfg = ConfigObj(filename,indent_type='  ')
-    cfg['config'] = {}
-    cfg['config']['addr']=get_random_uuid().str
+    cfg = ConfigObj(filename, indent_type="  ")
+    cfg['config'] = {'addr' : get_random_uuid().str}
     return cfg
 
-def get_random_uuid():
+
+def get_random_uuid() -> UUID:
     return UUID.random()
 
-def get_random_base_uuid(digit=2):
+
+def get_random_base_uuid(digit=2) -> UUID:
     return UUID.random_base(digit)
 
-def get_uuid(val):
-    if isinstance(val,UUID):
+
+def get_uuid(val: Union[UUID, str]) -> Optional[UUID]:
+    if isinstance(val, UUID):
         return val
-    if isinstance(val,str):
+    if isinstance(val, str):
         return str_to_uuid(val)
     return None
 
-def str_to_uuid(val):
-    """ return an xAAL address for a given string"""
+
+def str_to_uuid(val: str) -> Optional[UUID]:
+    """return an xAAL address for a given string"""
     try:
         return UUID(val)
     except ValueError:
         return None
 
-def bytes_to_uuid(val):
+
+def bytes_to_uuid(val: bytes) -> Optional[UUID]:
     try:
         return UUID(bytes=val)
     except ValueError:
         return None
 
-def is_valid_uuid(val):
-    return isinstance(val,UUID)
 
-def is_valid_address(val):
+def is_valid_uuid(val: UUID) -> bool:
+    return isinstance(val, UUID)
+
+
+def is_valid_address(val: UUID) -> bool:
     return is_valid_uuid(val)
 
+
 @functools.lru_cache(maxsize=128)
-def is_valid_dev_type(val):
-    if not isinstance(val,str):
+def is_valid_dev_type(val: str) -> bool:
+    if not isinstance(val, str):
         return False
-    if re.match(XAAL_DEVTYPE_PATTERN,val):
-       return True
+    if re.match(XAAL_DEVTYPE_PATTERN, val):
+        return True
     return False
 
-def pass2key(passphrase):
+
+def pass2key(passphrase: str) -> bytes:
     """Generate key from passphrase using libsodium
     crypto_pwhash_scryptsalsa208sha256 func
     salt: buffer of zeros
     opslimit: crypto_pwhash_scryptsalsa208sha256_OPSLIMIT_INTERACTIVE
     memlimit: crypto_pwhash_scryptsalsa208sha256_MEMLIMIT_INTERACTIVE
     """
-    buf = passphrase.encode('utf-8')
-    KEY_BYTES = pysodium.crypto_pwhash_scryptsalsa208sha256_SALTBYTES #32
+    buf = passphrase.encode("utf-8")
+    KEY_BYTES = pysodium.crypto_pwhash_scryptsalsa208sha256_SALTBYTES  # 32
     # this should be:
     # salt = bytes(KEY_BYTES)
     # but due to bytes() stupid stuff in py2 we need this awfull stuff
@@ -122,8 +135,9 @@ def pass2key(passphrase):
     key = pysodium.crypto_pwhash_scryptsalsa208sha256(KEY_BYTES, buf, salt, opslimit, memlimit)
     return key
 
+
 @functools.lru_cache(maxsize=128)
-def reduce_addr(addr):
+def reduce_addr(addr: UUID) -> str:
     """return a string based addred without all  digits"""
     tmp = addr.str
     return tmp[:5] + '..' + tmp[-5:]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xaal.lib
-Version: 0.7.6
+Version: 0.7.8
 Summary: Official Python stack for xAAL protocol
 Author-email: Jerome Kerdreux <Jerome.Kerdreux@imt-atlantique.fr>
 License: GPL License
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Home Automation
 Description-Content-Type: text/x-rst
-Requires-Dist: cbor2 ==5.4.2
+Requires-Dist: cbor2==5.4.2
 Requires-Dist: pysodium
 Requires-Dist: configobj
 Requires-Dist: coloredlogs
@@ -43,7 +43,7 @@ xaal.lib depends on :
 Install
 ~~~~~~~
 Please refer to the official `full documentation to install the lib in a virtualenv
-<https://redmine.imt-atlantique.fr/svn/xaal/code/Python/branches/0.7/README.html>`_
+<https://gitlab.imt-atlantique.fr/xaal/code/python/-/blob/main/README.rst>`_
 
 
 Usage
@@ -99,6 +99,23 @@ Let's take a look at a simple lamp device :
    eng.run()
 
 
+To avoid to rewrite the same code for each device, you can use the `xaal.schemas package <https://gitlab.imt-atlantique.fr/xaal/code/python/-/tree/main/libs/schemas>`_.
+This package provides a set of predefined devices, you can use them as a template to create your own device.
+
+.. code-block:: python
+
+   from xaal.schemas import devices
+   from xaal.lib import Engine
+
+   # create and configure the lamp device
+   dev = devices.lamp()
+
+   # last step, create an engine and register the lamp
+   eng = Engine()
+   eng.add_device(dev)
+   eng.run()
+
+
 FAQ
 ~~~
 The core engine run forever so how can I use it in webserver, GUI or to develop device

xaal.lib-0.7.8.dist-info/RECORD

@@ -0,0 +1,22 @@
+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,,

{xaal.lib-0.7.6.dist-info → xaal.lib-0.7.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

xaal.lib-0.7.6.dist-info/RECORD

@@ -1,22 +0,0 @@
-xaal/__init__.py,sha256=jv2YF__bseklT3OWEzlqJ5qE24c4aWd5F4r0TTjOrWQ,65
-xaal/lib/__init__.py,sha256=MMXBicq9vNn6yCzBPcqZfTXk329NEL-qTM95jXUMymE,471
-xaal/lib/__main__.py,sha256=xsVqqoIh3UeJIXxeexSfmGSUP4YxUcibdZExjEzk4lE,30
-xaal/lib/aioengine.py,sha256=3MTG9aGKekVvsWhYaehZqZem6YmPng4UqGfDoRTaC2E,13100
-xaal/lib/aiohelpers.py,sha256=2a310wSXzbg9SGYzrTfcHbaZ8PWEe9rLteDmS2i62kU,1007
-xaal/lib/aionetwork.py,sha256=pH-5kf8o4FHsbvs-oFf5guAgYaEu0aosyTuI3k8xt2M,2484
-xaal/lib/bindings.py,sha256=EkDJJ_iBQbC7UzsjHfoXAjpGSwC613hrIm5ubrkcw4k,1994
-xaal/lib/cbor.py,sha256=yOTAo3TBO7m8KU_ffccJdOZmiJF5tfY7H8nC1XfMIS8,1630
-xaal/lib/config.py,sha256=jNAEXCswWsKrVab3hycupQn4aYt4c61eq628ow_I2ZI,1736
-xaal/lib/core.py,sha256=VfaisNREUse-zMrilJuKf6NLVO9HugL1U_I4M7BFzKQ,10806
-xaal/lib/devices.py,sha256=ZDNVNVmJ26W2atuNkzB7xtYZQAT3dWTrQCvMCDMSVWA,9574
-xaal/lib/engine.py,sha256=p2of6IPQB0It0RNu5fkJHHp615K_2rgzHfuWOpvJ6Is,7539
-xaal/lib/exceptions.py,sha256=ZKDKGlm_F48K_0NlaV1fa0Z-a4ZnOxT7NU8c8MKSJAc,504
-xaal/lib/helpers.py,sha256=mXxVxv7fTV9O9xO1BROhVYBTmdviMl6qx3Il8q1ox8w,2679
-xaal/lib/messages.py,sha256=W7RdHOtX_DT0bCeJAzs0p4KkU5KXofZUCMQYQsOuFF8,11571
-xaal/lib/network.py,sha256=3HWuQ0afQ-X6_-En2rFeqYJ0Scy5IEHfd0qTldxxCFo,3130
-xaal/lib/test.py,sha256=laVbgG4HtQquxDzixAG-Cka-HO4kpb7YUsLL267mGPU,3006
-xaal/lib/tools.py,sha256=qLZZOfA1VvQWJjGR46JWdAwWzv8Uog2TUTw7lK34CZg,3832
-xaal.lib-0.7.6.dist-info/METADATA,sha256=2G3bWHGiju5IwDw2rJ_rEy48_khPSpfFGUaUBvSvscU,3809
-xaal.lib-0.7.6.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-xaal.lib-0.7.6.dist-info/top_level.txt,sha256=UZ2WDkN02ztkh1OrsjrW8Kmj4n3WqC0BQxaEYOYfWa0,5
-xaal.lib-0.7.6.dist-info/RECORD,,