nsarchive 0.1b3__py3-none-any.whl → 1.0.0__py3-none-any.whl

nsarchive/__init__.py

@@ -2,24 +2,50 @@ import time
 
 import deta
 
+from .cls.base import *
 from .cls.entities import *
 from .cls.archives import *
 from .cls.republic import *
-from .cls.bank import *
+from .cls.economy import *
 
 from .cls.exceptions import *
 
 class EntityInstance:
+    """
+    Instance qui vous permettra d'interagir avec les profils des membres ainsi que les différents métiers et secteurs d'activité.
+
+    ## Informations disponibles
+    - Profil des membres et des entreprises: `.User | .Organization | .Entity`
+    - Participation d'un membre à différent votes: `.User | .Organization | .Entity`
+    - Appartenance et permissions d'un membre dans un groupe: `.GroupMember.MemberPermissions`
+    - Position légale et permissions d'une entité: `.Position.Permissions`
+    - Sanctions et modifications d'une entité: `.Action[ .AdminAction | .Sanction ]`
+    """
     def __init__(self, token: str) -> None:
         self.db = deta.Deta(token)
         self.base = self.db.Base('entities')
         self.electors = self.db.Base('electors')
         self.archives = self.db.Base('archives')
         self.avatars = self.db.Drive('avatars')
+        self.positions = self.db.Base('positions') # Liste des métiers
 
-    def get_entity(self, id: str) -> User | Organization | Entity:
-        id = id.upper()
+    def get_entity(self, id: str | NSID) -> User | Organization | Entity:
+        """
+        Fonction permettant de récupérer le profil public d'une entité.\n
+
+        ## Paramètres
+        id: `NSID`\n
+            ID héxadécimal de l'entité à récupérer
+
+        ## Renvoie
+        - `.User` dans le cas où l'entité choisie est un membre
+        - `.Organization` dans le cas où c'est un groupe
+        - `.Entity` dans le cas où c'est indéterminé
+        """
+
+        id = NSID(id)
         _data = self.base.get(id)
+        _votes = self.electors.get(id)
 
         if _data is None:
             return Entity("0")
@@ -29,16 +55,20 @@ class EntityInstance:
 
             entity.xp = _data['xp']
             entity.boosts = _data['boosts']
+            entity.votes = [ NSID(vote) for vote in _votes['votes'] ]
         elif _data['_type'] == 'organization':
             entity = Organization(id)
 
-            entity.owner = self.get_entity(_data['owner_id'].upper())
+            entity.owner = self.get_entity(NSID(_data['owner_id']))
             
             for _member in _data['members']:
                 member = GroupMember(_member['id'])
                 member.permissions.__dict__ = _member['permissions']
 
-            entity.avatar = self.avatars.get(id).read()
+            try:
+                entity.avatar = self.avatars.get(id).read()
+            except: 
+                entity.avatar = None
 
             entity.certifications = _data['certifications']
         else:
@@ -51,6 +81,16 @@ class EntityInstance:
         return entity
 
     def save_entity(self, entity: Entity) -> None:
+        """
+        Fonction permettant de créer ou modifier une entité.
+
+        ## Paramètres
+        entity: `.Entity` ( `.User | .Organization` )
+            L'entité à sauvegarder
+        """
+
+        entity.id = NSID(entity.id)
+
         _base = self.base
         _data = {
             '_type': 'user' if type(entity) == User else 'organization' if type(entity) == Organization else 'unknown',
@@ -60,13 +100,13 @@ class EntityInstance:
         }
 
         if type(entity) == Organization:
-            _data['owner_id'] = entity.owner.id.upper() if entity.owner else "0"
+            _data['owner_id'] = NSID(entity.owner.id) if entity.owner else NSID("0")
             _data['members'] = []
             _data['certifications'] = entity.certifications
 
             for member in entity.members:
                 _member = {
-                    'id': member.id,
+                    'id': NSID(member.id),
                     'permissions': member.permissions.__dict__.copy()
                 }
 
@@ -77,38 +117,35 @@ class EntityInstance:
             _data['xp'] = entity.xp
             _data['boosts'] = entity.boosts
 
-        _base.put(_data, entity.id.upper(), expire_in = 3 * 31536000) # Données supprimées tous les trois ans
-    
-    def delete_entity(self, entity: Entity) -> None:
-        self.base.delete(entity.id.upper())
+        _base.put(_data, entity.id, expire_in = 3 * 31536000) # Données supprimées tous les trois ans
 
-        if type(entity) == Organization:
-            self.avatars.delete(entity.id.upper())
+    def delete_entity(self, entity: Entity) -> None:
+        """
+        Fonction permettant de supprimer le profil d'une entité
+        
+        ## Paramètres
+        entity: `.Entity` ( `.User | .Organization` )
+            L'entité à supprimer
+        """
 
