logs-py 2.7.1__py3-none-any.whl → 2.8__py3-none-any.whl

LOGS/Entities/CustomField.py

@@ -0,0 +1,173 @@
+from datetime import datetime
+from typing import List, Optional
+
+from regex import Regex
+
+from LOGS.Auxiliary.Decorators import Endpoint
+from LOGS.Entities.CustomFieldEnums import CustomFieldDataTypes, CustomFieldTypes
+from LOGS.Entity.EntityWithStrId import EntityWithStrId
+from LOGS.Interfaces.INamedEntity import INamedEntity
+from LOGS.Interfaces.IOwnedEntity import IOwnedEntity
+from LOGS.LOGSConnection import LOGSConnection
+
+
+@Endpoint("custom_fields")
+class CustomField(
+    EntityWithStrId,
+    IOwnedEntity,
+    INamedEntity,
+):
+    _createdAt: Optional[datetime]
+    _widget: Optional[CustomFieldTypes] = CustomFieldTypes.Text
+    _type: Optional[CustomFieldDataTypes] = CustomFieldDataTypes.String
+    _description: Optional[str]
+    _defaultValue: Optional[str]
+    _isReadOnly: Optional[bool]
+    _isRequired: Optional[bool]
+    _isMulti: Optional[bool]
+    _validationRegexp: Optional[str]
+    _validationMessage: Optional[str]
+    _enumOptions: Optional[List[str]]
+
+    _alphanumeric = Regex(r"[^a-zA-Z0-9_]")
+
+    def __init__(
+        self,
+        ref=None,
+        id: Optional[str] = None,
+        connection: Optional[LOGSConnection] = None,
+        name: str = "",
+    ):
+        self._name = name
+        if id is None:
+            id = self._idFromName(name)
+        self._createdAt = None
+        self._widget = None
+        self._type = None
+        self._description = None
+        self._defaultValue = None
+        self._isReadOnly = None
+        self._isRequired = None
+        self._isMulti = None
+        self._validationRegexp = None
+        self._validationMessage = None
+        self._enumOptions = None
+
+        if ref != None and isinstance(ref, (str, int, float)):
+            ref = {"text": str(ref)}
+
+        super().__init__(connection=connection, id=id, ref=ref)
+
+    def fromDict(self, ref, formatDict=None) -> None:
+        if isinstance(ref, dict) and "type" in ref and isinstance(ref["type"], int):
+            del ref["type"]
+        if isinstance(ref, dict) and "widget" in ref and isinstance(ref["widget"], int):
+            del ref["widget"]
+
+        super().fromDict(ref=ref, formatDict=formatDict)
+
+    @classmethod
+    def _idFromName(cls, name):
+        return cls._alphanumeric.sub("_", name).lower()
+
+    @property
+    def createdAt(self) -> Optional[datetime]:
+        return self._createdAt
+
+    @createdAt.setter
+    def createdAt(self, value):
+        self._createdAt = self.checkAndConvertNullable(value, datetime, "createdAt")
+
+    @property
+    def widget(self) -> Optional[CustomFieldTypes]:
+        return self._widget
+
+    @widget.setter
+    def widget(self, value):
+        self._widget = self.checkAndConvertNullable(value, CustomFieldTypes, "widget")
+
+    @property
+    def type(self) -> Optional[CustomFieldDataTypes]:
+        return self._type
+
+    @type.setter
+    def type(self, value):
+        self._type = self.checkAndConvertNullable(value, CustomFieldDataTypes, "type")
+
+    @property
+    def description(self) -> Optional[str]:
+        return self._description
+
+    @description.setter
+    def description(self, value):
+        self._description = self.checkAndConvertNullable(value, str, "description")
+
+    @property
+    def defaultValue(self) -> Optional[str]:
+        return self._defaultValue
+
+    @defaultValue.setter
+    def defaultValue(self, value):
+        self._defaultValue = self.checkAndConvertNullable(value, str, "defaultValue")
+
+    @property
+    def isReadOnly(self) -> Optional[bool]:
+        return self._isReadOnly
+
+    @isReadOnly.setter
+    def isReadOnly(self, value):
+        self._isReadOnly = self.checkAndConvertNullable(value, bool, "isReadOnly")
+
+    @property
+    def isRequired(self) -> Optional[bool]:
+        return self._isRequired
+
+    @isRequired.setter
+    def isRequired(self, value):
+        self._isRequired = self.checkAndConvertNullable(value, bool, "isRequired")
+
+    @property
+    def isMulti(self) -> Optional[bool]:
+        return self._isMulti
+
+    @isMulti.setter
+    def isMulti(self, value):
+        self._isMulti = self.checkAndConvertNullable(value, bool, "isMulti")
+
+    @property
+    def validationRegexp(self) -> Optional[str]:
+        return self._validationRegexp
+
+    @validationRegexp.setter
+    def validationRegexp(self, value):
+        self._validationRegexp = self.checkAndConvertNullable(
+            value, str, "validationRegexp"
+        )
+
+    @property
+    def validationMessage(self) -> Optional[str]:
+        return self._validationMessage
+
+    @validationMessage.setter
+    def validationMessage(self, value):
+        self._validationMessage = self.checkAndConvertNullable(
+            value, str, "validationMessage"
+        )
+
+    @property
+    def enumOptions(self) -> Optional[List[str]]:
+        return self._enumOptions
+
+    @enumOptions.setter
+    def enumOptions(self, value):
+        self._enumOptions = self.checkListAndConvertNullable(value, str, "enumOptions")
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    @name.setter
+    def name(self, value):
+        self._name = self.checkAndConvert(value, str, "name", allowNone=True)
+        if self.id is None or self.id == "":
+            self.id = self._idFromName(self._name)

