nsarchive 2.0.0a1__tar.gz → 2.0.0a2__tar.gz

{nsarchive-2.0.0a1 → nsarchive-2.0.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nsarchive
-Version: 2.0.0a1
+Version: 2.0.0a2
 Summary: API-wrapper pour récupérer des données liées à Nation
 License: GPL-3.0
 Author: happex

{nsarchive-2.0.0a1 → nsarchive-2.0.0a2}/nsarchive/cls/archives.py

@@ -2,69 +2,75 @@ import time
 
 from .base import *
 
-class Action:
+class Archive:
     def __init__(self, author: str | NSID = '0', target: str | NSID = '0') -> None:
         self.date: int = round(time.time())
 
         self.id: NSID = NSID(self.date)
-        self.action: str = ""
         self.author: NSID = NSID(author)
         self.target: NSID = NSID(target)
 
+        self.action: str = ""
+        self.details: dict = {
+            "reason": None
+        }
 
-# Entities
 
-class Sanction(Action):
-    def __init__(self, author: str | NSID, target: str | NSID) -> None:
-        super().__init__(author, target)
-
-        self.details: str = ""
-        self.major: bool = False # Sanction majeure ou non
-        self.duration: int = 0 # Durée en secondes, 0 = définitif
+# Entities
 
-class AdminAction(Action):
+class Sanction(Archive):
     def __init__(self, author: str | NSID, target: str | NSID) -> None:
         super().__init__(author, target)
 
-        self.details: str = ""
-        self.new_state: str | int | bool = None
+        self.details: dict = {
+            "reason": None,
+            "major": False, # Sanction majeure ou non
+            "duration": 0 # Durée en secondes , 0 = définitif
+        }
 
-class Report(Action):
+class Report(Archive):
     def __init__(self, author: str | NSID, target: str | NSID) -> None:
         super().__init__(author, target)
 
-        self.details: str = ""
+        self.details: dict = {
+            "reason": None,
+            "elements": [] # Liste des pièces jointes
+        }
 
 
 # Community
 
-class Election(Action):
+class Election(Archive):
     def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
         super().__init__(author, target)
 
-        self.position: str = position
-        self.positive_votes: int = 0
-        self.total_votes: int = 0
+        self.details = {
+            "position": position,
+            "positive_votes": 0,
+            "total_votes": 0
+        }
 
-class Promotion(Action):
+class Promotion(Archive):
     def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
         super().__init__(author, target)
 
-        self.position: str = position
+        self.details = {
+            "position": position
+        }
 
-class Demotion(Action):
+class Demotion(Archive):
     def __init__(self, author: str | NSID, target: str | NSID) -> None:
         super().__init__(author, target)
 
-        self.reason: str = None
-
 
 # Bank
 
-class Transaction(Action):
-    def __init__(self, author: str | NSID, target: str | NSID, amount: int) -> None:
+class Transaction(Archive):
+    def __init__(self, author: str | NSID, target: str | NSID) -> None:
         super().__init__(author, target)
 
-        self.amount: int = amount
-        self.currency: str = 'HC'
-        self.reason: str = None
+        self.details = {
+            "amount": 0,
+            "currency": "HC",
+            "reason": None
+        }

{nsarchive-2.0.0a1 → nsarchive-2.0.0a2}/nsarchive/instances/_economy.py

@@ -185,7 +185,7 @@ class EconomyInstance(Instance):
     ---- ARCHIVES ----
     """
 
-    def _add_archive(self, archive: Action):
+    def _add_archive(self, archive: Archive):
         """Ajoute une archive d'une transaction ou d'une vente dans la base de données."""
 
         archive.id = NSID(archive.id)
@@ -195,14 +195,13 @@ class EconomyInstance(Instance):
         _data = archive.__dict__.copy()
 
         if type(archive) == Transaction:
-            _data['type'] = "transaction"
-            archive.currency = archive.currency.upper()
+            _data['_type'] = "transaction"
         else:
-            _data['type'] = "unknown"
+            _data['_type'] = "unknown"
 
         self._put_in_db('archives', _data)
 
-    def _get_archive(self, id: str | NSID) -> Action | Transaction:
+    def _get_archive(self, id: str | NSID) -> Archive | Transaction:
         """
         Récupère une archive spécifique.
 
@@ -211,30 +210,28 @@ class EconomyInstance(Instance):
             ID de l'archive.
 
         ## Renvoie
-        - `.Action | .Transaction`
+        - `.Archive | .Transaction`
         """
 
         id = NSID(id)
-        _data = self.archives.get(id)
+        _data = self._get_by_ID('archives', id)
 
         if _data is None:
             return None
 
-        if _data['type'] == "transaction":
-            archive = Transaction(_data['author'], _data['target'], _data['amount'])
-
-            archive.reason = _data['reason']
-            archive.currency = _data['currency']
+        if _data['_type'] == "transaction":
+            archive = Transaction(_data['author'], _data['target'])
         else:
-            archive = Action(_data['author'], _data['target'])
+            archive = Archive(_data['author'], _data['target'])
 
         archive.id = id
         archive.action = _data['action']
         archive.date = _data['date']
+        archive.details = _data['details']
 
         return archive
 
-    def _fetch_archives(self, **query) -> list[ Action | Transaction ]:
+    def _fetch_archives(self, **query) -> list[ Archive | Transaction ]:
         """
         Récupère une liste d'archives correspondant à la requête.
 
@@ -243,9 +240,9 @@ class EconomyInstance(Instance):
             Requête pour filtrer les archives.
 
         ## Renvoie
-        - `list[Action | Transaction]`
+        - `list[.Archive | .Transaction]`
         """
 
         _res = self.fetch('archives', **query)
 
-        return [ self._get_archive(archive['key']) for archive in _res ]
+        return [ self._get_archive(archive['id']) for archive in _res ]

{nsarchive-2.0.0a1 → nsarchive-2.0.0a2}/nsarchive/instances/_entities.py

@@ -84,7 +84,7 @@ class EntityInstance(Instance):
                 entity.append(member)
 
             entity.certifications = _data['certifications']
-            entity.shares = _data['shares']
+            entity.parts = _data['parts']
         else:
             entity = Entity(id)
 
@@ -155,7 +155,7 @@ class EntityInstance(Instance):
 
         self._delete_by_ID('individuals' if isinstance(entity, User) else 'organizations', NSID(entity.id))
 
-    def fetch_entities(self, query: dict = None) -> list[ Entity | User | Organization ]:
+    def fetch_entities(self, **query: dict) -> list[ Entity | User | Organization ]:
         """
         Récupère une liste d'entités en fonction d'une requête.
 
@@ -184,8 +184,8 @@ class EntityInstance(Instance):
         """
 
         id = NSID(id)
-        groups = self.fetch_entities({'_type': 'organization'})
-        groups.extend(self.fetch_entities({'_type': 'organization', 'owner_id': id}))
+        groups = self.fetch_entities(_type = 'organization')
+        groups.extend(self.fetch_entities(_type = 'organization', owner_id = id))
 
         for group in groups:
             if group is None:
@@ -230,7 +230,7 @@ class EntityInstance(Instance):
     ---- ARCHIVES --
     """
 
-    def _add_archive(self, archive: Action) -> None:
+    def _add_archive(self, archive: Archive) -> None:
         """
         Ajoute une archive d'une action (modification au sein d'un groupe ou sanction) dans la base de données.
         """
@@ -242,17 +242,15 @@ class EntityInstance(Instance):
         _data = archive.__dict__.copy()
 
         if type(archive) == Sanction:
-            _data['type'] = "sanction"
-        elif type(archive) == AdminAction:
-            _data['type'] = "adminaction"
+            _data['_type'] = "sanction"
         elif type(archive) == Report:
-            _data['type'] = "report"
+            _data['_type'] = "report"
         else:
-            _data['type'] = "unknown"
+            _data['_type'] = "unknown"
 
         self._put_in_db('archives', _data)
 
-    def _get_archive(self, id: str | NSID) -> Action | Sanction | AdminAction:
+    def _get_archive(self, id: str | NSID) -> Archive | Sanction:
         """
         Récupère une archive spécifique.
 
@@ -261,7 +259,7 @@ class EntityInstance(Instance):
             ID de l'archive.
 
         ## Renvoie
-        - `.Action | .Sanction | .AdminAction`
+        - `.Archive | .Sanction `
         """
 
         id = NSID(id)
@@ -270,31 +268,21 @@ class EntityInstance(Instance):
         if _data is None:
             return None
 
-        if _data['type'] == "sanction": # Mute, ban, GAV, kick, détention, prune (xp seulement)
+        if _data['_type'] == "sanction": # Mute, ban, GAV, kick, détention, prune (xp seulement)
             archive = Sanction(_data['author'], _data['target'])
-
-            archive.details = _data['details']
-            archive.major = _data['major']
-            archive.duration = _data['duration']
-        elif _data['type'] == "adminaction": # Renommage, promotion, démotion (au niveau de l'état)
-            archive = AdminAction(_data['author'], _data['target'])
-
-            archive.details = _data['details']
-            archive.new_state = _data['new_state']
-        elif _data['type'] == "report": # Plainte
+        elif _data['_type'] == "report": # Plainte
             archive = Report(_data['author'], _data['target'])
-
-            archive.details = _data['details']
         else:
-            archive = Action(_data['author'], _data['target'])
+            archive = Archive(_data['author'], _data['target'])
 
         archive.id = id
-        archive.action = _data['action']
         archive.date = _data['date']
+        archive.action = _data['action']
+        archive.details = _data['details']
 
         return archive
 
-    def _fetch_archives(self, **query) -> list[ Action | Sanction | AdminAction ]:
+    def _fetch_archives(self, **query) -> list[ Archive | Sanction ]:
         """
         Récupère une liste d'archives correspondant à la requête.
 
@@ -303,9 +291,9 @@ class EntityInstance(Instance):
             Requête pour filtrer les archives.
 
         ## Renvoie
-        - `list[Action | Sanction | AdminAction]`
+        - `list[.Archive | .Sanction]`
         """
 
         _res = self.fetch('archives', **query)
 
-        return [ self._get_archive(archive['key']) for archive in _res ]
+        return [ self._get_archive(archive['id']) for archive in _res ]

{nsarchive-2.0.0a1 → nsarchive-2.0.0a2}/nsarchive/instances/_republic.py

@@ -103,9 +103,9 @@ class RepublicInstance(Instance):
 
         base = 'mandate' if current_mandate else 'archives'
 
-        _contributions = self.fetch(base, {'author': id, 'type': 'contrib'})
-        _mandates = self.fetch(base, {'target': id, 'type': 'election'}) +\
-                    self.fetch(base, {'target': id, 'type': 'promotion'})
+        _contributions = self.fetch(base, {'author': id, '_type': 'contrib'})
+        _mandates = self.fetch(base, {'target': id, '_type': 'election'}) +\
+                    self.fetch(base, {'target': id, '_type': 'promotion'})
 
         user = Official(id)
         for mandate in _mandates:
@@ -209,25 +209,25 @@ class RepublicInstance(Instance):
     ---- ARCHIVES ----
     """
 
-    def _add_archive(self, archive: Action) -> None:
+    def _add_archive(self, archive: Archive) -> None:
         """Ajoute une archive d'une action (élection, promotion, ou rétrogradation) dans la base de données."""
 
         archive.id = NSID(archive.id)
         _data = archive.__dict__.copy()
 
         if type(archive) == Election:
-            _data['type'] = "election"
+            _data['_type'] = "election"
         elif type(archive) == Promotion:
-            _data['type'] = "promotion"
+            _data['_type'] = "promotion"
         elif type(archive) == Demotion:
-            _data['type'] = "demotion"
+            _data['_type'] = "demotion"
         else:
-            _data['type'] = "unknown"
+            _data['_type'] = "unknown"
 
         self._put_in_db('archives', _data)
         self._put_in_db('mandate', _data) # Ajouter les archives à celle du mandat actuel
 
-    def _get_archive(self, id: str | NSID) -> Action | Election | Promotion | Demotion:
+    def _get_archive(self, id: str | NSID) -> Archive | Election | Promotion | Demotion:
         """
         Récupère une archive spécifique.
 
@@ -236,7 +236,7 @@ class RepublicInstance(Instance):
             ID de l'archive.
 
         ## Renvoie
-        - `.Action | .Election | .Promotion | .Demotion`
+        - `.Archive | .Election | .Promotion | .Demotion`
         """
 
         id = NSID(id)
@@ -245,27 +245,23 @@ class RepublicInstance(Instance):
         if _data is None:
             return None
 
-        if _data['type'] == "election":
+        if _data['_type'] == "election":
             archive = Election(_data['author'], _data['target'], _data['position'])
-
-            archive.positive_votes = _data['positive_votes']
-            archive.total_votes = _data['total_votes']
-        elif _data['type'] == "promotion":
+        elif _data['_type'] == "promotion":
             archive = Promotion(_data['author'], _data['target'], _data['position'])
-        elif _data['type'] == "demotion":
+        elif _data['_type'] == "demotion":
             archive = Demotion(_data['author'], _data['target'])
-
-            archive.reason = _data['reason']
         else:
-            archive = Action(_data['author'], _data['target'])
+            archive = Archive(_data['author'], _data['target'])
 
         archive.id = id
         archive.action = _data['action']
         archive.date = _data['date']
+        archive.details = _data['details']
 
         return archive
 
-    def _fetch_archives(self, **query) -> list[ Action | Election | Promotion | Demotion ]:
+    def _fetch_archives(self, **query) -> list[ Archive | Election | Promotion | Demotion ]:
         """
         Récupère une liste d'archives correspondant à la requête.
 
@@ -274,9 +270,9 @@ class RepublicInstance(Instance):
             Requête pour filtrer les archives.
 
         ## Renvoie
-        - `list[Action | Election | Promotion | Demotion]`
+        - `list[.Archive | .Election | .Promotion | .Demotion]`
         """
 
         _res = self.fetch('archives', **query)
         
-        return [ self._get_archive(archive['key']) for archive in _res ]
+        return [ self._get_archive(archive['id']) for archive in _res ]

{nsarchive-2.0.0a1 → nsarchive-2.0.0a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nsarchive"
-version = "2.0.0-alpha.1"
+version = "2.0.0-alpha.2"
 description = "API-wrapper pour récupérer des données liées à Nation"
 authors = ["happex <110610727+okayhappex@users.noreply.github.com>"]
 license = "GPL-3.0"