Merge pull request #66 from Cumulocity-IoT/feature/python37-support

Feature/python37 support

Author: chsou

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Version 3.1
+
+* Adding support for Python 3.7 as this is still widely used in the industry. New code can now safely used with
+  Python 3.7 throughout Python 3.13. Added `invoke` task for docker-based tests with different Python versions.
+* Greatly improved _dot notation_ access to all complex Cumulocity objects (Managed Objects, Events, Alarms,
+  Operations, etc.) This now also supports mixed access, e.g. `obj.fragment[3].sub["name"]`.
+* Publicly releasing a generic `get` function to complex objects which allows accessing a nested value without
+  the need to check for null values, e.g. `obj.get('fragment.sub.name', default='N/A')`.
+
 ## Version 3
 
 * Unified query behaviour of all API classes (introducing potentially breaking changes as the order of parameters needed to change).

bookworm311.dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.11-slim-bookworm
+
+RUN apt-get update && apt-get -y install git
+
+COPY requirements.txt /
+RUN pip install --upgrade pip && pip install -r requirements.txt

buster37.dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.7-slim-buster
+
+RUN apt-get update && apt-get -y install git
+
+COPY requirements.txt /
+RUN pip install --upgrade pip && pip install -r requirements.txt

c8y_api/__init__.py

@@ -4,7 +4,10 @@
 # Use, reproduction, transfer, publication or disclosure is prohibited except
 # as specifically provided for in your License Agreement with Software AG.
 
-from importlib.metadata import version
+try:
+    from importlib.metadata import version
+except ModuleNotFoundError:
+    from importlib_metadata import version
 
 from c8y_api._base_api import (
     ProcessingMode,

c8y_api/model/_base.py

@@ -10,14 +10,14 @@
 from typing import Any, Iterable, Set
 from urllib.parse import quote_plus, urlencode
 
-from collections.abc import MutableMapping
+from collections.abc import MutableMapping, MutableSequence
 from deprecated import deprecated
 
 from c8y_api._base_api import CumulocityRestApi
 from c8y_api.model._util import _DateUtil, _StringUtil, _QueryUtil
 
 
-class _DictWrapper(MutableMapping):
+class _DictWrapper(MutableMapping, dict):
 
     def __init__(self, dictionary: dict, on_update=None):
         self.__dict__['_property_items'] = dictionary
@@ -29,10 +29,16 @@ def has(self, name: str):
 
     def __getitem__(self, name):
         item = self.__dict__['_property_items'][name]
-        return item if not isinstance(item, dict) else _DictWrapper(item, self.__dict__['_property_on_update'])
+        if isinstance(item, dict):
+            return _DictWrapper(item, self.__dict__['_property_on_update'])
+        if isinstance(item, list):
+            return _ListWrapper(item, self.__dict__['_property_on_update'])
+        return item
 
     def __setitem__(self, name, value):
         self.__dict__['_property_items'][name] = value
+        if self.__dict__['_property_on_update']:
+            self.__dict__['_property_on_update']()
 
     def __delitem__(self, _):
         raise NotImplementedError
@@ -52,13 +58,53 @@ def __getattr__(self, name):
             ) from None
 
     def __setattr__(self, name, value):
-        if self.__dict__['_property_on_update']:
-            self.__dict__['_property_on_update']()
         self[name] = value
 
     def __str__(self):
         return self.__dict__['_property_items'].__str__()
 
+class _ListWrapper(MutableSequence, list):
+
+    def __init__(self, values: list, on_update=None):
+        self.__dict__['_property_items'] = values
+        self.__dict__['_property_on_update'] = on_update
+
+    def __getitem__(self, i):
+        item = self.__dict__['_property_items'][i]
+        if isinstance(item, dict):
+            return _DictWrapper(item, self.__dict__['_property_on_update'])
+        if isinstance(item, list):
+            return _ListWrapper(item, self.__dict__['_property_on_update'])
+        return item
+
+    def __setitem__(self, i, value):
+        self.__dict__['_property_items'][i] = value
+        if self.__dict__['_property_on_update']:
+            self.__dict__['_property_on_update']()
+
+    def __delitem__(self, i):
+        del self.__dict__['_property_items'][i]
+        if self.__dict__['_property_on_update']:
+            self.__dict__['_property_on_update']()
+
+    def __len__(self):
+        return len(self.__dict__['_property_items'])
+
+    # def append(self, value):
+    #     self.__dict__['_property_items'].append(value)
+    #     if self.__dict__['_property_on_update']:
+    #         self.__dict__['_property_on_update']()
+
+    def insert(self, i, value):
+        self.__dict__['_property_items'].insert(i, value)
+        if self.__dict__['_property_on_update']:
+            self.__dict__['_property_on_update']()
+
+    # def extend(self, other):
+    #     self.__dict__['_property_items'].extend(other)
+    #     if self.__dict__['_property_on_update']:
+    #         self.__dict__['_property_on_update']()
+
 
 class CumulocityObject:
     """Base class for all Cumulocity database objects."""
@@ -355,10 +401,13 @@ def __getitem__(self, name: str):
         # it is ensured that the same access behaviour is ensured on all levels.
         # All updated anywhere within the dictionary tree will be reported as an update
         # to this instance.
-        # If the element is not a dictionary, it can be returned directly
+        # If the element is not a dictionary or a list, it can be returned directly
         item = self.fragments[name]