LOGS/Entities/CustomFieldEnums.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class CustomFieldTypes(Enum):
+    Text = "Text"
+    TextArea = "TextArea"
+    Number = "Number"
+    EnumDropdown = "EnumDropdown"
+    Date = "Date"
+    Toggle = "Toggle"
+
+
+class CustomFieldDataTypes(Enum):
+    String = "String"
+    Date = "Date"
+    Number = "Number"
+    Boolean = "Boolean"
+    DateTime = "DateTime"
+
+
+class CustomFieldPropertyFilters(Enum):
+    DefaultValue = "DefaultValue"
+    IsReadOnly = "IsReadOnly"
+    IsRequired = "IsRequired"
+    ValidationRegexp = "ValidationRegexp"

LOGS/Entities/CustomFieldMinimal.py

@@ -0,0 +1,8 @@
+from LOGS.Auxiliary.Decorators import FullModel
+from LOGS.Entities.CustomField import CustomField
+from LOGS.Entity.EntityMinimalWithIntId import EntityMinimalWithIntId
+
+
+@FullModel(CustomField)
+class CustomFieldMinimal(EntityMinimalWithIntId[CustomField]):
+    pass

LOGS/Entities/CustomFieldRequestParameter.py

@@ -0,0 +1,40 @@
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import List, Optional
+
+from LOGS.Entities.CustomFieldEnums import CustomFieldPropertyFilters, CustomFieldTypes
+from LOGS.Entity.EntityRequestParameter import EntityRequestParameter
+from LOGS.Interfaces.INamedEntity import INamedEntityRequest
+from LOGS.Interfaces.IOwnedEntity import IOwnedEntityRequest
+from LOGS.Interfaces.IPaginationRequest import IPaginationRequest
+
+
+class CustomFieldOrder(Enum):
+    ID_ASC = "ID_ASC"
+    ID_DESC = "ID_DESC"
+    NAME_ASC = "NAME_ASC"
+    NAME_DESC = "NAME_DESC"
+    TYPE_ASC = "TYPE_ASC"
+    TYPE_DESC = "TYPE_DESC"
+    WIDGET_ASC = "WIDGET_ASC"
+    WIDGET_DESC = "WIDGET_DESC"
+    OWNER_ASC = "OWNER_ASC"
+    OWNER_DESC = "OWNER_DESC"
+    CREATED_ON_ASC = "CREATED_ON_ASC"
+    CREATED_ON_DESC = "CREATED_ON_DESC"
+
+
+@dataclass
+class CustomFieldRequestParameter(
+    EntityRequestParameter[CustomFieldOrder],
+    IPaginationRequest,
+    IOwnedEntityRequest,
+    INamedEntityRequest,
+):
+    name: Optional[str] = None
+    ownerIds: Optional[List[int]] = None
+    creationDateFrom: Optional[datetime] = None
+    creationDateTo: Optional[datetime] = None
+    widgets: Optional[List[CustomFieldTypes]] = None
+    properties: Optional[List[CustomFieldPropertyFilters]] = None

LOGS/Entities/CustomFields.py

@@ -0,0 +1,12 @@
+from LOGS.Auxiliary.Decorators import Endpoint
+from LOGS.Entities.CustomField import CustomField
+from LOGS.Entities.CustomFieldRequestParameter import CustomFieldRequestParameter
+from LOGS.Entity.EntityIterator import EntityIterator
+
+
+@Endpoint("custom_fields")
+class CustomFields(EntityIterator[CustomField, CustomFieldRequestParameter]):
+    """LOGS connected CustomFields iterator"""
+
+    _generatorType = CustomField
+    _parameterType = CustomFieldRequestParameter

LOGS/Entities/CustomSchema.py

@@ -1,29 +1,43 @@
 from datetime import datetime
-from typing import TYPE_CHECKING, Optional
+from typing import List, Optional
 
