Naming Conventions
params-proto automatically converts Python naming conventions to CLI conventions.
Parameter Names: snake_case → kebab-case
Python parameters convert to CLI arguments:
CLI arguments:
Conversion rule: Replace _ with -, then lowercase
Class Names: PascalCase → kebab-case
When using Union types for subcommands, class names convert to CLI commands:
CLI commands:
Conversion rule: PascalCase → kebab-case (e.g., HTTPServer → http-server, MLModel → ml-model)
Prefix Names: PascalCase → kebab-case
When using @proto.prefix, class names convert to kebab-case prefixes:
CLI arguments:
Conversion rule: Class name converts to kebab-case (e.g., DataLoader → data-loader), parameters convert to kebab-case.
Naming Best Practices
1. Use Simple Names for Union Types
2. Use snake_case for Parameters
3. Keep Prefix Names Simple
Syntax Variations
For Union type selection (like --camera:ClassName), all naming conventions work:
| Python Class | CLI Syntax Options |
|---|---|
PerspectiveCamera | perspective-camera, perspectivecamera, PerspectiveCamera |
HTTPServer | httpserver, http-server, HTTPServer |
MLModel | mlmodel, ml-model, MLModel |
Note
For prefix parameter access (like
--http-server.port), you must use the exact registered prefix name, which is the kebab-case version of the class name (e.g.,http-serverforHTTPServer). Attribute names always convert to kebab-case:
Summary
Key conversions:
- Parameters:
snake_case→--kebab-case - Union classes:
PascalCase→kebab-case - Prefixes:
PascalCase→--kebab-case.kebab-case - Booleans:
bool→--flag/--no-flag
Best practices:
- Use simple class names for Union types
- Use snake_case for all parameters
- Keep prefix names short and clear
- Document with comments and docstrings
Related
- CLI Fundamentals - Core CLI features
- CLI Patterns - Advanced CLI patterns
- Help Generation - Documentation extraction
Union Types- Union subcommands