Module activitypubdantic.models.actor

ACTOR PYDANTIC MODELS FOR VALIDATION

Documentation: https://www.w3.org/TR/activitystreams-vocabulary/#actor-types

# -*- coding: utf-8 -*-
"""
ACTOR PYDANTIC MODELS FOR VALIDATION \n
Documentation: https://www.w3.org/TR/activitystreams-vocabulary/#actor-types
"""
# Import Pydantic models and types
from pydantic import BaseModel, ConfigDict, field_validator, HttpUrl
from typing import List, Literal, Union

# Import core models that are required for the actor definition
# Not all will be directly called
from activitypubdantic.models.core import (
    CollectionModel,
    CollectionPageModel,
    ImageModel,
    LinkModel,
    PlaceModel,
    ObjectModel,
    OrderedCollectionModel,
    _must_be_camel,
    _must_be_collections,
    _must_be_list,
    _must_be_ordered_collections,
    validate_collections,
)


"""
VALIDATORS
"""


# Validate HttpUrl or EndPoints
def validate_httpurls_or_endpoints(v):
    if isinstance(v, str):  # If a string, default to HttpUrl
        return v
    elif isinstance(v, dict):  # If a dictionary, use EndPointsModel
        return EndpointsModel(**v)
    return v


# Validate list of Collections
def validate_list_collections(v):
    v = _must_be_list(v)
    for i, item in enumerate(v):
        if item:
            v[i] = _must_be_collections(item)
        else:
            v.pop(i)
    return v if v else None


# Validate ordered Collections
def validate_ordered_collections(v):
    return _must_be_ordered_collections(v)


"""
ACTOR DEPENDENCIES
"""


class EndpointsModel(BaseModel):
    """
    A JSON object which maps additional (typically server/domain-wide) endpoints,
    which may be useful either for this actor or someone referencing this actor.
    Documentation: https://www.w3.org/TR/activitypub/#actor-objects
    """

    # Ensure camel case for all aliases
    model_config = ConfigDict(alias_generator=_must_be_camel, populate_by_name=True)

    # Properties
    proxy_url: Union[None, HttpUrl] = None
    oauth_authorization_endpoint: Union[HttpUrl, None] = None
    oauth_token_endpoint: Union[HttpUrl, None] = None
    provide_client_key: Union[HttpUrl, None] = None
    sign_client_key: Union[HttpUrl, None] = None
    shared_inbox: Union[HttpUrl, None] = None


"""
ACTOR TYPES
"""


class ActorModel(ObjectModel):
    """
    Actor types are Object types that are capable of performing activities.
    ActivityPub adds properties: https://www.w3.org/TR/activitypub/#actors
    """

    # Type
    type: Literal["Actor"] = "Actor"

    # Properties
    preferred_username: str = None
    inbox: ObjectModel = None  # Required
    outbox: ObjectModel = None  # Required
    following: Union[None, ObjectModel] = None
    followers: Union[None, ObjectModel] = None
    liked: Union[None, ObjectModel] = None
    streams: Union[None, List[Union[None, ObjectModel]]] = None
    endpoints: Union[None, HttpUrl, EndpointsModel] = None

    # Validation
    _actor_collections = field_validator(
        "following", "followers", "liked", mode="before"
    )(validate_collections)
    _actor_list_collections = field_validator("streams", mode="before")(
        validate_list_collections
    )
    _actor_orderedcollections = field_validator("inbox", "outbox", mode="before")(
        validate_ordered_collections
    )
    _actor_httpurls_or_endpoints = field_validator("endpoints", mode="before")(
        validate_httpurls_or_endpoints
    )


class ApplicationModel(ActorModel):
    """
    Describes a software application.
    """

    # Type
    type: Literal["Application"] = "Application"


class GroupModel(ActorModel):
    """
    Represents a formal or informal collective of Actors.
    """

    # Type
    type: Literal["Group"] = "Group"


class OrganizationModel(ActorModel):
    """
    Represents an organization.
    """

    # Type
    type: Literal["Organization"] = "Organization"


class PersonModel(ActorModel):
    """
    Represents an individual person.
    """

    # Type
    type: Literal["Person"] = "Person"


class ServiceModel(ActorModel):
    """
    Represents a service of any kind.
    """

    # Type
    type: Literal["Service"] = "Service"

Functions

def validate_httpurls_or_endpoints(v)

Expand source code

def validate_httpurls_or_endpoints(v):
    if isinstance(v, str):  # If a string, default to HttpUrl
        return v
    elif isinstance(v, dict):  # If a dictionary, use EndPointsModel
        return EndpointsModel(**v)
    return v

def validate_list_collections(v)

Expand source code

def validate_list_collections(v):
    v = _must_be_list(v)
    for i, item in enumerate(v):
        if item:
            v[i] = _must_be_collections(item)
        else:
            v.pop(i)
    return v if v else None

def validate_ordered_collections(v)

Expand source code

def validate_ordered_collections(v):
    return _must_be_ordered_collections(v)

Classes

class ActorModel (id: HttpUrl = None, **kwargs)