+from regex import Regex
+
+from LOGS.Auxiliary.Decorators import Endpoint
+from LOGS.Entities.CustomSchemaSection import CustomSchemaSection
 from LOGS.Entity.EntityWithStrId import EntityWithStrId
 from LOGS.Interfaces.INamedEntity import INamedEntity
 from LOGS.Interfaces.IOwnedEntity import IOwnedEntity
 from LOGS.LOGSConnection import LOGSConnection
 
-if TYPE_CHECKING:
-    pass
-
 
+@Endpoint("custom_fields")
 class CustomSchema(EntityWithStrId, IOwnedEntity, INamedEntity):
     _createdAt: Optional[datetime]
     _enabled: Optional[bool]
+    _sections: Optional[List[CustomSchemaSection]]
+
+    _alphanumeric = Regex(r"[^a-zA-Z0-9_]")
 
     def __init__(
         self,
         ref=None,
         id: Optional[str] = None,
         connection: Optional[LOGSConnection] = None,
+        name: str = "",
     ):
-        self._name = None
+        self._name = name
+        if id is None or id == "":
+            id = self._idFromName(name)
         self._createdAt = None
         self._enabled = None
-        super().__init__(ref=ref, id=id, connection=connection)
+        self._sections = None
+
+        super().__init__(connection=connection, id=id, ref=ref)
+
+    @classmethod
+    def _idFromName(cls, name):
+        return cls._alphanumeric.sub("_", name).lower()
 
     @property
     def createdAt(self) -> Optional[datetime]:
@@ -33,6 +47,16 @@ class CustomSchema(EntityWithStrId, IOwnedEntity, INamedEntity):
     def createdAt(self, value):
         self._createdAt = self.checkAndConvertNullable(value, datetime, "createdAt")
 
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    @name.setter
+    def name(self, value):
+        self._name = self.checkAndConvert(value, str, "name", allowNone=True)
+        if self.id is None or self.id == "":
+            self.id = self._idFromName(self._name)
+
     @property
     def enabled(self) -> Optional[bool]:
         return self._enabled
@@ -40,3 +64,13 @@ class CustomSchema(EntityWithStrId, IOwnedEntity, INamedEntity):
     @enabled.setter
     def enabled(self, value):
         self._enabled = self.checkAndConvertNullable(value, bool, "enabled")
+
+    @property
+    def sections(self) -> Optional[List[CustomSchemaSection]]:
+        return self._sections
+
+    @sections.setter
+    def sections(self, value):
+        self._sections = self.checkListAndConvertNullable(
+            value, CustomSchemaSection, "sections"
+        )

LOGS/Entities/CustomSchemaParameter.py

@@ -0,0 +1,41 @@
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import Generic, List, Optional, TypeVar
+
+from LOGS.Entity.EntityRequestParameter import EntityRequestParameter
+from LOGS.Interfaces.INamedEntity import INamedEntityRequest
+from LOGS.Interfaces.IOwnedEntity import IOwnedEntityRequest
+from LOGS.Interfaces.IPaginationRequest import IPaginationRequest
+
+
+class CustomSchemaOrder(Enum):
+    ID_ASC = "ID_ASC"
+    ID_DESC = "ID_DESC"
+    NAME_ASC = "NAME_ASC"
+    NAME_DESC = "NAME_DESC"
+    TYPE_ASC = "TYPE_ASC"
+    TYPE_DESC = "TYPE_DESC"
+    OWNER_ASC = "OWNER_ASC"
+    OWNER_DESC = "OWNER_DESC"
+    CREATED_ON_ASC = "CREATED_ON_ASC"
+    CREATED_ON_DESC = "CREATED_ON_DESC"
+
+
+_Sorting = TypeVar("_Sorting", bound=Enum)
+
+
+@dataclass
+class CustomSchemaParameter(
+    Generic[_Sorting],
+    EntityRequestParameter[_Sorting],
+    IPaginationRequest,
+    IOwnedEntityRequest,
+    INamedEntityRequest,
+):
+    name: Optional[str] = None
+    ownerIds: Optional[List[int]] = None
+    creationDateFrom: Optional[datetime] = None
+    creationDateTo: Optional[datetime] = None
+    customFieldIds: Optional[List[str]] = None
+    isEnabled: Optional[bool] = None

LOGS/Entities/CustomSchemaSection.py

