linting, CI fixes, circular import fix

circular import issue

Author: dr7ana

sogs/model/clientmanager.py

@@ -79,26 +79,20 @@ class ClientManager:
         queue - BotQueue object
     """
 
-    def __init__(
-        self,
-        *,
-        id: Optional[int] = None,
-    ) -> None:
+    def __init__(self, *, id: Optional[int] = None) -> None:
         self.id = id
         self.filter = False
         self.bqueue = BotQueue()
         self.clients = []
 
-
     def bqempty(self):
         return not self.bqueue._empty()
-    
 
     def register_client(self, conn_id, cid, authlevel, bot, priority):
         if not bot:
             # add client to self.clients
             return
-        
+
         if not priority:
             # if no priority is given, lowest priority is assigned
             priority = self.qsize()
@@ -108,19 +102,16 @@ def register_client(self, conn_id, cid, authlevel, bot, priority):
                 priority += 1
         self.bqueue._put(PriorityTuple(priority, bot))
 
-
     def deregister_client(self, cid, bot):
         if not bot:
             # remove client from clients list
             return
-        
+
         # remove bot from bot queue
-        
 
     def peek(self, priority: int):
         return self.bqueue._peek(priority)
 
-
     def check_permission_for(
         self,
         room: Room,

sogs/model/room.py

@@ -154,7 +154,6 @@ def _refresh(self, *, id=None, token=None, row=None, perms=False):
         if perms or not hasattr(self, '_perm_cache'):
             self._perm_cache = {}
 
-
     def __str__(self):
         """Returns `Room[token]` when converted to a str"""
         return f"Room[{self.token}]"

sogs/omq.py

@@ -4,8 +4,8 @@
 import oxenmq, queue
 from oxenc import bt_serialize, bt_deserialize
 
-from mule import log_exceptions
-from routes import omq_auth
+from .mule import log_exceptions
+from .routes import omq_auth
 from . import crypto, config
 from .postfork import postfork
 from .model.clientmanager import ClientManager
@@ -36,7 +36,7 @@ def __init__(self):
         if uwsgi.mule_id() != 0:
             uwsgi.opt['mule'].setup_omq(self)
             return
-        
+
         uwsgi.register_signal(123, 'internal', self.handle_proxied_omq_req)
 
         from .web import app  # Imported here to avoid circular import
@@ -52,57 +52,49 @@ def __init__(self):
         global omq_global
         omq_global = self
 
-    
     @log_exceptions
     def subreq_response(self):
         pass
 
-
     @log_exceptions
     def handle_proxied_omq_req(self):
-        id, subreq_body = self.send_mule(
-            command='get_next_request',
-            prefix='internal'
-        )
+        id, subreq_body = self.send_mule(command='get_next_request', prefix='internal')
 
         '''
             
             Handle omq subrequest
 
         '''
 
-        return 
+        return
 
     @log_exceptions
     def get_next_request(self):
         subreq_body = self.subreq_queue.get()
         id = list(subreq_body.keys())[0]
         return id, subreq_body[id]
 
-
     @log_exceptions
     def register_client(self, msg: oxenmq.Message):
         cid, authlevel, bot, priority = bt_deserialize(msg.data()[0])
         conn_id = msg.conn()
         self.client_map[conn_id] = cid
         self.manager.register_client(msg)
 
-
     @log_exceptions
     def deregister_client(self, msg: oxenmq.Message):
         cid, bot = bt_deserialize(msg.data()[0])
         self.client_map.pop(cid)
         self.manager.deregister_client(cid, bot)
 
-
     def send_mule(self, command, *args, prefix="worker."):
         """
         Sends a command to the mule from a worker (or possibly from the mule itself).  The command will
         be prefixed with "worker." (unless overridden).
 
         Any args will be bt-serialized and send as message parts.
         """
-        
+
         if prefix:
             command = prefix + command
 

sogs/routes/clients.py

@@ -22,7 +22,7 @@
 @omq_auth.first_request
 def register(cid):
     """
