logs-py 3.0.5__py3-none-any.whl → 3.0.7__py3-none-any.whl

LOGS/Entities/LabNotebookEntryContent/IEntryContentWithTextAttribute.py

@@ -1,10 +1,10 @@
 from typing import Optional
 
 from LOGS.Entities.LabNotebookEntryContent.TextAttribute import TextAttribute
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 
-class IEntryContentWithTextAttribute(SerializeableContent):
+class IEntryContentWithTextAttribute(SerializableContent):
     _attrs: Optional[TextAttribute] = None
 
     @property

LOGS/Entities/LabNotebookEntryRelations.py

@@ -5,7 +5,6 @@ from LOGS.Entity.EntityRelations import EntityRelations
 
 if TYPE_CHECKING:
     from LOGS.Entities.Dataset import Dataset
-    from LOGS.Entities.Document import Document
     from LOGS.Entities.LabNotebookEntry import LabNotebookEntry
     from LOGS.Entities.Person import Person
     from LOGS.Entities.Project import Project
@@ -20,7 +19,6 @@ class LabNotebookEntryRelations(EntityRelations):
     _persons: Optional[EntityRelation["Person"]] = None
     _samples: Optional[EntityRelation["Sample"]] = None
     _projects: Optional[EntityRelation["Project"]] = None
-    _documents: Optional[EntityRelation["Document"]] = None
 
     @property
     def persons(self) -> Optional[EntityRelation["Person"]]:
@@ -32,16 +30,6 @@ class LabNotebookEntryRelations(EntityRelations):
 
         self._persons = self._entityConverter(value, Persons)
 
-    @property
-    def documents(self) -> Optional[EntityRelation["Document"]]:
-        return self._documents
-
-    @documents.setter
-    def documents(self, value):
-        from LOGS.Entities.Documents import Documents
-
-        self._documents = self._entityConverter(value, Documents)
-
     @property
     def datasets(self) -> Optional[EntityRelation["Dataset"]]:
         return self._datasets

LOGS/Entities/ParserLog.py

@@ -1,9 +1,9 @@
 from typing import List, Optional
 
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 
-class ParserLog(SerializeableContent):
+class ParserLog(SerializableContent):
     _type: Optional[str] = None
     _message: Optional[str] = None
     _description: Optional[List[str]] = None

LOGS/Entities/PersonCategory.py

@@ -1,9 +1,9 @@
 from typing import Optional
 
-from LOGS.Entity.SerializeableContent import SerializeableClass
+from LOGS.Entity.SerializableContent import SerializableClass
 
 
-class PersonCategory(SerializeableClass):
+class PersonCategory(SerializableClass):
     id: Optional[int] = None
     name: Optional[str] = None
 

LOGS/Entities/PersonRelations.py

@@ -5,11 +5,9 @@ from LOGS.Entity.EntityRelations import EntityRelations
 
 if TYPE_CHECKING:
     from LOGS.Entities.Dataset import Dataset
-    from LOGS.Entities.Document import Document
     from LOGS.Entities.LabNotebookEntry import LabNotebookEntry
     from LOGS.Entities.Sample import Sample
 
-    # public EntityRelation Documents { get; set; }
     # public EntityRelation LabNotebooks { get; set; }
     # public EntityRelation LabNotebookExperiments { get; set; }
     # public EntityRelation LabNotebooksEntries { get; set; }
@@ -21,20 +19,9 @@ class PersonRelations(EntityRelations):
 
     _datasets: Optional[EntityRelation["Dataset"]] = None
     _samples: Optional[EntityRelation["Sample"]] = None
-    _documents: Optional[EntityRelation["Document"]] = None
     _labNotebooksEntries: Optional[EntityRelation["LabNotebookEntry"]] = None
     _labNotebooksEntryMentions: Optional[EntityRelation["LabNotebookEntry"]] = None
 