Actor types are Object types that are capable of performing activities. ActivityPub adds properties: https://www.w3.org/TR/activitypub/#actors

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class ActorModel(ObjectModel):
    """
    Actor types are Object types that are capable of performing activities.
    ActivityPub adds properties: https://www.w3.org/TR/activitypub/#actors
    """

    # Type
    type: Literal["Actor"] = "Actor"

    # Properties
    preferred_username: str = None
    inbox: ObjectModel = None  # Required
    outbox: ObjectModel = None  # Required
    following: Union[None, ObjectModel] = None
    followers: Union[None, ObjectModel] = None
    liked: Union[None, ObjectModel] = None
    streams: Union[None, List[Union[None, ObjectModel]]] = None
    endpoints: Union[None, HttpUrl, EndpointsModel] = None

    # Validation
    _actor_collections = field_validator(
        "following", "followers", "liked", mode="before"
    )(validate_collections)
    _actor_list_collections = field_validator("streams", mode="before")(
        validate_list_collections
    )
    _actor_orderedcollections = field_validator("inbox", "outbox", mode="before")(
        validate_ordered_collections
    )
    _actor_httpurls_or_endpoints = field_validator("endpoints", mode="before")(
        validate_httpurls_or_endpoints
    )

Ancestors

• ObjectModel
• CoreModel
• pydantic.main.BaseModel

Subclasses

• ApplicationModel
• GroupModel
• OrganizationModel
• PersonModel
• ServiceModel

Class variables

var endpoints : Union[None, typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)], EndpointsModel]

var followers : Optional[None]

var following : Optional[None]

var inbox : ObjectModel

var liked : Optional[None]

var model_config

var model_fields

var outbox : ObjectModel

var preferred_username : str

var streams : Optional[None]

var type : Literal['Actor']

class ApplicationModel (id: HttpUrl = None, **kwargs)

Describes a software application.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class ApplicationModel(ActorModel):
    """
    Describes a software application.
    """

    # Type
    type: Literal["Application"] = "Application"

Ancestors

• ActorModel
• ObjectModel
• CoreModel
• pydantic.main.BaseModel

Class variables

var model_config

var model_fields

var type : Literal['Application']

class EndpointsModel (**data: Any)

A JSON object which maps additional (typically server/domain-wide) endpoints, which may be useful either for this actor or someone referencing this actor. Documentation: https://www.w3.org/TR/activitypub/#actor-objects

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class EndpointsModel(BaseModel):
    """
    A JSON object which maps additional (typically server/domain-wide) endpoints,
    which may be useful either for this actor or someone referencing this actor.
    Documentation: https://www.w3.org/TR/activitypub/#actor-objects
    """

    # Ensure camel case for all aliases
    model_config = ConfigDict(alias_generator=_must_be_camel, populate_by_name=True)

    # Properties
    proxy_url: Union[None, HttpUrl] = None
    oauth_authorization_endpoint: Union[HttpUrl, None] = None
    oauth_token_endpoint: Union[HttpUrl, None] = None
    provide_client_key: Union[HttpUrl, None] = None
    sign_client_key: Union[HttpUrl, None] = None
    shared_inbox: Union[HttpUrl, None] = None

Ancestors

• pydantic.main.BaseModel

Class variables

var model_config

var model_fields

var oauth_authorization_endpoint : Optional[typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)]]

var oauth_token_endpoint : Optional[typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)]]

var provide_client_key : Optional[typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)]]

var proxy_url : Optional[typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)]]

var shared_inbox : Optional[typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)]]

var sign_client_key : Optional[typing_extensions.Annotated[pydantic_core._pydantic_core.Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)]]

class GroupModel (id: HttpUrl = None, **kwargs)

Represents a formal or informal collective of Actors.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class GroupModel(ActorModel):
    """
    Represents a formal or informal collective of Actors.
    """

    # Type
    type: Literal["Group"] = "Group"

Ancestors

• ActorModel
• ObjectModel
• CoreModel
• pydantic.main.BaseModel

Class variables

var model_config

var model_fields

var type : Literal['Group']

class OrganizationModel (id: HttpUrl = None, **kwargs)

Represents an organization.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class OrganizationModel(ActorModel):
    """
    Represents an organization.
    """

    # Type
    type: Literal["Organization"] = "Organization"

Ancestors

• ActorModel
• ObjectModel
• CoreModel
• pydantic.main.BaseModel

Class variables

var model_config

var model_fields

var type : Literal['Organization']

class PersonModel (id: HttpUrl = None, **kwargs)

Represents an individual person.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class PersonModel(ActorModel):
    """
    Represents an individual person.
    """

    # Type
    type: Literal["Person"] = "Person"

Ancestors

• ActorModel
• ObjectModel
• CoreModel
• pydantic.main.BaseModel

Class variables

var model_config

var model_fields

var type : Literal['Person']

class ServiceModel (id: HttpUrl = None, **kwargs)

Represents a service of any kind.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Expand source code

class ServiceModel(ActorModel):
    """
    Represents a service of any kind.
    """

    # Type
    type: Literal["Service"] = "Service"

Ancestors

• ActorModel
• ObjectModel
• CoreModel
• pydantic.main.BaseModel

Class variables

var model_config

var model_fields

var type : Literal['Service']