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

metaflow-stubs/metadata/metadata.pyi

@@ -0,0 +1,377 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.998314                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metadata.metadata
+    import metaflow.exception
+
+class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowTaggingError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def validate_tag(tag):
+    """
+    - Tag must be either of bytes-type or unicode-type.
+    - If tag is of bytes-type, it must be UTF-8 decodable
+    - If tag is of unicode-type, it must be UTF-8 encodable
+    - Tag may not be empty string.
+    - Tag cannot be too long (500 chars)
+    """
+    ...
+
+class DataArtifact(tuple, metaclass=type):
+    @staticmethod
+    def __new__(_cls, name, ds_type, ds_root, url, type, sha):
+        """
+        Create new instance of DataArtifact(name, ds_type, ds_root, url, type, sha)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+class MetaDatum(tuple, metaclass=type):
+    @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.
+        """
+        ...
+    ...
+
+class MetadataProviderMeta(type, metaclass=type):
+    @staticmethod
+    def __new__(metaname, classname, bases, attrs):
+        ...
+    def __init__(classobject, classname, bases, attrs):
+        ...
+    @property
+    def INFO(classobject):
+        ...
+    @INFO.setter
+    def INFO(classobject, val):
+        ...
+    ...
+
+def with_metaclass(mcls):
+    ...
+
+class ObjectOrder(object, metaclass=type):
+    @staticmethod
+    def order_to_type(order):
+        ...
+    @staticmethod
+    def type_to_order(obj_type):
+        ...
+    ...
+
+class MetadataProvider(object, metaclass=MetadataProviderMeta):
+    @classmethod
+    def compute_info(cls, val):
+        """
+        Compute the new information for this provider
+        
+        The computed value should be returned and will then be accessible directly as cls.INFO.
+        This information will be printed by the client when describing this metadata provider
+        
+        Parameters
+        ----------
+        val : str
+            Provider specific information used in computing the new information. For example, this
+            can be a path.
+        
+        Returns
+        -------
+        str :
+            Value to be set to INFO
+        """
+        ...
+    @classmethod
+    def default_info(cls):
+        """
+        Returns the default information for this provider
+        
+        This should compute and return the default value for the information regarding this provider.
+        For example, this can compute where the metadata is stored
+        
+        Returns
+        -------
+        str
+            Value to be set by default in INFO
+        """
+        ...
+    def version(self):
+        """
+        Returns the version of this provider
+        
+        Returns
+        -------
+        str
+            Version of the provider
+        """
+        ...
+    def new_run_id(self, tags = None, sys_tags = None):
+        """
+        Creates an ID and registers this new run.
+        
+        The run ID will be unique within a given flow.
+        
+        Parameters
+        ----------
+        tags : list, optional
+            Tags to apply to this particular run, by default None
+        sys_tags : list, optional
+            System tags to apply to this particular run, by default None
+        
+        Returns
+        -------
+        int
+            Run ID for the run
+        """
+        ...
+    def register_run_id(self, run_id, tags = None, sys_tags = None):
+        """
+        No-op operation in this implementation.
+        
+        Parameters
+        ----------
+        run_id : int
+            Run ID for this run
+        tags : list, optional
+            Tags to apply to this particular run, by default None
+        sys_tags : list, optional
+            System tags to apply to this particular run, by default None
+        Returns
+        -------
+        bool
+            True if a new run was registered; False if it already existed
+        """
+        ...
+    def new_task_id(self, run_id, step_name, tags = None, sys_tags = None):
+        """
+        Creates an ID and registers this new task.
+        
+        The task ID will be unique within a flow, run and step
+        
+        Parameters
+        ----------
+        run_id : int
+            ID of the run
+        step_name : string
+            Name of the step
+        tags : list, optional
+            Tags to apply to this particular task, by default None
+        sys_tags : list, optional
+            System tags to apply to this particular task, by default None
+        
+        Returns
+        -------
+        int
+            Task ID for the task
+        """
+        ...
+    def register_task_id(self, run_id, step_name, task_id, attempt = 0, tags = None, sys_tags = None):
+        """
+        No-op operation in this implementation.
+        
+        Parameters
+        ----------
+        run_id : int or convertible to int
+            Run ID for this run
+        step_name : string
+            Name of the step
+        task_id : int
+            Task ID
+        tags : list, optional
+            Tags to apply to this particular run, by default []
+        sys_tags : list, optional
+            System tags to apply to this particular run, by default []
+        Returns
+        -------
+        bool
+            True if a new run was registered; False if it already existed
+        """
+        ...
+    def get_runtime_environment(self, runtime_name):
+        """
+        Returns a dictionary of environment variables to be set
+        
+        Parameters
+        ----------
+        runtime_name : string
+            Name of the runtime for which to get the environment
+        
+        Returns
+        -------
+        dict[string] -> string
+            Environment variables from this metadata provider
+        """
+        ...
+    def register_data_artifacts(self, run_id, step_name, task_id, attempt_id, artifacts):
+        """
+        Registers the fact that the data-artifacts are associated with
+        the particular task.
+        
+        Artifacts produced by a given task can be associated with the
+        task using this call
+        
+        Parameters
+        ----------
+        run_id : int
+            Run ID for the task
+        step_name : string
+            Step name for the task
+        task_id : int
+            Task ID for the task
+        attempt_id : int
+            Attempt for the task
+        artifacts : List of DataArtifact
+            Artifacts associated with this task
+        """
+        ...
+    def register_metadata(self, run_id, step_name, task_id, metadata):
+        """
+        Registers metadata with a task.
+        
+        Note that the same metadata can be registered multiple times for the same task (for example
+        by multiple attempts). Internally, the timestamp of when the registration call is made is
+        also recorded allowing the user to determine the latest value of the metadata.
+        
+        Parameters
+        ----------
+        run_id : int
+            Run ID for the task
+        step_name : string
+            Step name for the task
+        task_id : int
+            Task ID for the task
+        metadata : List of MetaDatum
+            Metadata associated with this task
+        """
+        ...
+    def start_task_heartbeat(self, flow_id, run_id, step_name, task_id):
+        ...
+    def start_run_heartbeat(self, flow_id, run_id):
+        ...
+    def stop_heartbeat(self):
+        ...
+    def add_sticky_tags(self, tags = None, sys_tags = None):
+        """
+        Adds tags to be added to every run and task
+        
+        Tags can be added to record information about a run/task. Such tags can be specified on a
+        per run or task basis using the new_run_id/register_run_id or new_task_id/register_task_id
+        functions but can also be set globally using this function. Tags added here will be
+        added to every run/task created after this call is made.
+        
+        Parameters
+        ----------
+        tags : list, optional
+            Tags to add to every run/task, by default None
+        sys_tags : list, optional
+            System tags to add to every run/task, by default None
+        """
+        ...
+    @classmethod
+    def get_object(cls, obj_type, sub_type, filters, attempt, *args):
+        """
+        Returns the requested object depending on obj_type and sub_type
+        
+        obj_type can be one of 'root', 'flow', 'run', 'step', 'task',
+        or 'artifact'
+        
+        sub_type describes the aggregation required and can be either:
+        'metadata', 'self' or any of obj_type provided that it is slotted below
+        the object itself. For example, if obj_type is 'flow', you can
+        specify 'run' to get all the runs in that flow.
+        A few special rules:
+            - 'metadata' is only allowed for obj_type 'task'
+            - For obj_type 'artifact', only 'self' is allowed
+        A few examples:
+            - To get a list of all flows:
+                - set obj_type to 'root' and sub_type to 'flow'
+            - To get a list of all tasks:
+                - set obj_type to 'root' and sub_type to 'task'
+            - To get a list of all artifacts in a task:
+                - set obj_type to 'task' and sub_type to 'artifact'
+            - To get information about a specific flow:
+                - set obj_type to 'flow' and sub_type to 'self'
+        
+        Parameters
+        ----------
+        obj_type : string
+            One of 'root', 'flow', 'run', 'step', 'task', 'artifact' or 'metadata'
+        sub_type : string
+            Same as obj_type with the addition of 'self'
+        filters : dict
+            Dictionary with keys 'any_tags', 'tags' and 'system_tags'. If specified
+            will return only objects that have the specified tags present. Filters
+            are ANDed together so all tags must be present for the object to be returned.
+        attempt : int or None
+            If None, for metadata and artifacts:
+              - returns information about the latest attempt for artifacts
+              - returns all metadata across all attempts
+            Otherwise, returns information about metadata and artifacts for that
+            attempt only.
+            NOTE: For older versions of Metaflow (pre 2.4.0), the attempt for
+            metadata is not known; in that case, all metadata is returned (as
+            if None was passed in).
+        
+        Return
+        ------
+            object or list :
+                Depending on the call, the type of object return varies
+        """
+        ...
+    @classmethod
+    def mutate_user_tags_for_run(cls, flow_id, run_id, tags_to_remove = None, tags_to_add = None):
+        """
+        Mutate the set of user tags for a run.
+        
+        Removals logically get applied after additions.  Operations occur as a batch atomically.
+        Parameters
+        ----------
+        flow_id : str
+            Flow id, that the run belongs to.
+        run_id: str
+            Run id, together with flow_id, that identifies the specific Run whose tags to mutate
+        tags_to_remove: iterable over str
+            Iterable over tags to remove
+        tags_to_add: iterable over str
+            Iterable over tags to add
+        
+        Return
+        ------
+        Run tags after mutation operations
+        """
+        ...
+    def __init__(self, environment, flow, event_logger, monitor):
+        ...
+    ...
+

