moviewyrm/bookwyrm/activitypub/ordered_collection.py

80 lines
1.7 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" defines activitypub collections (lists) """
2021-02-02 17:37:46 +00:00
from dataclasses import dataclass, field
from typing import List
from .base_activity import ActivityObject
@dataclass(init=False)
class OrderedCollection(ActivityObject):
2021-04-26 16:15:42 +00:00
"""structure of an ordered collection activity"""
2021-03-08 16:49:10 +00:00
totalItems: int
first: str
2021-02-02 17:37:46 +00:00
last: str = None
name: str = None
owner: str = None
2021-03-08 16:49:10 +00:00
type: str = "OrderedCollection"
@dataclass(init=False)
class OrderedCollectionPrivate(OrderedCollection):
2021-04-26 16:15:42 +00:00
"""an ordered collection with privacy settings"""
2021-03-08 16:49:10 +00:00
2021-02-02 17:37:46 +00:00
to: List[str] = field(default_factory=lambda: [])
cc: List[str] = field(default_factory=lambda: [])
2021-03-08 16:49:10 +00:00
@dataclass(init=False)
class Shelf(OrderedCollectionPrivate):
2021-04-26 16:15:42 +00:00
"""structure of an ordered collection activity"""
2021-03-08 16:49:10 +00:00
type: str = "Shelf"
@dataclass(init=False)
class BookList(OrderedCollectionPrivate):
2021-04-26 16:15:42 +00:00
"""structure of an ordered collection activity"""
2021-03-08 16:49:10 +00:00
summary: str = None
2021-03-08 16:49:10 +00:00
curation: str = "closed"
type: str = "BookList"
@dataclass(init=False)
class OrderedCollectionPage(ActivityObject):
2021-04-26 16:15:42 +00:00
"""structure of an ordered collection activity"""
2021-03-08 16:49:10 +00:00
partOf: str
orderedItems: List
2021-02-17 21:33:48 +00:00
next: str = None
prev: str = None
2021-03-08 16:49:10 +00:00
type: str = "OrderedCollectionPage"
2021-04-08 21:16:34 +00:00
@dataclass(init=False)
class CollectionItem(ActivityObject):
2021-04-26 16:15:42 +00:00
"""an item in a collection"""
2021-04-08 22:11:16 +00:00
2021-04-08 21:16:34 +00:00
actor: str
type: str = "CollectionItem"
@dataclass(init=False)
class ListItem(CollectionItem):
2021-04-26 16:15:42 +00:00
"""a book on a list"""
2021-04-08 22:11:16 +00:00
2021-04-08 21:16:34 +00:00
book: str
notes: str = None
approved: bool = True
order: int = None
type: str = "ListItem"
@dataclass(init=False)
class ShelfItem(CollectionItem):
2021-04-26 16:15:42 +00:00
"""a book on a list"""
2021-04-08 22:11:16 +00:00
2021-04-08 21:16:34 +00:00
book: str
type: str = "ShelfItem"