-    def get_elector(self, id: str) -> Elector:
-        id = id.upper()
-        _data = self.electors.get(id)
+        self.base.delete(NSID(entity.id))
 
-        if _data is None:
-            self.save_elector(Elector(id))
-            return Elector(id)
-        
-        elector = Elector(id)
-        elector.votes = _data['votes']
-        
-        return elector
+        if type(entity) == Organization:
+            self.avatars.delete(NSID(entity.id))
 
-    def save_elector(self, elector: Elector):
-        _data = {
-            "votes": elector.votes
-        }
+    def fetch_entities(self, query: dict = None, listquery: dict | None = None) -> list[ Entity | User | Organization ]:
+        """
+        Récupère une liste d'entités en fonction d'une requête.
 
-        self.electors.put(_data, elector.id.upper())
-    
-    # Les archives ne permettent pas de garder une trace des votes
-    # Donc je préfère aucune fonction permettant de les supprimer
+        ## Paramètres
+        query: `dict`
+            La requête pour filtrer les entités.
+        listquery: `dict | None`
+            Requête secondaire pour n'afficher que les listes contenant un certain élément.
 
-    def fetch_entities(self, query = None, listquery: dict | None = None) -> list[Entity | User | Organization]:
+        ## Renvoie
+        - `list[Entity | User | Organization]`
+        """
         _res = self.base.fetch(query).items
 
         if listquery is not None:
@@ -116,15 +153,60 @@ class EntityInstance:
                 for target, value in listquery.items():
                     if value not in item[target]:
                         _res.remove(item)
-        
-        return [ self.get_entity(entity['key']) for entity in _res ]
 
-    def get_entity_groups(self, id: str) -> list[Organization]:
+        return [ self.get_entity(NSID(entity['key'])) for entity in _res ]
+
+    def get_entity_groups(self, id: str | NSID) -> list[Organization]:
+        """
+        Récupère les groupes auxquels appartient une entité.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID de l'entité.
+
+        ## Renvoie
+        - `list[Organization]`
+        """
+
+        id = NSID(id)
         groups = self.fetch_entities({'_type': 'organization'}, {'members': id})
         
         return groups
-    
-    def _add_archive(self, archive: Action):
+
+    def get_position(self, id: str) -> Position:
+        """
+        Récupère une position légale (métier, domaine professionnel).
+
+        ## Paramètres
+        id: `str`
+            ID de la position (SENSIBLE À LA CASSE !)
+
+        ## Renvoie
+        - `.Position`
+        """
+
+        _data = self.positions.get(id)
+
+        if _data is None:
+            raise RessourceNotFoundError(f"No position with ID {id}")
+
+        position = Position(id)
+        position.name = _data['name']
+
+        for _permission in _data['permissions']:
+            position.permissions.__setattr__(_permission, True)
+
+        return position
+
+    def _add_archive(self, archive: Action) -> None:
+        """
+        Ajoute une archive d'une action (modification au sein d'un groupe ou sanction) dans la base de données.
+        """
+
+        archive.id = NSID(archive.id)
+        archive.author = NSID(archive.author)
+        archive.target = NSID(archive.target)
+
         _data = archive.__dict__.copy()
 
         if type(archive) == Sanction:
@@ -134,11 +216,21 @@ class EntityInstance:
         else:
             _data['type'] = "unknown"
         
-        del _data['id']
-
         self.archives.put(key = archive.id, data = _data)
 
-    def _get_archive(self, id: str) -> Action | Sanction | AdminAction:
+    def _get_archive(self, id: str | NSID) -> Action | Sanction | AdminAction:
+        """
+        Récupère une archive spécifique.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID de l'archive.
+
+        ## Renvoie
+        - `.Action | .Sanction | .AdminAction`
+        """
+
+        id = NSID(id)
         _data = self.archives.get(id)
 
         if _data is None:
@@ -163,84 +255,139 @@ class EntityInstance:
         archive.date = _data['date']
 
         return archive
-    
+
     def _fetch_archives(self, **query) -> list[ Action | Sanction | AdminAction ]:
+        """
+        Récupère une liste d'archives correspondant à la requête.
+
+        ## Paramètres
+        query: `dict`
+            Requête pour filtrer les archives.
+
+        ## Renvoie
+        - `list[Action | Sanction | AdminAction]`
+        """
+
         _res = self.archives.fetch(query).items
         
         return [ self._get_archive(archive['key']) for archive in _res ]
-    
+
 class RepublicInstance:
+    """
+    Gère les interactions avec les votes, les archives de la république, et les fonctionnaires.
+
+    ## Informations
+    - Résultats des votes: `.Vote | .ClosedVote`
+    - Différentes institutions: `.Institutions | .Administration | .Government | .Assembly | .Court | .PoliceForces`
+    - Occupants des différents rôles et historique de leurs actions: `.Official`
+    """
+
     def __init__(self, token: str) -> None:
