metaflow-stubs 2.12.28__py2.py3-none-any.whl → 2.12.29__py2.py3-none-any.whl

metaflow-stubs/plugins/datatools/s3/s3.pyi

@@ -1,253 +1,27 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.457428                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.565859                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import typing
-    import io
     import metaflow.exception
-    import metaflow.datastore.inputs
-    import metaflow.flowspec
-    import metaflow.metaflow_current
+    import io
     import metaflow.plugins.datatools.s3.s3
 
-TYPE_CHECKING: bool
+from ....flowspec import FlowSpec as FlowSpec
+from ....metaflow_current import current as current
+from ....tuple_util import namedtuple_with_defaults as namedtuple_with_defaults
+from ....exception import MetaflowException as MetaflowException
+from .s3util import get_s3_client as get_s3_client
+from .s3util import read_in_chunks as read_in_chunks
+from .s3util import get_timestamp as get_timestamp
 
-class FlowSpec(object, metaclass=metaflow.flowspec._FlowSpecMeta):
-    """
-    Main class from which all Flows should inherit.
-    
-    Attributes
-    ----------
-    index
-    input
-    """
-    def __init__(self, use_cli = True):
-        """
-        Construct a FlowSpec
-        
-        Parameters
-        ----------
-        use_cli : bool, default True
-            Set to True if the flow is invoked from __main__ or the command line
-        """
-        ...
-    @property
-    def script_name(self) -> str:
-        """
-        [Legacy function - do not use. Use `current` instead]
-        
-        Returns the name of the script containing the flow
-        
-        Returns
-        -------
-        str
-            A string containing the name of the script
-        """
-        ...
-    def __iter__(self):
-        """
-        [Legacy function - do not use]
-        
-        Iterate over all steps in the Flow
-        
-        Returns
-        -------
-        Iterator[graph.DAGNode]
-            Iterator over the steps in the flow
-        """
-        ...
-    def __getattr__(self, name: str):
-        ...
-    def cmd(self, cmdline, input = {}, output = []):
-        """
-        [Legacy function - do not use]
-        """
-        ...
-    @property
-    def index(self) -> typing.Optional[int]:
-        """
-        The index of this foreach branch.
-        
-        In a foreach step, multiple instances of this step (tasks) will be executed,
-        one for each element in the foreach. This property returns the zero based index
-        of the current task. If this is not a foreach step, this returns None.
-        
-        If you need to know the indices of the parent tasks in a nested foreach, use
-        `FlowSpec.foreach_stack`.
-        
-        Returns
-        -------
-        int, optional
-            Index of the task in a foreach step.
-        """
-        ...
-    @property
-    def input(self) -> typing.Optional[typing.Any]:
-        """
-        The value of the foreach artifact in this foreach branch.
-        
-        In a foreach step, multiple instances of this step (tasks) will be executed,
-        one for each element in the foreach. This property returns the element passed
-        to the current task. If this is not a foreach step, this returns None.
-        
-        If you need to know the values of the parent tasks in a nested foreach, use
-        `FlowSpec.foreach_stack`.
-        
-        Returns
-        -------
-        object, optional
-            Input passed to the foreach task.
-        """
-        ...
-    def foreach_stack(self) -> typing.Optional[typing.List[typing.Tuple[int, int, typing.Any]]]:
-        """
-        Returns the current stack of foreach indexes and values for the current step.
-        
-        Use this information to understand what data is being processed in the current
-        foreach branch. For example, considering the following code:
-        ```
-        @step
-        def root(self):
-            self.split_1 = ['a', 'b', 'c']
-            self.next(self.nest_1, foreach='split_1')
-        
-        @step
-        def nest_1(self):
-            self.split_2 = ['d', 'e', 'f', 'g']
-            self.next(self.nest_2, foreach='split_2'):
-        
-        @step
-        def nest_2(self):
-            foo = self.foreach_stack()
-        ```
-        
-        `foo` will take the following values in the various tasks for nest_2:
-        ```
-            [(0, 3, 'a'), (0, 4, 'd')]
-            [(0, 3, 'a'), (1, 4, 'e')]
-            ...
-            [(0, 3, 'a'), (3, 4, 'g')]
-            [(1, 3, 'b'), (0, 4, 'd')]
-            ...
-        ```
-        where each tuple corresponds to:
-        
-        - The index of the task for that level of the loop.
-        - The number of splits for that level of the loop.
-        - The value for that level of the loop.
-        
-        Note that the last tuple returned in a task corresponds to:
-        
-        - 1st element: value returned by `self.index`.
-        - 3rd element: value returned by `self.input`.
-        
-        Returns
-        -------
-        List[Tuple[int, int, Any]]
-            An array describing the current stack of foreach steps.
-        """
-        ...
-    def merge_artifacts(self, inputs: metaflow.datastore.inputs.Inputs, exclude: typing.Optional[typing.List[str]] = None, include: typing.Optional[typing.List[str]] = None):
-        """
-        Helper function for merging artifacts in a join step.
-        
-        This function takes all the artifacts coming from the branches of a
-        join point and assigns them to self in the calling step. Only artifacts
-        not set in the current step are considered. If, for a given artifact, different
-        values are present on the incoming edges, an error will be thrown and the artifacts
-        that conflict will be reported.
-        
-        As a few examples, in the simple graph: A splitting into B and C and joining in D:
-        ```
-        A:
-          self.x = 5
-          self.y = 6
-        B:
-          self.b_var = 1
-          self.x = from_b
-        C:
-          self.x = from_c
-        
-        D:
-          merge_artifacts(inputs)
-        ```
-        In D, the following artifacts are set:
-          - `y` (value: 6), `b_var` (value: 1)
-          - if `from_b` and `from_c` are the same, `x` will be accessible and have value `from_b`
-          - if `from_b` and `from_c` are different, an error will be thrown. To prevent this error,
-            you need to manually set `self.x` in D to a merged value (for example the max) prior to
-            calling `merge_artifacts`.
-        
-        Parameters
-        ----------
-        inputs : Inputs
-            Incoming steps to the join point.
-        exclude : List[str], optional, default None
-            If specified, do not consider merging artifacts with a name in `exclude`.
-            Cannot specify if `include` is also specified.
-        include : List[str], optional, default None
-            If specified, only merge artifacts specified. Cannot specify if `exclude` is
-            also specified.
-        
-        Raises
-        ------
-        MetaflowException
-            This exception is thrown if this is not called in a join step.
-        UnhandledInMergeArtifactsException
-            This exception is thrown in case of unresolved conflicts.
-        MissingInMergeArtifactsException
-            This exception is thrown in case an artifact specified in `include` cannot
-            be found.
-        """
-        ...
-    def next(self, *dsts: typing.Callable[..., None], **kwargs):
-        """
-        Indicates the next step to execute after this step has completed.
-        
-        This statement should appear as the last statement of each step, except
-        the end step.
-        
-        There are several valid formats to specify the next step:
-        
-        - Straight-line connection: `self.next(self.next_step)` where `next_step` is a method in
-          the current class decorated with the `@step` decorator.
-        
-        - Static fan-out connection: `self.next(self.step1, self.step2, ...)` where `stepX` are
-          methods in the current class decorated with the `@step` decorator.
-        
-        - Foreach branch:
-          ```
-          self.next(self.foreach_step, foreach='foreach_iterator')
-          ```
-          In this situation, `foreach_step` is a method in the current class decorated with the
-          `@step` decorator and `foreach_iterator` is a variable name in the current class that
-          evaluates to an iterator. A task will be launched for each value in the iterator and
-          each task will execute the code specified by the step `foreach_step`.
-        
-        Parameters
-        ----------
-        dsts : Callable[..., None]
-            One or more methods annotated with `@step`.
-        
-        Raises
-        ------
-        InvalidNextException
-            Raised if the format of the arguments does not match one of the ones given above.
-        """
-        ...
-    def __str__(self):
-        ...
-    def __getstate__(self):
-        ...
-    ...
-
-current: metaflow.metaflow_current.Current
+TYPE_CHECKING: bool
 
 DATATOOLS_S3ROOT: None
 
