summaryrefslogtreecommitdiffstats
path: root/szuruboorupy/dataclasses.py
diff options
context:
space:
mode:
Diffstat (limited to 'szuruboorupy/dataclasses.py')
-rw-r--r--szuruboorupy/dataclasses.py48
1 files changed, 48 insertions, 0 deletions
diff --git a/szuruboorupy/dataclasses.py b/szuruboorupy/dataclasses.py
new file mode 100644
index 0000000..350a876
--- /dev/null
+++ b/szuruboorupy/dataclasses.py
@@ -0,0 +1,48 @@
+"""
+Module for collection of dataclasses that map Szurubooru r.
+"""
+
+
+from dataclasses import field
+from typing import List, Optional
+
+from pydantic.dataclasses import dataclass
+
+
+@dataclass
+class Tag:
+ """A single tag. Tags are used to let users search for posts.
+
+ The Szurubooru structure:
+ .. code-block:: JSON
+ {
+ "version": <version>,
+ "names": <names>,
+ "category": <category>,
+ "implications": <implications>,
+ "suggestions": <suggestions>,
+ "creationTime": <creation-time>,
+ "lastEditTime": <last-edit-time>,
+ "usages": <usage-count>,
+ "description": <description>
+ }
+
+ **Field meaning**
+ - `<version>`: resource version.
+ - `<names>`: a list of tag names (aliases). Tagging a post with any name will
+ automatically assign the first name from this list.
+ - `<category>`: the name of the category the given tag belongs to.
+ - `<implications>`: a list of implied tags, serialized as micro tag resource.
+ - `<suggestions>`: a list of suggested tags, serialized as micro tag resource.
+ - `<creation-time>`: time the tag was created, formatted as per RFC 3339.
+ - `<last-edit-time>`: time the tag was edited, formatted as per RFC 3339.
+ - `<usage-count>`: the number of posts the tag was used in.
+ - `<description>`: the tag description (instructions how to use, history etc.)
+ """
+
+ name: str
+ version: int = -1
+ description: Optional[str] = ""
+ category: str = "General"
+ implications: List[str] = field(default_factory=list)
+ suggestions: List[str] = field(default_factory=list)