-    Registers a client with SOGS OMQ instance. In this context, "client" refers to any entity 
+    Registers a client with SOGS OMQ instance. In this context, "client" refers to any entity
     seeking to create an authenticated OMQ connection. This may be, but is not limited to,
     a user or a bot
 
@@ -44,12 +44,11 @@ def register(cid):
     """
 
     req = request.json
-    bot = utils.get_int_param('bot')    # will set bot == 1 if key "bot" has value True
+    bot = utils.get_int_param('bot')  # will set bot == 1 if key "bot" has value True
     authlevel = req.get('authlevel')
     priority = req.get('priority')
-    
-    client = (bot is 1)[register_client(cid, authlevel),
-                        register_bot(cid, authlevel, priority)]
+
+    client = (bot is 1)[register_client(cid, authlevel), register_bot(cid, authlevel, priority)]
 
     return client
 
@@ -78,7 +77,7 @@ def register_bot(cid, authlevel, priority):
         authlevel=authlevel,
         bot=1,
         priority=priority,
-        prefix='handler'
+        prefix='handler',
     )
 
     return client
@@ -106,7 +105,7 @@ def register_client(cid, authlevel):
         authlevel=authlevel,
         bot=0,
         priority=None,
-        prefix='handler'
+        prefix='handler',
     )
 
     return client
@@ -125,7 +124,7 @@ def unregister(cid):
 
         - 'bot' (bool) : is bot or not
     """
-    
+
     bot = utils.get_int_param('bot')
 
     client = (bot)[unregister_client(cid), unregister_bot(cid)]
@@ -137,25 +136,15 @@ def unregister(cid):
 @clients.delete("/client/registered/client/<cid>")
 def unregister_client(cid):
 
-    client = omq_global.send_mule(
-        command='unregister_client',
-        cid=cid,
-        bot=0,
-        prefix='handler'
-    )
-    
+    client = omq_global.send_mule(command='unregister_client', cid=cid, bot=0, prefix='handler')
+
     return client
 
 
 @clients.post("/bot/deregistered/bot/<cid>")
 @clients.delete("/bot/registered/bot/<cid>")
 def unregister_bot(cid):
-    
-    client = omq_global.send_mule(
-        command='unregister_bot',
-        cid=cid,
-        bot=1,
-        prefix='handler'
-    )
+
+    client = omq_global.send_mule(command='unregister_bot', cid=cid, bot=1, prefix='handler')
 
     return client

sogs/routes/legacy.py

@@ -2,7 +2,6 @@
 from werkzeug.exceptions import HTTPException
 from ..web import app
 from .. import crypto, config, db, http, utils
-from ..omq import send_mule
 from ..utils import jsonify_with_base64
 from ..model.room import Room, get_accessible_rooms, get_deletions_deprecated
 from ..model.user import User
@@ -321,7 +320,13 @@ def handle_legacy_delete_messages(ids=None):
     ids = room.delete_posts(ids, user)
 
     if ids:
-        send_mule("messages_deleted", ids)
+        # avoid circular imports
+        try:
+            from ..omq import omq_global
+        except ModuleNotFoundError:
+            return
+        
+        omq_global.send_mule("messages_deleted", ids)
 
     return jsonify({'status_code': http.OK})
 

sogs/routes/messages.py

@@ -10,6 +10,7 @@
 messages = Blueprint('messages', __name__)
 blueprints_global['messages'] = messages
 
+
 def qs_reactors():
     return utils.get_int_param('reactors', 4, min=0, max=20, truncate=True)
 
@@ -314,6 +315,7 @@ def message_single(room: Room, msg_id):
         - add some decorator to this s.t. it routes it to the correct OMQ endpoint
 """
 
+
 @messages.post("/room/<Room:room>/message")
 @auth.user_required
 def post_message(room: Room):