Module

health.validators.sitemap

Sitemap validator - checks sitemap.xml validity for SEO.

Validates:

  • Sitemap file exists
  • XML is well-formed
  • No duplicate URLs
  • URLs are properly formatted
  • Sitemap follows protocol
View source
1 Class

Classes

SitemapValidator
Validates sitemap.xml for SEO. Checks: - Sitemap file exists - XML is well-formed - Follows sitema…
5

Validates sitemap.xml for SEO.

Checks:

  • Sitemap file exists
  • XML is well-formed
  • Follows sitemap protocol (http://www.sitemaps.org/)
  • No duplicate URLs
  • URLs are absolute and properly formatted
  • Sitemap includes expected pages
Inherits from BaseValidator

Methods 1

validate
Run sitemap validation checks.
2 list[CheckResult] 
def validate(self, site: Site, build_context: BuildContext | Any | None = None) -> list[CheckResult]

Run sitemap validation checks.

Parameters 2
site Site
build_context BuildContext | Any | None
Returns

list[CheckResult]

Internal Methods 4
_check_sitemap_structure
Check sitemap structure validity.
1 list[CheckResult] 
def _check_sitemap_structure(self, root: ET.Element) -> list[CheckResult]

Check sitemap structure validity.

Parameters 1
root ET.Element
Returns

list[CheckResult]

_check_sitemap_urls
Check URLs in sitemap are properly formatted.
2 list[CheckResult] 
def _check_sitemap_urls(self, root: ET.Element, site: Site) -> list[CheckResult]

Check URLs in sitemap are properly formatted.

Parameters 2
root ET.Element
site Site
Returns

list[CheckResult]

_check_duplicate_urls
Check for duplicate URLs in sitemap.
1 list[CheckResult] 
def _check_duplicate_urls(self, root: ET.Element) -> list[CheckResult]

Check for duplicate URLs in sitemap.

Parameters 1
root ET.Element
Returns

list[CheckResult]

_check_sitemap_coverage
Check sitemap includes expected pages.
2 list[CheckResult] 
def _check_sitemap_coverage(self, root: ET.Element, site: Site) -> list[CheckResult]

Check sitemap includes expected pages.

Parameters 2
root ET.Element
site Site
Returns

list[CheckResult]