logs-py 3.0.1__py3-none-any.whl → 3.0.2__py3-none-any.whl

LOGS/Entity/EntityIterator.py

@@ -6,6 +6,7 @@ from LOGS.Auxiliary.Tools import Tools
 from LOGS.Entity.Entity import Entity
 from LOGS.Entity.EntityConnector import EntityConnector
 from LOGS.Entity.EntityRequestParameter import EntityRequestParameter
+from LOGS.Entity.IdIterator import IdIterator
 from LOGS.LOGSConnection import RESPONSE_TYPES, LOGSConnection, ResponseTypes
 
 # SELF = TypeVar("SELF", bound="EntityConnector")
@@ -189,8 +190,8 @@ class EntityIterator(Generic[ENTITY, REQUEST], EntityConnector[ENTITY]):
 
         items = iter(self)
         ids = []
-        for dataset in items:
-            ids.append(dataset.id)
+        for item in items:
+            ids.append(item.id)
             if len(ids) >= size:
                 param = dataclasses.replace(self._parameters)
                 param.ids = ids
@@ -205,6 +206,17 @@ class EntityIterator(Generic[ENTITY, REQUEST], EntityConnector[ENTITY]):
             iterator._parameters = param
             yield iterator
 
+    def ids(self):
+        if not self._generatorType:
+            return
+        d = self._generatorType()
+        iterator = IdIterator[type(d.id), REQUEST](connection=self._connection)
+        iterator._endpoint = self._endpoint
+        iterator._parameters = self._parameters
+        iterator._parameterType = self._parameterType
+        iterator._generatorType = type(d.id)
+        return iterator
+
     def first(self):
         i = iter(self)
         try:

LOGS/Entity/IdIterator.py

