Adding some type hints; Adding owner to search parameters; Fixed fire-and-forget functionality for inventory.

Author: chsou

c8y_api/__init__.py

@@ -22,6 +22,8 @@
 
 class CumulocityRestApi:
 
+    ACCEPT_MANAGED_OBJECT = 'application/vnd.com.nsn.cumulocity.managedobject+json'
+
     def __init__(self, base_url, tenant_id, username, password, tfa_token=None, application_key=None):
         self.base_url = base_url
         self.tenant_id = tenant_id
@@ -70,7 +72,8 @@ def post(self, resource, json, accept='application/json', content_type=None):
             raise SyntaxError(f"Invalid POST request. Status: {r.status_code} Response:\n" + r.text)
         if r.status_code != 201 and r.status_code != 200:
             raise ValueError(f"Unable to perform POST request. Status: {r.status_code} Response:\n" + r.text)
-        return r.json()
+        if r.content:
+            return r.json()
 
     def post_file(self, resource, file, binary_meta_information):
         assert isinstance(binary_meta_information, Binary)
@@ -106,7 +109,8 @@ def put(self, resource, json, accept='application/json', content_type=None):
             raise SyntaxError(f"Invalid PUT request. Status: {r.status_code} Response:\n" + r.text)
         if r.status_code != 200:
             raise ValueError(f"Unable to perform PUT request. Status: {r.status_code} Response:\n" + r.text)
-        return r.json()
+        if r.content:
+            return r.json()
 
     def put_file(self, resource, file, media_type):
         headers = {'Content-Type': media_type, **self.__default_headers}

c8y_api/model/_util.py

@@ -444,7 +444,7 @@ def __prepare_resource(resource: str):
         return '/' + resource.strip('/')
 
     @staticmethod
