ob-metaflow-stubs 6.0.3.186__py2.py3-none-any.whl → 6.0.3.188rc0__py2.py3-none-any.whl

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/app_config.pyi

@@ -0,0 +1,98 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.332432                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+
+from .cli_to_config import build_config_from_options as build_config_from_options
+
+CODE_PACKAGE_PREFIX: str
+
+CAPSULE_DEBUG: bool
+
+class classproperty(property, metaclass=type):
+    def __get__(self, owner_self, owner_cls):
+        ...
+    ...
+
+class AppConfigError(Exception, metaclass=type):
+    """
+    Exception raised when app configuration is invalid.
+    """
+    ...
+
+class AuthType(object, metaclass=type):
+    @classmethod
+    def enums(cls):
+        ...
+    @property
+    def default(cls):
+        ...
+    ...
+
+class AppConfig(object, metaclass=type):
+    """
+    Class representing an Outerbounds App configuration.
+    """
+    def __init__(self, config_dict: typing.Dict[str, typing.Any]):
+        """
+        Initialize configuration from a dictionary.
+        """
+        ...
+    def set_state(self, key, value):
+        ...
+    def get_state(self, key, default = None):
+        ...
+    def dump_state(self):
+        ...
+    def get(self, key: str, default: typing.Any = None) -> typing.Any:
+        """
+        Get a configuration value by key.
+        """
+        ...
+    def validate(self):
+        """
+        Validate the configuration against the schema.
+        """
+        ...
+    def set_deploy_defaults(self, packaging_directory: str):
+        """
+        Set default values for fields that are not provided.
+        """
+        ...
+    def to_dict(self) -> typing.Dict[str, typing.Any]:
+        """
+        Return the configuration as a dictionary.
+        """
+        ...
+    def to_yaml(self) -> str:
+        """
+        Return the configuration as a YAML string.
+        """
+        ...
+    def to_json(self) -> str:
+        """
+        Return the configuration as a JSON string.
+        """
+        ...
+    @classmethod
+    def from_file(cls, file_path: str) -> "AppConfig":
+        """
+        Create a configuration from a file.
+        """
+        ...
+    def update_from_cli_options(self, options):
+        """
+        Update configuration from CLI options using the same logic as build_config_from_options.
+        This ensures consistent handling of CLI options whether they come from a config file
+        or direct CLI input.
+        """
+        ...
+    ...
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/capsule.pyi