@@ -0,0 +1,192 @@
+from calendar import c
+import dataclasses
+from typing import Any, Generic, List, Optional, Type, TypeVar, Union, cast
+
+from LOGS.Auxiliary.Exceptions import LOGSException
+from LOGS.Auxiliary.Tools import Tools
+from LOGS.Entity.Entity import Entity
+from LOGS.Entity.EntityConnector import EntityConnector
+from LOGS.Entity.EntityRequestParameter import EntityRequestParameter
+from LOGS.LOGSConnection import RESPONSE_TYPES, LOGSConnection, ResponseTypes
+
+# SELF = TypeVar("SELF", bound="EntityConnector")
+
+_idType = TypeVar("_idType", bound=Union[int, str])
+REQUEST = TypeVar("REQUEST", bound=EntityRequestParameter)
+
+
+class IdIterator(Generic[_idType, REQUEST], EntityConnector[Entity]):
+    """Represents a connected LOGS entity id iterator"""
+
+    _entityIterator: int
+    _currentResults: Optional[RESPONSE_TYPES]
+    _generatorType: Optional[Type[_idType]] = None
+    _parameterType: Optional[Type[REQUEST]] = None
+
+    _parametersInput: Optional[REQUEST]
+    _parameters: REQUEST
+    _responseType: ResponseTypes = ResponseTypes.JSON
+    _includeUrl: bool = True
+    _connection: Optional[LOGSConnection]
+    _count: Optional[int]
+
+    def __init__(
+        self, connection: Optional[LOGSConnection], parameters: Optional[REQUEST] = None
+    ):
+        super().__init__(connection=connection)
+        self._connection = connection
+
+        self._parametersInput = parameters
+
+        self._entityIterator = 0
+        self._currentResults = None
+        self._count = None
+
+    def __iter__(self):
+        self._initEntityIterator()
+        return self
+
+    def __next__(self) -> _idType:
+        if not self._generatorType:
+            raise NotImplementedError(
+                "Iterator cannot generate items without a specified 'generatorType' field in class %a"
+                % type(self).__name__
+            )
+
+        return self._getNextEntity()
+
+    def _getNextPage(self, result):
+        if not self._connection:
+            raise LOGSException("Connection of %a is not defined" % type(self).__name__)
+
+        if "hasNext" not in result or not result["hasNext"]:
+            return None, None
+
+        url = result["url"]
+
+        page = 1
+        if "page" in result:
+            page = int(result["page"])
+        elif self._parameters.page:
+            page = self._parameters.page
+        self._parameters.page = page + 1
+        return self._connection.postUrl(
+            url=url,
+            data=self._parameters.toDict(),
+            responseType=self._responseType,
+            includeUrl=self._includeUrl,
+        )
+
+    def _checkParameterType(self):
+        if not self._parameterType:
+            raise NotImplementedError(
+                "Entity connection cannot be initialized without the request 'parameterType' field in class %a"
+                % type(self).__name__
+            )
+
+        if not isinstance(self._parameterType, type):
+            raise NotImplementedError(
+                "The field 'parameterType' must be a 'type' got %a in class %a"
+                % (type(self._parameterType), type(self).__name__)
+            )
+
+        if self._parametersInput and not isinstance(
+            self._parametersInput, self._parameterType
+        ):
+            raise LOGSException(
+                "Parameter for iterator %a must be of type %a. (Got %a)"
+                % (
+                    type(self).__name__,
+                    self._parameterType.__name__,
+                    type(self._parametersInput).__name__,
+                )
+            )
+
+        self._parametersInput = Tools.checkAndConvert(
+            self._parametersInput, self._parameterType, "parameters", initOnNone=True
+        )
+
+    def _initEntityIterator(self):
+        self._checkParameterType()
+
+        url = self.getBaseUrl()
+        self._entityIterator = 0
+
+        if not self._connection:
+            raise LOGSException(
+                "Entity connector %a is not connected" % type(self).__name__
+            )
+
+        tmp = False
+        if hasattr(self._parameters, "includeCount"):
+            tmp = self._parameters.includeCount
+            self._parameters.includeCount = True
+
+        self._currentResults, responseError = self._connection.postUrl(
+            url=url + "/ids_only",
+            data=self._parameters.toDict(),
+            responseType=self._responseType,
+            includeUrl=self._includeUrl,
+        )
+
+        if hasattr(self._parameters, "includeCount"):
+            self._parameters.includeCount = tmp
+
+        if isinstance(self._currentResults, dict) and "count" in self._currentResults:
+            self._count = int(self._currentResults["count"])
+
+        if responseError:
+            raise LOGSException(responseError=responseError)
+
+    def _getNextEntity(self):
+        if not isinstance(self._currentResults, dict):
+            raise StopIteration
+
+        results = self._currentResults["results"]
+        if self._entityIterator < len(results):
+            result = results[self._entityIterator]
+            self._entityIterator += 1
+            return result
+
+        self._currentResults, error = self._getNextPage(self._currentResults)
+        if error:
+            raise Exception("Connection error: %a", error)
+        self._entityIterator = 0
+
+        if (
+            not self._currentResults
+            or not isinstance(self._currentResults, dict)
+            or len(self._currentResults["results"]) < 1
+        ):
+            raise StopIteration
+
+        return self._getNextEntity()
+
+    def first(self):
+        i = iter(self)
+        try:
+            return cast(_idType, next(i))
+        except StopIteration:
+            return None
+
+    def toList(self, count: Optional[int] = None):
+        if count:
+            count = int(count)
+            if count < 0:
+                raise Exception("Invalid negative count %d" % count)
+            result = cast(List[_idType], [])
+            num = 0
+            for entity in self:
+                result.append(entity)
+                num += 1
+                if num >= count:
+                    break
+            return result
+
+        return list(self)
+
+    @property
+    def count(self) -> int:
+        if self._count is None:
+            self._initEntityIterator()
+        return self._count if self._count else 0

