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

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

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

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

@@ -2255,13 +2255,128 @@ class SnowflakeUDTFResultColumn:
     data_type: str
     description: str
 
-def consumer_udtf(
+@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 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):
+        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 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):
+        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
+    expose_to_consumer: bool
+
+    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 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
@@ -2309,18 +2424,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[type]:
+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)
@@ -2336,16 +2452,27 @@ def find_consumer_udtf_classes(path:str = '.') -> List[type]:
         # 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_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):
                 matching_classes.append(obj)
+            
     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
     """
@@ -2385,18 +2512,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[function]:
+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)
@@ -2412,7 +2540,17 @@ def find_consumer_udf_functions(path:str = '.') -> List[function]:
         # 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_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__
+                ))
+            elif isinstance(obj, JavaUDFDefinition):
                 matching_classes.append(obj)
 
     return matching_classes