@@ -259,28 +33,6 @@ S3_SERVER_SIDE_ENCRYPTION: None
 
 TEMPDIR: str
 
-def namedtuple_with_defaults(typename, field_descr, defaults = ()):
-    ...
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-def get_s3_client(s3_role_arn = None, s3_session_vars = None, s3_client_params = None):
-    ...
-
-def read_in_chunks(dst, src, src_sz, max_chunk_size):
-    ...
-
-def get_timestamp(dt):
-    """
-    Python2 compatible way to compute the timestamp (seconds since 1/1/1970)
-    """
-    ...
-
 TRANSIENT_RETRY_START_LINE: str
 
 TRANSIENT_RETRY_LINE_CONTENT: str
@@ -667,7 +419,7 @@ class S3(object, metaclass=type):
     @classmethod
     def get_root_from_config(cls, echo, create_on_absent = True):
         ...
-    def __enter__(self) -> S3:
+    def __enter__(self) -> "S3":
         ...
     def __exit__(self, *args):
         ...

metaflow-stubs/plugins/datatools/s3/s3tail.pyi

@@ -1,17 +1,14 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.560773                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.643540                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-def aws_retry(f):
-    ...
-
-def get_s3_client(s3_role_arn = None, s3_session_vars = None, s3_client_params = None):
-    ...
+from .s3util import aws_retry as aws_retry
+from .s3util import get_s3_client as get_s3_client
 
 class S3Tail(object, metaclass=type):
     def __init__(self, s3url):

