formatparse

Contents:

  • Installation
    • From PyPI
    • From Source
    • Requirements
  • User Guides
    • Getting Started
      • Installation
      • Basic Usage
      • Parsing with Named Fields
      • Searching in Text
      • Finding All Matches
      • Understanding ParseResult
      • Next Steps
    • Pattern Syntax
      • Field Syntax
        • Basic Fields
      • Type Specifiers
        • Regex lookarounds after :d / :f (issue #9)
        • Brace-delimited text in the input (:brace)
        • Nested format patterns in a field spec (#12)
      • Format Specifiers
        • Alignment
        • Width
        • Precision
        • Combining Width and Precision
        • Integer width and precision (#82 / parse#107)
      • Positional vs Named Fields
      • Escaping Braces
      • Advanced Examples
        • Complex Format Specifiers
        • Zero-Padding
        • Scientific Notation
      • See also
    • Multiline and indent-block fields
      • Examples
    • Nesting and composition
      • Nested field patterns
      • Composition with composed_type
    • Post-parse validation
    • Replacing parse (migration)
      • API surface
      • Malformed patterns
      • Pattern cache and extra_types
      • Pickling
    • Performance
    • DateTime Parsing
      • Supported DateTime Formats
        • ISO 8601 Format (:ti)
        • HTTP Date Format (:th)
        • RFC 2822 Format (:te)
        • Global Date Format (:tg)
        • US Date Format (:ta)
        • Ctime Format (:tc)
        • System Log Format (:ts)
      • Custom DateTime Formats (:strftime)
      • Timezone Handling
      • Example: Parsing Log Entries
    • Custom Types
      • Basic Custom Types
      • Compile-time extra_types
      • Regex Patterns
      • Regex Groups
      • Integration with parse/search/findall
      • Advanced Examples
        • Parsing IP Addresses
        • Parsing Enumerations
        • Complex Parsing
    • Bidirectional Patterns
      • Basic Usage
      • Formatting Back
      • Modifying Values
      • Validation
      • Using format() Method Directly
      • Real-World Use Cases
        • Configuration File Updates
        • Data Transformation Pipelines
        • Form Validation
  • API Reference
    • Core Functions
      • parse
        • parse()
      • search
        • search()
      • findall
        • findall()
      • findall_iter
        • findall_iter()
      • parse_batch
        • parse_batch()
      • parse_with_validation
        • parse_with_validation()
      • compile
        • compile()
      • with_pattern
        • with_pattern()
    • Types and iterators
      • FindallIter
        • FindallIter
      • ComposedType
        • ComposedType
      • composed_type
        • composed_type()
      • ValidatedParser
        • ValidatedParser
    • Validation
      • ValidationPipeline
        • ValidationPipeline
      • apply_validators
        • apply_validators()
      • validator
        • validator()
      • Built-in validators
        • in_range()
        • non_empty_str()
        • is_valid_email()
        • is_valid_url()
      • Type aliases
        • ValidationMode
        • ValidatorMap
    • Classes
      • ParseResult
        • ParseResult
      • FormatParser
        • FormatParser
      • BidirectionalPattern
        • BidirectionalPattern
      • BidirectionalResult
        • BidirectionalResult
      • FixedTzOffset
        • FixedTzOffset
    • Exceptions
      • PatternParseMismatch
        • PatternParseMismatch
      • ValidationError
        • ValidationError
      • ValidationWarning
        • ValidationWarning
      • MultipleValidationErrors
        • MultipleValidationErrors
      • RepeatedNameError
        • RepeatedNameError
  • Examples and Cookbook
    • Cookbook
      • Common Patterns and Solutions
        • Parsing Log Files
        • Extracting URLs
        • Parsing Configuration Files
        • Processing CSV-like Data
        • Custom types (extra_types)
      • Performance Tips
        • Use compile() for Repeated Patterns
        • Use findall() for Multiple Matches
      • Best Practices
        • Handle None Results
        • Use Type Specifiers
        • Validate Input with BidirectionalPattern
  • Security Best Practices
    • Input Validation
    • Pattern Complexity
    • Regular Expression Denial of Service (ReDoS)
    • Resource Limits
    • Error Handling
    • Dependencies
    • Performance Considerations
    • Known Limitations
    • Reporting Security Issues
  • Changelog
    • [Unreleased]
      • Planned
    • 0.8.2 - 2026-05-22
      • Added
      • Changed
      • Fixed
    • 0.8.1 - 2026-05-15
      • Changed
      • Maintenance
    • 0.8.0 - 2026-05-15
      • Added
      • Fixed
      • Changed
      • Documentation
      • Maintenance
    • 0.7.0 - 2026-05-14
      • PyPI publish (post-tag workflow fix)
      • Added
      • Fixed
      • Changed
      • Maintenance
formatparse
  • API Reference
  • View page source

API Reference

This section provides detailed API documentation for all formatparse functions and classes.

  • Core Functions
    • parse
    • search
    • findall
    • findall_iter
    • parse_batch
    • parse_with_validation
    • compile
    • with_pattern
  • Types and iterators
    • FindallIter
    • ComposedType
    • composed_type
    • ValidatedParser
  • Validation
    • ValidationPipeline
    • apply_validators
    • validator
    • Built-in validators
    • Type aliases
  • Classes
    • ParseResult
    • FormatParser
    • BidirectionalPattern
    • BidirectionalResult
    • FixedTzOffset
  • Exceptions
    • PatternParseMismatch
    • ValidationError
    • ValidationWarning
    • MultipleValidationErrors
    • RepeatedNameError
Previous Next

© Copyright 2024-2026, Odos Matthews.

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