SmartSeeds Logo

Getting Started

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Verify Installation
    • Optional Dependencies
      • Development
      • Documentation
    • Next Steps
  • Quick Start
    • Installation
    • Basic Usage
      • Example: Service Configuration
    • Three Calling Styles
      • Style 1: Prefix Style (Most Explicit)
      • Style 2: Dict Style (Compact)
      • Style 3: Boolean Activation (Use Defaults)
    • Multiple Prefix Families
    • Why Use extract_kwargs?
      • Problem: Nested Configuration is Messy
    • Next Steps

User Guide

  • extract_kwargs Decorator
    • Overview
    • Basic Usage
    • Multiple Prefix Families
    • Calling Styles
      • Style 1: Prefix Style (Most Explicit)
      • Style 2: Dict Style (Compact)
      • Style 3: Boolean Activation
    • Advanced Options
      • Custom Extraction Options
      • Keep Prefix in Keys
    • Reserved Keywords
    • Merging with Existing kwargs
    • Advanced Features
      • Dynamic Extraction Specs (_dictkwargs)
      • Adapter Hook (_adapter)
    • Signature
    • Requirements
    • Works with Functions Too
    • See Also
  • SmartOptions Guide
    • Overview
    • Basic Usage
    • Filtering Options
      • Ignore None Values
      • Ignore Empty Collections
      • Custom Filter Function
    • Converting to Dict
    • Dynamic Attributes
    • Use Cases
      • API Client Configuration
      • Plugin Configuration
      • CLI Argument Processing
    • Combining with extract_kwargs
    • API Reference
    • See Also
  • ASCII Table
    • Overview
    • Quick Start
      • Basic Table
      • With Title
    • Data Structure Format
      • Headers
      • Rows
      • Table Options
    • Type Formatting
      • String
      • Integer
      • Float
      • Boolean
      • Date
      • DateTime
    • Column Alignment
    • Hierarchical Data
    • Text Wrapping
    • ANSI Color Support
    • Markdown Export
    • Complete Example
    • API Reference
      • Main Functions
        • render_ascii_table(data, max_width=None)
        • render_markdown_table(data)
      • Utility Functions
        • format_cell(value, coldef)
        • strip_ansi(text)
        • normalize_date_format(fmt)
        • parse_bool(value)
    • See Also
  • Best Practices
    • General Guidelines
      • 1. Always Use Type Hints
      • 2. Document Expected Parameters
      • 3. Provide Sensible Defaults
    • Common Patterns
      • Pattern 1: Plugin Configuration
      • Pattern 2: Nested Object Creation
      • Pattern 3: Configuration from Files
    • Performance Considerations
      • Minimize Decorator Overhead
      • Use pop=False Only When Needed
    • Error Handling
      • Validate Extracted Configuration
      • Handle Optional Configurations Gracefully
    • Testing
      • Test with Different Calling Styles
      • Mock for Testing
    • Security Considerations
      • Sanitize Parameters
      • Avoid Injection Risks
    • Integration with Other Tools
      • With Pydantic
      • With dataclasses
    • See Also

Examples

  • Examples
    • SmartRoute Integration
    • Web Framework Configuration
    • CLI Tool Configuration
    • Data Pipeline
    • See Also

API Reference

  • API Reference
    • extract_kwargs
      • extract_kwargs()
      • Function Signature
      • Parameters
      • Returns
      • Examples
    • SmartOptions
      • SmartOptions
        • SmartOptions.__init__()
        • SmartOptions.as_dict()
      • Class Signature
      • Parameters
      • Methods
      • Examples
    • safe_is_instance
      • safe_is_instance()
      • Function Signature
      • Parameters
      • Returns
      • Examples
    • ASCII Table
      • render_ascii_table
        • render_ascii_table()
      • Function Signature
      • Parameters
      • Returns
      • render_markdown_table
        • render_markdown_table()
      • Function Signature
      • Parameters
      • Returns
      • Examples
    • Helper Functions
      • filtered_dict
      • make_opts
    • dictExtract (Internal)
    • Type Definitions
    • See Also

Appendix

  • Architecture
    • Overview
    • Core Components
      • 1. extract_kwargs Decorator
      • 2. dictExtract Utility
    • Design Principles
      • 1. Zero Dependencies
      • 2. Performance Optimization
      • 3. Type Safety
    • Execution Flow
      • Basic Flow
      • With Adapter
    • Type System
    • Error Handling
      • Missing Adapter
      • Reserved Names
    • Testing Architecture
    • Extension Points
      • Custom Adapters
      • Dynamic Specifications
    • See Also
  • Contributing
    • Development Setup
      • 1. Clone the Repository
      • 2. Create Virtual Environment
      • 3. Install Development Dependencies
      • 4. Run Tests
    • Project Structure
    • Coding Standards
      • Python Style
      • Type Hints
      • Docstrings
    • Testing Guidelines
      • Test Organization
      • Test Requirements
      • Running Tests
    • Documentation
      • Building Docs Locally
      • Documentation Standards
    • Pull Request Process
      • 1. Create Branch
      • 2. Make Changes
      • 3. Commit
      • 4. Push and Create PR
      • 5. Review Process
    • Release Process
      • Pre-Release Checklist
      • Step-by-Step Release Process
        • 1. Update Version Numbers
        • 2. Update Changelog
        • 3. Commit Version Updates
        • 4. Create and Push Tag
        • 5. Verify Build
      • Troubleshooting Releases
        • Wrong Version Published
        • Release Failed
      • Version Management Best Practices
    • Getting Help
    • Code of Conduct
      • Our Standards
      • Unacceptable Behavior
    • License
    • Recognition
    • See Also
SmartSeeds
  • Index
  • Edit on GitHub

Index

_ | A | E | R | S

_

  • __init__() (smartseeds.SmartOptions method)

A

  • as_dict() (smartseeds.SmartOptions method)

E

  • extract_kwargs() (in module smartseeds)

R

  • render_ascii_table() (in module smartseeds.ascii_table)
  • render_markdown_table() (in module smartseeds.ascii_table)

S

  • safe_is_instance() (in module smartseeds)
  • SmartOptions (class in smartseeds)

© Copyright 2025, Genropy Team.

Built with Sphinx using a theme provided by Read the Docs.