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

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

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 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                                                            #
+# Generated on 2025-07-09T05:17:09.550820                                                            #
 ######################################################################################################
 
 from __future__ import annotations

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

@@ -1,15 +1,15 @@
 ######################################################################################################
 #                                 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                                                            #
+# Generated on 2025-07-09T05:17:09.586424                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import typing
     import metaflow.datastore.content_addressed_store
+    import typing
 
 
 DATASTORE_SYSROOT_S3: None
@@ -20,6 +20,8 @@ DATASTORE_SYSROOT_GS: None
 
 DATASTORE_SYSROOT_LOCAL: None
 
+DEFAULT_FILE_SUFFIXES: list
+
 CODE_PACKAGE_PREFIX: str
 
 def walk_without_cycles(top_root):

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

@@ -0,0 +1,22 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-09T05:17:09.549102                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+
+from . import config_utils as config_utils
+from . import unified_config as unified_config
+from .unified_config import CoreConfig as CoreConfig
+from . import cli_generator as cli_generator
+from .cli_generator import auto_cli_options as auto_cli_options
+from .config_utils import PureStringKVPairType as PureStringKVPairType
+from .config_utils import JsonFriendlyKeyValuePairType as JsonFriendlyKeyValuePairType
+from .config_utils import CommaSeparatedListType as CommaSeparatedListType
+from .config_utils import MergingNotAllowedFieldsException as MergingNotAllowedFieldsException
+from .config_utils import ConfigValidationFailedException as ConfigValidationFailedException
+from .config_utils import RequiredFieldMissingException as RequiredFieldMissingException
+from . import schema_export as schema_export
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/cli_generator.pyi

@@ -0,0 +1,53 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-09T05:17:09.584796                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow_extensions.outerbounds.plugins.apps.core.config.unified_config
+
+from ......._vendor import click as click
+from .unified_config import CoreConfig as CoreConfig
+from .config_utils import CLIOption as CLIOption
+from .config_utils import ConfigMeta as ConfigMeta
+from .config_utils import PureStringKVPairType as PureStringKVPairType
+from .config_utils import JsonFriendlyKeyValuePairType as JsonFriendlyKeyValuePairType
+from .config_utils import CommaSeparatedListType as CommaSeparatedListType
+
+class CLIGenerator(object, metaclass=type):
+    """
+    Generates Click CLI options from CoreConfig dataclass.
+    """
+    def __init__(self, config_class: type = metaflow_extensions.outerbounds.plugins.apps.core.config.unified_config.CoreConfig):
+        ...
+    def generate_options(self):
+        """
+        Generate all CLI options from the configuration class.
+        """
+        ...
+    def create_decorator(self, command_type: str = 'deploy') -> callable:
+        """
+        Create a decorator that applies all CLI options to a command.
+        """
+        ...
+    ...
+
+def auto_cli_options(config_class: type = metaflow_extensions.outerbounds.plugins.apps.core.config.unified_config.CoreConfig, command_type: str = 'deploy'):
+    """
+    Decorator that automatically adds CLI options from CoreConfig.
+    
+    Args:
+        command_type: Type of command (e.g., "deploy", "list", "delete")
+    
+    Usage:
+        @auto_cli_options("deploy")
+        def deploy_command(**kwargs):
+            config = CoreConfig.from_cli(kwargs)
+            # ... use config
+    """
+    ...
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/config_utils.pyi

