dataclass-args 1.4.2__tar.gz → 1.4.3__tar.gz

{dataclass_args-1.4.2 → dataclass_args-1.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataclass-args
-Version: 1.4.2
+Version: 1.4.3
 Summary: Zero-boilerplate CLI generation from Python dataclasses with advanced type support and file loading
 Author-email: Martin Bartlett <martin.j.bartlett@gmail.com>
 License: MIT

{dataclass_args-1.4.2 → dataclass_args-1.4.3}/dataclass_args/__init__.py

@@ -91,7 +91,7 @@ from .exceptions import ConfigBuilderError, ConfigurationError, FileLoadingError
 from .file_loading import is_file_loadable_value, load_file_content
 from .utils import load_structured_file
 
-__version__ = "1.4.2"
+__version__ = "1.4.3"
 
 __all__ = [
     # Main API

{dataclass_args-1.4.2 → dataclass_args-1.4.3}/dataclass_args/builder.py

@@ -450,7 +450,10 @@ class GenericConfigBuilder:
                 info = mapping["nested_info"]
                 prefix = mapping["prefix"]
                 if not is_cli_positional(info):
-                    self._add_argument(parser, nested_field, info, cli_name, prefix)
+                    parent = mapping["parent_field"]
+                    self._add_argument(
+                        parser, nested_field, info, cli_name, prefix, parent
+                    )
             else:
                 # Regular field - skip if nested dataclass
                 field_name = mapping["field_name"]
@@ -520,6 +523,7 @@ class GenericConfigBuilder:
         info: Dict[str, Any],
         cli_name: Optional[str] = None,
         prefix: str = "",
+        parent_field: Optional[str] = None,
     ) -> None:
         """
         Add CLI argument for a field (unified handler for flat and nested fields).
@@ -530,6 +534,7 @@ class GenericConfigBuilder:
             info: Field info dict
             cli_name: Pre-computed CLI name (for nested fields), uses info["cli_name"] if None
             prefix: Prefix for nested fields (empty string = no prefix)
+            parent_field: Parent field name for nested fields (for help text context)
         """
         # Boolean fields handled separately
         if info["type"] == bool:
@@ -553,9 +558,12 @@ class GenericConfigBuilder:
 
         # Build help text
         custom_help = get_cli_help(info)
-        help_text = (
-            custom_help if custom_help else ("nested field" if prefix else field_name)
-        )
+        if custom_help:
+            help_text = custom_help
+        elif parent_field:
+            help_text = f"{parent_field}.{field_name}"
+        else:
+            help_text = field_name
         choices = get_cli_choices(info)
 
         # Handle append fields

{dataclass_args-1.4.2 → dataclass_args-1.4.3}/dataclass_args.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataclass-args
-Version: 1.4.2
+Version: 1.4.3
 Summary: Zero-boilerplate CLI generation from Python dataclasses with advanced type support and file loading
 Author-email: Martin Bartlett <martin.j.bartlett@gmail.com>
 License: MIT

{dataclass_args-1.4.2 → dataclass_args-1.4.3}/dataclass_args.egg-info/SOURCES.txt

@@ -33,6 +33,7 @@ tests/test_config_merging_simple.py
 tests/test_description.py
 tests/test_file_loading.py
 tests/test_nested_dict_override.py
+tests/test_nested_help_text.py
 tests/test_nested_property_override_bug.py
 tests/test_positional.py
 tests/test_type_inspector.py

{dataclass_args-1.4.2 → dataclass_args-1.4.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dataclass-args"
-version = "1.4.2"
+version = "1.4.3"
 description = "Zero-boilerplate CLI generation from Python dataclasses with advanced type support and file loading"
 readme = "README.md"
 requires-python = ">=3.8"

dataclass_args-1.4.3/tests/test_nested_help_text.py

@@ -0,0 +1,151 @@
+"""Test that nested field help text shows parent.field context."""
+
+import argparse
+from dataclasses import dataclass
+
+from dataclass_args import GenericConfigBuilder, cli_help, cli_nested
+
+
+class TestNestedHelpText:
+    """Test nested field help text generation."""
+
+    def test_nested_with_prefix_shows_parent_field_in_help(self):
+        """Nested fields with prefix should show 'parent.field' in help text."""
+
+        @dataclass
+        class AgentConfig:
+            name: str = "default"
+            timeout: int = 30
+
+        @dataclass
+        class Config:
+            agent: AgentConfig = cli_nested(prefix="a2a")
+
+        builder = GenericConfigBuilder(Config)
+        parser = argparse.ArgumentParser()
+        builder.add_arguments(parser)
+
+        # Get help text
+        help_text = parser.format_help()
+
+        # Should show parent.field in help text
+        assert "agent.name" in help_text
+        assert "agent.timeout" in help_text
+
+        # Should NOT show generic "nested field"
+        assert "nested field" not in help_text
+
+    def test_nested_with_custom_help_uses_custom(self):
+        """Custom help text should override parent.field format."""
+
+        @dataclass
+        class Inner:
+            value: str = cli_help("Custom help text", default="test")
+
+        @dataclass
+        class Outer:
+            inner: Inner = cli_nested(prefix="i")
+
+        builder = GenericConfigBuilder(Outer)
+        parser = argparse.ArgumentParser()
+        builder.add_arguments(parser)
+
+        help_text = parser.format_help()
+
+        # Should use custom help text
+        assert "Custom help text" in help_text
+
+        # Should NOT show parent.field format
+        assert "inner.value" not in help_text
+
+    def test_nested_empty_prefix_shows_field_name(self):
+        """Nested fields with empty prefix should show just the field name."""
+
+        @dataclass
+        class Inner:
+            count: int = 5
+
+        @dataclass
+        class Outer:
+            inner: Inner = cli_nested(prefix="")
+
+        builder = GenericConfigBuilder(Outer)
+        parser = argparse.ArgumentParser()
+        builder.add_arguments(parser)
+
+        help_text = parser.format_help()
+
+        # With empty prefix, should show field name
+        assert "--count" in help_text
+        # Should show just "count" not "inner.count" since prefix is empty
+        lines = help_text.split("\n")
+        count_help = [line for line in lines if "--count" in line]
+        assert any("count" in line for line in count_help)
+
+    def test_multiple_nested_fields_all_show_parent(self):
+        """Multiple nested fields should all show parent.field format."""
+
+        @dataclass
+        class DatabaseConfig:
+            host: str = "localhost"
+            port: int = 5432
+            user: str = "admin"
+
+        @dataclass
+        class CacheConfig:
+            host: str = "localhost"
+            port: int = 6379
+
+        @dataclass
+        class AppConfig:
+            database: DatabaseConfig = cli_nested(prefix="db")
+            cache: CacheConfig = cli_nested(prefix="cache")
+
+        builder = GenericConfigBuilder(AppConfig)
+        parser = argparse.ArgumentParser()
+        builder.add_arguments(parser)
+
+        help_text = parser.format_help()
+
+        # Database fields
+        assert "database.host" in help_text
+        assert "database.port" in help_text
+        assert "database.user" in help_text
+
+        # Cache fields
+        assert "cache.host" in help_text
+        assert "cache.port" in help_text
+
+        # CLI names should have prefixes
+        assert "--db-host" in help_text
+        assert "--db-port" in help_text
+        assert "--cache-host" in help_text
+        assert "--cache-port" in help_text
+
+    def test_nested_dataclass_field_shows_parent_context(self):
+        """Nested dataclass fields (not fully flattened) show parent context."""
+
+        @dataclass
+        class Level3:
+            value: str = "deep"
+
+        @dataclass
+        class Level2:
+            level3: Level3 = cli_nested(prefix="l3")
+
+        @dataclass
+        class Level1:
+            level2: Level2 = cli_nested(prefix="l2")
+
+        builder = GenericConfigBuilder(Level1)
+        parser = argparse.ArgumentParser()
+        builder.add_arguments(parser)
+
+        help_text = parser.format_help()
+
+        # Level2.level3 is not fully flattened (requires recursive flattening)
+        # So it shows as level2.level3
+        assert "level2.level3" in help_text
+
+        # CLI name has the l2 prefix
+        assert "--l2-level3" in help_text