-        return item if not isinstance(item, dict) else \
-            _DictWrapper(self.fragments[name], lambda: self._signal_updated_fragment(name))
+        if isinstance(item, dict):
+            return _DictWrapper(self.fragments[name], lambda: self._signal_updated_fragment(name))
+        if isinstance(item, list):
+            return _ListWrapper(self.fragments[name], lambda: self._signal_updated_fragment(name))
+        return item
 
     def __getattr__(self, name: str):
         """ Get the value of a custom fragment.
@@ -372,10 +421,12 @@ def __getattr__(self, name: str):
         if name in self:
             return self[name]
         pascal_name = _StringUtil.to_pascal_case(name)
+        if pascal_name == name:
+            raise AttributeError(f"'{type(self).__name__}' object has no attribute '{name}'.") from None
         if pascal_name in self:
             return self[pascal_name]
         raise AttributeError(
-            f"'{type(self).__name__}' object has no attribute '{name}' or '{pascal_name}'"
+            f"'{type(self).__name__}' object has no attribute '{name}' or '{pascal_name}'."
         ) from None
 
     def _setattr_(self, name, value):
@@ -574,14 +625,14 @@ def multi(*xs):
             'q': q,
             'query': query,
             'type': type,
-            'name': f"'{_QueryUtil.encode_odata_query_value(name)}'" if name else None,
+            'name': _QueryUtil.encode_odata_text_value(name)if name else None,
             'owner': owner,
             'source': source,
             'fragmentType': fragment,
             'deviceId': device_id,
             'agentId': agent_id,
             'bulkId': bulk_id,
-            'text': f"'{_QueryUtil.encode_odata_query_value(text)}'" if text else None,
+            'text': _QueryUtil.encode_odata_text_value(text) if text else None,
             'ids': ','.join(str(i) for i in ids) if ids else None,
             'bulkOperationId': bulk_id,
             'dateFrom': date_from,

c8y_api/model/_util.py

@@ -3,6 +3,7 @@
 # and/or its subsidiaries and/or its affiliates and/or their licensors.
 # Use, reproduction, transfer, publication or disclosure is prohibited except
 # as specifically provided for in your License Agreement with Software AG.
+
 import re
 from datetime import datetime, timedelta, timezone
 from dateutil import parser
@@ -32,6 +33,14 @@ def encode_odata_query_value(value):
         # single quotes escaped through single quote
         return sub('\'', '\'\'', value)
 
+    @staticmethod
+    def encode_odata_text_value(value):
+        """Encode value strings according to OData query rules.
+        http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_URLParsing
+        http://docs.oasis-open.org/odata/odata/v4.01/cs01/abnf/odata-abnf-construction-rules.txt """
+        # single quotes escaped through single quote
+        encoded_quotes = sub('\'', '\'\'', value)
+        return encoded_quotes if " " not in encoded_quotes else f"'{encoded_quotes}'"
 
 class _DateUtil(object):
 

c8y_api/model/measurements.py

@@ -322,9 +322,9 @@ def indexes_by_name():
         def parse_timestamp(t):
             """Parse timestamps."""
             if timestamps == 'datetime':
-                return datetime.fromisoformat(t)
+                return _DateUtil.to_datetime(t)
             if timestamps == 'epoch':
-                return datetime.fromisoformat(t).timestamp()
+                return _DateUtil.to_datetime(t).timestamp()
             return t
 
         # use all series if no series provided

c8y_api/model/tenant_options.py

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-from typing import Generator, List
+from typing import Generator, List, Dict
 
 from c8y_api._base_api import CumulocityRestApi
 from c8y_api.model._base import SimpleObject, CumulocityResource
@@ -181,7 +181,7 @@ def get_all(self, category: str = None, limit: int = None,
         """
         return list(self.select(category=category, limit=limit, page_size=page_size, page_number=page_number))
 
-    def get_all_mapped(self, category: str = None) -> dict[str, str]:
+    def get_all_mapped(self, category: str = None) -> Dict[str, str]:
         """ Query the database for tenant options and return the results
         as a dictionary.
 
@@ -262,7 +262,7 @@ def update(self, *options: TenantOption) -> None:
         for o in options:
             self.c8y.put(self.build_object_path(o.category, o.key), json=o.to_diff_json(), accept=None)
 
-    def update_by(self, category: str, options: dict[str, str]) -> None:
+    def update_by(self, category: str, options: Dict[str, str]) -> None:
         """ Update options within the database.
 
         Args:

c8y_tk/interactive/context.py

@@ -8,6 +8,7 @@
 import getpass
 import os
 import time
+from typing import Dict
 from urllib.parse import urlparse
 
 from c8y_api import CumulocityApi, UnauthorizedError, MissingTfaError, HTTPBearerAuth, CumulocityRestApi, HttpError
@@ -30,7 +31,7 @@ class CumulocityContext(CumulocityApi):
     ```
     """
 
-    _cached_passwords: dict[str, str] = {}
+    _cached_passwords: Dict[str, str] = {}
 
     @staticmethod
     def _read_variable(env_name: str, prompt: str = None, secret: bool = False):

integration_tests/test_applications.py

@@ -29,7 +29,7 @@ def test_select_owner(live_c8y: CumulocityApi):
 
 @pytest.mark.parametrize('param, param_func', [
     ('type', lambda x: 'HOSTED'),
-    ('user', lambda x: x.username),
+    ('user', lambda x: 'service_sms-gateway'),
     ('tenant', lambda x: x.tenant_id),
     ('subscriber', lambda x: x.tenant_id),
     ('provided_for', lambda x: x.tenant_id),