@@ -0,0 +1,407 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-09T05:17:09.583352                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+import metaflow
+if typing.TYPE_CHECKING:
+    import typing
+    import metaflow._vendor.click.types
+    import metaflow.mf_extensions.outerbounds.plugins.apps.core.config.config_utils
+
+from ......._vendor import click as click
+
+class FieldBehavior(object, metaclass=type):
+    """
+    Defines how configuration fields behave when merging values from multiple sources.
+    
+    FieldBehavior controls the merging logic when the same field receives values from
+    different configuration sources (CLI options, config files, environment variables).
+    This is crucial for maintaining consistent and predictable configuration behavior
+    across different deployment scenarios.
+    
+    The behavior system allows fine-grained control over how different types of fields
+    should handle conflicting values, ensuring that sensitive configuration (like
+    dependency specifications) cannot be accidentally overridden while still allowing
+    flexible configuration for runtime parameters.
+    
+    Behavior Types:
+    
+    UNION (Default):
+        - **For Primitive Types**: Override value takes precedence
+        - **For Lists**: Values are merged by extending the base list with override values
+        - **For Dictionaries**: Values are merged by updating base dict with override values
+        - **For Nested Objects**: Recursively merge nested configuration objects
+    
+        Example:
+        ```python
+        # Base config: {"tags": ["prod", "web"]}
+        # CLI config: {"tags": ["urgent"]}
+        # Result: {"tags": ["prod", "web", "urgent"]}
+        ```
+    
+    NOT_ALLOWED:
+        - CLI values cannot override config file values
+        - CLI values are only used if config file value is None
+        - Ensures critical configuration is only set in one place to avoid ambiguity.
+    
+        Example:
+        ```python
+        # Base config: {"dependencies": {"numpy": "1.21.0"}}
+        # CLI config: {"dependencies": {"numpy": "1.22.0"}}
+        # Result: Exception is raised
+        ```
+    
+        ```python
+        # Base config: {"dependencies": {"pypi": null, "conda": null}}
+        # CLI config: {"dependencies": {"pypi": {"numpy": "1.22.0"}}}
+        # Result: {"dependencies": {"pypi": {"numpy": "1.22.0"}}} # since there is nothing in base config, the CLI config is used.
+        ```
+    
+    Integration with Merging:
+        The behavior is enforced by the `merge_field_values` function during configuration
+        merging. Each field's behavior is checked and the appropriate merging logic is applied.
+    """
+    ...
+
+class CLIOption(object, metaclass=type):
+    """
+    Metadata container for automatic CLI option generation from configuration fields.
+    
+    CLIOption defines how a ConfigField should be exposed as a command-line option in the
+    generated CLI interface. It provides a declarative way to specify CLI parameter names,
+    help text, validation rules, and Click-specific behaviors without tightly coupling
+    configuration definitions to CLI implementation details.
+    
+    This class bridges the gap between configuration field definitions and Click option
+    generation, allowing the same field definition to work seamlessly across different
+    interfaces (CLI, config files, programmatic usage).
+    
+    Click Integration:
+    The CLIOption metadata is used by CLIGenerator to create Click options:
+    ```python
+    @click.option("--port", "port", type=int, help="Application port")
+    ```
+    
+    This is automatically generated from:
+    ```python
+    port = ConfigField(
+        cli_meta=CLIOption(
+            name="port",
+            cli_option_str="--port",
+            help="Application port"
+        ),
+        field_type=int
+    )
+    ```
+    
+    
+    Parameters
+    ----------
+    name : str
+        Parameter name used in Click option and function signature (e.g., "my_foo").
+    cli_option_str : str
+        Command-line option string (e.g., "--foo", "--enable/--disable").
+    help : Optional[str], optional
+        Help text displayed in CLI help output.
+    short : Optional[str], optional
+        Short option character (e.g., "-f" for "--foo").
+    multiple : bool, optional
+        Whether the option accepts multiple values.
+    is_flag : bool, optional
+        Whether this is a boolean flag option.
+    choices : Optional[List[str]], optional
+        List of valid choices for the option.
+    default : Any, optional
+        Default value for the CLI option (separate from ConfigField default).
+    hidden : bool, optional
+        Whether to hide this option from CLI (config file only).
+    click_type : Optional[Any], optional
+        Custom Click type for specialized parsing (e.g., KeyValuePair).
+    """
+    def __init__(self, name: str, cli_option_str: str, help: typing.Optional[str] = None, short: typing.Optional[str] = None, multiple: bool = False, is_flag: bool = False, choices: typing.Optional[typing.List[str]] = None, default: typing.Any = None, hidden: bool = False, click_type: typing.Optional[typing.Any] = None):
+        ...
+    ...
+
+class ConfigField(object, metaclass=type):
+    """
+    Descriptor for configuration fields with comprehensive metadata and behavior control.
+    
+    ConfigField is a Python descriptor that provides a declarative way to define configuration
+    fields with rich metadata, validation, CLI integration, and merging behavior. It acts as
+    both a data descriptor (controlling get/set access) and a metadata container.
+    
+    Key Functionality:
+    - **Descriptor Protocol**: Implements __get__, __set__, and __set_name__ to control
+      field access and automatically capture the field name during class creation.
+    - **Type Safety**: Optional strict type checking during value assignment.
+    - **CLI Integration**: Automatic CLI option generation via CLIOption metadata.
+    - **Validation**: Built-in validation functions and required field checks.
+    - **Merging Behavior**: Controls how values are merged from different sources (CLI, config files).
+    - **Default Values**: Supports both static defaults and callable defaults for dynamic initialization.
+    
+    Merging Behaviors:
+    - **UNION**: Values from different sources are merged (lists extended, dicts updated).
+    - **NOT_ALLOWED**: Override values are ignored if base value exists.
+    
+    Field Lifecycle:
+    1. **Definition**: Field is defined in a ConfigMeta-based class
+    2. **Registration**: __set_name__ is called to register the field name
+    3. **Initialization**: Field is initialized with None or nested config objects
+    4. **Population**: Values are set from CLI options, config files, or direct assignment
+    5. **Validation**: Validation functions are called during commit phase
+    6. **Default Application**: Default values are applied to None fields
+    
+    Examples:
+        Basic field definition:
+        ```python
+        name = ConfigField(
+            field_type=str,
+            required=True,
+            help="Application name",
+            example="myapp"
+        )
+        ```
+    
+        Field with CLI integration:
+        ```python
+        port = ConfigField(
+            cli_meta=CLIOption(
+                name="port",
+                cli_option_str="--port",
+                help="Application port"
+            ),
+            field_type=int,
+            required=True,
+            validation_fn=lambda x: 1 <= x <= 65535
+        )
+        ```
+    
+        Nested configuration field:
+        ```python
+        resources = ConfigField(
+            field_type=ResourceConfig,
+            help="Resource configuration"
+        )
+        ```
+    
+    Parameters
+    ----------
+    default : Any or Callable[["ConfigField"], Any], optional
+        Default value for the field. Can be a static value or a callable for dynamic defaults.
+    cli_meta : CLIOption, optional
+        CLIOption instance defining CLI option generation parameters.
+    field_type : type, optional
+        Expected type of the field value (used for validation and nesting).
+    required : bool, optional
+        Whether the field must have a non-None value after configuration.
+    help : str, optional
+        Help text describing the field's purpose.
+    behavior : str, optional
+        FieldBehavior controlling how values are merged from different sources.
+    example : Any, optional
+        Example value for documentation and schema generation.
+    strict_types : bool, optional
+        Whether to enforce type checking during value assignment.
+    validation_fn : callable, optional
+        Optional function to validate field values.
+    is_experimental : bool, optional
+        Whether this field is experimental (for documentation).
+    """
+    def __init__(self, default: typing.Union[typing.Any, typing.Callable[["ConfigField"], typing.Any]] = None, cli_meta = None, field_type = None, required = False, help = None, behavior: str = 'union', example = None, strict_types = True, validation_fn: typing.Optional[callable] = None, is_experimental = False):
+        ...
+    def __set_name__(self, owner, name):
+        ...
+    def __get__(self, instance, owner):
+        ...
+    def __set__(self, instance, value):
+        ...
+    def __str__(self) -> str:
+        ...
+    ...
+
+class ConfigMeta(type, metaclass=type):
+    """
+    Metaclass that transforms regular classes into configuration classes with automatic field management.
+    
+    ConfigMeta is the core metaclass that enables the declarative configuration system. It automatically
+    processes ConfigField descriptors defined in class bodies and transforms them into fully functional
+    configuration classes with standardized initialization, field access, and metadata management.
+    
+    Key Transformations:
+    - **Field Collection**: Automatically discovers and collects all ConfigField instances from the class body.
+    - **Metadata Storage**: Stores field metadata in a `_fields` class attribute for runtime introspection.
+    - **Auto-Generated __init__**: Creates a standardized __init__ method that handles field initialization.
+    - **Field Access**: Injects helper methods like `_get_field` for programmatic field access.
+    - **Nested Object Support**: Automatically instantiates nested configuration objects during initialization.
+    
+    Class Transformation Process:
+    1. **Discovery**: Scan the class namespace for ConfigField instances
+    2. **Registration**: Store found fields in `_fields` dictionary
+    3. **Method Injection**: Add `_get_field` helper method to the class
+    4. **__init__ Generation**: Create standardized initialization logic
+    5. **Class Creation**: Return the transformed class with all enhancements
+    
+    Generated __init__ Behavior:
+    - Initializes all fields to None by default (explicit defaulting is done separately)
+    - Automatically creates instances of nested ConfigMeta-based classes
+    - Accepts keyword arguments to override field values during instantiation
+    - Ensures consistent initialization patterns across all configuration classes
+    
+    Usage Pattern:
+    ```python
+    class MyConfig(metaclass=ConfigMeta):
+        name = ConfigField(field_type=str, required=True)
+        port = ConfigField(field_type=int, default=8080)
+        resources = ConfigField(field_type=ResourceConfig)
+    
+    # The metaclass transforms this into a fully functional config class
+    config = MyConfig()  # Uses auto-generated __init__
+    config.name = "myapp"  # Uses ConfigField descriptor
+    field_info = config._get_field("name")  # Uses injected helper method
+    ```
+    
+    Integration Points:
+    - **CLI Generation**: Field metadata is used to automatically generate CLI options
+    - **Config Loading**: Fields are populated from dictionaries, YAML, or JSON files
+    - **Validation**: Field validation functions are called during config commit
+    - **Merging**: Field behaviors control how values are merged from different sources
+    - **Export**: Configuration instances can be exported back to dictionaries
+    
+    The metaclass ensures that all configuration classes have consistent behavior and
+    interfaces, regardless of their specific field definitions.
+    """
+    @staticmethod
+    def is_instance(value) -> bool:
+        ...
+    @staticmethod
+    def __new__(mcs, name, bases, namespace):
+        ...
+    ...
+
+def apply_defaults(config):
+    """
+    Apply default values to any fields that are still None.
+    
+    Args:
+        config: instance of a ConfigMeta object
+    """
+    ...
+
+class ConfigValidationFailedException(Exception, metaclass=type):
+    def __init__(self, field_name: str, field_info: ConfigField, current_value, message: str = None):
+        ...
+    ...
+
+class RequiredFieldMissingException(ConfigValidationFailedException, metaclass=type):
+    ...
+
+class MergingNotAllowedFieldsException(ConfigValidationFailedException, metaclass=type):
+    def __init__(self, field_name: str, field_info: ConfigField, current_value: typing.Any, override_value: typing.Any):
+        ...
+    ...
+
+def validate_required_fields(config_instance):
+    ...
+
+def validate_config_meta(config_instance):
+    ...
+
+def config_meta_to_dict(config_instance) -> typing.Dict[str, typing.Any]:
+    """
+    Convert a configuration instance to a nested dictionary.
+    
+    Recursively converts ConfigMeta-based configuration instances to dictionaries,
+    handling nested config objects and preserving the structure.
+    
+    Args:
+        config_instance: Instance of a ConfigMeta-based configuration class
+    
+    Returns:
+        Nested dictionary representation of the configuration
+    
+    Examples:
+        # Convert a config instance to dict
+    
+        config_dict = to_dict(config)
+    
+        # Result will be:
+        # {
+        #     "name": "myapp",
+        #     "port": 8000,
+        #     "resources": {
+        #         "cpu": "500m",
+        #         "memory": "1Gi",
+        #         "gpu": None,
+        #         "disk": "20Gi"
+        #     },
+        #     "auth": None,
+        #     ...
+        # }
+    """
+    ...
+
+def merge_field_values(base_value: typing.Any, override_value: typing.Any, field_info, behavior: str) -> typing.Any:
+    """
+    Merge individual field values based on behavior.
+    
+    Args:
+        base_value: Value from base config
+        override_value: Value from override config
+        field_info: Field metadata
+        behavior: FieldBehavior for this field
+    
+    Returns:
+        Merged value
+    """
+    ...
+
+class JsonFriendlyKeyValuePair(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    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):
+        ...
+    ...
+
+class PureStringKVPair(metaflow._vendor.click.types.ParamType, metaclass=type):
+    """
+    Click type for key-value pairs (KEY=VALUE).
+    """
+    def convert(self, value, param, ctx):
+        ...
+    ...
+
+PureStringKVPairType: PureStringKVPair
+
+CommaSeparatedListType: CommaSeparatedList
+
+JsonFriendlyKeyValuePairType: JsonFriendlyKeyValuePair
+
+def populate_config_recursive(config_instance, config_class, source_data, get_source_key_fn, get_source_value_fn):
+    """
+    Recursively populate a config instance from source data.
+    
+    Args:
+        config_instance: Config object to populate
+        config_class: Class of the config object
+        source_data: Source data (dict, CLI options, etc.)
+        get_source_key_fn: Function to get the source key for a field
+        get_source_value_fn: Function to get the value from source for a key
+    """
+    ...
+

