SiteMapUrl source

        
class SiteMapUrl(pydantic.BaseModel):
    """[DEPRECATED] A model representing a URL entry in the sitemap.xml file.

    WARNING: This class is part of the deprecated sitemap plugin. Please migrate to
    the feeds plugin which provides more comprehensive sitemap generation capabilities.

    To configure the base URL for your site, set the 'url' field in your markata config:
    ```yaml
    url: https://example.com
    ```

    If no base URL is set, relative URLs will be used.
    """

    slug: str = Field(..., exclude=True)
    loc: str = Field(
        None,
        include=True,
        description="The full URL for this page in the sitemap. Generated automatically from config.url + slug.",
    )
    changefreq: str = Field("daily", include=True)
    priority: str = Field("0.7", include=True)
    markata: Any = Field(None, exclude=True)

    model_config = pydantic.ConfigDict(
        validate_assignment=False,
        arbitrary_types_allowed=True,
        extra="allow",
        str_strip_whitespace=True,
        validate_default=True,
        coerce_numbers_to_str=True,
        populate_by_name=True,
    )

    @pydantic.field_validator("loc", mode="before")
    @classmethod
    def validate_loc(cls, v, info) -> str:
        """Generate the URL for the sitemap entry.

        Uses markata.config.url as the base URL if set, otherwise uses relative URLs.
        Example: https://example.com/my-page/ or /my-page/
        """
        if v is None:
            markata = info.data.get("markata")
            slug = info.data.get("slug")
            if markata is None or slug is None:
                raise ValueError(
                    "Could not generate sitemap URL: markata and slug are required. "
                    "This usually means the Post model is missing required fields. "
                    "Check that your post has a valid slug and markata instance."
                )

            # Get base URL from config, default to empty string if not set
            base_url = getattr(markata.config, "url", "")
            if not base_url:
                return f"/{slug}/"

            # Ensure URL has a trailing slash for consistency
            return f"{base_url.rstrip('/')}/{slug}/"
        return v

    def dict(self, *args, **kwargs):
        return {"url": {**super().dict(*args, **kwargs)}}

SiteMapPost source

        
class SiteMapPost(pydantic.BaseModel):
    """[DEPRECATED] A model for posts that will be included in the sitemap.

    WARNING: This class is part of the deprecated sitemap plugin. Please migrate to
    the feeds plugin which provides more comprehensive sitemap generation capabilities.

    To configure the base URL for your site, set the 'url' field in your markata config:
    ```yaml
    url: https://example.com
    ```
    """

    slug: str = None
    published: bool = True
    sitemap_url: Optional[SiteMapUrl] = None
    markata: Any = Field(None, exclude=True)

    model_config = pydantic.ConfigDict(
        validate_assignment=False,
        arbitrary_types_allowed=True,
        extra="allow",
        str_strip_whitespace=True,
        validate_default=True,
        coerce_numbers_to_str=True,
        populate_by_name=True,
    )

    @pydantic.field_validator("sitemap_url", mode="before")
    @classmethod
    def validate_sitemap_url(cls, v, info) -> Optional[SiteMapUrl]:
        """Initialize sitemap_url if not provided."""
        markata = info.data.get("markata")
        slug = info.data.get("slug")
        if markata is None or slug is None:
            raise ValueError(
                "Could not create sitemap entry: markata and slug are required. "
                "This usually means the Post model is missing required fields. "
                "Check that your post has a valid slug and markata instance."
            )

        if v is None:
            return SiteMapUrl(markata=markata, slug=slug)
        if isinstance(v, dict):
            return SiteMapUrl(**v, markata=markata, slug=slug)
        if v.markata is None:
            v.markata = markata
        if v.slug is None:
            v.slug = slug
        return v

validate_loc source

        
def validate_loc(cls, v, info) -> str:
        """Generate the URL for the sitemap entry.

        Uses markata.config.url as the base URL if set, otherwise uses relative URLs.
        Example: https://example.com/my-page/ or /my-page/
        """
        if v is None:
            markata = info.data.get("markata")
            slug = info.data.get("slug")
            if markata is None or slug is None:
                raise ValueError(
                    "Could not generate sitemap URL: markata and slug are required. "
                    "This usually means the Post model is missing required fields. "
                    "Check that your post has a valid slug and markata instance."
                )

            # Get base URL from config, default to empty string if not set
            base_url = getattr(markata.config, "url", "")
            if not base_url:
                return f"/{slug}/"

            # Ensure URL has a trailing slash for consistency
            return f"{base_url.rstrip('/')}/{slug}/"
        return v

validate_sitemap_url source

        
def validate_sitemap_url(cls, v, info) -> Optional[SiteMapUrl]:
        """Initialize sitemap_url if not provided."""
        markata = info.data.get("markata")
        slug = info.data.get("slug")
        if markata is None or slug is None:
            raise ValueError(
                "Could not create sitemap entry: markata and slug are required. "
                "This usually means the Post model is missing required fields. "
                "Check that your post has a valid slug and markata instance."
            )

        if v is None:
            return SiteMapUrl(markata=markata, slug=slug)
        if isinstance(v, dict):
            return SiteMapUrl(**v, markata=markata, slug=slug)
        if v.markata is None:
            v.markata = markata
        if v.slug is None:
            v.slug = slug
        return v