ob-metaflow-stubs 6.0.3.117__py2.py3-none-any.whl → 6.0.3.118__py2.py3-none-any.whl

metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi

@@ -0,0 +1,165 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.905160                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import metaflow
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.runner.deployer
+    import metaflow.plugins.argo.argo_workflows_deployer_objects
+
+from ...client.core import get_metadata as get_metadata
+from ...exception import MetaflowException as MetaflowException
+from .argo_client import ArgoClient as ArgoClient
+from .argo_workflows import ArgoWorkflows as ArgoWorkflows
+from ...runner.deployer import Deployer as Deployer
+from ...runner.deployer import DeployedFlow as DeployedFlow
+from ...runner.deployer import TriggeredRun as TriggeredRun
+from ...runner.utils import get_lower_level_group as get_lower_level_group
+from ...runner.utils import handle_timeout as handle_timeout
+
+KUBERNETES_NAMESPACE: str
+
+def generate_fake_flow_file_contents(flow_name: str, param_info: dict, project_name: typing.Optional[str] = None):
+    ...
+
+class ArgoWorkflowsTriggeredRun(metaflow.runner.deployer.TriggeredRun, metaclass=type):
+    """
+    A class representing a triggered Argo Workflow execution.
+    """
+    def suspend(self, **kwargs) -> bool:
+        """
+        Suspend the running workflow.
+        
+        Parameters
+        ----------
+        authorize : str, optional, default None
+            Authorize the suspension with a production token.
+        
+        Returns
+        -------
+        bool
+            True if the command was successful, False otherwise.
+        """
+        ...
+    def unsuspend(self, **kwargs) -> bool:
+        """
+        Unsuspend the suspended workflow.
+        
+        Parameters
+        ----------
+        authorize : str, optional, default None
+            Authorize the unsuspend with a production token.
+        
+        Returns
+        -------
+        bool
+            True if the command was successful, False otherwise.
+        """
+        ...
+    def terminate(self, **kwargs) -> bool:
+        """
+        Terminate the running workflow.
+        
+        Parameters
+        ----------
+        authorize : str, optional, default None
+            Authorize the termination with a production token.
+        
+        Returns
+        -------
+        bool
+            True if the command was successful, False otherwise.
+        """
+        ...
+    @property
+    def status(self) -> typing.Optional[str]:
+        """
+        Get the status of the triggered run.
+        
+        Returns
+        -------
+        str, optional
+            The status of the workflow considering the run object, or None if
+            the status could not be retrieved.
+        """
+        ...
+    ...
+
+class ArgoWorkflowsDeployedFlow(metaflow.runner.deployer.DeployedFlow, metaclass=metaflow.runner.deployer.DeployedFlowMeta):
+    """
+    A class representing a deployed Argo Workflow template.
+    """
+    @classmethod
+    def from_deployment(cls, identifier: str, metadata: typing.Optional[str] = None):
+        """
+        Retrieves a `ArgoWorkflowsDeployedFlow` object from an identifier and optional
+        metadata.
+        
+        Parameters
+        ----------
+        identifier : str
+            Deployer specific identifier for the workflow to retrieve
+        metadata : str, optional, default None
+            Optional deployer specific metadata.
+        
+        Returns
+        -------
+        ArgoWorkflowsDeployedFlow
+            A `ArgoWorkflowsDeployedFlow` object representing the
+            deployed flow on argo workflows.
+        """
+        ...
+    @property
+    def production_token(self) -> typing.Optional[str]:
+        """
+        Get the production token for the deployed flow.
+        
+        Returns
+        -------
+        str, optional
+            The production token, None if it cannot be retrieved.
+        """
+        ...
+    def delete(self, **kwargs) -> bool:
+        """
+        Delete the deployed workflow template.
+        
+        Parameters
+        ----------
+        authorize : str, optional, default None
+            Authorize the deletion with a production token.
+        
+        Returns
+        -------
+        bool
+            True if the command was successful, False otherwise.
+        """
+        ...
+    def trigger(self, **kwargs) -> ArgoWorkflowsTriggeredRun:
+        """
+        Trigger a new run for the deployed flow.
+        
+        Parameters
+        ----------
+        **kwargs : Any
+            Additional arguments to pass to the trigger command,
+            `Parameters` in particular.
+        
+        Returns
+        -------
+        ArgoWorkflowsTriggeredRun
+            The triggered run instance.
+        
+        Raises
+        ------
+        Exception
+            If there is an error during the trigger process.
+        """
+        ...
+    ...
+

metaflow-stubs/plugins/aws/__init__.pyi

