mkdocs_fedi_comments.actor

Actor dataclass

Configuration model for an actor

Parameters:

Name	Type	Description	Default
name	str		required
handle	str		required
summary	str | None		None
icon	str | None	url of an icon to display	None

Source code in mkdocs_fedi_comments/actor.py

@dataclass
class Actor:
    """Configuration model for an actor"""

    name: str
    handle: str
    summary: str | None = field(default=None)
    icon: str | None = field(
        default=None, metadata={"description": "url of an icon to display"}
    )

    def as_json(self):
        return json.dumps(asdict(self))  # type: ignore

    def as_file(self, config):
        return File.generated(
            src_uri="fedi-actor.json",
            config=config,
            content=self.as_json(),
        )

Comments