+        """Initialise une nouvelle RepublicInstance avec un token Deta."""
+
         self.db = deta.Deta(token)
         self.votes = self.db.Base('votes')
         self.archives = self.db.Base('archives')
         self.mandate = self.db.Base('mandate')
         self.functions = self.db.Base('functions') # Liste des fonctionnaires
 
-    def get_vote(self, id: str) -> Vote | ClosedVote:
-        id = id.upper()
+    def get_vote(self, id: str | NSID) -> Vote | ClosedVote:
+        """
+        Récupère un vote spécifique.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID du vote.
+
+        ## Renvoie
+        - `.Vote | .ClosedVote`
+        """
+
+        id = NSID(id)
         _data = self.votes.get(id)
 
         if _data is None:
-            return None
-        
+            raise RessourceNotFoundError(f"The vote #{id} does not exist.")
+
         if _data['_type'] == 'open':
             vote = Vote(id, _data['title'], tuple(_data['choices'].keys()))
         elif _data['_type'] == 'closed':
             vote = ClosedVote(id, _data['title'])
         else:
             vote = Vote('0', 'Unknown Vote', ())
-        
+
         vote.author = _data['author']
         vote.startDate = _data['startDate']
         vote.endDate = _data['endDate']
         vote.choices = _data['choices']
-        
+
         return vote
 
-    def save_vote(self, vote: Vote | ClosedVote):
+    def save_vote(self, vote: Vote | ClosedVote) -> None:
+        """Sauvegarde un vote dans la base de données."""
+
+        vote.id = NSID(vote.id)
+
         _data = {
             '_type': 'open' if type(vote) == Vote else 'closed' if type(vote) == ClosedVote else 'unknown',
             'title': vote.title,
-            'author': vote.author,
+            'author': NSID(vote.author),
             'startDate': vote.startDate,
             'endDate': vote.endDate,
             'choices': vote.choices
         }
 
-        self.votes.put(_data, vote.id.upper())
+        self.votes.put(_data, vote.id)
+
+    def get_official(self, id: str | NSID, current_mandate: bool = True) -> Official:
+        """
+        Récupère les informations d'un fonctionnaire (mandats, contributions).
+
+        ## Paramètres
+        id: `str | NSID`
+            ID du fonctionnaire.
+        current_mandate: `bool`
+            Indique si l'on doit récupérer le mandat actuel ou les anciens mandats.
+
+        ## Renvoie
+        - `.Official`
+        """
+
+        id = NSID(id)
 
-    def get_official(self, id: str, current_mandate: bool = True) -> FunctionalUser:
         archives = self.mandate if current_mandate else self.archives
 
         _contributions = archives.fetch({'author': id, 'type': 'contrib'}).items
         _mandates = archives.fetch({'target': id, 'type': 'election'}).items\
                     + archives.fetch({'target': id, 'type': 'promotion'}).items
 
-        user = FunctionalUser(id)
+        user = Official(id)
         for mandate in _mandates:
-            if mandate['position'].startswith('MIN'): mandate['position'] = 'MIN'
+            if mandate['position'].startswith('MIN'):
+                mandate['position'] = 'MIN'
 
             try:
                 user.mandates[mandate['position']] += 1
             except KeyError:
                 user.mandates[mandate['position']] = 1
-        
+
         for contrib in _contributions:
             try:
                 user.contributions[contrib['action']] += 1
             except KeyError:
                 user.contributions[contrib['action']] = 1
-        
+
         return user
 
     def get_institutions(self) -> Organization:
+        """Récupère l'état actuel des institutions de la république."""
+
         admin = Administration()
-        gov = Government(FunctionalUser('0'))
+        gov = Government(Official('0'))
         assembly = Assembly()
         court = Court()
         police_forces = PoliceForces()
-        
+
         _admins = self.functions.get('ADMIN')
         admin.members = [ self.get_official(user) for user in _admins['users'] ]
         admin.president = self.get_official('F7DB60DD1C4300A') # happex (remplace Kheops pour l'instant)
@@ -272,8 +419,17 @@ class RepublicInstance:
         instits.police = police_forces
 
         return instits
-    
+
     def update_institutions(self, institutions: Institutions):
+        """
+        Fonction communément appelée après un vote législatif ou une nomination.\n
+        Celle-ci met à jour: Le gouvernement (président, ministres), les différents députés et leur président, les différents juges, les différents policiers.\n
+
+        ## Paramètres
+        institutions: `.Institutions`\n
+            Le nouvel état des institutions, à sauvegarder.
+        """
+
         get_ids = lambda institution : [ member.id for member in institutions.__getattribute__(institution).members ]
 
         self.functions.put(key = 'ADMIN', data = { 'users': get_ids('administration') })
@@ -291,14 +447,21 @@ class RepublicInstance:
         self.functions.put(key = 'MIN_AUD', data = { 'users': [ institutions.government.press_minister.id ] })
         self.functions.put(key = 'MIN_OUT', data = { 'users': [ institutions.government.outer_minister.id ] })
 
