wry 0.3.2.dev0__py3-none-any.whl → 0.3.2.dev2__py3-none-any.whl

wry/__init__.py

@@ -55,10 +55,27 @@ try:
     if __commit_id__:
         __version_full__ += f"+{__commit_id__}"
 except ImportError:
-    # Fallback for development when _version.py is not generated
-    __version__ = "0.0.0"
-    __version_full__ = __version__
-    __commit_id__ = None
+    # Fallback for development/editable installs
+    try:
+        # Try to get version dynamically for editable installs
+        from setuptools_scm import get_version
+
+        __version__ = get_version(root="../..", relative_to=__file__)
+        # Extract commit hash from version if present
+        if "+" in __version__ and "g" in __version__:
+            # Version like "0.0.2+g1234567" or "0.0.2.dev1+g1234567"
+            __commit_id__ = __version__.split("+")[-1].split(".")[0]
+            __version_full__ = __version__
+        else:
+            __commit_id__ = None
+            __version_full__ = __version__
+        # Clean version for consistency
+        __version__ = __version__.split("+")[0]
+    except Exception:
+        # Ultimate fallback
+        __version__ = "0.0.1-dev"
+        __version_full__ = __version__
+        __commit_id__ = None
 
 __author__ = "Tyler House"
 __email__ = "26489166+tahouse@users.noreply.github.com"

wry/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.2.dev0'
-__version_tuple__ = version_tuple = (0, 3, 2, 'dev0')
+__version__ = version = '0.3.2.dev2'
+__version_tuple__ = version_tuple = (0, 3, 2, 'dev2')
 
 __commit_id__ = commit_id = None

wry/auto_model.py