{logs_py-3.0.1.dist-info → logs_py-3.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: logs-py
-Version: 3.0.1
+Version: 3.0.2
 Summary: A python interface for the LOGS public API
 Home-page: https://docs.logs-python.com
 Author: Sina Kazemi

{logs_py-3.0.1.dist-info → logs_py-3.0.2.dist-info}/RECORD

@@ -220,7 +220,7 @@ LOGS/Entities/LabNotebookEntryContent/__init__.py,sha256=03TqIEBq0R2B0pUcGplIP68
 LOGS/Entity/ConnectedEntity.py,sha256=FP1jJoDOXoMBTozz6sur36IxjhlfqGI-1qUK-G001vc,2805
 LOGS/Entity/Entity.py,sha256=WLCtVjRxyRg6nX8UzEMjKJ4MkLICrMmXSo5xrtRHaUE,6300
 LOGS/Entity/EntityConnector.py,sha256=kjCoieYABujwX1hIaldJVHmg_Js2OdWdbkvNwgBLeNo,2109
-LOGS/Entity/EntityIterator.py,sha256=3gUZx28451sxsHrUT0qYlPRmi03U8rVAcJs0KHXmrEs,7721
+LOGS/Entity/EntityIterator.py,sha256=EF29TdSvC0rTMMnQgCe5X99mYAYNjZydtLaQc3n7-6k,8165
 LOGS/Entity/EntityMinimal.py,sha256=GysThwk8YbT8xqbHvJqmYKgPf8ckALO5pG-J_SNT0vw,3237
 LOGS/Entity/EntityMinimalWithIntId.py,sha256=6eVhFFbXKdH3LPj-fAzQLpnzbkWqh1AmV_uRksTi7Ho,1045
 LOGS/Entity/EntityMinimalWithStrId.py,sha256=JmuY0Aah4YLngrgluzwMkhIyeExj2j6kiBZ6Y115hbA,1046
@@ -230,6 +230,7 @@ LOGS/Entity/EntityRelations.py,sha256=zaAASS5SVDwPVMUyNgUH8DcZhWdErRulrZjD6MAWlh
 LOGS/Entity/EntityRequestParameter.py,sha256=RH6-Sh8ug3aeq_AOFHs0Lp2J94cKI9Ts3slAATZ1tNA,828
 LOGS/Entity/EntityWithIntId.py,sha256=B79VqAQ9I0uEQwbf3DMHXoi064gCw4fv3vCKoXwrHQM,631
 LOGS/Entity/EntityWithStrId.py,sha256=5hz8-F_t_X4kf85DMwW3DJ2NqH_RiRV1Io1WiMN11yk,631
+LOGS/Entity/IdIterator.py,sha256=GwQj6XmDfEqeQFIGje2nOURLcl5OYuNXImDXGrzoBL8,6263
 LOGS/Entity/SerializeableContent.py,sha256=iN_rW3zorXnvL1RBjyQvwxEJwvx5d3RqZKRtPSlScXk,22203
 LOGS/Entity/__init__.py,sha256=8q6dB_AqlLGx-6PexFn8QH7LWOnSGRhgPfFVkYAghR0,749
 LOGS/Interfaces/ICreationRecord.py,sha256=SpACPwz2zA60pkApErZelUOsPq40fHAfiFW3vm9qW9k,1461
@@ -257,7 +258,7 @@ LOGS/Parameters/ParameterElement.py,sha256=fr6AlO_flKRygZZFx1OILP4P-2lV2Tx4PAe6W
 LOGS/Parameters/ParameterList.py,sha256=ijukB1__iKI5cefmOIIWz0wKaPz9Cx8KpD7Y7Gz2Pn0,1478
 LOGS/Parameters/ParameterTable.py,sha256=7Lew4DPgWmKcpV1T-1Pvt00kEI05FB383QqO-LHAjds,1758
 LOGS/Parameters/__init__.py,sha256=jNF_VnD9u6V7usDFymzvDx5kzvcYssnpASICiKW0wdU,341
-logs_py-3.0.1.dist-info/METADATA,sha256=_sJJ09I_3FP5hLKlmCbDBLTjIAcA2jeuZoSco0MR4nY,2072
-logs_py-3.0.1.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-logs_py-3.0.1.dist-info/top_level.txt,sha256=Ckn2LiAmGaR7k3tdEnKAc04z_uboMD4gLreYghRNdCs,5
-logs_py-3.0.1.dist-info/RECORD,,
+logs_py-3.0.2.dist-info/METADATA,sha256=b2jgXrwXDx1KMAlz7IW0heyPHiWKzT1RBMZlvLd6WdI,2072
+logs_py-3.0.2.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+logs_py-3.0.2.dist-info/top_level.txt,sha256=Ckn2LiAmGaR7k3tdEnKAc04z_uboMD4gLreYghRNdCs,5
+logs_py-3.0.2.dist-info/RECORD,,