@@ -1,9 +1,15 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.387147                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.864440                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import aws_utils as aws_utils
+from . import step_functions as step_functions
+from . import batch as batch
+from . import aws_client as aws_client
+from . import secrets_manager as secrets_manager
+

metaflow-stubs/plugins/aws/aws_client.pyi

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.419034                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.896266                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 cached_aws_sandbox_creds: None
 
 cached_provider_class: None

metaflow-stubs/plugins/aws/aws_utils.pyi

@@ -1,18 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.418587                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.895540                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ...exception import MetaflowException as MetaflowException
 
 MAX_MEMORY_PER_TASK: None
 

metaflow-stubs/plugins/aws/batch/__init__.pyi

@@ -1,9 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.418819                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.895978                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import batch_client as batch_client
+from . import batch as batch
+from . import batch_decorator as batch_decorator
+

metaflow-stubs/plugins/aws/batch/batch.pyi

@@ -1,46 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.436702                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.908382                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
 
-class S3Tail(object, metaclass=type):
-    def __init__(self, s3url):
-        ...
-    def reset_client(self, hard_reset = False):
-        ...
-    def clone(self, s3url):
-        ...
-    @property
-    def bytes_read(self):
-        ...
-    @property
-    def tail(self):
-        ...
-    def __iter__(self):
-        ...
-    def _make_range_request(self, *args, **kwargs):
-        ...
-    ...
-
-def sanitize_batch_tag(key, value):
-    """
-    Sanitize a key and value for use as a Batch tag.
-    """
-    ...
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ...datatools.s3.s3tail import S3Tail as S3Tail
+from ..aws_utils import sanitize_batch_tag as sanitize_batch_tag
+from ....exception import MetaflowException as MetaflowException
+from .batch_client import BatchClient as BatchClient
 
 OTEL_ENDPOINT: None
 
@@ -68,25 +42,6 @@ S3_SERVER_SIDE_ENCRYPTION: None
 
 BASH_SAVE_LOGS: str
 
-class BatchClient(object, metaclass=type):
-    def __init__(self):
-        ...
-    def active_job_queues(self):
-        ...
-    def unfinished_jobs(self):
-        ...
-    def describe_jobs(self, job_ids):
-        ...
-    def describe_job_queue(self, job_queue):
-        ...
-    def job(self):
-        ...
-    def attach_job(self, job_id):
-        ...
-    def region(self):
-        ...
-    ...
-
 LOGS_DIR: str
 
 STDOUT_FILE: str

metaflow-stubs/plugins/aws/batch/batch_client.pyi

@@ -1,21 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.435737                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.907510                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ....exception import MetaflowException as MetaflowException
 
 AWS_SANDBOX_ENABLED: bool
 

metaflow-stubs/plugins/aws/batch/batch_decorator.pyi

@@ -1,80 +1,25 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.437460                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.908960                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
-    import metaflow.metaflow_current
-    import metaflow.exception
 
-current: metaflow.metaflow_current.Current
-
-class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
-    """
-    Specifies the resources needed when executing this step.
-    
-    Use `@resources` to specify the resource requirements
-    independently of the specific compute layer (`@batch`, `@kubernetes`).
-    
-    You can choose the compute layer on the command line by executing e.g.
-    ```
-    python myflow.py run --with batch
-    ```
-    or
-    ```
-    python myflow.py run --with kubernetes
-    ```
-    which executes the flow on the desired system using the
-    requirements specified in `@resources`.
-    
-    Parameters
-    ----------
-    cpu : int, default 1
-        Number of CPUs required for this step.
-    gpu : int, optional, default None
-        Number of GPUs required for this step.
-    disk : int, optional, default None
-        Disk size (in MB) required for this step. Only applies on Kubernetes.
-    memory : int, default 4096
-        Memory size (in MB) required for this step.
-    shared_memory : int, optional, default None
-        The value for the size (in MiB) of the /dev/shm volume for this step.
-        This parameter maps to the `--shm-size` option in Docker.
-    """
-    ...
-
-def get_run_time_limit_for_task(step_decos):
-    ...
-
-class MetaDatum(tuple, metaclass=type):
-    """
-    MetaDatum(field, value, type, tags)
-    """
-    @staticmethod
-    def __new__(_cls, field, value, type, tags):
-        """
-        Create new instance of MetaDatum(field, value, type, tags)
-        """
-        ...
-    def __repr__(self):
-        """
-        Return a nicely formatted representation string
-        """
-        ...
-    def __getnewargs__(self):
-        """
-        Return self as a plain tuple.  Used by copy and pickle.
-        """
-        ...
-    ...
-
-def sync_local_metadata_to_datastore(metadata_local_dir, task_ds):
-    ...
+from ....metaflow_current import current as current
+from ...resources_decorator import ResourcesDecorator as ResourcesDecorator
+from ...timeout_decorator import get_run_time_limit_for_task as get_run_time_limit_for_task
+from ....metadata_provider.metadata import MetaDatum as MetaDatum
+from ....metadata_provider.util import sync_local_metadata_to_datastore as sync_local_metadata_to_datastore
+from .batch import BatchException as BatchException
+from ..aws_utils import compute_resource_attributes as compute_resource_attributes
+from ..aws_utils import get_docker_registry as get_docker_registry
+from ..aws_utils import get_ec2_instance_metadata as get_ec2_instance_metadata
 
 ECS_S3_ACCESS_IAM_ROLE: None
 