metaflow-stubs/mf_extensions/outerbounds/plugins/apps/core/config/schema_export.pyi

@@ -0,0 +1,64 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.18.1+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-09T05:17:09.585105                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+
+
+HAS_YAML: bool
+
+def to_openapi_schema(config_class) -> typing.Dict[str, typing.Any]:
+    """
+    Generate OpenAPI schema for a configuration class.
+    
+    Args:
+        config_class: The configuration class to generate schema for
+    
+    Returns:
+        OpenAPI schema dictionary
+    """
+    ...
+
+def to_json_schema(config_class) -> typing.Dict[str, typing.Any]:
+    """
+    Generate JSON schema for a configuration class.
+    
+    Args:
+        config_class: The configuration class to generate schema for
+    
+    Returns:
+        JSON schema dictionary
+    """
+    ...
+
+def export_schema(config_class, filepath: str, schema_type: str = 'openapi', format: str = 'yaml'):
+    """
+    Export configuration schema to file.
+    
+    Args:
+        config_class: The configuration class to export schema for
+        filepath: Path to save the schema file
+        schema_type: Type of schema to generate ('openapi' or 'json')
+        format: Output format ('yaml' or 'json')
+    
+    Examples:
+        # Export OpenAPI schema as YAML (default)
+        export_schema(CoreConfig, "schema.yaml")
+    
+        # Export JSON schema as YAML
+        export_schema(CoreConfig, "schema.yaml", schema_type="json")
+    
+        # Export OpenAPI schema as JSON
+        export_schema(CoreConfig, "schema.json", schema_type="openapi", format="json")
+    
+        # Export JSON schema as JSON
+        export_schema(CoreConfig, "schema.json", schema_type="json", format="json")
+    """
+    ...
+