kodexa 7.0.1a8003211616__py3-none-any.whl → 7.0.1a9196667375__py3-none-any.whl

kodexa/model/entities/product.py

@@ -0,0 +1,126 @@
+from typing import Optional, List
+
+from pydantic import BaseModel, ConfigDict, Field
+from kodexa.model.base import StandardDateTime
+from kodexa.platform.client import EntityEndpoint, PageEndpoint, EntitiesEndpoint
+
+
+class Product(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    """
+    A product
+    """
+
+
+    id: Optional[str] = None
+    uuid: Optional[str] = None
+    change_sequence: Optional[int] = Field(None, alias="changeSequence")
+    created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
+    updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
+    name: str
+    description: Optional[str] = None
+    overview_markdown: Optional[str] = Field(None, alias="overviewMarkdown")
+
+
+class ProductEndpoint(Product, EntityEndpoint):
+    """Handles the endpoint for a product
+
+    This class is a combination of DataException and EntityEndpoint. It is used
+    to manage the endpoint for data exceptions.
+
+    Methods:
+        get_type: Returns the type of the endpoint.
+    """
+
+    def get_type(self) -> str:
+        """Gets the type of the endpoint.
+
+        This method returns the type of the endpoint which is "exceptions".
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "products"
+
+
+class PageProduct(BaseModel):
+    """
+
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    total_pages: Optional[int] = Field(None, alias="totalPages")
+    total_elements: Optional[int] = Field(None, alias="totalElements")
+    size: Optional[int] = None
+    content: Optional[List[Product]] = None
+    number: Optional[int] = None
+
+    number_of_elements: Optional[int] = Field(None, alias="numberOfElements")
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
+class PageProductEndpoint(PageProduct, PageEndpoint):
+    def get_type(self) -> Optional[str]:
+        return "product"
+
+
+class ProductsEndpoint(EntitiesEndpoint):
+    """Represents the products endpoint
+
+    This class is used to represent the products endpoint in the system.
+
+    Attributes:
+        object_dict: A dictionary containing the object data.
+    """
+
+    """Represents a assistants endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint
+
+        This method is used to get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "products"
+
+    def get_instance_class(self, object_dict=None):
+        """Get the instance class of the endpoint
+
+        This method is used to get the instance class of the endpoint.
+
+        Args:
+            object_dict (dict, optional): A dictionary containing the object data.
+
+        Returns:
+            AssistantEndpoint: The instance class of the endpoint.
+        """
+        return ProductEndpoint
+
+    def get_page_class(self, object_dict=None):
+        """Get the page class of the endpoint
+
+        This method is used to get the page class of the endpoint.
+
+        Args:
+            object_dict (dict, optional): A dictionary containing the object data.
+
+        Returns:
+            PageAssistantEndpoint: The page class of the endpoint.
+        """
+        return PageProductEndpoint

kodexa/model/entities/product_subscription.py

@@ -0,0 +1,122 @@
+from typing import Optional, List
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from kodexa.model.base import StandardDateTime
+from kodexa.model.entities.product import Product
+from kodexa.model.objects import Organization
+from kodexa.platform.client import EntityEndpoint, PageEndpoint, EntitiesEndpoint
+
+
+class ProductSubscription(BaseModel):
+    """
+    A product subscription
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+
+    id: Optional[str] = Field(None)
+    uuid: Optional[str] = None
+    change_sequence: Optional[int] = Field(None, alias="changeSequence")
+    created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
+    updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
+    product: Optional[Product] = None
+    organization: Optional[Organization] = None
+
+
+class ProductSubscriptionEndpoint(ProductSubscription, EntityEndpoint):
+    """Handles the endpoint for a product subscription
+
+    This class is a combination of ProductSubscription and EntityEndpoint. It is used
+    to manage the endpoint for product subscriptions.
+
+    Methods:
+        get_type: Returns the type of the endpoint.
+    """
+
+    def get_type(self) -> str:
+        """Gets the type of the endpoint.
+
+        This method returns the type of the endpoint which is "product_subscriptions".
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "productSubscription"
+
+
+class PageProductSubscription(BaseModel):
+    """
+    A page of product subscriptions
+    """
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        arbitrary_types_allowed=True,
+        protected_namespaces=("model_config",),
+    )
+    total_pages: Optional[int] = Field(None, alias="totalPages")
+    total_elements: Optional[int] = Field(None, alias="totalElements")
+    size: Optional[int] = None
+    content: Optional[List[ProductSubscription]] = None
+    number: Optional[int] = None
+
+    number_of_elements: Optional[int] = Field(None, alias="numberOfElements")
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
+class PageProductSubscriptionEndpoint(PageProductSubscription, PageEndpoint):
+    def get_type(self) -> Optional[str]:
+        return "productSubscription"
+
+
+class ProductSubscriptionsEndpoint(EntitiesEndpoint):
+    """Represents the product subscriptions endpoint
+
+    This class is used to represent the product subscriptions endpoint in the system.
+
+    Attributes:
+        object_dict: A dictionary containing the object data.
+    """
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint
+
+        This method is used to get the type of the endpoint.
+
+        Returns:
+            str: The type of the endpoint.
+        """
+        return "productSubscriptions"
+
+    def get_instance_class(self, object_dict=None):
+        """Get the instance class of the endpoint
+
+        This method is used to get the instance class of the endpoint.
+
+        Args:
+            object_dict (dict, optional): A dictionary containing the object data.
+
+        Returns:
+            ProductSubscriptionEndpoint: The instance class of the endpoint.
+        """
+        return ProductSubscriptionEndpoint
+
+    def get_page_class(self, object_dict=None):
+        """Get the page class of the endpoint
+
+        This method is used to get the page class of the endpoint.
+
+        Args:
+            object_dict (dict, optional): A dictionary containing the object data.
+
+        Returns:
+            PageProductSubscriptionEndpoint: The page class of the endpoint.
+        """
+        return PageProductSubscriptionEndpoint

kodexa/model/model.py

@@ -8,8 +8,8 @@ import os
 import re
 import uuid
 from enum import Enum
-from typing import Any, List, Optional, Dict
-
+from typing import Any, List, Optional
+from addict import Dict
 import deepdiff
 import msgpack
 from pydantic import BaseModel, ConfigDict
@@ -67,6 +67,7 @@ class Ref:
 
 import addict
 
+
 class DocumentMetadata(addict.Dict):
     """A flexible dict based approach to capturing metadata for the document.
 
@@ -114,6 +115,7 @@ class ContentException(dict):
             exception_details: Optional[str] = None,
             node_uuid: Optional[str] = None,
             value: Optional[str] = None,
+            boolean_value: Optional[bool] = None,
             *args,
             **kwargs,
     ):
@@ -128,9 +130,10 @@ class ContentException(dict):
         self.severity = severity
         self.value = value
         self.exception_type_id = exception_type_id
+        self.boolean_value = boolean_value
 
 
-class Tag(dict):
+class Tag(Dict):
     """A class to represent the metadata for a label that is applied as a feature on a content node.
 
     Attributes:
@@ -173,6 +176,8 @@ class Tag(dict):
             **kwargs,
     ):
         super().__init__(*args, **kwargs)
