logs-py 4.0.7__py3-none-any.whl

LOGS/Entities/LabNotebookEntryContent/EntryContentBulletList.py

@@ -0,0 +1,17 @@
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextMarkAtributes import BasicAttribute
+
+
+class EntryContentBulletList(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[BasicAttribute],
+):
+    _attrType = BasicAttribute
+    _type = "bulletList"

LOGS/Entities/LabNotebookEntryContent/EntryContentCallout.py

@@ -0,0 +1,40 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.BasicAttribute import BasicAttribute
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+
+
+class CalloutAttribute(BasicAttribute):
+    _type: Optional[str] = None
+    _emoji: Optional[str] = None
+
+    @property
+    def type(self) -> Optional[str]:
+        return self._type
+
+    @type.setter
+    def type(self, value):
+        self._type = self.checkAndConvertNullable(value, str, "type")
+
+    @property
+    def emoji(self) -> Optional[str]:
+        return self._emoji
+
+    @emoji.setter
+    def emoji(self, value):
+        self._emoji = self.checkAndConvertNullable(value, str, "emoji")
+
+
+class EntryContentCallout(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[CalloutAttribute],
+):
+    _attrType = CalloutAttribute
+    _type = "callout"

LOGS/Entities/LabNotebookEntryContent/EntryContentContentPlaceholderNode.py

@@ -0,0 +1,31 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextAttribute import TextAttribute
+
+
+class PlaceholderNodeAttribute(TextAttribute):
+    _label: Optional[str] = None
+
+    @property
+    def label(self) -> Optional[str]:
+        return self._label
+
+    @label.setter
+    def label(self, value):
+        self._label = self.checkAndConvertNullable(value, str, "label")
+
+
+class EntryContentContentPlaceholderNode(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[PlaceholderNodeAttribute],
+):
+    _attrType = PlaceholderNodeAttribute
+    _type = "contentPlaceholderNode"

LOGS/Entities/LabNotebookEntryContent/EntryContentConverter.py

