kodexa 7.0.1a9987865527__py3-none-any.whl → 7.0.1a11915814268__py3-none-any.whl

kodexa/utils/__init__.py

@@ -0,0 +1,178 @@
+"""
+This module provides a set of functions to manipulate and convert taxonomy objects for use within a data model.
+It includes functions to convert taxonomy names to various naming conventions such as property names, class names,
+and group paths. Additionally, it offers utility functions for string manipulation, like converting snake case strings
+to camel case or title case, making string names safe for use as attribute names, converting strings to hexadecimal
+color codes, estimating the token count of a text, and recursively finding all non-abstract subclasses of a given class.
+"""
+
+import keyword
+import logging
+import re
+from inspect import isabstract
+
+from kodexa.model.objects import Taxon
+
+logger = logging.getLogger(__name__)
+
+
+def taxon_to_property_name(taxon: Taxon):
+    # We need to convert the taxon name to a property name
+    # if the name of the taxon doesn't look like a UUID we will camel case
+    # it otherwise we will camelcase the taxon label
+    safe_property_name = to_snake(safe_name(taxon.label))
+    taxon.external_name = safe_property_name
+    return safe_property_name
+
+
+def taxon_to_class_name(taxon: Taxon):
+    # We need to convert the taxon name to a class name
+    # if the name of the taxon doesn't look like a UUID we will camel case
+    # it otherwise we will camelcase the taxon label
+    safe_class_name = snake_to_camel(safe_name(taxon.label))
+    taxon.external_name = safe_class_name
+    return safe_class_name
+
+
+def taxon_to_group_path(taxon: Taxon):
+    # We need to get the "group_name" from one of the taxons
+    # Which is the first part of the taxon path
+    return taxon.path.split('/')[0]
+
+
+def snake_to_camel(snake_str):
+    components = snake_str.replace(" ", "_").split("_")
+    # We convert first letter of second word to uppercase
+    return components[0].strip().title() + "".join(
+        x.strip().title() for x in components[1:]
+    )
+
+
+def to_snake(base_str):
+    components = base_str.replace(" ", "_").replace("-", "_").split("_")
+
+    # if the base string starts with a number than we add n_ to the start
+    if components[0].isdigit():
+        components[0] = "n_" + components[0]
+
+    # We convert first letter of second word to uppercase
+    return "_".join(x.strip().lower() for x in components)
+
+
+def make_safe_attribute_name(name):
+    # Replace invalid characters (anything not a letter, digit, or underscore) with an underscore
+    safe_name = ''.join(char if char.isalnum() or char == '_' else '_' for char in name)
+
+    # If the name starts with a digit, prepend an underscore
+    if safe_name[0].isdigit():
+        safe_name = '_' + safe_name
+
+    # Append an underscore if the name is a Python keyword
+    if keyword.iskeyword(safe_name):
+        safe_name += '_'
+
+    return safe_name
+
+
+def safe_name(string):
+    """
+    Removes invalid characters from a string, replaces spaces with underscores, removes leading/trailing underscores and hyphens, and makes the string lowercase. If the resulting string
+    * starts with a number, it prefixes it with "n_".
+
+    :param string: The string to be transformed.
+    :return: The transformed string.
+    """
+    # Remove invalid characters
+
+    # trim the string
+    string = string.strip()
+
+    string = re.sub(r"[^\w\s-]", "", string)
+
+    # Replace spaces with underscores
+    string = re.sub(r"\s+", "_", string)
+
+    # Remove leading/trailing underscores and hyphens
+    string = string.strip("_-")
+
+    # Make it lowercase
+    string = string.lower()
+
+    if string[0].isdigit():
+        # can't have things starting with a number
+        string = "n_" + string
+
+    # make sure we don't collide with a python keyword
+    return make_safe_attribute_name(string)
+
+
+def snake_case_to_title_case(snake_case_string):
+    words = snake_case_string.split("_")
+    title_case_words = [word.capitalize() for word in words]
+    return " ".join(title_case_words)
+
+
+def string_to_hex_color(string):
+    # Remove any leading or trailing whitespace from the string
+    string = string.strip()
+
+    # Calculate the hash value of the string
+    hash_value = hash(string)
+
+    # Convert the hash value to a 24-bit hexadecimal color code
+    hex_color = "#{:06x}".format(hash_value & 0xFFFFFF)
+
+    return hex_color
+
+
+def get_is_square_bracket_first(string):
+    first_square_bracket = string.find("[")
+    first_bracket = string.find("{")
+    # Check if both "{" and "[" exist in the string
+    if first_bracket != -1 and first_square_bracket != -1:
+        # Compare their indices to determine which appears first
+        if first_bracket < first_square_bracket:
+            return False
+        else:
+            return True
+    # If only one of them exists, return the one that appears
+    elif first_bracket != -1:
+        return False
+    elif first_square_bracket != -1:
+        return True
+    else:
+        return None
+
+
+def cosine_similarity(v1, v2):
+    """Compute the cosine similarity between two vectors."""
+    dot_product = sum(a * b for a, b in zip(v1, v2))
+    norm_a = sum(a * a for a in v1) ** 0.5
+    norm_b = sum(b * b for b in v2) ** 0.5
+    return dot_product / (norm_a * norm_b)
+
+
+def estimate_token_count(text, avg_token_length=1):
+    # Removing spaces to focus on characters that form tokens
+    char_count = len(text.replace(" ", ""))
+    # Estimating token count
+    estimated_tokens = char_count / avg_token_length
+    return round(estimated_tokens)
+
+
+def get_all_concrete_subclasses(cls):
+    """
+    Recursively find all non-abstract subclasses of a given class.
+
+    Parameters:
+    cls (class): The parent class to find subclasses for.
+
+    Returns:
+    list: A list of all non-abstract subclasses of cls.
+    """
+    concrete_subclasses = []
+    for subclass in cls.__subclasses__():
+        if not isabstract(subclass):
+            concrete_subclasses.append(subclass)
+        concrete_subclasses.extend(get_all_concrete_subclasses(subclass))
+    return concrete_subclasses