-    def new_mandate(self, institutions: Institutions, weeks: int = 4):
+    def new_mandate(self, institutions: Institutions, weeks: int = 4) -> None:
+        """
+        Fonction qui amène à supprimer toutes les archives du mandat précédent
+        """
+
         for item in self.mandate.fetch().items:
-            if item['date'] >= round(time.time()) - weeks * 604800:
+            if item['date'] >= round(time.time()) - weeks * 604800: # On évite de supprimer les informations écrites lors de la période définie
                 self.mandate.delete(item['id'])
-        
+
         self.update_institutions(institutions)
 
-    def _add_archive(self, archive: Action):
+    def _add_archive(self, archive: Action) -> 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:
@@ -309,17 +472,28 @@ class RepublicInstance:
             _data['type'] = "demotion"
         else:
             _data['type'] = "unknown"
-        
-        del _data['id']
 
         self.archives.put(key = archive.id, data = _data)
+        self.mandate.put(key = archive.id, data = _data) # Ajouter les archives à celle du mandat actuel
+
+    def _get_archive(self, id: str | NSID) -> Action | Election | Promotion | Demotion:
+        """
+        Récupère une archive spécifique.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID de l'archive.
 
-    def _get_archive(self, id: str) -> Action | Election | Promotion | Demotion:
+        ## Renvoie
+        - `.Action | .Election | .Promotion | .Demotion`
+        """
+
+        id = NSID(id)
         _data = self.archives.get(id)
 
         if _data is None:
             return None
-        
+
         if _data['type'] == "election":
             archive = Election(_data['author'], _data['target'], _data['position'])
 
@@ -333,88 +507,194 @@ class RepublicInstance:
             archive.reason = _data['reason']
         else:
             archive = Action(_data['author'], _data['target'])
-        
+
         archive.id = id
         archive.action = _data['action']
         archive.date = _data['date']
 
         return archive
-    
+
     def _fetch_archives(self, **query) -> list[ Action | Election | Promotion | Demotion ]:
+        """
+        Récupère une liste d'archives correspondant à la requête.
+
+        ## Paramètres
+        query: `dict`
+            Requête pour filtrer les archives.
+
+        ## Renvoie
+        - `list[Action | Election | Promotion | Demotion]`
+        """
+
         _res = self.archives.fetch(query).items
         
         return [ self._get_archive(archive['key']) for archive in _res ]
 
 class BankInstance:
+    """Gère les interactions avec les comptes bancaires, les transactions, et le marché."""
+
     def __init__(self, token: str) -> None:
         self.db = deta.Deta(token)
         self.archives = self.db.Base('archives')
         self.accounts = self.db.Base('accounts')
         self.registry = self.db.Base('banks')
+        self.marketplace = self.db.Base('shop')
+
+    def get_account(self, id: str | NSID) -> BankAccount:
+        """
+        Récupère les informations d'un compte bancaire.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID du compte.
+
+        ## Renvoie
+        - `.BankAccount`
+        """
 
-    def get_account(self, id: str) -> BankAccount:
-        id = id.upper()
+        id = NSID(id)
         _data = self.accounts.get(id)
 
         if _data is None:
             return None
-        
-        acc = BankAccount(id)
-        acc.amount = _data['amount']
-        acc.locked = _data['locked']
-        acc.owner = _data['owner_id']
-        acc.bank = _data['bank']
 
-        return acc
+        account = BankAccount(id)
+        account.amount = _data['amount']
+        account.locked = _data['locked']
+        account.owner = _data['owner_id']
+        account.bank = _data['bank']
+
+        return account
+
+    def save_account(self, account: BankAccount):
+        """Sauvegarde un compte bancaire dans la base de données."""
 
-    def save_account(self, acc: BankAccount):
         _data = {
-            'amount': acc.amount,
-            'locked': acc.locked, 
-            'owner_id': acc.owner, 
-            'bank': acc.bank
+            'amount': account.amount,
+            'locked': account.locked, 
+            'owner_id': account.owner, 
+            'bank': account.bank
         }
 
-        self.accounts.put(_data, acc.id.upper())
-    
-    def lock_account(self, acc: BankAccount):
-        acc.locked = True
+        self.accounts.put(_data, NSID(account.id))
+
+    def lock_account(self, account: BankAccount):
+        """Verrouille un compte bancaire pour empêcher toute transaction."""
+
+        account.id = account.id.upper()
+        account.locked = True
+
+        self.save_account(account)
+
+    def get_item(self, id: str | NSID) -> Item | None:
+        """
+        Récupère un item du marché.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID de l'item.
 
-        self.save_account(acc)
+        ## Renvoie
+        - `.Item | None`
+        """
 
-    def _add_archive(self, _archive: Action):
-        _data = _archive.__dict__.copy()
+        id = NSID(id)
 