@@ -138,7 +138,7 @@ def create_auto_model(name: str, fields: dict[str, Any], **kwargs: Any) -> type[
         # Use it with Click
         @click.command()
         @generate_click_parameters(MyConfig)
-        def my_command(**kwargs):
+        def my_command(**kwargs: Any):
             config = MyConfig.from_click_context(**kwargs)
             print(f"Connecting to {config.host}:{config.port}")
         ```

wry/click_integration.py

@@ -378,7 +378,9 @@ def generate_click_parameters(
 
         if field_type == AutoClickParameter.OPTION or field_type == AutoClickParameter.REQUIRED_OPTION:
             # Auto-generate Click option from Field info
-            option_name = f"--{field_name.replace('_', '-')}"
+            # Use alias if available, otherwise use field name
+            name_for_option = field_info.alias if field_info.alias else field_name
+            option_name = f"--{name_for_option.replace('_', '-')}"
 
             # Check if field is required first (needed to decide on default handling)
             is_required = field_info.is_required() or field_type == AutoClickParameter.REQUIRED_OPTION
@@ -457,7 +459,9 @@ def generate_click_parameters(
 
             # Get the environment variable prefix
             env_prefix = getattr(model_class, "env_prefix", "DRYCLI_")
-            env_var_name = f"{env_prefix}{field_name.upper()}"
+            # Use alias for env var name if available, otherwise use field name
+            name_for_env = field_info.alias if field_info.alias else field_name
+            env_var_name = f"{env_prefix}{name_for_env.upper()}"
 
             env_var_set = env_var_name in os.environ
 
@@ -508,8 +512,18 @@ def generate_click_parameters(
             elif base_type is not str:  # Only specify type if not string (Click default)
                 click_kwargs["type"] = base_type
 
-            # Note: required=False to allow --config to replace arg
-            arguments.append(click.argument(argument_name, **click_kwargs, required=False))
+            # Check if field has a default or if env var is set
+            import os
+
+            env_prefix = getattr(model_class, "env_prefix", "")
+            name_for_env = field_info.alias if field_info.alias else field_name
+            env_var_name = f"{env_prefix}{name_for_env.upper()}"
+            env_var_set = env_var_name in os.environ
+
+            # Mark as not required if field has default or env var is set
+            is_required_arg = field_info.is_required() and not env_var_set
+
+            arguments.append(click.argument(argument_name, **click_kwargs, required=is_required_arg))
 
             # Track argument description for docstring injection
             if field_info.description:
@@ -633,7 +647,7 @@ def extract_and_modify_argument_decorator(
     """
     # Default values - use a safe fallback
     param_decls: list[str] = ["argument"]
-    attrs: dict[str, Any] = {"required": False}
+    attrs: dict[str, Any] = {}  # Don't override required - let Click handle it
 
     # Try to extract from closure, but don't rely on it
     try:
@@ -658,7 +672,7 @@ def extract_and_modify_argument_decorator(
                     for k, v in dict_contents.items():
                         if isinstance(k, str):
                             attrs[k] = v
-                    attrs["required"] = False  # Always override to make optional
+                    # Don't override required - preserve original setting
 
                 # Handle Click parameter classes
                 elif isinstance(contents, type):

wry/core/env_utils.py

@@ -23,8 +23,10 @@ def get_env_var_names(model_class: type[T]) -> dict[str, str]:
     prefix = getattr(model_class, "env_prefix", "")
     env_vars = {}
 
-    for field_name in model_class.model_fields:
-        env_name = f"{prefix}{field_name.upper()}"
+    for field_name, field_info in model_class.model_fields.items():
+        # Use alias if available, otherwise use field name
+        name_for_env = field_info.alias if field_info.alias else field_name
+        env_name = f"{prefix}{name_for_env.upper()}"
         env_vars[field_name] = env_name
 
     return env_vars
@@ -46,9 +48,24 @@ def print_env_vars(model_class: type[T]) -> None:
         field_info = model_class.model_fields[field_name]
         field_type = type_hints.get(field_name, Any)
 
-        # Format type for display
+        # Extract base type from Annotated types
+        from typing import Annotated, get_args, get_origin
+
+        # Handle Annotated[Type, ...] - extract the actual type
+        origin = get_origin(field_type)
+        if origin is not None and str(origin) == str(Annotated):
+            args = get_args(field_type)
+            if args:
+                # First arg is the actual type (might be a Union)
+                field_type = args[0]
+
+        # Format type for display (preserve Union types like str | None)
         type_str = getattr(field_type, "__name__", str(field_type))
 
+        # Clean up type string representation for display
+        if "typing." in type_str:
+            type_str = type_str.replace("typing.", "")
+
         # Check if field is required
         required = field_info.default is PydanticUndefined and field_info.default_factory is None
 

wry/core/model.py

@@ -52,7 +52,7 @@ class WryModel(BaseModel):
         ```
     """
 
-    model_config = ConfigDict(arbitrary_types_allowed=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, validate_by_name=True, validate_by_alias=True)
 
     # Class variables that should not trigger Pydantic warnings
     env_prefix: ClassVar[str] = ""
@@ -450,7 +450,7 @@ class WryModel(BaseModel):
             @click.command()
             @generate_click_parameters(MyConfig)
             @click.pass_context
-            def my_command(ctx, **kwargs):
+            def my_command(ctx: click.Context, **kwargs: Any):
                 config = MyConfig.from_click_context(ctx, **kwargs)
                 print(f"Hello {config.name}")
                 print(f"Source: {config.source.name}")  # Accurate source
@@ -474,18 +474,41 @@ class WryModel(BaseModel):
             strict = cls.model_config.get("extra", "ignore") == "forbid"
 
         if strict:
-            # Check for extra fields
-            extra_fields = set(kwargs.keys()) - set(cls.model_fields.keys())
+            # Build alias set for validation
+            valid_aliases = {field_info.alias for field_info in cls.model_fields.values() if field_info.alias}
+            # Check for extra fields (allow both field names and aliases)
+            valid_keys = set(cls.model_fields.keys()) | valid_aliases
+            extra_fields = set(kwargs.keys()) - valid_keys
             if extra_fields:
                 raise ValueError(f"Extra fields not allowed: {extra_fields}")
 
-        # Filter kwargs to only include model fields
+        # Build alias-to-field mapping for handling Pydantic aliases
+        alias_to_field: dict[str, str] = {}
+        for field_name, field_info in cls.model_fields.items():
+            if field_info.alias:
+                alias_to_field[field_info.alias] = field_name
+
+        # Filter kwargs to include both field names AND aliases
         model_fields = set(cls.model_fields.keys())
-        filtered_kwargs = {k: v for k, v in kwargs.items() if k in model_fields}
+        filtered_kwargs: dict[str, Any] = {}
+
+        for k, v in kwargs.items():
+            if k in model_fields:
+                # Direct field name match
+                filtered_kwargs[k] = v
+            elif k in alias_to_field:
+                # Alias match - map to field name
+                field_name = alias_to_field[k]
+                filtered_kwargs[field_name] = v
 
         # If kwargs are empty but ctx.params has values, use those (for test compatibility)
         if not filtered_kwargs and hasattr(ctx, "params") and ctx.params:
-            filtered_kwargs = {k: v for k, v in ctx.params.items() if k in model_fields}
+            for k, v in ctx.params.items():
+                if k in model_fields:
+                    filtered_kwargs[k] = v
+                elif k in alias_to_field:
+                    field_name = alias_to_field[k]
+                    filtered_kwargs[field_name] = v
 
         # Get JSON data from context if available
         json_data = ctx.obj.get("json_data", {}) if ctx.obj else {}
@@ -508,19 +531,33 @@ class WryModel(BaseModel):
         for field_name, value in env_values.items():
             config_data[field_name] = TrackedValue(value, ValueSource.ENV)
 
-        # 3. Override with JSON values
-        for field_name, value in json_data.items():
-            if field_name in cls.model_fields:
+        # 3. Override with JSON values (handle both field names and aliases)
+        for key, value in json_data.items():
+            if key in cls.model_fields:
+                # Direct field name match
+                config_data[key] = TrackedValue(value, ValueSource.JSON)
+            elif key in alias_to_field:
+                # Alias match - map to field name
+                field_name = alias_to_field[key]
                 config_data[field_name] = TrackedValue(value, ValueSource.JSON)
 
         # 4. Override with CLI values from kwargs (but respect Click's source info)
         for field_name in cls.model_fields:
             if field_name in filtered_kwargs:
                 value = filtered_kwargs[field_name]
+                field_info = cls.model_fields[field_name]
 
                 # Check Click's parameter source if available
+                # Try both alias and field name since Click might know it by either
                 try:
-                    param_source = ctx.get_parameter_source(field_name)
+                    # First try the alias if it exists (for explicit click.option with custom names)
+                    param_name = field_info.alias if field_info.alias else field_name
+                    param_source = ctx.get_parameter_source(param_name)
+
+                    # If alias didn't work, try field name
+                    if param_source is None and field_info.alias:
+                        param_source = ctx.get_parameter_source(field_name)
+
                     if param_source is not None:
                         source_str = str(param_source)
                         # Only override if it's actually from CLI
@@ -648,7 +685,7 @@ class WryModel(BaseModel):
             @click.command()
             @MyConfig.generate_click_parameters()
             @click.pass_context
-            def cli(ctx, **kwargs):
+            def cli(ctx: click.Context, **kwargs: Any):
                 config = MyConfig.from_click_context(ctx, **kwargs)
             ```
 

wry/multi_model.py

@@ -39,7 +39,7 @@ def split_kwargs_by_model(
         @click.command()
         @generate_click_parameters(ServerConfig)
         @generate_click_parameters(DatabaseConfig)
-        def cmd(**kwargs):
+        def cmd(**kwargs: Any):
             configs = split_kwargs_by_model(kwargs, ServerConfig, DatabaseConfig)
             server_config = ServerConfig(**configs[ServerConfig])
             db_config = DatabaseConfig(**configs[DatabaseConfig])
@@ -89,7 +89,7 @@ def create_models(
         @generate_click_parameters(ServerModel)
         @generate_click_parameters(DatabaseModel)
         @click.pass_context
-        def cmd(ctx, **kwargs):
+        def cmd(ctx: click.Context, **kwargs: Any):
             models = create_models(ctx, kwargs, ServerModel, DatabaseModel)
             server = models[ServerModel]
             db = models[DatabaseModel]
@@ -127,7 +127,7 @@ def multi_model(*model_classes: type[BaseModel], strict: bool = False) -> Any:
         @click.command()
         @multi_model(ServerModel, DatabaseModel)
         @click.pass_context  # Add this for source tracking
-        def my_command(ctx, **kwargs):
+        def my_command(ctx: click.Context, **kwargs: Any):
             models = create_models(ctx, kwargs, ServerModel, DatabaseModel)
             server = models[ServerModel]
             database = models[DatabaseModel]

{wry-0.3.2.dev0.dist-info → wry-0.3.2.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wry
-Version: 0.3.2.dev0
+Version: 0.3.2.dev2
 Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
 Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
 License: MIT
@@ -90,7 +90,7 @@ class AppArgs(AutoWryModel):
 
 @click.command()
 @AppArgs.generate_click_parameters()
-def main(**kwargs):
+def main(**kwargs: Any):
     """My simple CLI application."""
     # Create the model instance from kwargs
     config = AppArgs(**kwargs)
@@ -100,7 +100,10 @@ if __name__ == "__main__":
     main()
 ```
 
-**Note**: Currently, `generate_click_parameters()` passes individual parameters as kwargs to your function. You need to instantiate the model yourself. See the [Future Features](#future-features) section for a potential cleaner API.
+**See comprehensive examples:**
+- `examples/autowrymodel_comprehensive.py` - All AutoWryModel features including aliases
+- `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+- `examples/multimodel_comprehensive.py` - Multi-model usage
 
 Run it:
 
@@ -129,7 +132,7 @@ wry tracks where each configuration value came from, supporting all four sources
 ```python
 @click.command()
 @AppArgs.generate_click_parameters()
-def main(**kwargs):
+def main(**kwargs: Any):
     # Simple instantiation - no source tracking
     config = AppArgs(**kwargs)
     # Works fine, but config.source.* will always show CLI
@@ -143,7 +146,7 @@ To enable accurate source tracking, use `@click.pass_context` and `from_click_co
 @click.command()
 @AppArgs.generate_click_parameters()
 @click.pass_context
-def main(ctx, **kwargs):
+def main(ctx: click.Context, **kwargs: Any):
     # Full source tracking with context
     config = AppArgs.from_click_context(ctx, **kwargs)
 
@@ -181,7 +184,8 @@ python examples/source_tracking_comprehensive.py --config examples/sample_config
 ```
 
 **Output shows source for each field:**
-```
+
+```text
 host         = json-server.com      [from JSON]
 port         = 3000                 [from CLI]    ← CLI overrides JSON
 debug        = True                 [from ENV]
@@ -257,7 +261,7 @@ class DatabaseArgs(WryModel):
 @click.command()
 @multi_model(ServerConfig, DatabaseConfig)
 @click.pass_context
-def serve(ctx, **kwargs):
+def serve(ctx: click.Context, **kwargs: Any):
     # Create model instances
     configs = create_models(ctx, kwargs, ServerConfig, DatabaseConfig)
     server = configs[ServerConfig]
@@ -330,7 +334,7 @@ class AppArgs(WryModel):
 @click.command()
 @multi_model(DatabaseConfig, AppArgs)
 @click.pass_context
-def main(ctx, **kwargs):
+def main(ctx: click.Context, **kwargs: Any):
     # Automatically splits kwargs between models
     configs = create_models(ctx, kwargs, DatabaseConfig, AppArgs)
 
@@ -349,7 +353,7 @@ By default, `generate_click_parameters` runs in strict mode to prevent common mi
 @click.command()
 @Config.generate_click_parameters()  # strict=True by default
 @Config.generate_click_parameters()  # ERROR: Duplicate decorator detected!
-def main(**kwargs):
+def main(**kwargs: Any):
     pass
 ```
 
@@ -391,6 +395,76 @@ class Config(WryModel):
     )
 ```
 
+### Using Pydantic Aliases for Custom CLI Names
+
+**New in v0.3.2+**: Pydantic field aliases automatically control the generated CLI option names and environment variable names!
+
+This allows you to have concise Python field names while exposing descriptive CLI options:
+
+```python
+from pydantic import Field
+from wry import AutoWryModel
+
+class DatabaseConfig(AutoWryModel):
+    env_prefix = "DB_"
+
+    # Concise Python field name: db_url
+    # Alias controls CLI option: --database-url
+    # Environment variable: DB_DATABASE_URL
+    db_url: str = Field(
+        alias="database_url",
+        default="sqlite:///app.db",
+        description="Database connection URL"
+    )
+
+    pool_size: int = Field(
+        alias="connection_pool_size",
+        default=5,
+        description="Maximum connection pool size"
+    )
+```
+
+**How it works:**
+
+- **Python field**: `db_url` (concise, easy to type)
+- **CLI option**: `--database-url` (descriptive, user-friendly)
+- **Environment variable**: `DB_DATABASE_URL` (consistent with CLI)
+- **JSON config**: Accepts both `db_url` and `database_url`
+
+**Requirements:**
+
+- **None!** `WryModel` automatically sets `validate_by_name=True` and `validate_by_alias=True`
+  - This tells Pydantic to accept both field names and aliases
+  - No need to configure anything - it just works!
+- Aliases automatically control option names, env var names, and help text
+
+**Full support (v0.3.2+):**
+
+- ✅ Aliases automatically control auto-generated option names
+- ✅ Environment variables use alias names (consistent with CLI)
+- ✅ Source tracking works correctly
+- ✅ JSON config accepts both field names and aliases
+
+**Why this feature exists:**
+
+Before v0.3.2, if you wanted custom CLI option names, you had to use explicit `click.option()` decorators for every field. The alias feature eliminates this boilerplate for the common case where you just want different names.
+
+**For advanced use cases** (short options, custom Click types):
+
+You can still combine aliases with explicit `click.option()` decorators:
+
+```python
+class Config(AutoWryModel):
+    # Explicit click.option for short option support
+    verbose: Annotated[int, click.option("-v", "--verbose", count=True)] = Field(default=0)
+```
+
+See `examples/autowrymodel_comprehensive.py` for examples of explicit Click decorators.
+
+**See also:**
+- `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel example with aliases
+- `examples/wrymodel_comprehensive.py` - WryModel with aliases and source tracking
+
 ## Development
 
 ### Prerequisites

wry-0.3.2.dev2.dist-info/RECORD

@@ -0,0 +1,18 @@
+wry/__init__.py,sha256=BI1sXr3d2q6wm4LdFSjgpatETyhv4RruVKN3auO7WH8,4203
+wry/_version.py,sha256=ZmNNN5KY7zagAfK_ReGsNVBfLtZ1xBk0-Q-QqXvizhI,717
+wry/auto_model.py,sha256=TC3I8r00Yv870bG3zZ5qa2Iet1rSCZ1cRWSkZSvZhco,6932
+wry/click_integration.py,sha256=vo8Ajv-nD-YvTbBQsdW2txhTrUc_pdGXIghjswNtZaU,32554
+wry/help_system.py,sha256=zSryjsOXAWz9HyCpybwuFWrlaP9gwbMNIexuAWTcCns,5731
+wry/multi_model.py,sha256=-72Eder564guz5nwFW3te5MRVWbBmGUI8V6ig1axgtw,6023
+wry/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wry/core/__init__.py,sha256=24Mu7qGzaFde8tAnyJOPPkD1ScZq-iSXNlDdAWSw_mg,894
+wry/core/accessors.py,sha256=Kn5dziklgcMWClOjbeJSwWNHOCQkpAWV9b1uH9ZGUPI,3708
+wry/core/env_utils.py,sha256=_yZDUPlzjIdyk-BbsX-sBfLCLmRsUlk8_la4zkg5mkI,4838
+wry/core/field_utils.py,sha256=nDFkbzfIf7mNJm6T5BuqcZ1mYUVIKinXfw77xpK_FK0,4134
+wry/core/model.py,sha256=tP0dyt0rsCDMxM9ULMLhHcaoOF3s9xd96iMkGbQ4uFE,27056
+wry/core/sources.py,sha256=4uboTc23f_CXiD3ql767-TvrGfe6xXN5NhXEIfNxD2U,1171
+wry-0.3.2.dev2.dist-info/licenses/LICENSE,sha256=0EfVapSdYZQRHpfqCVAO5OeyT2xMu8cxPKaRkWWdb2g,1068
+wry-0.3.2.dev2.dist-info/METADATA,sha256=E_0Sux0uGD5MC0BExttbkPT0a9P8SMAO_PD0j6aaPE0,24030
+wry-0.3.2.dev2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wry-0.3.2.dev2.dist-info/top_level.txt,sha256=ytpYWd5uCeQpPCdTYaB1Vjzp4C5em03WpUKn3SiDDY8,4
+wry-0.3.2.dev2.dist-info/RECORD,,

wry-0.3.2.dev0.dist-info/RECORD

@@ -1,18 +0,0 @@
-wry/__init__.py,sha256=r42j1WbOhUjsB3lXyhX7H1vZATs2glLoeoxw69uAB_U,3496
-wry/_version.py,sha256=F2rbIVsiqBoq-pirIKA3f5y7JD5arTtBiGUAlm59LGg,717
-wry/auto_model.py,sha256=YY71mkYr46P3O4cjY8fN0AmothtPcvsDqvk1eQM4VbE,6927
-wry/click_integration.py,sha256=XDeNDHGh99Now77vrGMo151xp0KjWZYm7nTuIHh6CU4,31775
-wry/help_system.py,sha256=zSryjsOXAWz9HyCpybwuFWrlaP9gwbMNIexuAWTcCns,5731
-wry/multi_model.py,sha256=f6Hf5NMfIZtdXc6t00iTPtUEbiWnQZiC7NKVchQ7QU4,5978
-wry/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wry/core/__init__.py,sha256=24Mu7qGzaFde8tAnyJOPPkD1ScZq-iSXNlDdAWSw_mg,894
-wry/core/accessors.py,sha256=Kn5dziklgcMWClOjbeJSwWNHOCQkpAWV9b1uH9ZGUPI,3708
-wry/core/env_utils.py,sha256=8TCgVPr7n5-YNThEVC5MvAG6qB0TW5MJkO1YT5yHZYI,4051
-wry/core/field_utils.py,sha256=nDFkbzfIf7mNJm6T5BuqcZ1mYUVIKinXfw77xpK_FK0,4134
-wry/core/model.py,sha256=CP0zElttAqpFHj2yD8O8CgMSm9VpSAT46nXcnCHw38U,25150
-wry/core/sources.py,sha256=4uboTc23f_CXiD3ql767-TvrGfe6xXN5NhXEIfNxD2U,1171
-wry-0.3.2.dev0.dist-info/licenses/LICENSE,sha256=0EfVapSdYZQRHpfqCVAO5OeyT2xMu8cxPKaRkWWdb2g,1068
-wry-0.3.2.dev0.dist-info/METADATA,sha256=8EJZPjxs48klq0rrJpTOoY00zcU7T8kqHcPMpKhs6_U,21429
-wry-0.3.2.dev0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-wry-0.3.2.dev0.dist-info/top_level.txt,sha256=ytpYWd5uCeQpPCdTYaB1Vjzp4C5em03WpUKn3SiDDY8,4
-wry-0.3.2.dev0.dist-info/RECORD,,