ob-metaflow-stubs 2.11.4.1__py2.py3-none-any.whl

metaflow-stubs/plugins/airflow/sensors/__init__.pyi

@@ -0,0 +1,26 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.985004                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.airflow.sensors.base_sensor
+
+class ExternalTaskSensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    def serialize_operator_args(self):
+        ...
+    def validate(self):
+        ...
+    ...
+
+class S3KeySensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    def validate(self):
+        ...
+    ...
+
+SUPPORTED_SENSORS: list
+

metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi

@@ -0,0 +1,60 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.012744                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+    import metaflow.exception
+
+class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class AirflowTask(object, metaclass=type):
+    def __init__(self, name, operator_type = "kubernetes", flow_name = None, is_mapper_node = False, flow_contains_foreach = False):
+        ...
+    @property
+    def is_mapper_node(self):
+        ...
+    def set_operator_args(self, **kwargs):
+        ...
+    def to_dict(self):
+        ...
+    @classmethod
+    def from_dict(cls, task_dict, flow_name = None, flow_contains_foreach = False):
+        ...
+    def to_task(self):
+        ...
+    ...
+
+def id_creator(val, hash_len):
+    ...
+
+TASK_ID_HASH_LEN: int
+
+class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def serialize_operator_args(self):
+        """
+        Subclasses will parse the decorator arguments to
+        Airflow task serializable arguments.
+        """
+        ...
+    def create_task(self):
+        ...
+    def validate(self):
+        """
+        Validate if the arguments for the sensor are correct.
+        """
+        ...
+    def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    ...
+

metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi

@@ -0,0 +1,54 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.013288                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.airflow.sensors.base_sensor
+    import metaflow.decorators
+    import metaflow.exception
+
+class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def serialize_operator_args(self):
+        """
+        Subclasses will parse the decorator arguments to
+        Airflow task serializable arguments.
+        """
+        ...
+    def create_task(self):
+        ...
+    def validate(self):
+        """
+        Validate if the arguments for the sensor are correct.
+        """
+        ...
+    def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    ...
+
+class SensorNames(object, metaclass=type):
+    @classmethod
+    def get_supported_sensors(cls):
+        ...
+    ...
+
+class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+AIRFLOW_STATES: dict
+
+class ExternalTaskSensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    def serialize_operator_args(self):
+        ...
+    def validate(self):
+        ...
+    ...
+

metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi

@@ -0,0 +1,50 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.013759                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.airflow.sensors.base_sensor
+    import metaflow.decorators
+    import metaflow.exception
+
+class AirflowSensorDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def serialize_operator_args(self):
+        """
+        Subclasses will parse the decorator arguments to
+        Airflow task serializable arguments.
+        """
+        ...
+    def create_task(self):
+        ...
+    def validate(self):
+        """
+        Validate if the arguments for the sensor are correct.
+        """
+        ...
+    def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    ...
+
+class SensorNames(object, metaclass=type):
+    @classmethod
+    def get_supported_sensors(cls):
+        ...
+    ...
+
+class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class S3KeySensorDecorator(metaflow.plugins.airflow.sensors.base_sensor.AirflowSensorDecorator, metaclass=type):
+    def validate(self):
+        ...
+    ...
+

metaflow-stubs/plugins/argo/__init__.pyi

@@ -0,0 +1,9 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.929086                                        #
+##################################################################################
+
+from __future__ import annotations
+
+

metaflow-stubs/plugins/argo/argo_client.pyi

@@ -0,0 +1,77 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.962663                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class KubernetesClient(object, metaclass=type):
+    def __init__(self):
+        ...
+    def get(self):
+        ...
+    def job(self, **kwargs):
+        ...
+    ...
+
+class ArgoClientException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class ArgoClient(object, metaclass=type):
+    def __init__(self, namespace = None):
+        ...
+    def get_workflow(self, name):
+        ...
+    def get_workflow_template(self, name):
+        ...
+    def get_workflow_templates(self):
+        ...
+    def register_workflow_template(self, name, workflow_template):
+        ...
+    def delete_cronworkflow(self, name):
+        """
+        Issues an API call for deleting a cronworkflow
+        
+        Returns either the successful API response, or None in case the resource was not found.
+        """
+        ...
+    def delete_workflow_template(self, name):
+        """
+        Issues an API call for deleting a cronworkflow
+        
+        Returns either the successful API response, or None in case the resource was not found.
+        """
+        ...
+    def terminate_workflow(self, name):
+        ...
+    def suspend_workflow(self, name):
+        ...
+    def unsuspend_workflow(self, name):
+        ...
+    def trigger_workflow_template(self, name, parameters = {}):
+        ...
+    def schedule_workflow_template(self, name, schedule = None, timezone = None):
+        ...
+    def register_sensor(self, name, sensor = None):
+        ...
+    def delete_sensor(self, name):
+        """
+        Issues an API call for deleting a sensor
+        
+        Returns either the successful API response, or None in case the resource was not found.
+        """
+        ...
+    ...
+

metaflow-stubs/plugins/argo/argo_events.pyi

@@ -0,0 +1,79 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.960714                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+ARGO_EVENTS_WEBHOOK_AUTH: str
+
+ARGO_EVENTS_WEBHOOK_URL: None
+
+SERVICE_HEADERS: dict
+
+class ArgoEventException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class ArgoEvent(object, metaclass=type):
+    def __init__(self, name, url = None, payload = None, access_token = None):
+        ...
+    def add_to_payload(self, key, value):
+        """
+        Add a key-value pair in the payload. This is typically used to set parameters
+        of triggered flows. Often, `key` is the parameter name you want to set to
+        `value`. Overrides any existing value of `key`.
+        
+        Parameters
+        ----------
+        key : str
+            Key
+        value : str
+            Value
+        """
+        ...
+    def safe_publish(self, payload = None, ignore_errors = True):
+        """
+        Publishes an event when called inside a deployed workflow. Outside a deployed workflow
+        this function does nothing.
+        
+        Use this function inside flows to create events safely. As this function is a no-op
+        for local runs, you can safely call it during local development without causing unintended
+        side-effects. It takes effect only when deployed on Argo Workflows.
+        
+        Parameters
+        ----------
+        payload : dict
+            Additional key-value pairs to add to the payload.
+        ignore_errors : bool, default True
+            If True, events are created on a best effort basis - errors are silently ignored.
+        """
+        ...
+    def publish(self, payload = None, force = True, ignore_errors = True):
+        """
+        Publishes an event.
+        
+        Note that the function returns immediately after the event has been sent. It
+        does not wait for flows to start, nor it guarantees that any flows will start.
+        
+        Parameters
+        ----------
+        payload : dict
+            Additional key-value pairs to add to the payload.
+        ignore_errors : bool, default True
+            If True, events are created on a best effort basis - errors are silently ignored.
+        """
+        ...
+    ...
+