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

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

@@ -0,0 +1,126 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-03T01:34:48.337032                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import metaflow
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config
+    import metaflow._vendor.click.types
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.app_cli
+
+from ......_vendor import click as click
+from .app_config import AppConfig as AppConfig
+from .app_config import AppConfigError as AppConfigError
+from .app_config import AuthType as AuthType
+from .perimeters import PerimeterExtractor as PerimeterExtractor
+from .cli_to_config import build_config_from_options as build_config_from_options
+from .utils import MultiStepSpinner as MultiStepSpinner
+from . import experimental as experimental
+from .validations import deploy_validations as deploy_validations
+from .code_package.code_packager import CodePackager as CodePackager
+from .capsule import CapsuleDeployer as CapsuleDeployer
+from .capsule import list_and_filter_capsules as list_and_filter_capsules
+from .capsule import CapsuleApi as CapsuleApi
+from ._state_machine import DEPLOYMENT_READY_CONDITIONS as DEPLOYMENT_READY_CONDITIONS
+from .capsule import CapsuleApiException as CapsuleApiException
+from .capsule import CapsuleDeploymentException as CapsuleDeploymentException
+from .dependencies import bake_deployment_image as bake_deployment_image
+
+CODE_PACKAGE_PREFIX: str
+
+CAPSULE_DEBUG: bool
+
+class KeyValueDictPair(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class KeyValuePair(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class MountMetaflowArtifact(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        """
+        Convert a string like "flow=MyFlow,artifact=my_model,path=/tmp/abc" or
+        "pathspec=MyFlow/123/foo/345/my_model,path=/tmp/abc" to a dict.
+        """
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class MountSecret(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        """
+        Convert a string like "id=my_secret,path=/tmp/secret" to a dict.
+        """
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class CommaSeparatedList(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+KVPairType: KeyValuePair
+
+MetaflowArtifactType: MountMetaflowArtifact
+
+SecretMountType: MountSecret
+
+CommaSeparatedListType: CommaSeparatedList
+
+KVDictType: KeyValueDictPair
+
+class ColorTheme(object, metaclass=type):
+    ...
+
+class CliState(object, metaclass=type):
+    ...
+
+def print_table(data, headers):
+    """
+    Print data in a formatted table.
+    """
+    ...
+
+def parse_commands(app_config: metaflow.mf_extensions.outerbounds.plugins.apps.core.app_config.AppConfig, cli_command_input):
+    ...
+
+def deployment_instance_options(func):
+    ...
+
+def common_deploy_options(func):
+    ...
+
+def common_run_options(func):
+    """
+    Common options for running and deploying apps.
+    """
+    ...
+

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
+