@@ -0,0 +1,233 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.336079                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core._state_machine
+    import typing
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.capsule
+
+from .utils import TODOException as TODOException
+from .utils import safe_requests_wrapper as safe_requests_wrapper
+from .utils import MaximumRetriesExceeded as MaximumRetriesExceeded
+from .app_config import AppConfig as AppConfig
+from .app_config import AuthType as AuthType
+from . import experimental as experimental
+from ._state_machine import CapsuleWorkerSemanticStatus as CapsuleWorkerSemanticStatus
+from ._state_machine import WorkerStatus as WorkerStatus
+from ._state_machine import CapsuleStatus as CapsuleStatus
+from ._state_machine import DEPLOYMENT_READY_CONDITIONS as DEPLOYMENT_READY_CONDITIONS
+
+CAPSULE_DEBUG: bool
+
+class CapsuleStateMachine(object, metaclass=type):
+    """
+    - Every capsule create call will return a `identifier` and a `version` of the object.
+    - Each update call will return a new version.
+    - The status.currentlyServedVersion will be the version that is currently serving traffic.
+    - The status.updateInProgress will be True if an upgrade is in progress.
+    
+    CapsuleState Transition:
+    - Every capsule create call will return a `identifier` and a `version` of the object.
+    - Happy Path:
+        - First time Create :
+            - wait for status.updateInProgress to be set to False
+                - (interleved) Poll the worker endpoints to check their status
+                    - showcase how many workers are coming up if things are on the cli side.
+                - If the user has set some flag like `--dont-wait-to-fully-finish` then we check the `status.currentlyServedVersion` to see if even one replica is ready to
+                serve traffic.
+            - once the status.updateInProgress is set to False, it means that the replicas are ready
+        - Upgrade:
+            - wait for status.updateInProgress to be set to False
+                - (interleved) Poll the worker endpoints to check their status and signal the user the number replicas coming up
+                - If the user has set some flag like `--dont-wait-to-fully-finish` then we check the `status.currentlyServedVersion` to see if even one replica is ready to
+                serve traffic.
+    - Unhappy Path:
+        - First time Create :
+            - wait for status.updateInProgress to be set to False,
+                - (interleved) Poll the workers to check their status.
+                    - If the worker pertaining the current deployment instance version is crashlooping then crash the deployment process with the error messages and logs.
+        - Upgrade:
+            - wait for status.updateInProgress to be set to False,
+                - (interleved) Poll the workers to check their status.
+                    - If the worker pertaining the current deployment instance version is crashlooping then crash the deployment process with the error messages and logs.
+    """
+    def __init__(self, capsule_id: str, current_deployment_instance_version: str):
+        ...
+    def get_status_trail(self):
+        ...
+    def add_status(self, status: metaflow.mf_extensions.outerbounds.plugins.apps.core._state_machine.CapsuleStatus):
+        ...
+    @property
+    def current_status(self):
+        ...
+    @property
+    def out_of_cluster_url(self):
+        ...
+    @property
+    def in_cluster_url(self):
+        ...
+    @property
+    def update_in_progress(self):
+        ...
+    @property
+    def currently_served_version(self):
+        ...
+    @property
+    def ready_to_serve_traffic(self):
+        ...
+    @property
+    def available_replicas(self):
+        ...
+    def report_current_status(self, logger):
+        ...
+    def save_debug_info(self, state_dir: str):
+        ...
+    ...
+
+class CapsuleWorkersStateMachine(object, metaclass=type):
+    def __init__(self, capsule_id: str, end_state_capsule_version: str, deployment_mode: str = 'at_least_one_running', minimum_replicas: int = 1):
+        ...
+    def get_status_trail(self):
+        ...
+    def add_status(self, worker_list_response: typing.List[metaflow.mf_extensions.outerbounds.plugins.apps.core._state_machine.WorkerStatus]):
+        """
+        worker_list_response: List[Dict[str, Any]]
+            [
+                {
+                    "workerId": "c-4pqikm-659dd9ccdc-5hcwz",
+                    "phase": "Running",
+                    "activity": 0,
+                    "activityDataAvailable": false,
+                    "version": "0xhgaewiqb"
+                },
+                {
+                    "workerId": "c-4pqikm-b8559688b-xk2jh",
+                    "phase": "Pending",
+                    "activity": 0,
+                    "activityDataAvailable": false,
+                    "version": "421h48qh95"
+                }
+            ]
+        """
+        ...
+    def save_debug_info(self, state_dir: str):
+        ...
+    def report_current_status(self, logger):
+        ...
+    @property
+    def current_status(self) -> typing.List[metaflow.mf_extensions.outerbounds.plugins.apps.core._state_machine.WorkerStatus]:
+        ...
+    def current_version_deployment_status(self) -> metaflow.mf_extensions.outerbounds.plugins.apps.core._state_machine.CapsuleWorkerSemanticStatus:
+        ...
+    @property
+    def is_crashlooping(self) -> bool:
+        ...
+    ...
+
+class CapsuleInput(object, metaclass=type):
+    @classmethod
+    def construct_exec_command(cls, commands: list):
+        ...
+    @classmethod
+    def from_app_config(self, app_config: metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config.AppConfig):
+        ...
+    ...
+
+class CapsuleApiException(Exception, metaclass=type):
+    def __init__(self, url: str, method: str, status_code: int, text: str, message: typing.Optional[str] = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class CapsuleDeploymentException(Exception, metaclass=type):
+    def __init__(self, capsule_id: str, message: str):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class CapsuleApi(object, metaclass=type):
+    def __init__(self, base_url: str, perimeter: str, logger_fn = None):
+        ...
+    def create(self, capsule_input: dict):
+        ...
+    def get(self, capsule_id: str):
+        ...
+    def list(self):
+        ...
+    def delete(self, capsule_id: str):
+        ...
+    def get_workers(self, capsule_id: str) -> typing.List[typing.Dict[str, typing.Any]]:
+        ...
+    def logs(self, capsule_id: str, worker_id: str, previous: bool = False) -> typing.List[str]:
+        ...
+    ...
+
+def list_and_filter_capsules(capsule_api: CapsuleApi, project, branch, name, tags, auth_type, capsule_id):
+    ...
+
+class CapsuleInfo(tuple, metaclass=type):
+    """
+    CapsuleInfo(info, workers)
+    """
+    @staticmethod
+    def __new__(_cls, info, workers):
+        """
+        Create new instance of CapsuleInfo(info, workers)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+class CapsuleDeployer(object, metaclass=type):
+    def __init__(self, app_config: metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config.AppConfig, base_url: str, create_timeout: int = 300, debug_dir: typing.Optional[str] = None, success_terminal_state_condition: str = 'at_least_one_running', readiness_wait_time: int = 20, logger_fn = None):
+        ...
+    @property
+    def url(self):
+        ...
+    @property
+    def capsule_api(self):
+        ...
+    @property
+    def capsule_type(self):
+        ...
+    @property
+    def name(self):
+        ...
+    def create_input(self):
+        ...
+    @property
+    def current_deployment_instance_version(self):
+        """
+        The backend `create` call returns a version of the object that will be
+        """
+        ...
+    def create(self):
+        ...
+    def get(self):
+        ...
+    def get_workers(self):
+        ...
+    def wait_for_terminal_state(self):
+        """
+        """
+        ...
+    ...
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/cli_to_config.pyi

@@ -0,0 +1,17 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.331800                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+
+from . import experimental as experimental
+
+def build_config_from_options(options):
+    """
+    Build an app configuration from CLI options.
+    """
+    ...
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/click_importer.pyi

@@ -0,0 +1,12 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.331280                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+
+from ......_vendor import click as metaflow_click
+from ......_vendor import click as click
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/code_package/__init__.pyi

@@ -0,0 +1,12 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.334481                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+
+from . import code_packager as code_packager
+from .code_packager import CodePackager as CodePackager
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/code_package/code_packager.pyi

@@ -0,0 +1,242 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.366381                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.datastore.content_addressed_store
+
+
+DATASTORE_SYSROOT_S3: None
+
+DATASTORE_SYSROOT_AZURE: None
+
+DATASTORE_SYSROOT_GS: None
+
+DATASTORE_SYSROOT_LOCAL: None
+
+CODE_PACKAGE_PREFIX: str
+
+def walk_without_cycles(top_root):
+    ...
+
+def symlink_friendly_walk(root, exclude_hidden = True, suffixes = None):
+    ...
+
+class CodePackager(object, metaclass=type):
+    """
+    A datastore-agnostic class for packaging code.
+    
+    This class handles creating a code package (tarball) for deployment
+    and provides methods for storing and retrieving it using Metaflow's
+    ContentAddressedStore directly.
+    
+    Usage examples:
+    ```python
+    packager = CodePackager(
+        datastore_type: str = "s3",
+        datastore_root = None,
+        code_package_prefix = None,
+    )
+    
+    package_url, package_key = packager.store(
+        paths_to_include = ["./"],
+        file_suffixes = [".py", ".txt", ".yaml", ".yml", ".json"],
+    )
+    
+    package_url, package_key = packager.store(
+        package_create_fn = lambda: my_custom_package_create_fn(),
+    )
+    ```
+    """
+    def __init__(self, datastore_type: str = 's3', datastore_root: typing.Optional[str] = None, code_package_prefix: typing.Optional[str] = None):
+        """
+        Initialize the CodePackager with datastore configuration.
+        
+        Parameters
+        ----------
+        datastore_type : str, default "s3"
+            The type of datastore to use: "s3", "azure", "gs", or "local"
+        datastore_root : str, optional
+            Root path for the datastore. If not provided, uses the default for the datastore type.
+        code_package_prefix : str, optional
+            The prefix to use for storing code packages in the content addressed store.
+            If not provided, uses the CODE_PACKAGE_PREFIX configuration value.
+        """
+        ...
+    def store(self, package_create_fn: typing.Optional[typing.Callable[[], bytes]] = None, paths_to_include: typing.Optional[typing.List[str]] = None, file_suffixes: typing.Optional[typing.List[str]] = None, metadata: typing.Optional[typing.Dict[str, typing.Any]] = None) -> typing.Tuple[str, str]:
+        """
+        Create and store a code package using Metaflow's ContentAddressedStore.
+        
+        This method can be called in two ways:
+        1. With paths_to_include and file_suffixes to use the default packaging
+        2. With a custom package_create_fn for custom packaging logic
+        
+        Parameters
+        ----------
+        package_create_fn : Callable[[], bytes], optional
+            A function that creates and returns a package as bytes.
+            This allows for custom packaging logic without dependency on specific objects.
+        paths_to_include : List[str], optional
+            List of paths to include in the package. Used by default_package_create.
+        file_suffixes : List[str], optional
+            List of file suffixes to include. Used by default_package_create.
+        metadata : Dict[str, Any], optional
+            Metadata to include in the package when using default_package_create.
+        
+        Returns
+        -------
+        Tuple[str, str]
+            A tuple containing (package_url, package_key) that identifies the location
+            and content-addressed key of the stored package.
+        """
+        ...
+    @staticmethod
+    def get_content_addressed_store(datastore_type: str = 's3', datastore_root: typing.Optional[str] = None, prefix: typing.Optional[str] = None) -> metaflow.datastore.content_addressed_store.ContentAddressedStore:
+        """
+        Get a ContentAddressedStore instance for the specified datastore.
+        
+        Parameters
+        ----------
+        datastore_type : str, default "s3"
+            Type of datastore: "s3", "azure", "gs", or "local"
+        datastore_root : str, optional
+            Root path for the datastore. If not provided, uses the default for the datastore type.
+        prefix : str, optional
+            Prefix to use when storing objects in the datastore.
+            If not provided, uses the CODE_PACKAGE_PREFIX configuration value.
+        
+        Returns
+        -------
+        ContentAddressedStore
+            A ContentAddressedStore instance configured for the specified datastore
+        """
+        ...
+    @staticmethod
+    def get_download_cmd(package_url: str, datastore_type: str, python_cmd: str = 'python', target_file: str = 'job.tar', escape_quotes: bool = True) -> str:
+        """
+        Generate a command to download the code package.
+        
+        Parameters
+        ----------
+        package_url : str
+            The URL of the package to download
+        datastore_type : str
+            The type of datastore (s3, azure, gs, local)
+        python_cmd : str, optional
+            The Python command to use
+        target_file : str, optional
+            The target file name to save the package as
+        escape_quotes : bool, optional
+            Whether to escape quotes in the command
+        
+        Returns
+        -------
+        str
+            A shell command string to download the package
+        """
+        ...
+    def get_package_commands(self, code_package_url: str, python_cmd: str = 'python', target_file: str = 'job.tar', working_dir: str = 'metaflow', retries: int = 5, escape_quotes: bool = True) -> typing.List[str]:
+        """
+        Get a complete list of shell commands to download and extract a code package.
+        
+        This method generates a comprehensive set of shell commands for downloading
+        and extracting a code package, similar to MetaflowEnvironment.get_package_commands.
+        
+        Parameters
+        ----------
+        code_package_url : str
+            The URL of the code package to download
+        python_cmd : str, optional
+            The Python command to use
+        target_file : str, optional
+            The target file name to save the package as
+        working_dir : str, optional
+            The directory to create and extract the package into
+        retries : int, optional
+            Number of download retries to attempt
+        escape_quotes : bool, optional
+            Whether to escape quotes in the command
+        
+        Returns
+        -------
+        List[str]
+            List of shell commands to execute
+        """
+        ...
+    @staticmethod
+    def directory_walker(root, exclude_hidden = True, suffixes = None) -> typing.List[typing.Tuple[str, str]]:
+        """
+        Walk a directory and yield tuples of (file_path, relative_arcname) for files
+        that match the given suffix filters. It will follow symlinks, but not cycles.
+        
+        This function is similar to MetaflowPackage._walk and handles symlinks safely.
+        
+        Parameters
+        ----------
+        root : str
+            The root directory to walk
+        exclude_hidden : bool, default True
+            Whether to exclude hidden files and directories (those starting with '.')
+        suffixes : List[str], optional
+            List of file suffixes to include (e.g. ['.py', '.txt'])
+        
+        Returns
+        -------
+        List[Tuple[str, str]]
+            List of tuples (file_path, relative_arcname) where:
+            - file_path is the full path to the file
+            - relative_arcname is the path to use within the archive
+        """
+        ...
+    @staticmethod
+    def default_package_create(paths: typing.List[str], suffixes: typing.List[str], metadata: typing.Optional[typing.Dict[str, typing.Any]] = None) -> bytes:
+        """
+        Create a default tarball package from specified paths.
+        
+        Parameters
+        ----------
+        paths : List[str]
+            List of paths to include in the package
+        suffixes : List[str]
+            List of file suffixes to include
+        metadata : Dict[str, Any], optional
+            Metadata to include in the package
+        
+        Returns
+        -------
+        bytes
+            The binary content of the tarball
+        """
+        ...
+    @classmethod
+    def package_directory(cls, directory_path: str, suffixes: typing.Optional[typing.List[str]] = None, exclude_hidden: bool = True, metadata: typing.Optional[typing.Dict[str, typing.Any]] = None) -> bytes:
+        """
+        Package a directory and all of its contents that match the given suffixes.
+        
+        This is a convenience method that works similarly to MetaflowPackage._walk
+        to package a directory for deployment. Will default follow_symlinks.
+        
+        Parameters
+        ----------
+        directory_path : str
+            The directory to package
+        suffixes : List[str], optional
+            List of file suffixes to include (defaults to standard code extensions)
+        exclude_hidden : bool, default True
+            Whether to exclude hidden files and directories
+        metadata : Dict[str, Any], optional
+            Metadata to include in the package
+        Returns
+        -------
+        bytes
+            The binary content of the tarball
+        """
+        ...
+    ...
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/dependencies.pyi

@@ -0,0 +1,50 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.333999                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.dependencies
+
+from .app_config import AppConfig as AppConfig
+from .utils import TODOException as TODOException
+from ......metaflow_config import get_pinned_conda_libs as get_pinned_conda_libs
+
+DEFAULT_DATASTORE: str
+
+KUBERNETES_CONTAINER_IMAGE: None
+
+class BakingStatus(tuple, metaclass=type):
+    """
+    BakingStatus(image_should_be_baked, python_path, resolved_image)
+    """
+    @staticmethod
+    def __new__(_cls, image_should_be_baked, python_path, resolved_image):
+        """
+        Create new instance of BakingStatus(image_should_be_baked, python_path, resolved_image)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+class ImageBakingException(Exception, metaclass=type):
+    ...
+
+def bake_deployment_image(app_config: metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config.AppConfig, cache_file_path: str, logger: typing.Optional[typing.Callable[[str], typing.Any]] = None) -> BakingStatus:
+    ...
+