+
+        import uuid as uuid_gen
         self.start: Optional[int] = start
         """The start position (zero indexed) of the content within the node, if None then label is applied to the whole node"""
         self.end: Optional[int] = end
@@ -181,7 +186,7 @@ class Tag(dict):
         """A string representing the value that was labelled in the node"""
         self.data: Optional[Any] = data
         """Any data object (JSON serializable) that you wish to associate with the label"""
-        self.uuid: Optional[str] = uuid or str(uuid.uuid4())
+        self.uuid: Optional[str] = uuid or str(uuid_gen.uuid4())
         """The UUID for this tag instance, this allows tags that are on different content nodes to be related through the same UUID"""
         self.confidence: Optional[float] = confidence
         """The confidence of the tag in a range of 0-1"""
@@ -798,6 +803,7 @@ class ContentNode(object):
         >>> document.get_root().select('//*[hasTag($tagName)]', {"tagName": "div"})
            [ContentNode]
         """
+
         if variables is None:
             variables = {}
         from kodexa.selectors import parse
@@ -2438,6 +2444,19 @@ class Document(object):
                     for node in tag_instance.nodes:
                         node.remove_tag(tag)
 
+    def get_nodes_by_type(self, node_type: str) -> List[ContentNode]:
+        """
+        Get all the nodes of a specific type
+
+        Args:
+          node_type: the type of the node
+
+        Returns:
+          a list of nodes
+
+        """
+        return self._persistence_layer.get_nodes_by_type(node_type)
+
     def get_node_by_uuid(self, uuid: int) -> ContentNode:
         """
         Get a node by its uuid
@@ -2612,7 +2631,7 @@ class Document(object):
         return self
 
     @classmethod
-    def from_text(cls, text, separator=None):
+    def from_text(cls, text, separator=None, inmemory=False):
         """Creates a new Document from the text provided.
 
         Args:
@@ -2623,7 +2642,7 @@ class Document(object):
           the document
 
         """
-        new_document = Document()
+        new_document = Document(inmemory=inmemory)
         new_document.source.original_filename = f"text-{uuid.uuid4()}"
         new_document.content_node = new_document.create_node(node_type="text", index=0)
         if text:
@@ -2939,7 +2958,7 @@ class Document(object):
         )
         fp.write(source)
         fp.close()
-        return Document(kddb_path=fp.name, delete_on_close=True)
+        return Document(kddb_path=fp.name, delete_on_close=True, inmemory=inmemory)
 
     @classmethod
     def from_file(cls, file, unpack: bool = False):