@@ -0,0 +1,42 @@
+from typing import TYPE_CHECKING, List, Optional
+
+from LOGS.Entities.CustomField import CustomField
+from LOGS.Entity.SerializeableContent import SerializeableContent
+from LOGS.Interfaces.INamedEntity import INamedEntity
+
+if TYPE_CHECKING:
+    pass
+
+
+class CustomSchemaSection(SerializeableContent, INamedEntity):
+    _isFolded: Optional[bool]
+    _children: Optional[List[CustomField]]
+
+    def __init__(
+        self,
+        ref=None,
+        name: str = "",
+    ):
+        self._name = name
+        self._isFolded = None
+        self._children = None
+
+        super().__init__(ref=ref)
+
+    @property
+    def isFolded(self) -> Optional[bool]:
+        return self._isFolded
+
+    @isFolded.setter
+    def isFolded(self, value):
+        self._isFolded = self.checkAndConvertNullable(value, bool, "isRequired")
+
+    @property
+    def children(self) -> Optional[List[CustomField]]:
+        return self._children
+
+    @children.setter
+    def children(self, value):
+        self._children = self.checkListAndConvertNullable(
+            value, CustomField, "children"
+        )

LOGS/Entities/Project.py

@@ -4,6 +4,7 @@ from LOGS.Auxiliary.Decorators import Endpoint
 from LOGS.Entities.ProjectRelations import ProjectRelations
 from LOGS.Entities.ProjectUserPermission import ProjectUserPermission
 from LOGS.Entity.EntityWithIntId import IEntityWithIntId
+from LOGS.Entity.SerializeableContent import SerializeableClass
 from LOGS.Interfaces.ICreationRecord import ICreationRecord
 from LOGS.Interfaces.IModificationRecord import IModificationRecord
 from LOGS.Interfaces.INamedEntity import INamedEntity
@@ -13,6 +14,15 @@ from LOGS.Interfaces.IUniqueEntity import IUniqueEntity
 from LOGS.LOGSConnection import LOGSConnection
 
 
