Module

health.linkcheck.ignore_policy

Ignore policy for link checking.

Supports patterns, domains, and status ranges.

View source
1 Class

Classes

IgnorePolicy
Policy for ignoring certain links or statuses. Supports: - URL patterns (regex) - Domain exclusion…
4

Policy for ignoring certain links or statuses.

Supports:

  • URL patterns (regex)
  • Domain exclusions
  • Status code ranges (e.g., "500-599", "403")

Methods 3

should_ignore_url
Check if URL should be ignored.
1 tuple[bool, str | None] 
def should_ignore_url(self, url: str) -> tuple[bool, str | None]

Check if URL should be ignored.

Parameters 1
url str

URL to check
Returns

tuple[bool, str | None] —

Tuple of (should_ignore, reason)

should_ignore_status
Check if status code should be ignored.
1 tuple[bool, str | None] 
def should_ignore_status(self, status_code: int) -> tuple[bool, str | None]

Check if status code should be ignored.

Parameters 1
status_code int

HTTP status code
Returns

tuple[bool, str | None] —

Tuple of (should_ignore, reason)

from_config classmethod
Create IgnorePolicy from config dict.
1 IgnorePolicy 
def from_config(cls, config: dict[str, Any]) -> IgnorePolicy

Create IgnorePolicy from config dict.

Parameters 1
config dict[str, Any]

Configuration dict with optional keys: - exclude: list of URL patterns - exclude_domain: list of domains - ignore_status: list of status ranges
Returns

IgnorePolicy —

Configured IgnorePolicy instance

Internal Methods 1
__init__
Initialize ignore policy.
3 None 
def __init__(self, patterns: list[str] | None = None, domains: list[str] | None = None, status_ranges: list[str] | None = None)

Initialize ignore policy.

Parameters 3
patterns list[str] | None

Regex patterns to match against URLs
domains list[str] | None

Domain names to ignore (e.g., "localhost", "example.com")
status_ranges list[str] | None

Status code ranges to ignore (e.g., "500-599", "403")