-        if type(_archive) == Transaction:
+        _data = self.marketplace.get(id)
+
+        if _data is None:
+            return None
+
+        item = Item(id)
+        item.title = _data['title']
+        item.emoji = _data['emoji']
+        item.seller_id = _data['seller']
+        item.price = _data['price']
+
+        return item
+
+    def save_item(self, item: Item) -> None:
+        """Sauvegarde un item dans la base de données du marché."""
+
+        item.id = NSID(item.id)
+
+        _data = item.__dict__.copy()
+
+        self.marketplace.put(key = item.id, data = _data)
+
+    def delete_item(self, item: Item) -> None:
+        """Supprime un item du marché."""
+
+        item.id = NSID(item.id)
+        self.marketplace.delete(item.id)
+
+    def _add_archive(self, archive: Action):
+        """Ajoute une archive d'une transaction ou d'une vente dans la base de données."""
+
+        archive.id = NSID(archive.id)
+        archive.author = NSID(archive.author)
+        archive.target = NSID(archive.target)
+
+        _data = archive.__dict__.copy()
+
+        if type(archive) == Transaction:
             _data['type'] = "transaction"
+            archive.currency = archive.currency.upper()
+        elif type(archive) == Sale:
+            _data['type'] = "sale"
         else:
             _data['type'] = "unknown"
-        
-        del _data['id']
 
-        self.archives.put(key = _archive.id, data = _data)
+        self.archives.put(key = archive.id, data = _data)
+
+    def _get_archive(self, id: str | NSID) -> Action | Transaction:
+        """
+        Récupère une archive spécifique.
+
+        ## Paramètres
+        id: `str | NSID`
+            ID de l'archive.
 
-    def _get_archive(self, id: str) -> Action | Transaction:
+        ## Renvoie
+        - `.Action | .Transaction`
+        """
+
+        id = NSID(id)
         _data = self.archives.get(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']
+        elif _data['type'] == "sale":
+            archive = Sale(_data['author'], _data['target'])
+
+            archive.price = _data['price']
         else:
             archive = Action(_data['author'], _data['target'])
-        
+
         archive.id = id
         archive.action = _data['action']
         archive.date = _data['date']
 
         return archive
-    
+
     def _fetch_archives(self, **query) -> list[ Action | Transaction ]:
-        _res = self.archives.fetch(query).items
+        """
+        Récupère une liste d'archives correspondant à la requête.
+
+        ## Paramètres
+        query: `dict`
+            Requête pour filtrer les archives.
+
+        ## Renvoie
+        - `list[Action | Transaction]`
+        """
         
+        _res = self.archives.fetch(query).items
+
         return [ self._get_archive(archive['key']) for archive in _res ]

nsarchive/cls/archives.py

@@ -1,18 +1,21 @@
 import time
 
+from .base import *
+
 class Action:
-    def __init__(self, author: str = '11625D9061021010', target: str = '0') -> None:
-        self.id: str = hex(round(time.time()))[2:].upper()
-        self.date: int = int(self.id, 16)
+    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: str = author
-        self.target: str = target
+        self.author: NSID = NSID(author)
+        self.target: NSID = NSID(target)
 
 
 # Entities
 
 class Sanction(Action):
-    def __init__(self, author: str, target: str) -> None:
+    def __init__(self, author: str | NSID, target: str | NSID) -> None:
         super().__init__(author, target)
 
         self.details: str = ""
@@ -20,7 +23,7 @@ class Sanction(Action):
         self.duration: int = 0 # Durée en secondes, 0 = définitif
 
 class AdminAction(Action):
-    def __init__(self, author: str, target: str) -> None:
+    def __init__(self, author: str | NSID, target: str | NSID) -> None:
         super().__init__(author, target)
 
         self.details: str = ""
@@ -30,7 +33,7 @@ class AdminAction(Action):
 # Community
 
 class Election(Action):
-    def __init__(self, author: str, target: str, position: str) -> None:
+    def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
         super().__init__(author, target)
 
         self.position: str = position
@@ -38,23 +41,30 @@ class Election(Action):
         self.total_votes: int = 0
 
 class Promotion(Action):
-    def __init__(self, author: str, target: str, position: str) -> None:
+    def __init__(self, author: str | NSID, target: str | NSID, position: str) -> None:
         super().__init__(author, target)
 
         self.position: str = position
 
 class Demotion(Action):
-    def __init__(self, author: str, target: str) -> None:
+    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, target: str, amount: int) -> None:
+    def __init__(self, author: str | NSID, target: str | NSID, amount: int) -> None:
         super().__init__(author, target)
 
         self.amount: int = amount
         self.currency: str = 'HC'
-        self.reason: str = None
+        self.reason: str = None
+
+class Sale(Action):
+    def __init__(self, author: str | NSID = '0', target: str | NSID = '0') -> None:
+        super().__init__(author, target)
+
+        self.price: int = 0

