validator-collection

Warnings

• gotcha URL and domain validation logic has undergone frequent fixes and changes across minor versions (e.g., 1.3.3, 1.3.5, 1.4.1, 1.4.2, 1.5.0). This means the validation behavior for specific URLs might change after updating the library, potentially causing previously accepted (or rejected) inputs to now yield different results.
  Fix: Thoroughly re-test any existing URL or domain validation logic after upgrading to a new minor or patch version, especially for edge cases or non-standard URLs.
• deprecated The library officially supports Python 2.7, a version that has reached its end-of-life and is no longer maintained. While the library might function, continued use on Python 2.7 is highly discouraged due to security vulnerabilities and lack of future support.
  Fix: Migrate your application to a supported Python 3.x version (the library explicitly excludes Python 3.0-3.3, so aim for 3.4+).
• gotcha The library provides two distinct patterns for validation: `validators.function()` which returns the validated value or raises `ValueError`/`TypeError`, and `checkers.is_function()` which returns a boolean. Mixing these up can lead to unexpected behavior or incorrect error handling in your application logic.
  Fix: Always be explicit about whether you need to retrieve a validated value (use `validators`) or simply check for validity (use `checkers`). Implement `try-except` blocks for `validators` functions.
• gotcha The project's release cadence has shown variability, with significant gaps between some minor versions (e.g., between 2020 and 2023 for 1.5.0). While still maintained, this might imply a slower pace for bug fixes or new feature development compared to other libraries.
  Fix: When integrating `validator-collection`, factor in the release history and set appropriate expectations for rapid support or feature additions.

Install

• pip install validator-collection Install latest version

Imports

• email

  from validator_collection.validators import email

• url

  from validator_collection.validators import url

• is_email

  from validator_collection.checkers import is_email

• is_url

  from validator_collection.checkers import is_url

• validators

  from validator_collection import validators

  Allows access to all validator functions via 'validators.function_name()'
• checkers

  from validator_collection import checkers

  Allows access to all checker functions via 'checkers.is_function_name()'

Quickstart

This quickstart demonstrates the two primary ways to use `validator-collection`: 'validator' functions which return the validated data or raise an error, and 'checker' functions which return a boolean indicating validity.

from validator_collection.validators import email, url
from validator_collection.checkers import is_email, is_url

# Example 1: Using validators (raise ValueError/TypeError if invalid)
try:
    valid_email = email("test@example.com")
    print(f"Validated Email: {valid_email}")

    valid_url = url("https://www.example.com")
    print(f"Validated URL: {valid_url}")

    # This will raise a ValueError
    # invalid_email = email("invalid-email")

    # This will raise a ValueError
    # invalid_url = url("not-a-url")

except (ValueError, TypeError) as e:
    print(f"Validation Error: {e}")

# Example 2: Using checkers (return True/False)
print(f"Is 'test@example.com' a valid email? {is_email('test@example.com')}")
print(f"Is 'not-an-email' a valid email? {is_email('not-an-email')}")
print(f"Is 'https://example.com' a valid URL? {is_url('https://example.com')}")
print(f"Is 'ftp://another.com' a valid URL? {is_url('ftp://another.com')}") # Supports various protocols