@@ -90,76 +35,6 @@ DATASTORE_LOCAL_DIR: str
 
 UBF_CONTROL: str
 
-class BatchException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-def compute_resource_attributes(decos, compute_deco, step_name, resource_defaults):
-    """
-    Compute resource values taking into account defaults, the values specified
-    in the compute decorator (like @batch or @kubernetes) directly, and
-    resources specified via @resources decorator.
-    
-    Returns a dictionary of resource attr -> value (str).
-    """
-    ...
-
-def get_docker_registry(image_uri):
-    """
-    Explanation:
-        (.+?(?:[:.].+?)\/)? - [GROUP 0] REGISTRY
-            .+?                  - A registry must start with at least one character
-            (?:[:.].+?)\/       - A registry must have ":" or "." and end with "/"
-            ?                    - Make a registry optional
-        (.*?)                - [GROUP 1] REPOSITORY
-            .*?                  - Get repository name until separator
-        (?:[@:])?            - SEPARATOR
-            ?:                   - Don't capture separator
-            [@:]                 - The separator must be either "@" or ":"
-            ?                    - The separator is optional
-        ((?<=[@:]).*)?       - [GROUP 2] TAG / DIGEST
-            (?<=[@:])            - A tag / digest must be preceded by "@" or ":"
-            .*                   - Capture rest of tag / digest
-            ?                    - A tag / digest is optional
-    Examples:
-        image
-            - None
-            - image
-            - None
-        example/image
-            - None
-            - example/image
-            - None
-        example/image:tag
-            - None
-            - example/image
-            - tag
-        example.domain.com/example/image:tag
-            - example.domain.com/
-            - example/image
-            - tag
-        123.123.123.123:123/example/image:tag
-            - 123.123.123.123:123/
-            - example/image
-            - tag
-        example.domain.com/example/image@sha256:45b23dee0
-            - example.domain.com/
-            - example/image
-            - sha256:45b23dee0
-    """
-    ...
-
-def get_ec2_instance_metadata():
-    """
-    Fetches the EC2 instance metadata through AWS instance metadata service
-    
-    Returns either an empty dictionary, or one with the keys
-        - ec2-instance-id
-        - ec2-instance-type
-        - ec2-region
-        - ec2-availability-zone
-    """
-    ...
-
 class BatchDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     """
     Specifies that this step should execute on [AWS Batch](https://aws.amazon.com/batch/).

metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi

@@ -1,9 +1,11 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.419156                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.896465                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import aws_secrets_manager_secrets_provider as aws_secrets_manager_secrets_provider
+

metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi

@@ -1,35 +1,24 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.437901                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.909265                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
+import abc
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.exception
     import metaflow.plugins.secrets
     import abc
-    import metaflow.exception
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ....exception import MetaflowException as MetaflowException
+from ...secrets import SecretsProvider as SecretsProvider
 
 AWS_SECRETS_MANAGER_DEFAULT_REGION: None
 
-class SecretsProvider(abc.ABC, metaclass=abc.ABCMeta):
-    def get_secret_as_dict(self, secret_id, options = {}, role = None) -> typing.Dict[str, str]:
-        """
-        Retrieve the secret from secrets backend, and return a dictionary of
-        environment variables.
-        """
-        ...
-    ...
-
 class MetaflowAWSSecretsManagerBadResponse(metaflow.exception.MetaflowException, metaclass=type):
     """
     Raised when the response from AWS Secrets Manager is not valid in some way

metaflow-stubs/plugins/aws/step_functions/__init__.pyi

@@ -1,9 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.418710                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.895754                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import schedule_decorator as schedule_decorator
+from . import step_functions_deployer as step_functions_deployer
+from . import production_token as production_token
+

metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.431093                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.924243                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 class EventBridgeClient(object, metaclass=type):
     def __init__(self, name):
         ...

metaflow-stubs/plugins/aws/step_functions/production_token.pyi

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.430637                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.905728                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 def new_token(token_prefix, prev_token = None):
     ...