omnata-plugin-runtime 0.5.7a139__tar.gz → 0.5.7a141__tar.gz

{omnata_plugin_runtime-0.5.7a139 → omnata_plugin_runtime-0.5.7a141}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.5.7a139
+Version: 0.5.7a141
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.5.7a139 → omnata_plugin_runtime-0.5.7a141}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.5.7-a139"
+version = "0.5.7-a141"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.5.7a139 → omnata_plugin_runtime-0.5.7a141}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -6,6 +6,7 @@ Includes data container classes and defines the contract for a plugin.
 from __future__ import annotations
 from inspect import signature
 import sys
+from types import FunctionType
 from typing import Union
 if tuple(sys.version_info[:2]) >= (3, 9):
     # Python 3.9 and above
@@ -2232,13 +2233,24 @@ def get_nested_value(nested_dict:Dict, keys:List[str]):
 
 @dataclass
 class SnowflakeFunctionParameter:
+    """
+    Represents a parameter for a Snowflake UDF or UDTF
+    """
     name: str
     description: str
     data_type: str
     default_value_clause: Optional[str] = None
 
+    def __str__(self):
+        if self.default_value_clause:
+            return f"{self.name} {self.data_type} default {self.default_value_clause}"
+        return f"{self.name} {self.data_type}"
+
 @dataclass
 class SnowflakeUDTFResultColumn:
+    """
+    Represents a result column for a Snowflake UDTF
+    """
     name: str
     data_type: str
     description: str
@@ -2248,6 +2260,9 @@ def consumer_udtf(
         description: str,
         params: List[SnowflakeFunctionParameter],
         result_columns: List[SnowflakeUDTFResultColumn]):
+    """
+    A decorator for a class which should be automatically exposed to the consumer as a UDTF
+    """
     def class_decorator(cls):
         # Get the original 'process' method from the class
         original_process = getattr(cls, 'process')
@@ -2303,7 +2318,10 @@ def consumer_udtf(
     
     return class_decorator
 
-def find_consumer_udtf_classes(path:str = '.'):
+def find_consumer_udtf_classes(path:str = '.') -> List[type]:
+    """
+    Finds all classes in the specified directory which have the 'consumer_udtf' decorator applied
+    """
     # Get the directory's absolute path
     current_dir = os.path.abspath(path)
 
@@ -2328,6 +2346,9 @@ def consumer_udf(
         description: str,
         params: List[SnowflakeFunctionParameter],
         result_data_type: str):
+    """
+    A decorator for a function which should be automatically exposed to the consumer as a UDF
+    """
     def decorator(func):
         sig = signature(func)
         function_params = sig.parameters
@@ -2373,7 +2394,10 @@ def consumer_udf(
     
     return decorator
 
-def find_consumer_udf_functions(path:str = '.'):
+def find_consumer_udf_functions(path:str = '.') -> List[function]:
+    """
+    Finds all functions in the specified directory which have the 'consumer_udf' decorator applied
+    """
     # Get the current directory's absolute path
     current_dir = os.path.abspath(path)