ActivityStreams Vocabulary Objects

`vultron.as_vocab.base.objects`

`vultron.as_vocab.base.objects.base`

file: base author: adh created_at: 2/15/23 2:01 PM

`as_Object` `dataclass`

Bases: as_Base

Base class for all ActivityPub objects. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#object

Source code in vultron/as_vocab/base/objects/base.py

@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass(kw_only=True)
class as_Object(as_Base):
    """Base class for all ActivityPub objects.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#object>
    """

    replies: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    url: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    generator: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    context: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    tag: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    in_reply_to: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

    # time (aka Wibbly-Wobbly Time-Wimey Stuff)
    duration: Optional[timedelta] = field(
        metadata=config(
            exclude=exclude_if_none,
            encoder=to_isofmt,
            decoder=from_isofmt,
            mm_field=fields.TimeDelta(
                precision="seconds", serialization_type=int, allow_none=True
            ),
        ),
        default=None,
    )
    start_time: Optional[datetime] = field(
        metadata=config(
            exclude=exclude_if_none,
            encoder=to_isofmt,
            decoder=from_isofmt,
            mm_field=fields.DateTime(format="iso", allow_none=True),
        ),
        default=None,
    )
    end_time: Optional[datetime] = field(
        metadata=config(
            exclude=exclude_if_none,
            encoder=to_isofmt,
            decoder=from_isofmt,
            mm_field=fields.DateTime(format="iso", allow_none=True),
        ),
        default=None,
    )
    published: Optional[datetime] = field(
        metadata=config(
            exclude=exclude_if_none,
            encoder=to_isofmt,
            decoder=from_isofmt,
            mm_field=fields.DateTime(format="iso", allow_none=True),
        ),
        default_factory=now_utc,
    )
    updated: Optional[datetime] = field(
        metadata=config(
            exclude=exclude_if_none,
            encoder=to_isofmt,
            decoder=from_isofmt,
            mm_field=fields.DateTime(format="iso", allow_none=True),
        ),
        default_factory=now_utc,
    )

    # content
    content: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    summary: Optional[str] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    icon: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    image: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    attachment: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

    # location
    location: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

    # addressing
    to: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    cc: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

    bto: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )
    bcc: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

    audience: Optional[Any] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

    # Todo: replace camelCase with snake_case
    attributed_to: Optional[List[Any]] = field(
        metadata=config(exclude=exclude_if_none), default=None
    )

`vultron.as_vocab.base.objects.actors`

file: actors author: adh created_at: 12/8/22 3:57 PM

`as_Actor` `dataclass`

Bases: as_Object

Base class for all ActivityPub actors. Describes one or more entities that performed or are expected to perform an activity. Any single activity can have multiple actors. The actor may be specified using an indirect Link or as an embedded Object. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor

Source code in vultron/as_vocab/base/objects/actors.py

@activitystreams_object
@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass
class as_Actor(as_Object):
    """Base class for all ActivityPub actors.
    Describes one or more entities that performed or are expected to perform an activity.
    Any single activity can have multiple actors.
    The actor may be specified using an indirect Link or as an embedded Object.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor>
    """

    # todo: collections should be internally represented as lists but dumped as collections
    inbox: as_OrderedCollection = field(default_factory=as_OrderedCollection)
    outbox: as_OrderedCollection = field(default_factory=as_OrderedCollection)
    following: Optional[as_Collection] = None
    followers: Optional[as_Collection] = None
    liked: Optional[as_Collection] = None
    streams: Optional[as_Collection] = None
    preferred_username: Optional[str] = None
    endpoints: Optional[Any] = None

`as_Application` `dataclass`

Bases: as_Actor

A special kind of actor representing a software application. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#dfn-application

Source code in vultron/as_vocab/base/objects/actors.py

@activitystreams_object
@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass
class as_Application(as_Actor):
    """A special kind of actor representing a software application.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#dfn-application>
    """

`as_Group` `dataclass`

Bases: as_Actor

A special kind of actor representing a logical group of persons or other actors. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#dfn-group

Source code in vultron/as_vocab/base/objects/actors.py

@activitystreams_object
@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass
class as_Group(as_Actor):
    """A special kind of actor representing a logical group of persons or other actors.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#dfn-group>
    """

`as_Organization` `dataclass`

Bases: as_Actor

A special kind of actor representing a logical group of persons or other actors. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#dfn-organization

Source code in vultron/as_vocab/base/objects/actors.py

@activitystreams_object
@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass
class as_Organization(as_Actor):
    """A special kind of actor representing a logical group of persons or other actors.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#dfn-organization>
    """

`as_Person` `dataclass`

Bases: as_Actor

A special kind of actor representing an individual person. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#dfn-person

Source code in vultron/as_vocab/base/objects/actors.py

@activitystreams_object
@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass
class as_Person(as_Actor):
    """A special kind of actor representing an individual person.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#dfn-person>
    """

`as_Service` `dataclass`

Bases: as_Actor

A special kind of actor representing a service. See definition in ActivityStreams Vocabulary https://www.w3.org/TR/activitystreams-vocabulary/#dfn-service A service is a kind of actor that represents a non-human actor.

Source code in vultron/as_vocab/base/objects/actors.py

@activitystreams_object
@dataclass_json(letter_case=LetterCase.CAMEL)
@dataclass
class as_Service(as_Actor):
    """A special kind of actor representing a service.
    See definition in ActivityStreams Vocabulary <https://www.w3.org/TR/activitystreams-vocabulary/#dfn-service>
    A service is a kind of actor that represents a non-human actor.
    """

`vultron.as_vocab.base.objects.object_types`

file: object_types author: adh created_at: 12/8/22 4:11 PM