metaflow-stubs/metadata/util.pyi

@@ -0,0 +1,18 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.998631                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+def copy_tree(src, dst, update = False):
+    ...
+
+def sync_local_metadata_to_datastore(metadata_local_dir, task_ds):
+    ...
+
+def sync_local_metadata_from_datastore(metadata_local_dir, task_ds):
+    ...
+

metaflow-stubs/metaflow_config.pyi

@@ -0,0 +1,263 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.890695                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+DEFAULT_DATASTORE: str
+
+DEFAULT_ENVIRONMENT: str
+
+DEFAULT_EVENT_LOGGER: str
+
+DEFAULT_METADATA: str
+
+DEFAULT_MONITOR: str
+
+DEFAULT_PACKAGE_SUFFIXES: str
+
+DEFAULT_AWS_CLIENT_PROVIDER: str
+
+DEFAULT_GCP_CLIENT_PROVIDER: str
+
+DEFAULT_SECRETS_BACKEND_TYPE: None
+
+DEFAULT_SECRETS_ROLE: None
+
+USER: None
+
+DATASTORE_LOCAL_DIR: str
+
+DATASTORE_SYSROOT_LOCAL: None
+
+DATASTORE_SYSROOT_S3: None
+
+DATASTORE_SYSROOT_AZURE: None
+
+DATASTORE_SYSROOT_GS: None
+
+CLIENT_CACHE_PATH: str
+
+CLIENT_CACHE_MAX_SIZE: int
+
+CLIENT_CACHE_MAX_FLOWDATASTORE_COUNT: int
+
+CLIENT_CACHE_MAX_TASKDATASTORE_COUNT: int
+
+S3_ENDPOINT_URL: None
+
+S3_VERIFY_CERTIFICATE: None
+
+S3_SERVER_SIDE_ENCRYPTION: None
+
+S3_RETRY_COUNT: int
+
+S3_TRANSIENT_RETRY_COUNT: int
+
+RETRY_WARNING_THRESHOLD: int
+
+DATATOOLS_SUFFIX: str
+
+DATATOOLS_S3ROOT: None
+
+TEMPDIR: str
+
+DATATOOLS_CLIENT_PARAMS: dict
+
+DATATOOLS_SESSION_VARS: dict
+
+DATATOOLS_AZUREROOT: None
+
+DATATOOLS_GSROOT: None
+
+DATATOOLS_LOCALROOT: None
+
+AWS_SECRETS_MANAGER_DEFAULT_REGION: None
+
+ARTIFACT_LOCALROOT: str
+
+CARD_SUFFIX: str
+
+CARD_LOCALROOT: None
+
+CARD_S3ROOT: None
+
+CARD_AZUREROOT: None
+
+CARD_GSROOT: None
+
+CARD_NO_WARNING: bool
+
+SKIP_CARD_DUALWRITE: bool
+
+RUNTIME_CARD_RENDER_INTERVAL: int
+
+AZURE_STORAGE_BLOB_SERVICE_ENDPOINT: None
+
+AZURE_STORAGE_WORKLOAD_TYPE: str
+
+GS_STORAGE_WORKLOAD_TYPE: str
+
+SERVICE_URL: None
+
+SERVICE_RETRY_COUNT: int
+
+SERVICE_AUTH_KEY: None
+
+SERVICE_HEADERS: dict
+
+SERVICE_VERSION_CHECK: bool
+
+DEFAULT_CONTAINER_IMAGE: None
+
+DEFAULT_CONTAINER_REGISTRY: None
+
+INCLUDE_FOREACH_STACK: bool
+
+MAXIMUM_FOREACH_VALUE_CHARS: int
+
+UI_URL: None
+
+CONTACT_INFO: dict
+
+ECS_S3_ACCESS_IAM_ROLE: None
+
+ECS_FARGATE_EXECUTION_ROLE: None
+
+BATCH_JOB_QUEUE: None
+
+BATCH_CONTAINER_IMAGE: None
+
+BATCH_CONTAINER_REGISTRY: None
+
+SERVICE_INTERNAL_URL: None
+
+BATCH_EMIT_TAGS: bool
+
+SFN_IAM_ROLE: None
+
+SFN_DYNAMO_DB_TABLE: None
+
+EVENTS_SFN_ACCESS_IAM_ROLE: None
+
+SFN_STATE_MACHINE_PREFIX: None
+
+SFN_EXECUTION_LOG_GROUP_ARN: None
+
+SFN_S3_DISTRIBUTED_MAP_OUTPUT_PATH: None
+
+KUBERNETES_NAMESPACE: str
+
+KUBERNETES_SERVICE_ACCOUNT: None
+
+KUBERNETES_NODE_SELECTOR: str
+
+KUBERNETES_TOLERATIONS: str
+
+KUBERNETES_PERSISTENT_VOLUME_CLAIMS: str
+
+KUBERNETES_SECRETS: str
+
+KUBERNETES_LABELS: str
+
+KUBERNETES_GPU_VENDOR: str
+
+KUBERNETES_CONTAINER_IMAGE: None
+
+KUBERNETES_IMAGE_PULL_POLICY: None
+
+KUBERNETES_CONTAINER_REGISTRY: None
+
+KUBERNETES_FETCH_EC2_METADATA: bool
+
+KUBERNETES_PORT: None
+
+KUBERNETES_SHARED_MEMORY: None
+
+ARGO_WORKFLOWS_KUBERNETES_SECRETS: str
+
+ARGO_WORKFLOWS_ENV_VARS_TO_SKIP: str
+
+ARGO_EVENTS_SERVICE_ACCOUNT: None
+
+ARGO_EVENTS_EVENT_BUS: str
+
+ARGO_EVENTS_EVENT_SOURCE: None
+
+ARGO_EVENTS_EVENT: None
+
+ARGO_EVENTS_WEBHOOK_URL: None
+
+ARGO_EVENTS_INTERNAL_WEBHOOK_URL: None
+
+ARGO_EVENTS_WEBHOOK_AUTH: str
+
+ARGO_WORKFLOWS_UI_URL: None
+
+AIRFLOW_KUBERNETES_STARTUP_TIMEOUT_SECONDS: int
+
+AIRFLOW_KUBERNETES_CONN_ID: None
+
+AIRFLOW_KUBERNETES_KUBECONFIG_FILE: None
+
+AIRFLOW_KUBERNETES_KUBECONFIG_CONTEXT: None
+
+CONDA_PACKAGE_S3ROOT: None
+
+CONDA_PACKAGE_AZUREROOT: None
+
+CONDA_PACKAGE_GSROOT: None
+
+CONDA_DEPENDENCY_RESOLVER: str
+
+DEBUG_OPTIONS: list
+
+DEBUG_SUBCOMMAND: bool
+
+DEBUG_SIDECAR: bool
+
+DEBUG_S3CLIENT: bool
+
+DEBUG_TRACING: bool
+
+DEBUG_STUBGEN: bool
+
+AWS_SANDBOX_ENABLED: bool
+
+AWS_SANDBOX_STS_ENDPOINT_URL: None
+
+AWS_SANDBOX_API_KEY: None
+
+AWS_SANDBOX_INTERNAL_SERVICE_URL: None
+
+AWS_SANDBOX_REGION: None
+
+KUBERNETES_SANDBOX_INIT_SCRIPT: None
+
+OTEL_ENDPOINT: None
+
+ZIPKIN_ENDPOINT: None
+
+CONSOLE_TRACE_ENABLED: bool
+
+DISABLE_TRACING: bool
+
+MAX_MEMORY_PER_TASK: None
+
+MAX_CPU_PER_TASK: None
+
+MAX_ATTEMPTS: int
+
+def get_pinned_conda_libs(python_version, datastore_type):
+    ...
+