-    def __prepare_query_parameters(type=None, name=None, fragment=None, source=None,
+    def __prepare_query_parameters(type=None, name=None, fragment=None, source=None, owner=None,
                                    before=None, after=None, min_age=None, max_age=None,
                                    reverse=None, page_size=None, **kwargs):
         # min_age/max_age should be timedelta objects that can be used for
@@ -465,7 +465,7 @@ def __prepare_query_parameters(type=None, name=None, fragment=None, source=None,
         before = _DateUtil.ensure_timestring(before)
         after = _DateUtil.ensure_timestring(after)
 
-        params = {k: v for k, v in {'type': type, 'name': name,
+        params = {k: v for k, v in {'type': type, 'name': name, 'owner': owner,
                                     'source': source, 'fragmentType': fragment,
                                     'dateFrom': after, 'dateTo': before, 'revert': str(reverse),
                                     'pageSize': page_size}.items() if v}
@@ -506,20 +506,21 @@ def _iterate(self, base_query, limit, parse_func):
 
     def _create(self, jsonify_func, *objects):
         for o in objects:
-            self.c8y.post(self.resource, jsonify_func(o))
+            self.c8y.post(self.resource, json=jsonify_func(o), accept=None)
 
     def _create_bulk(self, jsonify_func, collection_name, content_type, *objects):
         bulk_json = {collection_name: [jsonify_func(o) for o in objects]}
         self.c8y.post(self.resource, bulk_json, content_type=content_type)
 
     def _update(self, jsonify_func, *objects):
         for o in objects:
-            self.c8y.put(self.resource + '/' + str(o.id), jsonify_func(o))
+            self.c8y.put(self.resource + '/' + str(o.id), json=jsonify_func(o), accept=None)
 
     def _apply_to(self, jsonify_func, model, *object_ids):
         model_json = jsonify_func(model)
+        print(model_json)
         for object_id in object_ids:
-            self.c8y.put(self.resource + '/' + str(object_id), model_json)
+            self.c8y.put(self.resource + '/' + str(object_id), model_json, accept=None)
 
     def delete(self, *objects):
         """ Delete one or more objects within the database.

c8y_api/model/administration.py

@@ -713,7 +713,7 @@ def select(self, username=None, page_size=5):
         """
         if username:
             # select by username
-            query = f'user/{self.c8y.tenant_id}/users/{username}/groups?pageSize={page_size}&currentPage='
+            query = f'/user/{self.c8y.tenant_id}/users/{username}/groups?pageSize={page_size}&currentPage='
             page_number = 1
             while True:
                 response_json = self.c8y.get(query + str(page_number))

c8y_api/model/inventory.py

@@ -89,7 +89,7 @@ def __getattr__(self, name):
         item = self.items[name]
         return item if not isinstance(item, dict) else _DictWrapper(item)
 
-    def has(self, name):
+    def has(self, name) -> bool:
         """ Check whether a specific element is defined.
 
         :param name:  Name of the element
@@ -232,7 +232,7 @@ def from_json(cls, object_json):
     def _parse_references(cls, base_json):
         return [NamedObject.from_json(j['managedObject']) for j in base_json['references']]
 
-    def to_json(self):
+    def to_json(self) -> dict:
         """ Convert the instance to JSON.
 
         The JSON format produced by this function is what is used by the
@@ -245,7 +245,7 @@ def to_json(self):
         """
         return self._parser.to_full_json(self)
 
-    def to_diff_json(self):
+    def to_diff_json(self) -> dict:
         """ Convert the changes made to this instance to a JSON representation.
 
         The JSON format produced by this function is what is used by the
@@ -287,7 +287,8 @@ def create(self):
         See also function Inventory.create which doesn't parse the result.
         """
         super()._assert_c8y()
-        result_json = self.c8y.post(self.__RESOURCE, self.to_json())
+        result_json = self.c8y.post(self.__RESOURCE,
+                                    json=self.to_json(), accept=self.c8y.ACCEPT_MANAGED_OBJECT)
         result = ManagedObject.from_json(result_json)
         result.c8y = self.c8y
         return result
@@ -302,7 +303,8 @@ def update(self):
         """
         super()._assert_c8y()
         super()._assert_id()
-        result_json = self.c8y.put(self._build_object_path(), self.to_diff_json())
+        result_json = self.c8y.put(self._build_object_path(),
+                                   json=self.to_diff_json(), accept=self.c8y.ACCEPT_MANAGED_OBJECT)
         result = ManagedObject.from_json(result_json)
         result.c8y = self.c8y
         return result
@@ -312,14 +314,15 @@ def apply_to(self, other_id):
         database.
 
         :param other_id:  Database ID of the event to update.
-        :returns:  A fresh ManagedObject instance representing the updated
+        :return:  A fresh :class:ManagedObject instance representing the updated
             object within the database.
 
-        See also function Inventory.apply_to which doesn't parse the result.
+        See also function :class:Inventory.apply_to which doesn't parse the result.
         """
         self._assert_c8y()
         # put diff json to another object (by ID)
-        result_json = self.c8y.put(self.__RESOURCE + other_id, self.to_diff_json())
+        result_json = self.c8y.put(self.__RESOURCE + str(other_id),
+                                   json=self.to_diff_json(), accept=self.c8y.ACCEPT_MANAGED_OBJECT)
         result = ManagedObject.from_json(result_json)
         result.c8y = self.c8y
         return result
@@ -640,7 +643,7 @@ class Inventory(_Query):
     def __init__(self, c8y):
         super().__init__(c8y, 'inventory/managedObjects')
 
-    def get(self, id):  # noqa (id)
+    def get(self, id) -> ManagedObject:  # noqa (id)
         """ Retrieve a specific managed object from the database.
 
         :param id:  ID of the managed object
@@ -651,7 +654,7 @@ def get(self, id):  # noqa (id)
         managed_object.c8y = self.c8y  # inject c8y connection into instance
         return managed_object
 
-    def get_all(self, type=None, fragment=None, name=None, limit=None, page_size=1000):  # noqa (type)
+    def get_all(self, type=None, fragment=None, name=None, owner=None, limit=None, page_size=1000):  # noqa (type)
         """ Query the database for managed objects and return the results
         as list.
 
@@ -662,7 +665,7 @@ def get_all(self, type=None, fragment=None, name=None, limit=None, page_size=100
         """
         return [x for x in self.select(type=type, fragment=fragment, name=name, limit=limit, page_size=page_size)]
 
-    def select(self, type=None, fragment=None, name=None, limit=None, page_size=1000):  # noqa (type)
+    def select(self, type=None, fragment=None, name=None, owner=None, limit=None, page_size=1000):  # noqa (type)
         """ Query the database for managed objects and iterate over the
         results.
 
@@ -680,7 +683,7 @@ def select(self, type=None, fragment=None, name=None, limit=None, page_size=1000
         :param page_size:  Define the number of events which are read (and
             parsed in one chunk). This is a performance related setting.
 
-        :returns:  Generator of ManagedObject instances
+        :yield:  ManagedObject instances
         """
         query = None
         if name:
@@ -769,7 +772,7 @@ def select(self, type=None, name=None, limit=None, page_size=100):  # noqa (type
         :param page_size:  Define the number of events which are read (and
             parsed in one chunk). This is a performance related setting.
 
-        :returns:  Generator of Device objects
+        :yield:  Device objects
         """
         return super().select(type=type, fragment='c8y_IsDevice', name=name, limit=limit, page_size=page_size)
 
@@ -828,7 +831,7 @@ def select(self, fragment=None, name=None, page_size=100):  # noqa
         :param name:  name string of the objects to select; no partial
             matching/patterns are supported
         :param page_size:  number of objects to fetch per request
-        :return:  Generator of ManagedObject instances
+        :yield:  ManagedObject instances
         """
         query = None
         if name: