cli-pydantic 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

cli_pydantic/lib.py

@@ -104,12 +104,12 @@ def model_help(model: type[BaseModel], prefix: str = "") -> list[str]:
                     if field.default is PydanticUndefined
                     else f" (default: {field.default})"
                 )
-                desc = field.description or ""
+                desc = f" {field.description}" if field.description else ""
                 out.append((f"--{key} {ty_name(ann)}", f"{desc}{default}"))
         return out
 
     items = entries(model, prefix)
-    col = max((len(f) for f, _ in items), default=0) + 2
+    col = max((len(f) for f, _ in items), default=0) + 1
     return [f"  {f:<{col}}{h}" for f, h in items]
 
 
@@ -152,9 +152,10 @@ def cli[T: BaseModel](model_cls: type[T], desc: str = "") -> T:
 
     def print_help():
         prog = Path(sys.argv[0]).name
-        lines = [f"usage: {prog} [-h] [configs ...] [--overrides ...]"]
+        lines = []
         if desc:
-            lines.append(f"\n{desc}")
+            lines.append(f"help: {desc}\n")
+        lines.append(f"usage: {prog} [-h] [configs ...] [--overrides ...]")
         lines.append("\nconfig arguments:")
         lines.extend(model_help(model_cls))
         print("\n".join(lines))

{cli_pydantic-0.2.0.dist-info → cli_pydantic-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cli-pydantic
-Version: 0.2.0
+Version: 0.2.1
 Summary: Add your description here
 Author: Tom Pollak
 Author-email: Tom Pollak <tomp@graphcore.ai>
@@ -25,8 +25,7 @@ pip install cli-pydantic
 ## Usage
 
 ```python
-# train.py
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 from cli_pydantic import cli
 
 class Data(BaseModel):
@@ -42,7 +41,7 @@ class Config(BaseModel):
     data: Data = Data()
     model: Model = Model()
     epochs: int = 10
-    verbose: bool = False
+    profile: bool = Field(False, description="dump chrome trace")
 
 cfg = cli(Config, desc="Training pipeline")
 ```
@@ -58,7 +57,7 @@ python train.py base.yaml
 python train.py base.yaml fast.yaml --model.lr 0.05 --epochs 3
 
 # Lists and booleans
-python train.py --model.layers 16,32 --verbose
+python train.py --model.layers 16,32 --profile
 ```
 
 ## Semantics:
@@ -67,3 +66,21 @@ python train.py --model.layers 16,32 --verbose
 - For lists: `--nums=1,2,3` or `--nums 1 --nums=2 --nums 3`
 - For bools: `--enable` / `--no-enable`
 - Lists will _replace_ previous configs on override -- not append!
+
+## Automatic help
+
+```bash
+$ python train.py --help
+help: Training pipeline
+
+usage: train.py [-h] [configs ...] [--overrides ...]
+
+config arguments:
+  --data.path str          (default: ./data)
+  --data.splits list[str]  (default: ['train', 'val'])
+  --model.arch str         (default: resnet50)
+  --model.lr float         (default: 0.001)
+  --model.layers list[int] (default: [64, 128, 256])
+  --epochs int             (default: 10)
+  --verbose bool           dump chrome trace (default: False)
+```

cli_pydantic-0.2.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+cli_pydantic/__init__.py,sha256=FzDWd6rL0-KFfomhD6Zfa_Au9y9g7jznspke55BFHbI,40
+cli_pydantic/lib.py,sha256=UE-pjLAzo4E5g0Mqz7SkpR9OQDm8WtCDLOvHyQEFccs,5661
+cli_pydantic/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli_pydantic-0.2.1.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+cli_pydantic-0.2.1.dist-info/METADATA,sha256=eoaU3Cr9uFSilxNQyVE7w6efqN-Rx6h9lF-DcxpwuNY,2093
+cli_pydantic-0.2.1.dist-info/RECORD,,

cli_pydantic-0.2.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-cli_pydantic/__init__.py,sha256=FzDWd6rL0-KFfomhD6Zfa_Au9y9g7jznspke55BFHbI,40
-cli_pydantic/lib.py,sha256=vZsv9rSlYmL-aIDKD1Y-cRE3ElhkKzdI82cpeLVmDbY,5603
-cli_pydantic/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cli_pydantic-0.2.0.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
-cli_pydantic-0.2.0.dist-info/METADATA,sha256=oR2y5ZDl6-9xvRW7xoEV24iTkRhO4g2yTxrlk15kLdw,1556
-cli_pydantic-0.2.0.dist-info/RECORD,,