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

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

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.5.7-a140"
+version = "0.5.7-a145"
 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.7a140 → omnata_plugin_runtime-0.5.7a145}/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
@@ -2254,6 +2255,117 @@ class SnowflakeUDTFResultColumn:
     data_type: str
     description: str
 
+@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.
+    """
+    name: str
+    description: str
+    params: List[SnowflakeFunctionParameter]
+    result_columns: List[SnowflakeUDTFResultColumn]
+    handler: str
+    packages: Optional[List[str]] = None
+
+    def __str__(self):
+        param_str = ', '.join([str(param) for param in self.params])
+        table_result_columns = ', '.join([f"{col.name} {col.data_type}" for col in self.result_columns])
+        packages_str = ', '.join([f"'{p}'" for p in self.packages])
+        return f"""CREATE OR REPLACE FUNCTION UDFS.{self.name}({param_str})
+RETURNS TABLE({table_result_columns})
+LANGUAGE PYTHON
+RUNTIME_VERSION=3.10
+COMMENT = $${self.description}$$
+PACKAGES = ({packages_str})
+IMPORTS = ('/app.zip')
+HANDLER='{self.handler}';
+"""
+    
+@dataclass
+class JavaUDTFDefinition:
+    """
+    The information needed by the plugin uploader to put a Java UDTF definition into the setup script.
+    These are created directly in python, since we don't want the omnata cli to need to do any Java reflection.
+    Any .jar files placed in the udf_direct_imports directory will be uploaded to the stage and can be
+    added to the imports parameter as (e.g.) '/my_jar.jar'.
+    """
+    name: str
+    description: str
+    params: List[SnowflakeFunctionParameter]
+    result_columns: List[SnowflakeUDTFResultColumn]
+    packages: List[str]
+    imports: List[str]
+    handler: str
+
+    def __str__(self):
+        param_str = ', '.join([str(param) for param in self.params])
+        table_result_columns = ', '.join([f"{col.name} {col.data_type}" for col in self.result_columns])
+        packages_str = ', '.join([f"'{p}'" for p in self.packages])
+        imports_str = ', '.join([f"'{i}'" for i in self.imports])
+        return f"""CREATE OR REPLACE FUNCTION UDFS.{self.name}({param_str})
+RETURNS TABLE({table_result_columns})
+LANGUAGE PYTHON
+RUNTIME_VERSION=3.10
+COMMENT = $${self.description}$$
+PACKAGES = ({packages_str})
+IMPORTS = ({imports_str})
+HANDLER='{self.handler}';
+"""
+
+@dataclass
+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.
+    """
+    name: str
+    description: str
+    params: List[SnowflakeFunctionParameter]
+    result_data_type: str
+    handler: str
+    packages: Optional[List[str]] = None
+
+    def __str__(self):
+        param_str = ', '.join([str(param) for param in self.params])
+        packages_str = ', '.join([f"'{p}'" for p in self.packages])
+        return f"""CREATE OR REPLACE FUNCTION UDFS.{self.name}({param_str})
+RETURNS {self.result_data_type}
+LANGUAGE PYTHON
+RUNTIME_VERSION=3.10
+COMMENT = $${self.description}$$
+PACKAGES = ({packages_str})
+IMPORTS = ('/app.zip')
+HANDLER='{self.handler}';
+"""
+
+@dataclass
+class JavaUDFDefinition:
+    """
+    The information needed by the plugin uploader to put a java UDF definition into the setup script.
+    """
+    name: str
+    description: str
+    params: List[SnowflakeFunctionParameter]
+    result_data_type: str
+    packages: List[str]
+    imports: List[str]
+    handler: str
+
+    def __str__(self):
+        param_str = ', '.join([str(param) for param in self.params])
+        packages_str = ', '.join([f"'{p}'" for p in self.packages])
+        imports_str = ', '.join([f"'{i}'" for i in self.imports])
+        return f"""CREATE OR REPLACE FUNCTION UDFS.{self.name}({param_str})
+RETURNS {self.result_data_type}
+LANGUAGE PYTHON
+RUNTIME_VERSION=3.10
+COMMENT = $${self.description}$$
+PACKAGES = ({packages_str})
+IMPORTS = ({imports_str})
+HANDLER='{self.handler}';
+"""
+
 def consumer_udtf(
         name:str,
         description: str,
@@ -2317,7 +2429,7 @@ def consumer_udtf(
     
     return class_decorator
 
-def find_consumer_udtf_classes(path:str = '.'):
+def find_consumer_udtf_classes(path:str = '.') -> List[PythonUDTFDefinition | JavaUDTFDefinition]:
     """
     Finds all classes in the specified directory which have the 'consumer_udtf' decorator applied
     """
@@ -2336,7 +2448,16 @@ def find_consumer_udtf_classes(path:str = '.'):
         for name, obj in inspect.getmembers(module, inspect.isclass):
             # Check if the class has the specified attribute
             if hasattr(obj, '_is_omnata_consumer_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,
+                    handler=obj.__module__+'.'+obj.__name__
+                ))
+            elif isinstance(obj, JavaUDTFDefinition):
                 matching_classes.append(obj)
+            
     return matching_classes
 
 
@@ -2393,7 +2514,7 @@ def consumer_udf(
     
     return decorator
 
-def find_consumer_udf_functions(path:str = '.'):
+def find_consumer_udf_functions(path:str = '.') -> List[PythonUDFDefinition | JavaUDFDefinition]:
     """
     Finds all functions in the specified directory which have the 'consumer_udf' decorator applied
     """
@@ -2412,6 +2533,15 @@ def find_consumer_udf_functions(path:str = '.'):
         for name, obj in inspect.getmembers(module, inspect.isfunction):
             # Check if the class has the specified attribute
             if hasattr(obj, '_is_omnata_consumer_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,
+                    packages=[],
+                    handler=obj.__module__+'.'+obj.__name__
+                ))
+            elif isinstance(obj, JavaUDFDefinition):
                 matching_classes.append(obj)
 
     return matching_classes