From 45301553e15e95afe3139f8efa4885c1462d436d Mon Sep 17 00:00:00 2001
From: Colin Wilk <colin.wilk@tum.de>
Date: Sun, 1 Oct 2023 19:46:53 +0200
Subject: Move tag into dataclass Module

Additionally change the description of the Tag modules (and other
dataclass modules) to match the description from the Szurubooru API
reference.

Signed-off-by: Colin Wilk <colin.wilk@tum.de>
---
 src/lib/dataclasses.py | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 src/lib/dataclasses.py

(limited to 'src/lib/dataclasses.py')

diff --git a/src/lib/dataclasses.py b/src/lib/dataclasses.py
new file mode 100644
index 0000000..16413b7
--- /dev/null
+++ b/src/lib/dataclasses.py
@@ -0,0 +1,46 @@
+"""
+Module for collection of dataclasses that map Szurubooru objects to python classes
+"""
+
+
+from dataclasses import dataclass, field
+from typing import List
+
+
+@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: str = ""
+    category: str = "General"
+    implications: List[str] = field(default_factory=list)
+    suggestions: List[str] = field(default_factory=list)
-- 
cgit v1.2.3