metaflow-stubs/plugins/datatools/s3/s3util.pyi

@@ -1,18 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.491603                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.595119                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ....exception import MetaflowException as MetaflowException
 
 DATATOOLS_CLIENT_PARAMS: dict
 

metaflow-stubs/plugins/debug_logger.pyi

@@ -1,15 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.484879                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.590044                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.event_logger
 
+
 class DebugEventLogger(metaflow.event_logger.NullEventLogger, metaclass=type):
     @classmethod
     def get_worker(cls):

metaflow-stubs/plugins/debug_monitor.pyi

@@ -1,15 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.485150                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.590292                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.monitor
 
+
 class DebugMonitor(metaflow.monitor.NullMonitor, metaclass=type):
     @classmethod
     def get_worker(cls):

metaflow-stubs/plugins/environment_decorator.pyi

@@ -1,15 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.482412                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.584404                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
 
+
 class EnvironmentDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     """
     Specifies environment variables to be set prior to the execution of a step.

metaflow-stubs/plugins/events_decorator.pyi

@@ -1,24 +1,18 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.483892                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.588905                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
-    import metaflow.metaflow_current
 
-current: metaflow.metaflow_current.Current
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ..metaflow_current import current as current
+from ..exception import MetaflowException as MetaflowException
 
 class TriggerDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
     """

metaflow-stubs/plugins/frameworks/__init__.pyi

@@ -1,9 +1,11 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.477952                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.587840                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import pytorch as pytorch
+

metaflow-stubs/plugins/frameworks/pytorch.pyi

@@ -1,55 +1,18 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.499514                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.629221                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.plugins.parallel_decorator
-    import metaflow.metaflow_current
 
-current: metaflow.metaflow_current.Current
-
-class ParallelDecorator(metaflow.decorators.StepDecorator, metaclass=type):
-    """
-    MF Add To Current
-    -----------------
-    parallel -> metaflow.metaflow_current.Parallel
-        Returns a namedtuple with relevant information about the parallel task.
-    
-        @@ Returns
-        -------
-        Parallel
-            `namedtuple` with the following fields:
-                - main_ip (`str`)
-                    The IP address of the control task.
-                - num_nodes (`int`)
-                    The total number of tasks created by @parallel
-                - node_index (`int`)
-                    The index of the current task in all the @parallel tasks.
-                - control_task_id (`Optional[str]`)
-                    The task ID of the control task. Available to all tasks.
-    
-    is_parallel -> bool
-        True if the current step is a @parallel step.
-    """
-    def __init__(self, attributes = None, statically_defined = False):
-        ...
-    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
-        ...
-    def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):
-        ...
-    def task_pre_step(self, step_name, task_datastore, metadata, run_id, task_id, flow, graph, retry_count, max_user_code_retries, ubf_context, inputs):
-        ...
-    def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):
-        ...
-    def setup_distributed_env(self, flow):
-        ...
-    ...
+from ...metaflow_current import current as current
+from ..parallel_decorator import ParallelDecorator as ParallelDecorator
 
 class PytorchParallelDecorator(metaflow.plugins.parallel_decorator.ParallelDecorator, metaclass=type):
     def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):

metaflow-stubs/plugins/gcp/__init__.pyi

@@ -1,12 +1,16 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.484599                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.589173                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-def get_credentials(scopes, *args, **kwargs):
-    ...
+from . import gs_storage_client_factory as gs_storage_client_factory
+from .gs_storage_client_factory import get_credentials as get_credentials
+from . import gs_exceptions as gs_exceptions
+from . import gs_utils as gs_utils
+from . import includefile_support as includefile_support
+from . import gcp_secret_manager_secrets_provider as gcp_secret_manager_secrets_provider
 

metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi

@@ -1,35 +1,22 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.545436                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.630764                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import abc
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.secrets
     import abc
     import metaflow.exception
+    import metaflow.plugins.secrets
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-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.
-        """
-        ...
-    ...
-
-def get_credentials(scopes, *args, **kwargs):
-    ...
+from ...exception import MetaflowException as MetaflowException
+from ..secrets import SecretsProvider as SecretsProvider
+from .gs_storage_client_factory import get_credentials as get_credentials
 
 GCP_SECRET_MANAGER_PREFIX: None
 

metaflow-stubs/plugins/gcp/gs_exceptions.pyi

@@ -1,21 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.544580                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.629638                                                            #
+######################################################################################################
 
 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
 
 class MetaflowGSPackageError(metaflow.exception.MetaflowException, metaclass=type):
     ...