{kodexa-7.0.1a9987865527.dist-info → kodexa-7.0.1a11915814268.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 7.0.1a9987865527
+Version: 7.0.1a11915814268
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com
@@ -18,7 +18,7 @@ Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: better-exceptions (>=0.3.3,<0.4.0)
 Requires-Dist: certifi (>=2024.7.4,<2025.0.0)
 Requires-Dist: chevron (>=0.14.0,<0.15.0)
-Requires-Dist: deepdiff (>=7.0.1,<8.0.0)
+Requires-Dist: deepdiff (>=8.0.1,<9.0.0)
 Requires-Dist: msgpack (>=1.0.6,<2.0.0)
 Requires-Dist: ply (>=3.11,<4.0)
 Requires-Dist: pydantic (>=2.5.3,<3.0.0)
@@ -28,7 +28,7 @@ Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: pyyaml (>=6.0,<7.0)
 Requires-Dist: requests (>=2.28.1,<3.0.0)
 Requires-Dist: semver (>=3.0.1,<4.0.0)
-Requires-Dist: simpleeval (>=0.9.13,<0.10.0)
+Requires-Dist: simpleeval (>=1.0.0,<2.0.0)
 Requires-Dist: urllib3 (>=2.0.0,<3.0.0)
 Description-Content-Type: text/markdown
 
@@ -66,7 +66,7 @@ working with a Kodexa platform instance.
 
 ## Documentation & Examples
 
-Documentation is available at the [Kodexa Documentation Portal](https://docs.kodexa.com)
+Documentation is available at the [Kodexa Support Portal](https://support.kodexa.ai)
 
 ## Set-up
 

{kodexa-7.0.1a9987865527.dist-info → kodexa-7.0.1a11915814268.dist-info}/RECORD

@@ -3,21 +3,23 @@ kodexa/assistant/__init__.py,sha256=nlXm_YnV_50hgn0TIT2Fkc2fQ-86OjmctY_j8My9nc4,
 kodexa/assistant/assistant.py,sha256=5KFdbqFSLIZJyDRyZdpcfr448fT-CW4JhYu9A6B9DGY,14663
 kodexa/connectors/__init__.py,sha256=WF6G_MUeU32TlKSUKkpNoNX7dq8iBPliFMep4E8BmZc,328
 kodexa/connectors/connectors.py,sha256=FpUZDkSyHld2b9eYRuVOWzaFtuGoaRuPXXicJB7THbc,10413
+kodexa/dataclasses/__init__.py,sha256=DKLWMALnUWYFDMraEc9We85GI_rvpp-z7Q1fKX-3jQI,18561
+kodexa/dataclasses/templates/llm_data_class.j2,sha256=YWjStW136chV_59JM3AYis3i-0jdrqDvLXsISUW9zDU,660
 kodexa/model/__init__.py,sha256=rtLXYJBxB-rnukhslN9rlqoB3--1H3253HyHGbD_Gc8,796
 kodexa/model/base.py,sha256=CaZK8nMhT1LdCpt4aLhebJGcorjq9qRID1FjnXnP14M,521
 kodexa/model/entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kodexa/model/entities/check_response.py,sha256=eqBHxO6G2OAziL3p9bHGI-oiPkAG82H6Choc8wyvtM4,3949
 kodexa/model/entities/product.py,sha256=ZDpHuBE_9FJ-klnkyBvTfPwYOqBkM1wraZMtHqNA8FQ,3526
 kodexa/model/entities/product_subscription.py,sha256=UcmWR-qgLfdV7VCtJNwzgkanoS8nBSL6ngVuxQUK1M8,3810
-kodexa/model/model.py,sha256=BURhrOEVTTlKkDJho5CEFeLR9Dyq157mztlvbAdL1d4,115769
-kodexa/model/objects.py,sha256=EPTqjlSF2yH8YhM0d3mmwJwwEQRZaFXG8ssznEHxU-s,176702
-kodexa/model/persistence.py,sha256=sx5FwTSsWMdAZpAs0-6PqyULHkQyNQClApUKJZ-ly8M,62032
+kodexa/model/model.py,sha256=wY5HnpsAnKlH_aDEHWNf-ZrhdrBg-DtqGFszjkdZtPU,118340
+kodexa/model/objects.py,sha256=CE76KwQwIT6FdWJuac8aIumX_Ok6-9oq1JXz0K_gdwo,185117
+kodexa/model/persistence.py,sha256=PTh9jmqYCDuWfiuCssLttFaYWiMA_fCiwjgsYDW4AhE,68281
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=ZYpJAWcwV4YRK589DUhU0vXGQlkNSj4J2TsGbYqTLjo,25221
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=GCOlFN7BgnCDEg4MNiLgDmSCHGglWdMeCrQQH6y2_oM,222182
+kodexa/platform/client.py,sha256=PWn-Xk3vH993Ne5YXDKqJT9rmj7okwVBivuQv9rt2UQ,226591
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
-kodexa/platform/kodexa.py,sha256=Bvf6x43FWsFuAuQ4N8TvjSZq6niEtBTESmFCWVPASeQ,34024
+kodexa/platform/kodexa.py,sha256=3qRbEtLOw4yl7OV5ISZZ85N9gKeb5DA4XtHzieFIdYc,34796
 kodexa/selectors/__init__.py,sha256=xA9-4vpyaAZWPSk3bh2kvDLkdv6XEmm7PjFbpziiTIk,100
 kodexa/selectors/ast.py,sha256=gG-1st841IntgBE5V7p3Cq9azaym2jV5lB_AIywQTCI,13269
 kodexa/selectors/core.py,sha256=kkt02DN20gXeaDGoGubPPeeTV7rCr4sxTyELrI0l1YU,3691
@@ -39,7 +41,8 @@ kodexa/testing/test_components.py,sha256=g5lP-GY0nTHuH5cIEw45vIejEeBaWkPKQGHL36j
 kodexa/testing/test_utils.py,sha256=DrLCkHxdb6AbZ-X3WmTMbQmnVIm55VEBL8MjtUK9POs,14021
 kodexa/training/__init__.py,sha256=xs2L62YpRkIRfslQwtQZ5Yxjhm7sLzX2TrVX6EuBnZQ,52
 kodexa/training/train_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kodexa-7.0.1a9987865527.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.0.1a9987865527.dist-info/METADATA,sha256=jFlJvhkVVyHXGha9WaOdJoSV4SWR-Gzl2YXE58cmUHA,3534
-kodexa-7.0.1a9987865527.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.0.1a9987865527.dist-info/RECORD,,
+kodexa/utils/__init__.py,sha256=Pnim1o9_db5YEnNvDTxpM7HG-qTlL6n8JwFwOafU9wo,5928
+kodexa-7.0.1a11915814268.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.0.1a11915814268.dist-info/METADATA,sha256=84lOTb7ed43y_Zb9Mo1WRZOR16ygEad2lj5MY1hdk_w,3529
+kodexa-7.0.1a11915814268.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.0.1a11915814268.dist-info/RECORD,,