omnata-plugin-runtime 0.5.7a145__tar.gz → 0.5.7a147__tar.gz

{omnata_plugin_runtime-0.5.7a145 → omnata_plugin_runtime-0.5.7a147}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.5.7a145
+Version: 0.5.7a147
 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.7a145 → omnata_plugin_runtime-0.5.7a147}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.5.7-a145"
+version = "0.5.7-a147"
 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.7a145 → omnata_plugin_runtime-0.5.7a147}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -2253,19 +2253,21 @@ class SnowflakeUDTFResultColumn:
     """
     name: str
     data_type: str
-    description: str
+    def __str__(self):
+        return f"{self.name} {self.data_type}"
 
 @dataclass
 class PythonUDTFDefinition:
     """
     The information needed by the plugin uploader to put a Python UDTF definition into the setup script.
-    Do not use this class directly in plugins, instead use the consumer_udtf decorator.
+    Do not use this class directly in plugins, instead use the omnata_udtf decorator.
     """
     name: str
     description: str
     params: List[SnowflakeFunctionParameter]
     result_columns: List[SnowflakeUDTFResultColumn]
     handler: str
+    expose_to_consumer: bool
     packages: Optional[List[str]] = None
 
     def __str__(self):
@@ -2317,13 +2319,14 @@ HANDLER='{self.handler}';
 class PythonUDFDefinition:
     """
     The information needed by the plugin uploader to put a Python UDF definition into the setup script.
-    Do not use this class directly in plugins, instead use the consumer_udf decorator.
+    Do not use this class directly in plugins, instead use the omnata_udf decorator.
     """
     name: str
     description: str
     params: List[SnowflakeFunctionParameter]
     result_data_type: str
     handler: str
+    expose_to_consumer: bool
     packages: Optional[List[str]] = None
 
     def __str__(self):
@@ -2351,6 +2354,7 @@ class JavaUDFDefinition:
     packages: List[str]
     imports: List[str]
     handler: str
+    expose_to_consumer: bool
 
     def __str__(self):
         param_str = ', '.join([str(param) for param in self.params])
@@ -2366,13 +2370,14 @@ IMPORTS = ({imports_str})
 HANDLER='{self.handler}';
 """
 
-def consumer_udtf(
+def omnata_udtf(
         name:str,
         description: str,
         params: List[SnowflakeFunctionParameter],
-        result_columns: List[SnowflakeUDTFResultColumn]):
+        result_columns: List[SnowflakeUDTFResultColumn],
+        expose_to_consumer: bool):
     """
-    A decorator for a class which should be automatically exposed to the consumer as a UDTF
+    A decorator for a class which should create a UDTF in the UDFS schema of the native app
     """
     def class_decorator(cls):
         # Get the original 'process' method from the class
