Make common Object iterable, add WebDAV propfind (#297)

Author: saimonation

cterasdk/asynchronous/core/files/browser.py

@@ -115,10 +115,9 @@ async def permalink(self, path):
         :param str path: Path.
         """
         p = self.normalize(path)
-        contents = [e async for e in await io.listdir(self._core,
-                                                      p.parent, 1, False, p.name, 1)]  # pylint: disable=unnecessary-comprehension
-        if contents and contents[0].name == p.name:
-            return contents[0].permalink
+        async for e in await io.listdir(self._core, p.parent, 1, False, p.name, 1):
+            if e.name == p.name:
+                return e.permalink
         raise FileNotFoundError('File not found.', path)
 
     def normalize(self, entries):

cterasdk/asynchronous/core/types.py

@@ -21,6 +21,7 @@ def __init__(  # pylint: disable=redefined-builtin, too-many-arguments
             self, type, guid, deleted, name, folder_id=None, modified=None,
             file_timestamp=None, size=None, id=None, acl=None, gvsn=None,
             parent_guid=None, portal_modified_date=None, virtual_portal_id=None):
+        super().__init__()
         self.type = type
         self.guid = guid
         self.folder_id = folder_id

cterasdk/audit/postman.py

@@ -15,6 +15,7 @@ class Collection(Object):
     __instance = None
 
     def __init__(self):
+        super().__init__()
         self.info = Info()
         self.item = []
         Collection.__instance = self
@@ -36,13 +37,15 @@ def serialize(self):
 class Info(Object):
 
     def __init__(self):
+        super().__init__()
         self.name = f'{str(uuid.uuid4())}'
         self.schema = "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 
 
 class Command(Object):
 
     def __init__(self, name, request):
+        super().__init__()
         self.name = name
         self.request = request
         self.response = []
@@ -51,6 +54,7 @@ def __init__(self, name, request):
 class Request(Object):
 
     def __init__(self, method, url):
+        super().__init__()
         self.method = method
         self.header = None
         self.url = url
@@ -65,6 +69,7 @@ def request_body(self, data):
 class Header(Object):
 
     def __init__(self, key, value):
+        super().__init__()
         self.key = key
         self.value = value
         self.type = 'text'
@@ -159,6 +164,7 @@ class Body(Object):
     """Request Body"""
 
     def __init__(self, mode):
+        super().__init__()
         self.mode = mode
 
 
@@ -217,6 +223,7 @@ def json(body):
 class URL(Object):
 
     def __init__(self, raw, protocol, host, port, path, query):
+        super().__init__()
         self.raw = raw
         self.protocol = protocol
         self.host = host

cterasdk/cio/core.py

@@ -81,6 +81,7 @@ def instance(src, dest=None):
         return SrcDstParam.__instance
 
     def __init__(self, src, dest=None):
+        super().__init__()
         self._classname = self.__class__.__name__
         self.src = src
         self.dest = dest
@@ -97,6 +98,7 @@ def instance():
         return ActionResourcesParam.__instance
 
     def __init__(self):
+        super().__init__()
         self._classname = self.__class__.__name__
         self.urls = []
         ActionResourcesParam.__instance = self  # pylint: disable=unused-private-member
@@ -115,6 +117,7 @@ def instance(path, access, expire_on):
         return CreateShareParam.__instance
 
     def __init__(self, path, access, expire_on):
+        super().__init__()
         self._classname = self.__class__.__name__
         self.url = path
         self.share = Object()
@@ -131,6 +134,7 @@ def __init__(self, path, access, expire_on):
 class FetchResourcesParam(Object):
 
     def __init__(self):
+        super().__init__()
         self._classname = 'FetchResourcesParam'
         self.start = 0
         self.limit = 100

cterasdk/clients/async_requests.py

@@ -134,6 +134,13 @@ def __init__(self, url, **kwargs):
         super().__init__('DELETE', url, **kwargs)
 
 
+class PropfindRequest(BaseRequest):
+    """PROPFIND"""
+
+    def __init__(self, url, **kwargs):
+        super().__init__('PROPFIND', url, **kwargs)
+
+
 class MkcolRequest(BaseRequest):
     """MKCOL"""
 

cterasdk/clients/base.py

@@ -68,7 +68,7 @@ def __init__(self, builder=None, session=None, settings=None, authenticator=None
 
         default_settings = ClientSessionSettings()
         if settings:
-            default_settings.update(**settings.kwargs)
+            default_settings.update(**settings)
 
         self._session = session if session else async_requests.Session(default_settings, TraceSettings())
 

cterasdk/clients/clients.py

@@ -59,6 +59,11 @@ class AsyncWebDAV(AsyncClient):
     async def download(self, path, **kwargs):
         return await super().get(path, **kwargs)
 
+    async def propfind(self, path):
+        request = async_requests.PropfindRequest(self._builder(path))
+        response = await self.async_request(request)
+        return await response.dav()
+
     async def mkcol(self, path):
         request = async_requests.MkcolRequest(self._builder(path))
         response = await self.async_request(request)
@@ -175,6 +180,9 @@ async def json(self):
     async def xml(self):
         return Deserializers.XML(await self._response.read())
 
+    async def dav(self):
+        return Deserializers.DAV(await self._response.read())
+
     @async_requests.decorate_stream_error
     async def read(self, n=-1):
         return await self._response.content.read(n)
@@ -251,6 +259,11 @@ class WebDAV(Client):
     def download(self, path, **kwargs):
         return super().handle(path, **kwargs)
 
+    def propfind(self, path):
+        request = async_requests.PropfindRequest(self._builder(path))
+        response = self.request(request)
+        return response.dav()
+
     def mkcol(self, path):
         request = async_requests.MkcolRequest(self._builder(path))
         response = self.request(request)
@@ -403,6 +416,9 @@ def json(self):  # pylint: disable=invalid-overridden-method
     def xml(self):  # pylint: disable=invalid-overridden-method
         return execute(super().xml)
 
+    def dav(self):  # pylint: disable=invalid-overridden-method
+        return execute(super().dav)
+
     @staticmethod
     def new():
         async def new_response(response):

cterasdk/clients/common.py

@@ -1,5 +1,5 @@
 from . import async_requests
-from ..convert import tojsonstr, toxmlstr, fromjsonstr, fromxmlstr
+from ..convert import tojsonstr, toxmlstr, fromjsonstr, fromxmlstr, fromdavxmlstr
 
 
 class Serializers:
@@ -11,6 +11,7 @@ class Serializers:
 class Deserializers:
     JSON = fromjsonstr
     XML = fromxmlstr
+    DAV = fromdavxmlstr
 
 
 class MultipartForm:

cterasdk/clients/errors.py

@@ -8,6 +8,7 @@
 class ClientError(Object):
 
     def __init__(self, exception, message):
+        super().__init__()
         self.request = Object()
         self.request.method = exception.request_info.method
         self.request.url = str(exception.request_info.real_url)

cterasdk/common/object.py

@@ -1,13 +1,29 @@
 import re
 import json
 import logging
+from collections.abc import MutableMapping
 
 
-class Object:  # pylint: disable=too-many-instance-attributes
+class Object(MutableMapping):  # pylint: disable=too-many-instance-attributes
 
-    @property
-    def kwargs(self):
-        return json.loads(str(self))
+    def __init__(self, **kwargs):
+        for k, v in kwargs.items():
+            setattr(self, k, v)
+
+    def __getitem__(self, key):
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        setattr(self, key, value)
+
+    def __delitem__(self, key):
+        delattr(self, key)
+
+    def __iter__(self):
+        return iter(self.__dict__)
+
+    def __len__(self):
+        return len(self.__dict__)
 
     def __str__(self):
         return json.dumps(self, default=lambda o: o.__dict__, indent=5)
@@ -19,6 +35,7 @@ def __repr__(self):
 class Device(Object):
 
     def __init__(self, uid, version, firmware):
+        super().__init__()
         self.namespace = 'http://www.w3.org/2001/XMLSchema-instance'
         self.location = '../../db/resources/db.xsd'
         self.id = uid