nsarchive/cls/base.py

@@ -0,0 +1,30 @@
+class NSID(str):
+    unknown = "0"
+    admin = "01"
+    gov = "02"
+    assembly = "03"
+    court = "04"
+    office = "05"
+    hexabank = "06"
+    archives = "07"
+
+    maintenance_committee = "101"
+    audiovisual_department = "102"
+    interior_department = "103"
+
+    def __new__(cls, value):
+        instance = super(NSID, cls).__new__(cls, value)
+        return instance
+
+    def __init__(self, value: str | int = ""):
+        if type(value) == int:
+            value = hex(value)
+        elif type(value) in (str, NSID):
+            value = hex(int(value, 16))
+        else:
+            return TypeError(f"<{value}> is not NSID serializable")
+
+        if value.startswith("0x"):
+            value = value[2:]
+
+        self.value = value.upper()

nsarchive/cls/economy.py

@@ -0,0 +1,20 @@
+from .base import *
+
+class BankAccount:
+    def __init__(self, id: str | NSID) -> None:
+        self.id: NSID = NSID(id)
+        self.owner: NSID = NSID(0)
+        self.amount: int = 0
+        self.locked: bool = False
+        self.bank: str = "HexaBank"
+
+        self.income: int = 0
+
+class Item:
+    def __init__(self, id: str | NSID) -> None:
+        self.id: NSID = NSID(id)
+        self.title: str = "Unknown Object"
+        self.emoji: str = ":light_bulb:"
+
+        self.seller_id: NSID = NSID(0)
+        self.price: int = 0

nsarchive/cls/entities.py

@@ -2,31 +2,68 @@ import io
 import time
 
 from .exceptions import *
+from .base import *
 
 from ..utils import assets
 
+class PositionPermissions:
+    """
+    Permissions d'une position à l'échelle du serveur. Certaines sont attribuées selon l'appartenance à divers groupes ayant une position précise
+    """
+
+    def __init__(self) -> None:
+        # Membres
+        self.approve_laws = False # Approuver ou désapprouver les lois proposées (vaut aussi pour la Constitution)
+        self.buy_items = False # Acheter des items depuis le marketplace
+        self.create_organizations = False # Créer une organisation
+        self.edit_constitution = False # Proposer une modification de la Constitution
+        self.edit_laws = False # Proposer une modification des différents textes de loi
+        self.manage_entities = False # Gérer les membres et les organisations
+        self.manage_national_channel = False # Prendre la parole sur la chaîne nationale et avoir une priorité de passage sur les autres chaînes
+        self.manage_state_budgets = False # Gérer les différents budgets de l'État
+        self.moderate_members = False # Envoyer des membres en garde à vue, en détention ou toute autre sanction non présente sur le client Discord
+        self.propose_new_laws = self.edit_constitution # Proposer un nouveau texte de loi pris en charge par la Constitution
+        self.publish_official_messages = False # Publier un message sous l'identité du bot Serveur
+        self.sell_items = False # Vendre des objets ou services sur le marketplace
+        self.vote_president = False # Participer aux élections présidentielles
+        self.vote_representatives = False # Participer aux élections législatives
+
+    def edit(self, **permissions: bool) -> None:
+        for perm in permissions.values():
+            self.__setattr__(*perm)
+
+class Position:
+    def __init__(self, id: str = 'inconnu') -> None:
+        self.name: str = "Inconnue"
+        self.id = id
+        self.permissions: PositionPermissions = PositionPermissions()
 class Entity:
-    def __init__(self, id: str) -> None:
-        self.id: str = id # ID hexadécimal de l'entité (ou nom dans le cas de l'entreprise)
+    def __init__(self, id: str | NSID) -> None:
+        self.id: NSID = NSID(id) # ID hexadécimal de l'entité (ou nom dans le cas de l'entreprise)
         self.name: str = "Entité Inconnue"
         self.registerDate: int = 0
-        self.legalPosition: str = 'Membre'
-    
+        self.legalPosition: Position = Position()
+
     def set_name(self, new_name: str) -> None:
         if len(new_name) > 32:
             raise NameTooLongError(f"Name length mustn't exceed 32 characters.")
-        
+
         self.name = new_name
-    
+
     def set_position(self, position: str) -> None:
         self.legalPosition = position
 
 class User(Entity):
-    def __init__(self, id: str) -> None:
-        super().__init__(id)
+    def __init__(self, id: str | NSID) -> None:
+        super().__init__(NSID(id))
 
         self.xp: int = 0
         self.boosts: dict[str, int] = {}
+        self.permissions: PositionPermissions = PositionPermissions() # Elles seront définies en récupérant les permissions de sa position
+        self.votes: list[str] = []
+
+    def add_vote(self, id: str | NSID):
+        self.votes.append(NSID(id))
 
     def get_level(self) -> None:
         i = 0
@@ -34,7 +71,7 @@ class User(Entity):
             i += 1
 
         return i