+class ProjectTag(SerializeableClass):
+    id: Optional[int] = None
+    name: Optional[str] = None
+
+    def __str__(self):
+        s = (" name:'%s'" % getattr(self, "name")) if hasattr(self, "name") else ""
+        return "<%s id:%s%s>" % (type(self).__name__, str(self.id), s)
+
+
 @Endpoint("projects")
 class Project(
     IEntityWithIntId,
@@ -26,7 +36,7 @@ class Project(
     _relationType = type(ProjectRelations)
 
     _notes: Optional[str]
-    _tags: Optional[List[str]]
+    _projectTags: Optional[List[ProjectTag]]
     _relations: Optional[ProjectRelations]
     _userPermissions: Optional[List[ProjectUserPermission]]
 
@@ -41,7 +51,7 @@ class Project(
 
         self._name = name
         self._notes = None
-        self._tags = None
+        self._projectTags = None
         self._relations = None
         self._userPermissions = None
         super().__init__(ref=ref, id=id, connection=connection)
@@ -55,12 +65,14 @@ class Project(
         self._notes = self.checkAndConvertNullable(value, str, "notes")
 
     @property
-    def tags(self) -> Optional[List[str]]:
-        return self._tags
+    def projectTags(self) -> Optional[List[ProjectTag]]:
+        return self._projectTags
 
-    @tags.setter
-    def tags(self, value):
-        self._tags = self.checkListAndConvertNullable(value, str, "tags")
+    @projectTags.setter
+    def projectTags(self, value):
+        self._projectTags = self.checkListAndConvertNullable(
+            value, ProjectTag, "projectTags"
+        )
 
     @property
     def relations(self) -> Optional[ProjectRelations]:

LOGS/Entities/SampleType.py

@@ -1,7 +1,34 @@
+from typing import Optional
+
 from LOGS.Auxiliary.Decorators import Endpoint
 from LOGS.Entities.CustomSchema import CustomSchema
+from LOGS.Entity.SerializeableContent import SerializeableClass
+from LOGS.LOGSConnection import LOGSConnection
+
+
+class SampleTypeStats(SerializeableClass):
+    samples: Optional[int] = None
 
 
 @Endpoint("sample_types")
 class SampleType(CustomSchema):
-    pass
+    _stats: Optional[SampleTypeStats]
+
+    def __init__(
+        self,
+        ref=None,
+        id: Optional[str] = None,
+        connection: Optional[LOGSConnection] = None,
+        name: str = "",
+    ):
+        self._stats = None
+
+        super().__init__(ref, id, connection, name)
+
+    @property
+    def stats(self) -> Optional[SampleTypeStats]:
+        return self._stats
+
+    @stats.setter
+    def stats(self, value):
+        self._stats = self.checkAndConvertNullable(value, SampleTypeStats, "stats")

LOGS/Entities/SampleTypeRequestParameter.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+from LOGS.Entities.CustomSchemaParameter import CustomSchemaOrder, CustomSchemaParameter
+
+
+@dataclass
+class SampleTypeRequestParameter(CustomSchemaParameter[CustomSchemaOrder]):
+    pass

LOGS/Entities/SampleTypes.py

@@ -0,0 +1,12 @@
+from LOGS.Auxiliary.Decorators import Endpoint
+from LOGS.Entities.SampleType import SampleType
+from LOGS.Entities.SampleTypeRequestParameter import SampleTypeRequestParameter
+from LOGS.Entity.EntityIterator import EntityIterator
+
+
+@Endpoint("sample_types")
+class SampleTypes(EntityIterator[SampleType, SampleTypeRequestParameter]):
+    """LOGS connected SampleTypes iterator"""
+
+    _generatorType = SampleType
+    _parameterType = SampleTypeRequestParameter

LOGS/Entities/__init__.py

@@ -14,6 +14,9 @@ from .Bridge import *
 from .BridgeMinimal import *
 from .BridgeRequestParameter import *
 from .BridgeType import *
+from .CustomField import *
+from .CustomFieldEnums import *
+from .CustomFieldRequestParameter import *
 from .CustomSchema import *
 from .Dataset import *
 from .DatasetCreator import *
@@ -92,6 +95,7 @@ from .SampleRequestParameter import *
 from .Samples import *
 from .SampleType import *
 from .SampleTypeMinimal import *
+from .SampleTypeRequestParameter import *
 from .Track import *
 from .TrackData import *
 from .TrackSettings import *

LOGS/LOGS.py

@@ -36,51 +36,33 @@ from LOGS.Auxiliary import (
     Tools,
     formatErrorMessage,
 )
-from LOGS.Entities import (
-    Bridge,
-    Dataset,
-    DatasetCreator,
-    DatasetMatching,
-    DatasetRequestParameter,
-    Datasets,
-    DatasetsUpdatableFiles,
-    Document,
-    DocumentRequestParameter,
-    Documents,
-    Entities,
-    EntitiesRequestParameter,
-    EntityOriginWriteModelWithId,
-    Equipment,
-    Experiment,
-    ExperimentRequestParameter,
-    Experiments,
-    FileEntry,
-    Instrument,
-    InstrumentRequestParameter,
-    Instruments,
-    IUniqueEntity,
-    LabNotebookEntry,
-    Method,
-    MethodRequestParameter,
-    Methods,
-    Origin,
-    OriginRequestParameter,
-    Origins,
-    Person,
-    PersonRequestParameter,
-    Persons,
-    Project,
-    ProjectRequestParameter,
-    Projects,
-    Sample,
-    SampleRequestParameter,
-    Samples,
-)
+from LOGS.Entities import SampleType
+from LOGS.Entities.Bridge import Bridge
 from LOGS.Entities.BridgeRequestParameter import BridgeRequestParameter
 from LOGS.Entities.Bridges import Bridges
+from LOGS.Entities.CustomField import CustomField
+from LOGS.Entities.CustomFieldRequestParameter import CustomFieldRequestParameter
+from LOGS.Entities.CustomFields import CustomFields
+from LOGS.Entities.Dataset import Dataset
+from LOGS.Entities.DatasetCreator import DatasetCreator
+from LOGS.Entities.DatasetMatching import DatasetMatching
+from LOGS.Entities.DatasetMatchTypes import DatasetsUpdatableFiles
+from LOGS.Entities.DatasetRequestParameter import DatasetRequestParameter
+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
+from LOGS.Entities.Equipment import Equipment
+from LOGS.Entities.Experiment import Experiment
+from LOGS.Entities.ExperimentRequestParameter import ExperimentRequestParameter
+from LOGS.Entities.Experiments import Experiments
+from LOGS.Entities.FileEntry import FileEntry
 from LOGS.Entities.Format import Format
 from LOGS.Entities.FormatFormat import FormatFormat
 from LOGS.Entities.FormatFormatRequestParameter import FormatFormatRequestParameter
@@ -98,16 +80,38 @@ from LOGS.Entities.Formats import Formats
 from LOGS.Entities.FormatVendor import FormatVendor
 from LOGS.Entities.FormatVendorRequestParameter import FormatVendorRequestParameter
 from LOGS.Entities.FormatVendors import FormatVendors
+from LOGS.Entities.Instrument import Instrument
+from LOGS.Entities.InstrumentRequestParameter import InstrumentRequestParameter
+from LOGS.Entities.Instruments import Instruments
 from LOGS.Entities.LabNotebookEntries import LabNotebookEntries
+from LOGS.Entities.LabNotebookEntry import LabNotebookEntry
 from LOGS.Entities.LabNotebookEntryRequestParameter import (
     LabNotebookEntryRequestParameter,
 )
+from LOGS.Entities.Method import Method
+from LOGS.Entities.MethodRequestParameter import MethodRequestParameter
+from LOGS.Entities.Methods import Methods
+from LOGS.Entities.Origin import Origin
+from LOGS.Entities.OriginRequestParameter import OriginRequestParameter
+from LOGS.Entities.Origins import Origins
+from LOGS.Entities.Person import Person
+from LOGS.Entities.PersonRequestParameter import PersonRequestParameter
+from LOGS.Entities.Persons import Persons
+from LOGS.Entities.Project import Project
+from LOGS.Entities.ProjectRequestParameter import ProjectRequestParameter
+from LOGS.Entities.Projects import Projects
 from LOGS.Entities.Role import Role
 from LOGS.Entities.RoleRequestParameter import RoleRequestParameter
 from LOGS.Entities.Roles import Roles
+from LOGS.Entities.Sample import Sample
+from LOGS.Entities.SampleRequestParameter import SampleRequestParameter
+from LOGS.Entities.Samples import Samples
+from LOGS.Entities.SampleTypeRequestParameter import SampleTypeRequestParameter
+from LOGS.Entities.SampleTypes import SampleTypes
 from LOGS.Entity import Entity, EntityIterator, IEntityWithIntId
 from LOGS.Entity.ConnectedEntity import ConnectedEntity
 from LOGS.Interfaces.ISoftDeletable import ISoftDeletable
+from LOGS.Interfaces.IUniqueEntity import IUniqueEntity
 from LOGS.LOGSConnection import LOGSConnection
 
 _T = TypeVar(
@@ -132,6 +136,8 @@ _T = TypeVar(
     FormatMethod,
     FormatInstrument,
     FormatFormat,
+    CustomField,
+    SampleType,
 )
 
 
@@ -153,6 +159,8 @@ class LOGS:
         Method,
         LabNotebookEntry,
         Origin,
+        CustomField,
+        SampleType,
     ]
     _entityByName = {t.__name__: t for t in _entities}
     _defaultConfigFile: str = "logs.json"
@@ -1034,6 +1042,40 @@ class LOGS:
             )
         return FormatFormats(connection=self._connection, parameters=parameter)
 
+    def customField(self, id: int) -> CustomField:
+        return self._fetchEntity(CustomField, id)
+
+    def customFields(
+        self, parameter: Optional[CustomFieldRequestParameter] = None
+    ) -> CustomFields:
+        if parameter and not isinstance(parameter, CustomFieldRequestParameter):
+            raise LOGSException(
+                "Parameter for %s.CustomFields must be of type %a. (Got %a)"
+                % (
+                    type(self).__name__,
+                    CustomFieldRequestParameter.__name__,
+                    type(parameter).__name__,
+                )
+            )
+        return CustomFields(connection=self._connection, parameters=parameter)
+
+    def sampleType(self, id: str) -> SampleType:
+        return self._fetchEntity(SampleType, id)
+
+    def sampleTypes(
+        self, parameter: Optional[SampleTypeRequestParameter] = None
+    ) -> SampleTypes:
+        if parameter and not isinstance(parameter, SampleTypeRequestParameter):
+            raise LOGSException(
+                "Parameter for %s.SampleTypes must be of type %a. (Got %a)"
+                % (
+                    type(self).__name__,
+                    SampleTypeRequestParameter.__name__,
+                    type(parameter).__name__,
+                )
+            )
+        return SampleTypes(connection=self._connection, parameters=parameter)
+
     def entity(self, uid: str):
         return Entities(connection=self._connection).fetch(uid=uid)
 

LOGS/LOGSConnection.py

@@ -147,7 +147,7 @@ class LOGSConnection:
                 or self._metadata.apiVersion not in self._compatibleAPIVersions
             ):
                 raise LOGSException(
-                    "This libraray is not compatible with the LOGS API version '%s'. (Expected %s %s)"
+                    "This library is not compatible with the LOGS API version '%s'. (Expected %s %s)"
                     % (
                         (
                             self._metadata.apiVersion

{logs_py-2.7.1.dist-info → logs_py-2.8.dist-info}/METADATA

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

{logs_py-2.7.1.dist-info → logs_py-2.8.dist-info}/RECORD

@@ -1,5 +1,5 @@
-LOGS/LOGS.py,sha256=weR3ZmO7cximZi12_o6MooGUI_71ssSlVRcFA6B8lLc,38570
-LOGS/LOGSConnection.py,sha256=3cPSxEWS_Y3w6oYAmOfAEI0wPYf16nWyJ63uCtwHTwE,19846
+LOGS/LOGS.py,sha256=DooJ7JjAsLAEth1YJmdVvFuirguv74oQexkIE_oJGTM,41673
+LOGS/LOGSConnection.py,sha256=GOkmFj7CtCinn9SmRkzzdToaZqnmUaiqwuMI0mQGvCo,19845
 LOGS/ServerMetaData.py,sha256=WdXCCiCSFqER6s9c3N3v0O273OvxygxBzmE6_C8FmXs,3361
 LOGS/__init__.py,sha256=faGD87i0eeKbqEq6DTcteF6KoNa2O0BH1RnjxEvuGbQ,253
 LOGS/Auxiliary/Constants.py,sha256=jKsThb6TS6b1adgnv1uAoqohBJi8ySGo7fULHlE2Es0,2504
@@ -23,7 +23,14 @@ LOGS/Entities/BridgeRelations.py,sha256=nI6mqu_BIDt01tKHKyK38COHhpqrRHCi8wyy9Iyw
 LOGS/Entities/BridgeRequestParameter.py,sha256=OwBb72M2Jmft6D_04mmSbYzOMaK7GsfffB_s3tVwjJs,722
 LOGS/Entities/BridgeType.py,sha256=YB55JKJtS38fAlRb5T_OIPvT2qTJIzUC6uoC24eq3sE,88
 LOGS/Entities/Bridges.py,sha256=WgspgZ9zXxi9tDPg4JPsDLq-fvNQkiaUbKEfbz1iG7E,420
-LOGS/Entities/CustomSchema.py,sha256=8ACKbuC_nEZWstFBQvsChqEQmyGvrRxy9_tnFdU2A5Q,1185
+LOGS/Entities/CustomField.py,sha256=jUvaEHdWiVnimao8sD1sgKvYDMqP5GOSO42aag7oiaY,5219
+LOGS/Entities/CustomFieldEnums.py,sha256=JNvaMmvzDKaoI504XgE8pjKrpzE0sZ6j9jA6fi-tZzM,520
+LOGS/Entities/CustomFieldMinimal.py,sha256=GrfKIeyE1Bp4vvCA1zVoN9Hp73Vlt0Vw7z5wUKBhpvQ,266
+LOGS/Entities/CustomFieldRequestParameter.py,sha256=lIkSRNteqOMFtkfv5c-6MT6FhHDlXlqAQG6NUf5Gb0U,1307
+LOGS/Entities/CustomFields.py,sha256=-LVjEtaKvyzVFcT7JkhPUnaoKu6-7TvZEB6kl2ZLnM0,470
+LOGS/Entities/CustomSchema.py,sha256=LD2PIpWKSBd8b9bMBZXdNqIMBGtMgcMVVOwMfE5I0R4,2223
+LOGS/Entities/CustomSchemaParameter.py,sha256=hU7bB0QiKHM9bSjunZePqB5Xvmm01g1cGP3H-6QHxi8,1195
+LOGS/Entities/CustomSchemaSection.py,sha256=j_dpOJvDjXKk5zkwrsxhNu0k2Yi97mO5YX45JZSAw3g,1075
 LOGS/Entities/DataSource.py,sha256=puyFmrW3ciJ4JZPfIPkM9B4_VFy-WPgmCgUPo4pqWIM,6307
 LOGS/Entities/DataSourceMinimal.py,sha256=KlejLccyZR_AP2LvFQgCJXpcmWwtaOg6rRTVsXXlODI,261
 LOGS/Entities/DataSourceRelations.py,sha256=eIszpHjZqz6v4WyhaPNu8efSzedsJLNrYR9b3hCa3HY,658
@@ -110,7 +117,7 @@ LOGS/Entities/PersonMinimal.py,sha256=W5lhHvFtYi_Ln4B9g91pnZddrhyJGoOwiX81hszmKN
 LOGS/Entities/PersonRelations.py,sha256=kN8Rfkg5qP0QSLbmCcqonZjKW5VtDSDyCMJ5WoUDvHk,2701
 LOGS/Entities/PersonRequestParameter.py,sha256=PsWJJeawEvhL_HcjD5NwvoSXrfXMIn3oN_BCvAfVCfE,2113
 LOGS/Entities/Persons.py,sha256=cj4SKaJZvitaIe7Fd1M9_qqNdAEEG38iuMPNiKPDPUA,413
-LOGS/Entities/Project.py,sha256=rtmWRJTOK5Gafq38CO3mX_udgbNXashHK0TdKXCd0oE,2520
+LOGS/Entities/Project.py,sha256=uuW66BScwuf1mjpoTHBLp8skXRV_yZCuteIzYtB3rdk,2962
 LOGS/Entities/ProjectMinimal.py,sha256=Xw8wnA2iSixEkVaisY_b4Z3Ujudum3MG6tBUfbiAk0s,246
 LOGS/Entities/ProjectRelations.py,sha256=Hf3F42iYanTqrLgG6GjY4HXBCFWCcVNjXzwrnEJc9GU,2136
 LOGS/Entities/ProjectRequestParameter.py,sha256=KRq5HlTySlROsS-hrbDEGDy22_chz_NA_KXXSMUH7NY,1923
@@ -126,8 +133,10 @@ LOGS/Entities/Sample.py,sha256=RWfGDpj8terRfdt8cajHalK-P5rdqWYu92PtiL-2A90,6610
 LOGS/Entities/SampleMinimal.py,sha256=rlLN_MVB2KNxY9wTbArnDGtyGrQ0_NGllGzocNxeZSY,241
 LOGS/Entities/SampleRelations.py,sha256=dVCJGrM90sbme63PzWrFhbrzaEdWm_-OtaUfMfihQcs,1423
 LOGS/Entities/SampleRequestParameter.py,sha256=3irGUXGit2dKaiW5EizH2VeDp-4Hosrom4fuTCDzoZQ,1586
-LOGS/Entities/SampleType.py,sha256=8DlY-rebHQyv-kq6uVmgBGRov5347HAPi_VOBkBtky4,168
+LOGS/Entities/SampleType.py,sha256=OuYa6CD5c_aZ7rw9ij5ozSj757jSUzq2K0Ryke46vjY,888
 LOGS/Entities/SampleTypeMinimal.py,sha256=e5bJ2ZJwJu9fMugaXrp9MxBsPkpNEihhx0fWncX5V5A,261
+LOGS/Entities/SampleTypeRequestParameter.py,sha256=uWkYftn9c0iin0i2JobawECEUmCjsX8dSh0jXswDo58,222
+LOGS/Entities/SampleTypes.py,sha256=cdkSBl5eZMTf431TZBCsfnKQ45QZGVys9CcXKkPTXL4,459
 LOGS/Entities/Samples.py,sha256=fAOp5MvHnACilEF0gehmdmLD3-gdvDEZAFAHitm3ib0,414
 LOGS/Entities/Track.py,sha256=a72Qiq5ZjvifqbBc2y7IfKhJspRWltBXxKR9_HEC_LQ,2782
 LOGS/Entities/TrackData.py,sha256=0qNQIVQPeNWex8L8d12lXlbGvihezJRfAZY0ghdd-yc,287
@@ -136,7 +145,7 @@ LOGS/Entities/TrackXY.py,sha256=rffrNVR8DbQpWcjQpFMM1_7OnefKEE7UzVWBPfYaRp0,1186
 LOGS/Entities/TrackXYComplex.py,sha256=dqByLLSTW3WerDrXkfOVgX6Nc2zuXHa6Pf3gulUlb6k,1692
 LOGS/Entities/TrackXYComplexData.py,sha256=xWd3_jdXa347Gh53NYIMo66nFirA60Zd2KxaPs4KHaY,1368
 LOGS/Entities/TrackXYData.py,sha256=6AbwG2qa2HN858ROLaLpzkuIlwsb8tN8wznaiKplRdo,819
-LOGS/Entities/__init__.py,sha256=S-M2_NYcugZT-kAbksGQ8VknnjBT_wwdiFIXhvhaqrc,3058
+LOGS/Entities/__init__.py,sha256=Os_fyLxwi2bju8GIBy5LpFtlcW7eCGc2NP31g1EEhoQ,3202
 LOGS/Entity/ConnectedEntity.py,sha256=RIaOcOJWCrWooc9H8CkN4tbrLD0q4pM4CAeBX3ZRIVg,1617
 LOGS/Entity/Entity.py,sha256=uF7lCp-4HwUJ90ocRX_GCPu9KAZg2VAF5bCMlVfDtDs,6605
 LOGS/Entity/EntityConnector.py,sha256=Lp5rGDyTEoayPslieh_3QSzezwLiaj0lehejhu1LdKg,2061
@@ -167,7 +176,7 @@ LOGS/Interfaces/ISoftDeletable.py,sha256=urnmSfcYJrEm1iIo0k3nyBvMMnpomJWAYAON_uv
 LOGS/Interfaces/ITypedEntity.py,sha256=hMlzGuca8vW1qT5Dop-b-6_gteAeXjK0sz85eRjOZrY,724
 LOGS/Interfaces/IUniqueEntity.py,sha256=K-Q80qZX1wTjPnjbs-1PF85BbzYre2su_2xMnescYi4,1894
 LOGS/Interfaces/__init__.py,sha256=tGykqoQeT2_HV-oLYVKJJ9Z0a_Li8_y3AOJjG1btKYw,172
-logs_py-2.7.1.dist-info/METADATA,sha256=nwmcxFn89NXtYW3EVIY1FvCV3v3MADBQKfER5a2O8Ws,2004
-logs_py-2.7.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-logs_py-2.7.1.dist-info/top_level.txt,sha256=Ckn2LiAmGaR7k3tdEnKAc04z_uboMD4gLreYghRNdCs,5
-logs_py-2.7.1.dist-info/RECORD,,
+logs_py-2.8.dist-info/METADATA,sha256=Cs1bFPykFYr4q4gLRtqp_tMVh4evCdS5BHhVUddiG08,2002
+logs_py-2.8.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+logs_py-2.8.dist-info/top_level.txt,sha256=Ckn2LiAmGaR7k3tdEnKAc04z_uboMD4gLreYghRNdCs,5
+logs_py-2.8.dist-info/RECORD,,