Welcome to pathvalidate’s documentation!

Table of Contents

• 1. pathvalidate
  • 1.1. Summary
  • 1.2. Features
  • 1.3. CLI tool
• 2. Installation
  • 2.1. Installation: pip
  • 2.2. Installation: conda
  • 2.3. Installation: apt
• 3. Dependencies
• 4. Examples
  • 4.1. Sanitize a filename
  • 4.2. Sanitize a filepath
  • 4.3. Replace symbols
  • 4.4. Validate a filename
  • 4.5. Validate a file path
  • 4.6. Check a filename
  • 4.7. Check a filepath
  • 4.8. filename/filepath validator for argparse
  • 4.9. filename/filepath sanitizer for argparse
  • 4.10. filename/filepath validator for click
  • 4.11. filename/filepath sanitizer for click
• 5. Reference
  • 5.1. Errors
    • ErrorReason
    • ValidationError
  • 5.2. Functions
    • 5.2.1. File name validation/sanitization
    • 5.2.2. Check a file name
    • 5.2.3. File path validation/sanitization
    • 5.2.4. Check a file path
    • 5.2.5. Symbol validation/sanitization
  • 5.3. Types
    • Platform
  • 5.4. Handlers
    • 5.4.1. Reserved name handlers
    • 5.4.2. Null value handlers
    • 5.4.3. Other handlers
  • 5.5. Tips
    • 5.5.1. Sanitize dot-files or dot-directories
• 6. Changelog
• 7. Sponsors
• 8. Indices and tables
• 9. Links

Indices and tables

• Index