-    
+
     def add_xp(self, amount: int) -> None:
         boost = 0 if 0 in self.boosts.values() else max(list(self.boosts.values()) + [ 1 ])
 
@@ -47,24 +84,28 @@ class User(Entity):
             del self.boosts[name]
 
 class MemberPermissions:
+    """
+    Permissions d'un utilisateur à l'échelle d'un groupe
+    """
+
     def __init__(self) -> None:
         self.manage_organization = False # Renommer ou changer le logo
         self.manage_members = False # Virer quelqu'un d'une entreprise, l'y inviter, changer ses rôles
         self.manage_roles = False # Promouvoir ou rétrograder les membres
-    
+
     def edit(self, **permissions: bool) -> None:
         for perm in permissions.values():
             self.__setattr__(*perm)
 
 class GroupMember():
-    def __init__(self, id: str) -> None:
-        self.id = id
+    def __init__(self, id: str | NSID) -> None:
+        self.id: NSID = NSID(id)
         self.permissions: MemberPermissions = MemberPermissions()
         self.position: str = 'membre'
 
-class FunctionalUser:
-    def __init__(self, id: str) -> None:
-        self.id: str = id
+class Official:
+    def __init__(self, id: str | NSID) -> None:
+        self.id: NSID = NSID(id)
 
         self.mandates: int = {
             'PRE_REP': 0, # Président de la République
@@ -82,8 +123,8 @@ class FunctionalUser:
         }
 
 class Organization(Entity):
-    def __init__(self, id: str) -> None:
-        super().__init__(id)
+    def __init__(self, id: str | NSID) -> None:
+        super().__init__(NSID(id))
 
         self.owner: Entity
         self.certifications: dict = {}
@@ -92,21 +133,16 @@ class Organization(Entity):
 
     def add_certification(self, certif: str) -> None:
         self.certifications[certif] = round(time.time())
-    
+
     def add_member(self, member: GroupMember) -> None:
         self.members.append(member)
-    
-    def remove_member(self, member: User) -> None:
+
+    def remove_member(self, member: GroupMember) -> None:
         if member in self.members:
             self.members.remove(member)
-    
+
     def set_owner(self, member: User) -> None:
         self.owner = member
 
     def get_member_id(self) -> list[str]:
-        return [ member.id for member in self.members ]
-
-class Elector(User):
-    def __init__(self, id: str) -> None:
-        super().__init__(id)
-        self.votes: list[str] = []
+        return [ member.id for member in self.members ]

nsarchive/cls/exceptions.py

@@ -15,5 +15,11 @@ class AvatarTooLongError(Exception):
 # Exceptions pour le vote
 
 class AlreadyVotedError(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)
+
+# Ressource pas trouvée
+
+class RessourceNotFoundError(Exception):
     def __init__(self, *args: object) -> None:
         super().__init__(*args)

nsarchive/cls/republic.py

@@ -3,8 +3,8 @@ from .entities import *
 # Votes
 
 class Vote:
-    def __init__(self, id: str, title: str, choices: tuple[str]) -> None:
-        self.id: str = id
+    def __init__(self, id: str | NSID, title: str, choices: tuple[str]) -> None:
+        self.id: NSID = NSID(id)
         self.title: str = title
         self.choices = { choice : 0 for choice in choices }
         self.author: str = '0'
@@ -12,7 +12,7 @@ class Vote:
         self.endDate: int = 0
 
 class ClosedVote(Vote):
-    def __init__(self, id: str, title: str) -> None:
+    def __init__(self, id: str | NSID, title: str) -> None:
         super().__init__(id, title, ('yes', 'no', 'blank'))
 
 
@@ -20,35 +20,35 @@ class ClosedVote(Vote):
 
 class Administration:
     def __init__(self) -> None:
-        self.president: FunctionalUser
-        self.members: list[FunctionalUser]
+        self.president: Official
+        self.members: list[Official]
 
 class Government:
-    def __init__(self, president: FunctionalUser) -> None:
-        self.president: FunctionalUser = president
-        self.prime_minister: FunctionalUser
+    def __init__(self, president: Official) -> None:
+        self.president: Official = president
+        self.prime_minister: Official
 
-        self.inner_minister: FunctionalUser
-        self.economy_minister: FunctionalUser
-        self.justice_minister: FunctionalUser
-        self.press_minister: FunctionalUser
-        self.outer_minister: FunctionalUser
+        self.inner_minister: Official
+        self.economy_minister: Official
+        self.justice_minister: Official
+        self.press_minister: Official
+        self.outer_minister: Official
 
 class Assembly:
     def __init__(self) -> None:
-        self.president: FunctionalUser
-        self.members: list[FunctionalUser]
+        self.president: Official
+        self.members: list[Official]
 
 class Court:
     def __init__(self) -> None:
-        self.president: FunctionalUser
+        self.president: Official
         # On discutera de la mise en place d'un potentiel président. Pour l'instant c'est le Ministre de la Justice
-        self.members: list[FunctionalUser]
+        self.members: list[Official]
 
 class PoliceForces:
     def __init__(self) -> None:
-        self.president: FunctionalUser
-        self.members: list[FunctionalUser]
+        self.president: Official
+        self.members: list[Official]
 
 class Institutions:
     def __init__(self) -> None:
@@ -56,4 +56,5 @@ class Institutions:
         self.government: Government
         self.court: Court
         self.assembly: Assembly
-        self.police: PoliceForces
+        self.police: PoliceForces
+

{nsarchive-0.1b3.dist-info → nsarchive-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nsarchive
-Version: 0.1b3
+Version: 1.0.0
 Summary: 
 License: GPL-3.0
 Author: happex

nsarchive-1.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+nsarchive/__init__.py,sha256=WAGTyFj-bQEgkz7tW8KTCIYqEMKq6RvjP6sp-9RaGp0,23899
+nsarchive/assets/default_avatar.png,sha256=n-4vG_WPke8LvbY3ZU6oA-H-OtRoIu7woKnRq9DCIlI,51764
+nsarchive/cls/archives.py,sha256=P3xOg7D7og-Vnf3VQWeIwmJRD9g7dVQBYChvMIMM6i8,2008
+nsarchive/cls/base.py,sha256=1B1BpDuQhQAU2gzpme_SmQcfT-xBiii08Fd4bv73_8E,777
+nsarchive/cls/economy.py,sha256=RjFu3VzNunazslbd4Ia5p1Jr-jJP5CvIcbVOzkDTwTU,549
+nsarchive/cls/entities.py,sha256=zz0JTphgtXpCIVH8dgb3hxc55nxwvXF3m2yIXgp_Q9k,5743
+nsarchive/cls/exceptions.py,sha256=QN6Qn7cxTkGoC4lO50hBAq4gZCgo7scQvCkb-xKl6Xs,692
+nsarchive/cls/republic.py,sha256=FphoO9TBE9hyfdjcePjQHqBw7NFT74f-avE9T5qTTuE,1750
+nsarchive/utils/assets.py,sha256=hd0STSpa0yT-OJlUyI_wCYXJqcBiUMQds2pZTXNNg9c,382
+nsarchive-1.0.0.dist-info/LICENSE,sha256=aFLFZg6LEJFpTlNQ8su3__jw4GfV-xWBmC1cePkKZVw,35802
+nsarchive-1.0.0.dist-info/METADATA,sha256=iHeEWqCHHmMSOrjN7qofN3bkqPPwLL7ZFPu2Xfz8bUk,5629
+nsarchive-1.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+nsarchive-1.0.0.dist-info/RECORD,,

nsarchive/cls/bank.py

@@ -1,7 +0,0 @@
-class BankAccount:
-    def __init__(self, id: str) -> None:
-        self.id: str = id
-        self.owner: str = '0'
-        self.amount: int = 0
-        self.locked: bool = False
-        self.bank: str = "HexaBank"

nsarchive-0.1b3.dist-info/RECORD

@@ -1,12 +0,0 @@
-nsarchive/__init__.py,sha256=2wELlOApcaP3RPByj_xr3JwQ8ngLSDWBzQIDp117HsM,15481
-nsarchive/assets/default_avatar.png,sha256=n-4vG_WPke8LvbY3ZU6oA-H-OtRoIu7woKnRq9DCIlI,51764
-nsarchive/cls/archives.py,sha256=5C66pXuXAANRXNDqNTvIepRtUrXIWOL7ymmYiBHsHAY,1720
-nsarchive/cls/bank.py,sha256=OactEpRn8PGv7BwnBUbMpzgHqrvv4yx526AMzh9uBO8,220
-nsarchive/cls/entities.py,sha256=Gv6nNEmLXyUokQfoQgNUIjq0kLTTlPT0Wmdpw83z7gY,3499
-nsarchive/cls/exceptions.py,sha256=UZ7G7AFUN5OkKAGpNl1OT7jauF1jC7WW8wWXVFt5sMs,539
-nsarchive/cls/republic.py,sha256=aY79B5PZF5IErwzEjn9ito6T8gXA4trm6LmIeYu6XLM,1821
-nsarchive/utils/assets.py,sha256=hd0STSpa0yT-OJlUyI_wCYXJqcBiUMQds2pZTXNNg9c,382
-nsarchive-0.1b3.dist-info/LICENSE,sha256=aFLFZg6LEJFpTlNQ8su3__jw4GfV-xWBmC1cePkKZVw,35802
-nsarchive-0.1b3.dist-info/METADATA,sha256=1KcsUxL-6mWvF4VJ42jYnNnL-wkkI8pBqYOtiZxscDI,5629
-nsarchive-0.1b3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-nsarchive-0.1b3.dist-info/RECORD,,