@@ -2420,18 +2425,19 @@ def consumer_udtf(
             return original_process(self, parameters, *args, **kwargs)
         # Replace the original 'process' method with the wrapped version
         setattr(cls, 'process', wrapped_process)
-        cls._is_omnata_consumer_udtf = True
-        cls._omnata_consumer_udtf_name = name
-        cls._omnata_consumer_udtf_description = description
-        cls._omnata_consumer_udtf_params = params
-        cls._omnata_consumer_udtf_result_columns = result_columns
+        cls._is_omnata_udtf = True
+        cls._omnata_udtf_name = name
+        cls._omnata_udtf_description = description
+        cls._omnata_udtf_params = params
+        cls._omnata_udtf_result_columns = result_columns
+        cls._omnata_udtf_expose_to_consumer = expose_to_consumer
         return cls
     
     return class_decorator
 
-def find_consumer_udtf_classes(path:str = '.') -> List[PythonUDTFDefinition | JavaUDTFDefinition]:
+def find_udtf_classes(path:str = '.') -> List[PythonUDTFDefinition | JavaUDTFDefinition]:
     """
-    Finds all classes in the specified directory which have the 'consumer_udtf' decorator applied
+    Finds all classes in the specified directory which have the 'omnata_udtf' decorator applied
     """
     # Get the directory's absolute path
     current_dir = os.path.abspath(path)
@@ -2447,12 +2453,13 @@ def find_consumer_udtf_classes(path:str = '.') -> List[PythonUDTFDefinition | Ja
         # Iterate over all members of the module
         for name, obj in inspect.getmembers(module, inspect.isclass):
             # Check if the class has the specified attribute
-            if hasattr(obj, '_is_omnata_consumer_udtf'):
+            if hasattr(obj, '_is_omnata_udtf'):
                 matching_classes.append(PythonUDTFDefinition(
-                    name=obj._omnata_consumer_udtf_name,
-                    description=obj._omnata_consumer_udtf_description,
-                    params=obj._omnata_consumer_udtf_params,
-                    result_columns=obj._omnata_consumer_udtf_result_columns,
+                    name=obj._omnata_udtf_name,
+                    description=obj._omnata_udtf_description,
+                    params=obj._omnata_udtf_params,
+                    result_columns=obj._omnata_udtf_result_columns,
+                    expose_to_consumer=obj._omnata_udtf_expose_to_consumer,
                     handler=obj.__module__+'.'+obj.__name__
                 ))
             elif isinstance(obj, JavaUDTFDefinition):
@@ -2461,11 +2468,12 @@ def find_consumer_udtf_classes(path:str = '.') -> List[PythonUDTFDefinition | Ja
     return matching_classes
 
 
-def consumer_udf(
+def omnata_udf(
         name: str,
         description: str,
         params: List[SnowflakeFunctionParameter],
-        result_data_type: str):
+        result_data_type: str,
+        expose_to_consumer: bool):
     """
     A decorator for a function which should be automatically exposed to the consumer as a UDF
     """
@@ -2505,18 +2513,19 @@ def consumer_udf(
             # Pass the validated arguments to the function
             return func(parameters, *args, **kwargs)
         
-        wrapper._is_omnata_consumer_udf = True
-        wrapper._omnata_consumer_udf_name = name
-        wrapper._omnata_consumer_udf_description = description
-        wrapper._omnata_consumer_udf_params = params
-        wrapper._omnata_consumer_udf_result_data_type = result_data_type
+        wrapper._is_omnata_udf = True
+        wrapper._omnata_udf_name = name
+        wrapper._omnata_udf_description = description
+        wrapper._omnata_udf_params = params
+        wrapper._omnata_udf_result_data_type = result_data_type
+        wrapper._omnata_udf_expose_to_consumer = expose_to_consumer
         return wrapper
     
     return decorator
 
-def find_consumer_udf_functions(path:str = '.') -> List[PythonUDFDefinition | JavaUDFDefinition]:
+def find_udf_functions(path:str = '.') -> List[PythonUDFDefinition | JavaUDFDefinition]:
     """
-    Finds all functions in the specified directory which have the 'consumer_udf' decorator applied
+    Finds all functions in the specified directory which have the 'omnata_udf' decorator applied
     """
     # Get the current directory's absolute path
     current_dir = os.path.abspath(path)
@@ -2532,12 +2541,13 @@ def find_consumer_udf_functions(path:str = '.') -> List[PythonUDFDefinition | Ja
         # Iterate over all members of the module
         for name, obj in inspect.getmembers(module, inspect.isfunction):
             # Check if the class has the specified attribute
-            if hasattr(obj, '_is_omnata_consumer_udf'):
+            if hasattr(obj, '_is_omnata_udf'):
                 matching_classes.append(PythonUDFDefinition(
-                    name=obj._omnata_consumer_udf_name,
-                    description=obj._omnata_consumer_udf_description,
-                    params=obj._omnata_consumer_udf_params,
-                    result_data_type=obj._omnata_consumer_udf_result_data_type,
+                    name=obj._omnata_udf_name,
+                    description=obj._omnata_udf_description,
+                    params=obj._omnata_udf_params,
+                    result_data_type=obj._omnata_udf_result_data_type,
+                    expose_to_consumer=obj._omnata_udf_expose_to_consumer,
                     packages=[],
                     handler=obj.__module__+'.'+obj.__name__
                 ))