-    @property
-    def documents(self) -> Optional[EntityRelation["Document"]]:
-        return self._documents
-
-    @documents.setter
-    def documents(self, value):
-        from LOGS.Entities.Documents import Documents
-
-        self._documents = self._entityConverter(value, Documents)
-
     @property
     def samples(self) -> Optional[EntityRelation["Sample"]]:
         return self._samples

LOGS/Entities/PersonRequestParameter.py

@@ -52,7 +52,6 @@ class PersonRequestParameter(
     personTags: Optional[List[str]] = None
     organizationIds: Optional[List[int]] = None
     roleIds: Optional[List[int]] = None
-    documentIds: Optional[List[int]] = None
     hasAccount: Optional[bool] = None
     isAccountEnabled: Optional[bool] = None
     includeSystemUsers: Optional[bool] = None

LOGS/Entities/Project.py

@@ -4,7 +4,7 @@ from LOGS.Auxiliary.Decorators import Endpoint
 from LOGS.Entities.ProjectPersonPermission import ProjectPersonPermission
 from LOGS.Entities.ProjectRelations import ProjectRelations
 from LOGS.Entity.EntityWithIntId import IEntityWithIntId
-from LOGS.Entity.SerializeableContent import SerializeableClass
+from LOGS.Entity.SerializableContent import SerializableClass
 from LOGS.Interfaces.ICreationRecord import ICreationRecord
 from LOGS.Interfaces.IModificationRecord import IModificationRecord
 from LOGS.Interfaces.INamedEntity import INamedEntity
@@ -15,7 +15,7 @@ from LOGS.Interfaces.IUniqueEntity import IUniqueEntity
 from LOGS.LOGSConnection import LOGSConnection
 
 
-class ProjectTag(SerializeableClass):
+class ProjectTag(SerializableClass):
     id: Optional[int] = None
     name: Optional[str] = None
 

LOGS/Entities/ProjectPersonPermission.py

@@ -1,14 +1,14 @@
 from typing import TYPE_CHECKING, Optional
 
 from LOGS.Auxiliary.MinimalModelGenerator import MinimalFromSingle
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 if TYPE_CHECKING:
     from LOGS.Entities.PersonMinimal import PersonMinimal
     from LOGS.Entities.ProjectMinimal import ProjectMinimal
 
 
-class ProjectPersonPermission(SerializeableContent):
+class ProjectPersonPermission(SerializableContent):
     _person: Optional["PersonMinimal"] = None
     _project: Optional["ProjectMinimal"] = None
     _administer: Optional[bool] = None

LOGS/Entities/ProjectRelations.py

@@ -2,8 +2,6 @@ from typing import Optional
 
 from LOGS.Entities.Dataset import Dataset
 from LOGS.Entities.Datasets import Datasets
-from LOGS.Entities.Document import Document
-from LOGS.Entities.Documents import Documents
 from LOGS.Entities.Sample import Sample
 from LOGS.Entities.Samples import Samples
 from LOGS.Entity.EntityRelation import EntityRelation
@@ -13,20 +11,11 @@ from LOGS.Entity.EntityRelations import EntityRelations
 class ProjectRelations(EntityRelations):
     """Relations of a Project with other entities"""
 
-    _documents: Optional[EntityRelation[Document]] = None
     _datasets: Optional[EntityRelation[Dataset]] = None
     _samples: Optional[EntityRelation[Sample]] = None
     _labNotebookEntries: Optional[EntityRelation] = None
     _labNotebooksEntryMentions: Optional[EntityRelation] = None
 
-    @property
-    def documents(self) -> Optional[EntityRelation[Document]]:
-        return self._documents
-
-    @documents.setter
-    def documents(self, value):
-        self._documents = self._entityConverter(value, Documents)
-
     @property
     def samples(self) -> Optional[EntityRelation[Sample]]:
         return self._samples

LOGS/Entities/ProjectRequestParameter.py

@@ -20,8 +20,6 @@ class ProjectOrder(Enum):
     DATASET_COUNT_DESC = "DATASET_COUNT_DESC"
     SAMPLE_COUNT_ASC = "SAMPLE_COUNT_ASC"
     SAMPLE_COUNT_DESC = "SAMPLE_COUNT_DESC"
-    DOCUMENT_COUNT_ASC = "DOCUMENT_COUNT_ASC"
-    DOCUMENT_COUNT_DESC = "DOCUMENT_COUNT_DESC"
     LAB_NOTEBOOK_COUNT_ASC = "LAB_NOTEBOOK_COUNT_ASC"
     LAB_NOTEBOOK_COUNT_DESC = "LAB_NOTEBOOK_COUNT_DESC"
     CREATED_ON_ASC = "CREATED_ON_ASC"
@@ -52,4 +50,3 @@ class ProjectRequestParameter(
     datasetIds: Optional[List[int]] = None
     mediaIds: Optional[List[int]] = None
     sampleIds: Optional[List[int]] = None
-    documentIds: Optional[List[int]] = None

LOGS/Entities/Sample.py

@@ -123,40 +123,6 @@ class Sample(
     def other(self, value):
         self._other = self.checkAndConvertNullable(value, str, "other")
 
-    # @property
-    # def preparators(self) -> List[Person]:
-    #     return self._preparators
-
-    # @preparators.setter
-    # def preparators(self, value):
-    #     self._preparators = self.checkAndConvertNullable(value, List, "preparators")
-
-    # @property
-    # def discarders(self) -> List[Person]:
-    #     return self._discarders
-
-    # @discarders.setter
-    # def discarders(self, value):
-    #     self._discarders = self.checkAndConvertNullable(value, List, "discarders")
-
-    # @property
-    # def projects(self) -> Optional[List["ProjectMinimal"]]:
-    #     return self._projects
-
-    # @projects.setter
-    # def projects(self, value):
-    #     self._projects = MinimalFromList(
-    #         value, "ProjectMinimal", "projects", connection=self.connection
-    #     )
-
-    # @property
-    # def documents(self) -> List[Document]:
-    #     return self._documents
-
-    # @documents.setter
-    # def documents(self, value):
-    #     self._documents = self.checkAndConvertNullable(value, List, "documents")
-
     @property
     def preparedBy(self) -> Optional[List["PersonMinimal"]]:
         return self._preparedBy

LOGS/Entities/SampleRelations.py

@@ -5,26 +5,14 @@ from LOGS.Entity.EntityRelations import EntityRelations
 
 if TYPE_CHECKING:
     from LOGS.Entities.Dataset import Dataset
-    from LOGS.Entities.Document import Document
 
 
 class SampleRelations(EntityRelations):
     """Relations of a Sample with other entities"""
 
-    _documents: Optional[EntityRelation["Document"]] = None
     _datasets: Optional[EntityRelation["Dataset"]] = None
     _labNotebookEntries: Optional[EntityRelation] = None
 
-    @property
-    def documents(self) -> Optional[EntityRelation["Document"]]:
-        return self._documents
-
-    @documents.setter
-    def documents(self, value):
-        from LOGS.Entities.Documents import Documents
-
-        self._documents = self._entityConverter(value, Documents)
-
     @property
     def datasets(self) -> Optional[EntityRelation["Dataset"]]:
         return self._datasets

LOGS/Entities/SampleRequestParameter.py

@@ -50,7 +50,6 @@ class SampleRequestParameter(
     discardedByIds: Optional[List[int]] = None
     discardedAtFrom: Optional[datetime] = None
     discardedAtTo: Optional[datetime] = None
-    documentIds: Optional[List[int]] = None
     excludeDiscarded: Optional[bool] = None
     includeTags: Optional[bool] = None
     organizationIds: Optional[List[int]] = None

LOGS/Entities/TrackData.py

@@ -1,7 +1,7 @@
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 
-class TrackData(SerializeableContent):
+class TrackData(SerializableContent):
     def fetchFull(self):
         raise NotImplementedError(
             "Specific %a class for this track type is not implemented yet."

LOGS/Entities/TrackSettings.py

@@ -1,10 +1,10 @@
 from typing import Optional
 
 from LOGS.Entities.AxisNaming import AxisNaming
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 
-class TrackSettings(SerializeableContent):
+class TrackSettings(SerializableContent):
     """LOGS general Track settings"""
 
     _color: Optional[str] = None

LOGS/Entities/__init__.py

@@ -4,7 +4,7 @@ This package is written for the LOGS Repository.
 It's objects can be used to write your own dataset parser.
 
 License:
-Permission to use this libraray and all of its contents is
+Permission to use this library and all of its contents is
 strictly permitted to the Signals Company.
 """
 
@@ -41,10 +41,6 @@ from .DatatrackFormattedTable import *
 from .DatatrackImage import *
 from .DatatrackNumericArray import *
 from .DatatrackNumericMatrix import *
-from .Document import *
-from .DocumentRelations import *
-from .DocumentRequestParameter import *
-from .Documents import *
 from .Entities import *
 from .EntitiesRequestParameter import *
 from .EntityOriginWriteModelWithId import *

LOGS/Entity/ConnectedEntity.py

@@ -1,11 +1,11 @@
 from typing import List, Optional, cast
 
 from LOGS.Auxiliary.Exceptions import EntityNotConnectedException
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 from LOGS.LOGSConnection import LOGSConnection
 
 
-class ConnectedEntity(SerializeableContent):
+class ConnectedEntity(SerializableContent):
     _connection: Optional[LOGSConnection]
     _endpoint: Optional[List[str]] = None
     _uiEndpoint: Optional[List[str]] = None

LOGS/Entity/EntityConnector.py

@@ -3,7 +3,7 @@ from typing import Generic, List, Optional, TypeVar
 from LOGS.Auxiliary.Exceptions import NotConnectedException
 from LOGS.Auxiliary.Tools import Tools
 from LOGS.Entity.Entity import Entity
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 from LOGS.LOGSConnection import LOGSConnection, ResponseTypes
 
 # SELF = TypeVar("SELF", bound="EntityConnector")
@@ -17,7 +17,7 @@ class EntityConnector(Generic[_T]):
     _endpoint: Optional[List[str]] = None
     _firstUrl: Optional[str] = None
 
-    _parameters: SerializeableContent
+    _parameters: SerializableContent
     _responseType: ResponseTypes = ResponseTypes.JSON
     _includeUrl: bool = True
     _connection: Optional[LOGSConnection] = None

LOGS/Entity/EntityRelation.py

@@ -2,12 +2,12 @@ from typing import Generator, Generic, Optional, TypeVar
 
 from LOGS.Entity.Entity import Entity
 from LOGS.Entity.EntityIterator import EntityIterator
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 _T = TypeVar("_T", bound=Entity)
 
 
-class EntityRelation(Generic[_T], SerializeableContent):
+class EntityRelation(Generic[_T], SerializableContent):
     _noSerialize = ["link", "entities"]
     _count: Optional[int] = None
     _link: Optional[str] = None

LOGS/Entity/EntityRequestParameter.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 from enum import Enum
 from typing import Generic, List, Optional, TypeVar, Union
 
-from LOGS.Entity.SerializeableContent import SerializeableClass
+from LOGS.Entity.SerializableContent import SerializableClass
 from LOGS.Interfaces.IPaginationRequest import IPaginationRequest
 
 
@@ -17,7 +17,7 @@ _Sorting = TypeVar("_Sorting", bound=Enum)
 
 
 @dataclass
-class EntityRequestParameter(Generic[_Sorting], SerializeableClass, IPaginationRequest):
+class EntityRequestParameter(Generic[_Sorting], SerializableClass, IPaginationRequest):
     _noSerialize = ["asString"]
     excludeIds: Optional[Union[List[int], List[str]]] = None
     searchTerm: Optional[str] = None

LOGS/Entity/{SerializeableContent.py → SerializableContent.py}

@@ -28,7 +28,7 @@ from LOGS.Auxiliary.Tools import Tools
 _T = TypeVar("_T")
 
 
-class SerializeableContent:
+class SerializableContent:
     _noSerialize: List[str] = []
     _typeMapper: Optional[Dict[str, Any]] = None
     _slack: Dict[str, Any] = {}
@@ -58,11 +58,7 @@ class SerializeableContent:
             ref = convertOtherType[1](ref)
 
         serializableAncestors = tuple(
-            [
-                c
-                for c in inspect.getmro(selfClass)
-                if issubclass(c, SerializeableContent)
-            ]
+            [c for c in inspect.getmro(selfClass) if issubclass(c, SerializableContent)]
         )
 
         # if isinstance(ref, selfClass):
@@ -123,14 +119,14 @@ class SerializeableContent:
                                 type(e) == c for c in ignoreClasses
                             ):
                                 continue
-                            if isinstance(e, SerializeableContent):
+                            if isinstance(e, SerializableContent):
                                 s = e._getSlack(ignoreClasses=ignoreClasses)
                                 if s["slack"]:
                                     slacks[f"{k}[{i}]"] = s
                         if slacks:
                             slack["slack"].update(slacks)
 
-                    if isinstance(item, SerializeableContent):
+                    if isinstance(item, SerializableContent):
                         if ignoreClasses and any(
                             type(item) == c for c in ignoreClasses
                         ):
@@ -202,7 +198,7 @@ class SerializeableContent:
 
     @classmethod
     def toBaseclassString(cls, obj):
-        if isinstance(obj, SerializeableContent):
+        if isinstance(obj, SerializableContent):
             return obj.toString()
         if isinstance(obj, dict):
             return "<%s>" % obj["type"] if "type" in obj else "unknown"
@@ -415,7 +411,7 @@ class SerializeableContent:
     ) -> _T:
         if (
             inspect.isclass(fieldType)
-            and issubclass(fieldType, SerializeableContent)
+            and issubclass(fieldType, SerializableContent)
             and isinstance(value, dict)
         ):
             return cast(Any, fieldType)(ref=value)
@@ -548,7 +544,7 @@ class SerializeableContent:
 
     def checkInstance(self, instance, path: List[str] = []):
         # print("check", path, instance)
-        if isinstance(instance, SerializeableContent):
+        if isinstance(instance, SerializableContent):
             instance.check(path)
 
     def checkProperty(self, property: str, path: List[str] = []):
@@ -670,5 +666,5 @@ class SerializeableContent:
         return "".join(map(lambda r: chr(random.randint(65, 90)), range(len)))
 
 
-class SerializeableClass(SerializeableContent):
+class SerializableClass(SerializableContent):
     _planeClass = True

LOGS/Entity/__init__.py

@@ -22,4 +22,4 @@ from .EntityRelations import *
 from .EntityRequestParameter import *
 from .EntityWithIntId import *
 from .EntityWithStrId import *
-from .SerializeableContent import *
+from .SerializableContent import *

LOGS/Interfaces/IPermissionedEntity.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING, Generic, Optional, Type, TypeVar, cast
 
 from LOGS.Auxiliary import Tools
-from LOGS.Entity.SerializeableContent import SerializeableClass
+from LOGS.Entity.SerializableContent import SerializableClass
 from LOGS.Interfaces.IEntityInterface import IEntityInterface
 
 if TYPE_CHECKING:
@@ -18,7 +18,7 @@ class IPermissionModel:
     edit: Optional[bool] = None
 
 
-class GenericPermission(IPermissionModel, SerializeableClass):
+class GenericPermission(IPermissionModel, SerializableClass):
     edit: Optional[bool] = False
 
 

LOGS/LOGS.py

@@ -47,9 +47,6 @@ from LOGS.Entities.Datasets import Datasets
 from LOGS.Entities.DataSource import DataSource
 from LOGS.Entities.DataSourceRequestParameter import DataSourceRequestParameter
 from LOGS.Entities.DataSources import DataSources
-from LOGS.Entities.Document import Document
-from LOGS.Entities.DocumentRequestParameter import DocumentRequestParameter
-from LOGS.Entities.Documents import Documents
 from LOGS.Entities.Entities import Entities
 from LOGS.Entities.EntitiesRequestParameter import EntitiesRequestParameter
 from LOGS.Entities.EntityOriginWriteModelWithId import EntityOriginWriteModelWithId
@@ -127,7 +124,6 @@ _T = TypeVar(
     CustomType,
     Dataset,
     DataSource,
-    Document,
     Equipment,
     Experiment,
     Format,
@@ -160,7 +156,6 @@ class LOGS:
         CustomType,
         Dataset,
         DataSource,
-        Document,
         Equipment,
         Experiment,
         Instrument,
@@ -244,7 +239,7 @@ class LOGS:
 
         if not isinstance(data, dict):
             raise LOGSException(
-                "Unexpected respons from session endpoint. Could not get current user."
+                "Unexpected response from session endpoint. Could not get current user."
             )
 
         person = None
@@ -253,7 +248,7 @@ class LOGS:
 
         if not person or not person.id:
             raise LOGSException(
-                "Unexpected respons from session endpoint. Could not get current user."
+                "Unexpected response from session endpoint. Could not get current user."
             )
 
         return person
@@ -820,23 +815,6 @@ class LOGS:
             )
         return Datasets(connection=self._connection, parameters=parameter)
 
-    def document(self, id: int) -> Document:
-        return self._fetchEntity(Document, id)
-
-    def documents(
-        self, parameter: Optional[DocumentRequestParameter] = None
-    ) -> Documents:
-        if parameter and not isinstance(parameter, DocumentRequestParameter):
-            raise LOGSException(
-                "Parameter for %s.documents must be of type %a. (Got %a)"
-                % (
-                    type(self).__name__,
-                    DocumentRequestParameter.__name__,
-                    type(parameter).__name__,
-                )
-            )
-        return Documents(connection=self._connection, parameters=parameter)
-
     def person(self, id: int) -> Person:
         return self._fetchEntity(Person, id)
 

LOGS/Parameters/Color.py

@@ -1,9 +1,9 @@
 from typing import List, Optional
 
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 
-class SingleColor(SerializeableContent):
+class SingleColor(SerializableContent):
     _color: str
     _offset: Optional[float]
     _value: Optional[float]
@@ -47,7 +47,7 @@ class SingleColor(SerializeableContent):
         self._value = value
 
 
-class Color(SerializeableContent):
+class Color(SerializableContent):
     _colors: List[SingleColor]
     _discrete: Optional[bool]
     _reverse: Optional[bool]

LOGS/Parameters/ParameterBase.py

@@ -1,10 +1,10 @@
 from typing import List, Optional
 
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 from LOGS.Parameters.Color import Color
 
 
-class ParameterBase(SerializeableContent):
+class ParameterBase(SerializableContent):
     _name: str = ""
     _tracks: Optional[List[str]] = None
     _colors: List[Color] = []

LOGS/ServerMetaData.py

@@ -2,10 +2,10 @@ from datetime import datetime
 from typing import Optional
 from uuid import UUID
 
-from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Entity.SerializableContent import SerializableContent
 
 
-class ServerMetaData(SerializeableContent):
+class ServerMetaData(SerializableContent):
     _application: Optional[str] = None
     _vendor: Optional[str] = None
     _version: Optional[str] = None

{logs_py-3.0.5.dist-info → logs_py-3.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: logs-py
-Version: 3.0.5
+Version: 3.0.7
 Summary: A python interface for the LOGS public API
 Home-page: https://docs.logs-python.com
 Author: Sina Kazemi
@@ -19,6 +19,7 @@ Requires-Dist: regex>=2019.12.9
 Requires-Dist: Pillow
 Requires-Dist: deprecation
 Requires-Dist: pytz
+Requires-Dist: tzlocal; platform_system == "Windows"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier