User Guide

Comprehensive documentation for all Vidhi features.

• Frozen Dataclasses
  • Basic Usage
  • Post-Initialization
  • Field Helper
• CLI Integration
  • Basic Usage
  • Field Metadata
  • Nested Configurations
  • Boolean Arguments
  • List Arguments
  • Polymorphic Type Selection
  • YAML File Loading
  • Overriding Programmatic Defaults
• Polymorphic Configurations
  • Defining Variants
  • Creating Instances
  • CLI with Polymorphic Configs
  • Nested Polymorphic Configs
  • YAML with Polymorphic Configs
  • Regular Configs Inside Polymorphic
• YAML Configuration
  • Loading via CLI
  • Nested Configs
  • Polymorphic Configs
  • Programmatic Loading
  • Serialization
• IDE Autocomplete
  • Quick Export
  • VS Code Setup
  • Programmatic Export
  • Other Formats
• Shell Completion
  • Quick Install
  • Programmatic Installation
  • Generating Scripts
  • Manual Setup
  • What Gets Completed
• API Reference
  • Core Functions
  • Data Loading
  • Polymorphism
  • Schema & Completion

Best Practices

1. Use enums for type discriminators - Provides type safety and IDE support

2. Provide sensible defaults - Make configurations easy to use out of the box

3. Document with help text - Use field(help="...") for CLI documentation

4. Group related configs - Use nested dataclasses for organization

5. Validate in __post_init__ - Check constraints during initialization

6. Keep configs immutable - Don’t work around the frozen constraint

7. Generate JSON Schema - Enable IDE autocomplete for config files