@@ -0,0 +1,207 @@
+from typing import Generic, List, Optional, TypeVar, cast
+
+from LOGS.Auxiliary.Tools import Tools
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+
+_T = TypeVar("_T", bound=EntryContentItem)
+
+
+class EntryContentConverter(Generic[_T]):
+
+    @classmethod
+    def _convertEntryContentDocument(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentDocument import (
+            EntryContentDocument,
+        )
+
+        return EntryContentDocument(item)
+
+    @classmethod
+    def _convertEntryContentHeading(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentHeading import (
+            EntryContentHeading,
+        )
+
+        return EntryContentHeading(item)
+
+    @classmethod
+    def _convertEntryContentText(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentText import (
+            EntryContentText,
+        )
+
+        return EntryContentText(item)
+
+    @classmethod
+    def _convertEntryContentParagraph(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentParagraph import (
+            EntryContentParagraph,
+        )
+
+        return EntryContentParagraph(item)
+
+    @classmethod
+    def _convertEntryContentBlockquote(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentBlockquote import (
+            EntryContentBlockquote,
+        )
+
+        return EntryContentBlockquote(item)
+
+    @classmethod
+    def _convertEntryContentBulletList(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentBulletList import (
+            EntryContentBulletList,
+        )
+
+        return EntryContentBulletList(item)
+
+    @classmethod
+    def _convertEntryContentOrderedList(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentOrderedList import (
+            EntryContentOrderedList,
+        )
+
+        return EntryContentOrderedList(item)
+
+    @classmethod
+    def _convertEntryContentCallout(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentCallout import (
+            EntryContentCallout,
+        )
+
+        return EntryContentCallout(item)
+
+    @classmethod
+    def _convertEntryContentContentPlaceholderNode(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentContentPlaceholderNode import (
+            EntryContentContentPlaceholderNode,
+        )
+
+        return EntryContentContentPlaceholderNode(item)
+
+    @classmethod
+    def _convertEntryContentEntity(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentEntity import (
+            EntryContentEntity,
+        )
+
+        return EntryContentEntity(item)
+
+    @classmethod
+    def _convertEntryContentEntityMention(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentEntityMention import (
+            EntryContentEntityMention,
+        )
+
+        return EntryContentEntityMention(item)
+
+    @classmethod
+    def _convertEntryContentHorizontalRule(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentHorizontalRule import (
+            EntryContentHorizontalRule,
+        )
+
+        return EntryContentHorizontalRule(item)
+
+    @classmethod
+    def _convertEntryContentListItem(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentListItem import (
+            EntryContentListItem,
+        )
+
+        return EntryContentListItem(item)
+
+    @classmethod
+    def _convertEntryContentTaskList(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentTaskList import (
+            EntryContentTaskList,
+        )
+
+        return EntryContentTaskList(item)
+
+    @classmethod
+    def _convertEntryContentTaskListItem(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentTaskListItem import (
+            EntryContentTaskListItem,
+        )
+
+        return EntryContentTaskListItem(item)
+
+    @classmethod
+    def _convertEntryContentTable(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentTable import (
+            EntryContentTable,
+        )
+
+        return EntryContentTable(item)
+
+    @classmethod
+    def _convertEntryContentTableCell(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentTableCell import (
+            EntryContentTableCell,
+        )
+
+        return EntryContentTableCell(item)
+
+    @classmethod
+    def _convertEntryContentTableRow(cls, item: dict):
+        from LOGS.Entities.LabNotebookEntryContent.EntryContentTableRow import (
+            EntryContentTableRow,
+        )
+
+        return EntryContentTableRow(item)
+
+    @classmethod
+    def convert(cls, item: dict, fieldName: Optional[str] = None) -> _T:
+        field = f"in field {fieldName}" if fieldName else ""
+
+        if isinstance(item, EntryContentItem):
+            return cast(_T, item)
+
+        if not isinstance(item, dict):
+            raise ValueError(
+                f"EntryContentItem {field} must be of type 'dict'. (Got type '{type(item).__name__}')"
+            )
+
+        if "type" not in item:
+            raise ValueError(
+                f"EntryContentItem {field} must contain a 'type' field. (Got '{Tools.truncString(str(item))}')"
+            )
+
+        _typeMapper = {
+            "blockquote": cls._convertEntryContentBlockquote,
+            "bulletList": cls._convertEntryContentBulletList,
+            "callout": cls._convertEntryContentCallout,
+            "contentPlaceholderNode": cls._convertEntryContentContentPlaceholderNode,
+            "doc": cls._convertEntryContentDocument,
+            "entity": cls._convertEntryContentEntity,
+            "entityMention": cls._convertEntryContentEntityMention,
+            "heading": cls._convertEntryContentHeading,
+            "horizontalRule": cls._convertEntryContentHorizontalRule,
+            "listItem": cls._convertEntryContentListItem,
+            "orderedList": cls._convertEntryContentOrderedList,
+            "paragraph": cls._convertEntryContentParagraph,
+            "table": cls._convertEntryContentTable,
+            "tableCell": cls._convertEntryContentTableCell,
+            "tableRow": cls._convertEntryContentTableRow,
+            "taskList": cls._convertEntryContentTaskList,
+            "taskListItem": cls._convertEntryContentTaskListItem,
+            "text": cls._convertEntryContentText,
+        }
+
+        mapper = _typeMapper.get(item["type"], None)
+        if mapper:
+            return cast(_T, mapper(item))
+
+        return cast(_T, EntryContentItem(item))
+
+    @classmethod
+    def convertList(cls, items, fieldName: Optional[str] = None) -> List[_T]:
+        if not isinstance(items, list):
+            items = [items]
+
+        return [
+            cls.convert(item, fieldName=f"{fieldName}[{i}]" if fieldName else None)
+            for i, item in enumerate(items)
+        ]

LOGS/Entities/LabNotebookEntryContent/EntryContentDocument.py

@@ -0,0 +1,8 @@
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+
+
+class EntryContentDocument(EntryContentItem, IEntryContentWithContent):
+    _type = "doc"

LOGS/Entities/LabNotebookEntryContent/EntryContentEntity.py

@@ -0,0 +1,13 @@
+from LOGS.Entities.LabNotebookEntryContent.EntityAttribute import EntityAttribute
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+
+
+class EntryContentEntity(
+    EntryContentItem,
+    IEntryContentWithAttribute[EntityAttribute],
+):
+    _attrType = EntityAttribute
+    _type = "entity"

LOGS/Entities/LabNotebookEntryContent/EntryContentEntityMention.py

@@ -0,0 +1,31 @@
+from typing import List, Optional
+
+from LOGS.Entities.LabNotebookEntryContent.EntityAttribute import EntityAttribute
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextMarkConverter import TextMarkConverter
+
+
+class EntryContentEntityMention(
+    EntryContentItem,
+    IEntryContentWithAttribute[EntityAttribute],
+):
+    _attrType = EntityAttribute
+    _type = "entityMention"
+
+    _marks: Optional[List[IEntryContentWithAttribute]] = None
+
+    @property
+    def marks(self) -> Optional[List[IEntryContentWithAttribute]]:
+        return self._marks
+
+    @marks.setter
+    def marks(self, value):
+        self._marks = self.checkListAndConvertNullable(
+            value,
+            IEntryContentWithAttribute,
+            "marks",
+            converter=TextMarkConverter.convert,
+        )

LOGS/Entities/LabNotebookEntryContent/EntryContentHeading.py

@@ -0,0 +1,33 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextAttribute import TextAttribute
+
+
+class HeadingAttribute(TextAttribute):
+    _level: Optional[int] = None
+
+    @property
+    def level(self) -> Optional[int]:
+        return self._level
+
+    @level.setter
+    def level(self, value):
+        self._level = self.checkAndConvertNullable(value, int, "level")
+
+
+class EntryContentHeading(EntryContentItem, IEntryContentWithContent):
+    _type = "heading"
+
+    _attrs: Optional[HeadingAttribute] = None
+
+    @property
+    def attrs(self) -> Optional[HeadingAttribute]:
+        return self._attrs
+
+    @attrs.setter
+    def attrs(self, value):
+        self._attrs = self.checkAndConvertNullable(value, HeadingAttribute, "attrs")

LOGS/Entities/LabNotebookEntryContent/EntryContentHorizontalRule.py

@@ -0,0 +1,12 @@
+from LOGS.Entities.LabNotebookEntryContent.BasicAttribute import BasicAttribute
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+
+
+class EntryContentHorizontalRule(
+    EntryContentItem, IEntryContentWithAttribute[BasicAttribute]
+):
+    _attrType = BasicAttribute
+    _type = "horizontalRule"

LOGS/Entities/LabNotebookEntryContent/EntryContentItem.py

@@ -0,0 +1,37 @@
+from typing import Optional
+
+from LOGS.Entity.SerializableContent import SerializableContent
+
+
+class EntryContentItem(SerializableContent):
+    __type: str = "Unknown"
+    _type: Optional[str] = None
+
+    def fromDict(self, ref) -> None:
+        if isinstance(ref, dict):
+            if "type" not in ref or not ref["type"]:
+                raise ValueError(
+                    f"EntryContentItem must contain a 'type' field. (Got '{self.truncString(str(ref))}')"
+                )
+
+        super().fromDict(ref)
+
+    @property
+    def type(self) -> str:
+        if type(self) == EntryContentItem:
+            return self.__type
+
+        if self._type:
+            return self._type
+        else:
+            raise ValueError(f"Field 'type' in class {type(self).__name__} is not set.")
+
+    @type.setter
+    def type(self, value):
+        if type(self) != EntryContentItem:
+            if self._type != value:
+                raise ValueError(
+                    f"Field 'type' in class {type(self).__name__} is not mutable. (Got '{self.truncString(str(value))}' expected '{self._type}')"
+                )
+            return
+        self.__type = self.checkAndConvertNullable(value, str, "type")

LOGS/Entities/LabNotebookEntryContent/EntryContentListItem.py

@@ -0,0 +1,49 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.BasicAttribute import BasicAttribute
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+
+
+class ListItemAttribute(BasicAttribute):
+    _order: Optional[int] = None
+    _closed: Optional[bool] = False
+    _nested: Optional[bool] = False
+
+    @property
+    def closed(self) -> Optional[bool]:
+        return self._closed
+
+    @closed.setter
+    def closed(self, value):
+        self._closed = self.checkAndConvertNullable(value, bool, "closed")
+
+    @property
+    def nested(self) -> Optional[bool]:
+        return self._nested
+
+    @nested.setter
+    def nested(self, value):
+        self._nested = self.checkAndConvertNullable(value, bool, "nested")
+
+    @property
+    def order(self) -> Optional[int]:
+        return self._order
+
+    @order.setter
+    def order(self, value):
+        self._order = self.checkAndConvertNullable(value, int, "order")
+
+
+class EntryContentListItem(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[ListItemAttribute],
+):
+    _attrType = ListItemAttribute
+    _type = "listItem"

LOGS/Entities/LabNotebookEntryContent/EntryContentOrderedList.py

@@ -0,0 +1,31 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.BasicAttribute import BasicAttribute
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+
+
+class OrderedListAttribute(BasicAttribute):
+    _order: Optional[int] = None
+
+    @property
+    def order(self) -> Optional[int]:
+        return self._order
+
+    @order.setter
+    def order(self, value):
+        self._order = self.checkAndConvertNullable(value, int, "order")
+
+
+class EntryContentOrderedList(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[OrderedListAttribute],
+):
+    _attrType = OrderedListAttribute
+    _type = "orderedList"

LOGS/Entities/LabNotebookEntryContent/EntryContentParagraph.py

@@ -0,0 +1,13 @@
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithTextAttribute import (
+    IEntryContentWithTextAttribute,
+)
+
+
+class EntryContentParagraph(
+    EntryContentItem, IEntryContentWithContent, IEntryContentWithTextAttribute
+):
+    _type = "paragraph"

LOGS/Entities/LabNotebookEntryContent/EntryContentTable.py

@@ -0,0 +1,17 @@
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextMarkAtributes import BasicAttribute
+
+
+class EntryContentTable(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[BasicAttribute],
+):
+    _attrType = BasicAttribute
+    _type = "table"

LOGS/Entities/LabNotebookEntryContent/EntryContentTableCell.py

@@ -0,0 +1,40 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextMarkAtributes import BasicAttribute
+
+
+class TableCellAttribute(BasicAttribute):
+    _colspan: Optional[int] = None
+    _rowspan: Optional[int] = None
+
+    @property
+    def colspan(self) -> Optional[int]:
+        return self._colspan
+
+    @colspan.setter
+    def colspan(self, value):
+        self._colspan = self.checkAndConvertNullable(value, int, "colspan")
+
+    @property
+    def rowspan(self) -> Optional[int]:
+        return self._rowspan
+
+    @rowspan.setter
+    def rowspan(self, value):
+        self._rowspan = self.checkAndConvertNullable(value, int, "rowspan")
+
+
+class EntryContentTableCell(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[TableCellAttribute],
+):
+    _attrType = TableCellAttribute
+    _type = "tableCell"

LOGS/Entities/LabNotebookEntryContent/EntryContentTableRow.py

@@ -0,0 +1,8 @@
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+
+
+class EntryContentTableRow(EntryContentItem, IEntryContentWithContent):
+    _type = "tableRow"

LOGS/Entities/LabNotebookEntryContent/EntryContentTaskList.py

@@ -0,0 +1,17 @@
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextMarkAtributes import BasicAttribute
+
+
+class EntryContentTaskList(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[BasicAttribute],
+):
+    _attrType = BasicAttribute
+    _type = "taskList"

LOGS/Entities/LabNotebookEntryContent/EntryContentTaskListItem.py

@@ -0,0 +1,31 @@
+from typing import Optional
+
+from LOGS.Entities.LabNotebookEntryContent.EntryContentItem import EntryContentItem
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithAttribute import (
+    IEntryContentWithAttribute,
+)
+from LOGS.Entities.LabNotebookEntryContent.IEntryContentWithContent import (
+    IEntryContentWithContent,
+)
+from LOGS.Entities.LabNotebookEntryContent.TextMarkAtributes import BasicAttribute
+
+
+class TaskListItemAttribute(BasicAttribute):
+    _checked: Optional[bool] = False
+
+    @property
+    def checked(self) -> Optional[bool]:
+        return self._checked
+
+    @checked.setter
+    def checked(self, value):
+        self._checked = self.checkAndConvertNullable(value, bool, "checked")
+
+
+class EntryContentTaskListItem(
+    EntryContentItem,
+    IEntryContentWithContent,
+    IEntryContentWithAttribute[TaskListItemAttribute],
+):
+    _attrType = TaskListItemAttribute
+    _type = "taskListItem"