logs-py 3.0.13__py3-none-any.whl → 3.0.15__py3-none-any.whl

LOGS/Entities/DataSource.py

@@ -14,6 +14,13 @@ from LOGS.Auxiliary.MinimalModelGenerator import (
 from LOGS.Entities.BridgeMinimal import BridgeMinimal
 from LOGS.Entities.DataSourceRelations import DataSourceRelations
 from LOGS.Entities.DataSourceStatus import DataSourceStatus
+from LOGS.Entities.DataSourceStatusHistoryIterator import (
+    DataSourceStatusHistoryIterator,
+)
+from LOGS.Entities.DataSourceStatusHistoryRequestParameter import (
+    DataSourceHistoryOrder,
+    DataSourceStatusHistoryRequestParameter,
+)
 from LOGS.Entities.FileExcludePattern import FileExcludePattern
 from LOGS.Entities.Format import Format
 from LOGS.Entities.FormatMinimal import FormatMinimal
@@ -95,6 +102,15 @@ class DataSource(
         if responseError:
             raise EntityAPIException(entity=self, responseError=responseError)
 
+    @property
+    def history(self) -> Optional[DataSourceStatusHistoryIterator]:
+        return DataSourceStatusHistoryIterator(
+            self._connection,
+            DataSourceStatusHistoryRequestParameter(
+                dataSourceIds=[self.id], orderby=DataSourceHistoryOrder.STARTED_ON_DESC
+            ),
+        )
+
     @property
     def enabled(self) -> Optional[bool]:
         return self._enabled

LOGS/Entities/DataSourceStatusHistory.py

@@ -0,0 +1,135 @@
+from datetime import datetime
+from typing import List, Optional
+
+from LOGS.Auxiliary.Decorators import Endpoint
+from LOGS.Entities.BridgeType import BridgeType
+from LOGS.Entities.RunState import RunState
+from LOGS.Entity.EntityWithIntId import IEntityWithIntId
+from LOGS.Entity.SerializableContent import SerializableClass
+from LOGS.LOGSConnection import LOGSConnection
+
+
+class DataSourceStatusError(SerializableClass):
+    message: Optional[str] = None
+
+
+@Endpoint("data_sources_status")
+class DataSourceStatusHistory(IEntityWithIntId):
+    _type: Optional[BridgeType] = None
+    _uuid: Optional[str] = None
+    _lastUpdated: Optional[datetime] = None
+    _counter: Optional[int] = None
+    _dataSourceId: Optional[int] = None
+    _runState: Optional[RunState] = None
+    _startedOn: Optional[datetime] = None
+    _duration: Optional[float] = None
+    _errors: Optional[List[DataSourceStatusError]] = None
+    _info: Optional[dict] = None
+
+    def __init__(
+        self,
+        ref=None,
+        id: Optional[int] = None,
+        connection: Optional[LOGSConnection] = None,
+    ):
+        """Represents a connected LOGS entity type"""
+
+        self._type = None
+        self._bridge = None
+        self._format = None
+        self._customImport = None
+        self._enabled = None
+        self._bridgeId = None
+        self._formats = None
+        self._directories = None
+        self._intervalInSeconds = None
+        self._method = None
+        self._instrument = None
+        self._cutoffDate = None
+        self._customImportId = None
+        self._status = None
+        self._info = None
+
+        super().__init__(ref=ref, id=id, connection=connection)
+
+    @property
+    def type(self) -> Optional[BridgeType]:
+        return self._type
+
+    @type.setter
+    def type(self, value):
+        self._type = self.checkAndConvertNullable(value, BridgeType, "type")
+
+    @property
+    def uuid(self) -> Optional[str]:
+        return self._uuid
+
+    @uuid.setter
+    def uuid(self, value):
+        self._uuid = self.checkAndConvertNullable(value, str, "uuid")
+
+    @property
+    def lastUpdated(self) -> Optional[datetime]:
+        return self._lastUpdated
+
+    @lastUpdated.setter
+    def lastUpdated(self, value):
+        self._lastUpdated = self.checkAndConvertNullable(value, datetime, "lastUpdated")
+
+    @property
+    def counter(self) -> Optional[int]:
+        return self._counter
+
+    @counter.setter
+    def counter(self, value):
+        self._counter = self.checkAndConvertNullable(value, int, "counter")
+
+    @property
+    def dataSourceId(self) -> Optional[int]:
+        return self._dataSourceId
+
+    @dataSourceId.setter
+    def dataSourceId(self, value):
+        self._dataSourceId = self.checkAndConvertNullable(value, int, "dataSourceId")
+
+    @property
+    def runState(self) -> Optional[RunState]:
+        return self._runState
+
+    @runState.setter
+    def runState(self, value):
+        self._runState = self.checkAndConvertNullable(value, RunState, "runState")
+
+    @property
+    def startedOn(self) -> Optional[datetime]:
+        return self._startedOn
+
+    @startedOn.setter
+    def startedOn(self, value):
+        self._startedOn = self.checkAndConvertNullable(value, datetime, "startedOn")
+
+    @property
+    def duration(self) -> Optional[float]:
+        return self._duration
+
+    @duration.setter
+    def duration(self, value):
+        self._duration = self.checkAndConvertNullable(value, float, "duration")
+
+    @property
+    def errors(self) -> Optional[List[DataSourceStatusError]]:
+        return self._errors
+
+    @errors.setter
+    def errors(self, value):
+        self._errors = self.checkListAndConvertNullable(
+            value, DataSourceStatusError, "errors"
+        )
+
+    @property
+    def info(self) -> Optional[dict]:
+        return self._info
+
+    @info.setter
+    def info(self, value):
+        self._info = self.checkAndConvertNullable(value, dict, "info")

LOGS/Entities/DataSourceStatusHistoryIterator.py

@@ -0,0 +1,16 @@
+from LOGS.Auxiliary.Decorators import Endpoint
+from LOGS.Entities.DataSourceStatusHistory import DataSourceStatusHistory
+from LOGS.Entities.DataSourceStatusHistoryRequestParameter import (
+    DataSourceStatusHistoryRequestParameter,
+)
+from LOGS.Entity.EntityIterator import EntityIterator
+
+
+@Endpoint("data_sources_status")
+class DataSourceStatusHistoryIterator(
+    EntityIterator[DataSourceStatusHistory, DataSourceStatusHistoryRequestParameter]
+):
+    """LOGS connected class DataSource iterator"""
+
+    _generatorType = DataSourceStatusHistory
+    _parameterType = DataSourceStatusHistoryRequestParameter

LOGS/Entities/DataSourceStatusHistoryRequestParameter.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import List, Optional
+
+from LOGS.Entities.BridgeType import BridgeType
+from LOGS.Entities.IRelatedEntityRequest import IRelatedEntityRequest
+from LOGS.Entities.RunState import RunState
+from LOGS.Entity.EntityRequestParameter import EntityRequestParameter
+from LOGS.Interfaces.INamedEntity import INamedEntityRequest
+from LOGS.Interfaces.IPermissionedEntity import IPermissionedEntityRequest
+
+
+class DataSourceHistoryOrder(Enum):
+    ID_ASC = "ID_ASC"
+    ID_DESC = "ID_DESC"
+    STARTED_ON_ASC = "STARTED_ON_ASC"
+    STARTED_ON_DESC = "STARTED_ON_DESC"
+
+
+@dataclass
+class DataSourceStatusHistoryRequestParameter(
+    EntityRequestParameter[DataSourceHistoryOrder],
+    INamedEntityRequest,
+    IRelatedEntityRequest,
+    IPermissionedEntityRequest,
+):
+    dataSourceIds: Optional[List[int]] = None
+    types: Optional[List[BridgeType]] = None
+    runStates: Optional[List[RunState]] = None
+    durationInSecondsMin: Optional[float] = None
+    durationInSecondsMax: Optional[float] = None
+    startedOnFrom: Optional[datetime] = None
+    startedOnTo: Optional[datetime] = None

LOGS/Entities/DataSources.py

@@ -4,9 +4,9 @@ from LOGS.Entities.DataSourceRequestParameter import DataSourceRequestParameter
 from LOGS.Entity.EntityIterator import EntityIterator
 
 
-@Endpoint("autoload_configurations")
+@Endpoint("data_sources")
 class DataSources(EntityIterator[DataSource, DataSourceRequestParameter]):
-    """LOGS connected class AutouploadSource iterator"""
+    """LOGS connected class DataSource iterator"""
 
     _generatorType = DataSource
     _parameterType = DataSourceRequestParameter

LOGS/Entities/__init__.py

@@ -36,6 +36,9 @@ from .DatasetUploadParameter import *
 from .DataSource import *
 from .DataSourceMinimal import *
 from .DataSourceRequestParameter import *
+from .DataSourceStatusHistory import *
+from .DataSourceStatusHistoryIterator import *
+from .DataSourceStatusHistoryRequestParameter import *
 from .Datatrack import *
 from .DatatrackFormattedTable import *
 from .DatatrackImage import *
@@ -52,11 +55,16 @@ from .ExperimentRequestParameter import *
 from .Experiments import *
 from .FileEntry import *
 from .Format import *
+from .FormatFormatMinimal import *
 from .FormatFormatRequestParameter import *
+from .FormatInstrumentMinimal import *
 from .FormatInstrumentRequestParameter import *
+from .FormatMethod import *
+from .FormatMethodMinimal import *
 from .FormatMethodRequestParameter import *
 from .FormatMinimal import *
 from .FormatRequestParameter import *
+from .FormatVendorMinimal import *
 from .FormatVendorRequestParameter import *
 from .HierarchyLeaf import *
 from .HierarchyNode import *

LOGS/Entity/SerializableContent.py

@@ -2,7 +2,7 @@ import inspect
 import json
 import math
 import random
-from datetime import datetime
+from datetime import datetime, timezone
 from enum import Enum
 from typing import (
     Any,
@@ -292,6 +292,10 @@ class SerializableContent:
                     l[i] = self._serializeItem(v)
                 d[k] = l
             elif isinstance(a, datetime):
+                a = a.astimezone(
+                    timezone.utc
+                )  # we convert all datetimes to UTC for the LOGS server
+
                 # if not a.tzinfo:
                 #     a.replace(tzinfo=tzlocal.get_localzone())
                 # print(">>>", a.strftime("%Y-%m-%dT%H:%M:%S.%fZ"))
@@ -604,12 +608,13 @@ class SerializableContent:
                             m.unshiftPath(k)
         elif isinstance(text, list):
             for i in range(0, len(text)):
-                text[i], messages = cls.replaceControlCharacters(
+                s, messages = cls.replaceControlCharacters(
                     text[i],
                     excludeKeys=excludeKeys,
                     excludeCharacters=excludeCharacters,
                     mergeMessages=mergeMessages,
                 )
+                text[i] = str(s)
                 if messages:
                     for m in messages:
                         m.unshiftPath(i)

{logs_py-3.0.13.dist-info → logs_py-3.0.15.dist-info}/METADATA

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

{logs_py-3.0.13.dist-info → logs_py-3.0.15.dist-info}/RECORD

@@ -48,12 +48,15 @@ LOGS/Entities/CustomTypeRelations.py,sha256=zTo81K9ZOgRHQ5pN7gbAKnolh1-bu6C8pGra
 LOGS/Entities/CustomTypeRequestParameter.py,sha256=Dj66a45ivFGgLq5L72KxcVrFOik8NDeVugX09-oxZwo,2371
 LOGS/Entities/CustomTypeSection.py,sha256=1Znbq5xrqXFyfbwMcEgVsNLRACpKPVDV2oaRZaCcMts,1141
 LOGS/Entities/CustomTypes.py,sha256=aUSnWZ7xIpNlFqzoLfJebbLMPBFft1QliOQ5QtGzPMY,452
-LOGS/Entities/DataSource.py,sha256=EM7Dqa9uACB8spI6aniVjcSt-qG5t_cF8X_-0CpRslo,6884
+LOGS/Entities/DataSource.py,sha256=K6Kwp2nVNAcPsAsHNbxp7PmkxFLukSP51Frv5YxuLcU,7453
 LOGS/Entities/DataSourceMinimal.py,sha256=KlejLccyZR_AP2LvFQgCJXpcmWwtaOg6rRTVsXXlODI,261
 LOGS/Entities/DataSourceRelations.py,sha256=eIszpHjZqz6v4WyhaPNu8efSzedsJLNrYR9b3hCa3HY,658
 LOGS/Entities/DataSourceRequestParameter.py,sha256=zAfC61NvVt4XO3HhIy1PLViN3AEBJo7Q6Fa_EtyqNvA,1610
 LOGS/Entities/DataSourceStatus.py,sha256=LIMesU020i1clMiTxvO3hAoESf4B1-fXsDGMMtWLdsM,427
-LOGS/Entities/DataSources.py,sha256=UU5ey98_vX4WQknyWITMy-dPOV-wgjblXxu5uXpnVso,481
+LOGS/Entities/DataSourceStatusHistory.py,sha256=HBQOuuP8uqycysf81PdX4qjPiMYNJaZ5VbAhvKGwS0I,3909
+LOGS/Entities/DataSourceStatusHistoryIterator.py,sha256=BzN32WSRVW_cvRntooqcaS6D7qCctNzOBFOpckTk4fk,610
+LOGS/Entities/DataSourceStatusHistoryRequestParameter.py,sha256=vdhG7CC1A1iB-q3_C2ratAlSAq4BkzJOD7o_U58AtFY,1174
+LOGS/Entities/DataSources.py,sha256=YLQef__hHUyEtkCF8VCHifWN8nKO049jCoXeb0Btf5Y,464
 LOGS/Entities/Dataset.py,sha256=VFPccmTCEsMH-WKd-MyqA9bbGl4CeZxNNzMZ9lHClOM,27758
 LOGS/Entities/DatasetCreator.py,sha256=GJ2e0pcYt5ziVqREViBM_uq45K3rm3FG_3NqIOjrO3Y,3253
 LOGS/Entities/DatasetInfo.py,sha256=GVs9dxE2ufMfiuhgKXDcN-GEi2VrZPM1TMBLwtsfMU0,4972
@@ -179,7 +182,7 @@ LOGS/Entities/TrackXY.py,sha256=klLXkgK9hkXdSIiTPbpGxnWoBf-fymOxJ4BJtcc97Cc,1332
 LOGS/Entities/TrackXYComplex.py,sha256=Ts8UusoZY81P8OX4gWgHfSEKiUflT3cr8oUoqFXuc0I,1698
 LOGS/Entities/TrackXYComplexData.py,sha256=xWd3_jdXa347Gh53NYIMo66nFirA60Zd2KxaPs4KHaY,1368
 LOGS/Entities/TrackXYData.py,sha256=6AbwG2qa2HN858ROLaLpzkuIlwsb8tN8wznaiKplRdo,819
-LOGS/Entities/__init__.py,sha256=CxPw9F8WKDAn1z514YIJ_tZoq3oPHhC9TodDP7Kuz2g,3800
+LOGS/Entities/__init__.py,sha256=L2akPaKwPQA8H-1pB6i6ekeb-Zb3kzabqRIUuPysHBY,4113
 LOGS/Entities/FormattedTable/DatatypeFormattedTable.py,sha256=M5rL0UZdXfylHANrTXKqAnnrML_rEUeMMBFyQEIyto4,3588
 LOGS/Entities/FormattedTable/DatatypeFormattedTableCell.py,sha256=1nBVgWqRecnUWHFwiO0oAqgChYtNSE3VQBxIAjPRjWk,2792
 LOGS/Entities/FormattedTable/DatatypeFormattedTableSettings.py,sha256=Eox_JyXtm6g29lt5kG_RBwD45ioWTg7F_5T36oZbPpY,308
@@ -228,7 +231,7 @@ LOGS/Entity/EntityRequestParameter.py,sha256=ZeA8SOCCrwXZIpe4dIk3yqBc_KLsIv5gqwc
 LOGS/Entity/EntityWithIntId.py,sha256=B79VqAQ9I0uEQwbf3DMHXoi064gCw4fv3vCKoXwrHQM,631
 LOGS/Entity/EntityWithStrId.py,sha256=5hz8-F_t_X4kf85DMwW3DJ2NqH_RiRV1Io1WiMN11yk,631
 LOGS/Entity/IdIterator.py,sha256=syaf7ygWPhbpSM3Sa5oukGi4wW9KiYInK8Ry61U85N8,6216
-LOGS/Entity/SerializableContent.py,sha256=yQfc_ktbyH2VA_PTOsDpaFUzuV6G1XGO30ygR23Igmg,22132
+LOGS/Entity/SerializableContent.py,sha256=ZF4uFqU4UsHrCb-olXvDxNOwleYY0M2pKWqkQ7z3AfQ,22310
 LOGS/Entity/__init__.py,sha256=IQ_V00xy6yJzf5wnvGpoW3MoFab1o7drifkgKa8EHWY,719
 LOGS/Interfaces/ICreationRecord.py,sha256=SpACPwz2zA60pkApErZelUOsPq40fHAfiFW3vm9qW9k,1461
 LOGS/Interfaces/ICustomField.py,sha256=rAMnUKW9wMxgUfkXUFECCclggYt9aGKgXlIep67sEo4,726
@@ -255,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=KpMSuBPx964v2YMZ1BqVp8vjrgSpuiW9KYBm-aejRuc,312
-logs_py-3.0.13.dist-info/METADATA,sha256=wYBZPvRrsD2qIMUK94IcMI1lHbcEyVPcnJpKcmjz97Y,2340
-logs_py-3.0.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-logs_py-3.0.13.dist-info/top_level.txt,sha256=Ckn2LiAmGaR7k3tdEnKAc04z_uboMD4gLreYghRNdCs,5
-logs_py-3.0.13.dist-info/RECORD,,
+logs_py-3.0.15.dist-info/METADATA,sha256=CeQq8aTBEbD_lO3blXPImHYrKrzxTa7uDtyGTivQAn4,2340
+logs_py-3.0.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+logs_py-3.0.15.dist-info/top_level.txt,sha256=Ckn2LiAmGaR7k3tdEnKAc04z_uboMD4gLreYghRNdCs,5
+logs_py-3.0.15.dist-info/RECORD,,