ul-api-utils 7.10.1__tar.gz → 7.10.3__tar.gz

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 7.10.1
+Version: 7.10.3
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/example/conf.py

@@ -8,9 +8,16 @@ from ul_api_utils.modules.api_sdk_config import ApiSdkConfig, ApiSdkIdentifyType
 from example.permissions import permissions
 
 sdk = ApiSdk(ApiSdkConfig(
-    sockets_config=SocketIOConfig(
+    server_socketio_config=SocketIOConfig(
         message_queue='redis://localhost:16379',
+        logs_enabled=True,
+        engineio_logs_enabled=False,
     ),
+    # client_socketio_config=SocketIOConfig(
+    #     message_queue='redis://localhost:16379',
+    #     logs_enabled=True,
+    #     engineio_logs_enabled=False,
+    # ),
     service_name='example_service',
     permissions=permissions,
     cache_storage_uri='redis://localhost:16379',

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/example/main.py

@@ -1,3 +1,8 @@
+# from gevent import monkey
+#
+# monkey.patch_all()
+# UNCOMMENT THIS IN CASE YOU'RE TESTING GEVENT WORKERS WITH SOCKET.IO
+
 import os
 
 if int(os.environ.get('PROFILE_MEM', '0')):

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/example/routes/api_some.py

@@ -1,16 +1,13 @@
 import logging
 from time import sleep
 from datetime import datetime, timedelta
-from typing import List, Optional, Tuple, Any
+from typing import List, Optional, Tuple
 
-from flask_socketio import emit
 
-from ul_api_utils.resources.sockets import socket_io
 from flask import jsonify
 from pydantic import BaseModel
 from ul_db_utils.modules.postgres_modules.db import db
 from werkzeug import Response as BaseResponse
-from flask import request
 from example.conf import sdk
 from example.permissions import SOME_PERMISSION, SOME_PERMISSION2
 from ul_api_utils.api_resource.api_request import ApiRequestQuery
@@ -321,21 +318,3 @@ def somefile(api_resource: ApiResource) -> FileApiResponse:
         as_attachment=True,
         attachment_filename='import_devices_log.txt',
     )
-
-
-@socket_io.on('message')
-def handle(data: Any, message: Any) -> None:
-    sid = request.sid
-    emit('message', {"data1": 1, "data": 2}, room=sid)
-
-
-@socket_io.event
-def connect():
-    logger.info("Connected!")
-    logger.info("SESSION INFO: " + str(request.sid))
-
-
-@socket_io.event('disconnect')
-def disconnect():
-    logger.info("Client disconnected!")
-    logger.info("SESSION INFO: " + str(request.sid))

ul-api-utils-7.10.3/example/sockets/on_connect.py

@@ -0,0 +1,16 @@
+import logging
+
+from flask import request
+from flask_socketio import emit  # type: ignore
+
+from example.conf import sdk
+
+
+logger = logging.getLogger(__name__)
+
+
+@sdk.socket.on('connect')
+def handle_connect() -> None:
+    logger.info("Connected!")
+    logger.info("SESSION INFO: " + str(request.sid))  # type: ignore
+    emit('message', {"data1": 1, "data": 2}, room=request.sid, broadcast=True)  # type: ignore

ul-api-utils-7.10.3/example/sockets/on_disconnect.py

@@ -0,0 +1,14 @@
+import logging
+
+from flask import request
+
+from example.conf import sdk
+
+
+logger = logging.getLogger(__name__)
+
+
+@sdk.socket.on('disconnect')
+def disconnect() -> None:
+    logger.info("Client disconnected!")
+    logger.info("SESSION INFO: " + str(request.sid))  # type: ignore

ul-api-utils-7.10.3/example/sockets/on_json.py

@@ -0,0 +1,10 @@
+from typing import Any
+
+from flask_socketio import send  # type: ignore
+
+from example.conf import sdk
+
+
+@sdk.socket.on('json')
+def handle_json(json: dict[str, Any]) -> None:
+    send(json, json=True)

ul-api-utils-7.10.3/example/sockets/on_message.py

@@ -0,0 +1,9 @@
+from typing import Any
+
+from example.conf import sdk
+
+
+@sdk.socket.on('message')
+def handle_message(data: Any) -> None:
+    print('received message: ')
+    print(data)

ul-api-utils-7.10.3/example/sockets/on_open.py

@@ -0,0 +1,16 @@
+import logging
+
+from flask import request
+from flask_socketio import emit  # type: ignore
+
+from example.conf import sdk
+
+
+logger = logging.getLogger(__name__)
+
+
+@sdk.socket.on('open')
+def handle_open() -> None:
+    logger.info("Connected!")
+    logger.info("SESSION INFO: " + str(request.sid))  # type: ignore
+    emit('message', {"data1": 1, "data": 2}, room=request.sid, broadcast=True)  # type: ignore

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/setup.py

@@ -9,7 +9,7 @@ with open(path.join(HERE, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='ul-api-utils',
-    version='7.10.1',
+    version='7.10.3',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,
@@ -62,6 +62,7 @@ setup(
         "pyjwt==2.4.0",
         "gunicorn==20.1.0",
         "gevent==24.2.1",
+        "gevent-websocket==0.10.1",
         "pyyaml==6.0",
         "requests==2.28.1",
         "cryptography==38.0.1",

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils/commands/cmd_generate_api_docs.py

@@ -6,7 +6,7 @@ import inspect
 import os
 import logging
 from datetime import datetime
-from typing import Dict, Callable, Any, List, TextIO, Set
+from typing import Dict, Callable, Any, List, TextIO
 from flask import url_for, Flask
 from ul_py_tool.commands.cmd import Cmd
 

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils/commands/cmd_start.py

@@ -4,7 +4,6 @@ import re
 import subprocess
 import sys
 from datetime import datetime
-from typing import Optional
 
 from ul_py_tool.commands.cmd import Cmd
 from ul_py_tool.utils.arg_str2bool import arg_str2bool
@@ -27,7 +26,6 @@ class CmdStart(Cmd):
     max_requests: int
     max_requests_jitter: int
     worker_class: str
-    statsd_endpoint: Optional[str]
 
     @property
     def app_rel_dir(self) -> str:
@@ -53,7 +51,6 @@ class CmdStart(Cmd):
         parser.add_argument('--max-requests', dest='max_requests', type=int, default=1000, required=False)
         parser.add_argument('--max-requests-jitter', dest='max_requests_jitter', type=int, default=50, required=False)
         parser.add_argument('--worker-class', dest='worker_class', type=str, default='sync', required=False)
-        parser.add_argument('--statsd_endpoint', dest='statsd_endpoint', type=str, default=None, required=False)
 
     def run(self) -> None:
         env = os.environ.copy()
@@ -87,10 +84,6 @@ class CmdStart(Cmd):
             *(['--reload'] if debug else ['--preload']),
             f'{self.app_module}:{self.app_name}',
         ]
-
-        if self.statsd_endpoint and self.env != ENV_LOCAL:
-            args.extend([f'--statsd-host={self.statsd_endpoint}', f"--statsd-prefix={self.app_module.split('.')[1]}:{self.env}"])
-
         write_stdout(f'name={name}')
         write_stdout(f'args={args}')
         subprocess.run(['gunicorn', '--check-config', '--print-config', *args], cwd=os.getcwd(), stdout=sys.stdout, stderr=sys.stderr, text=True, env=env)

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils/modules/api_sdk.py

@@ -8,7 +8,6 @@ from base64 import b64decode
 from datetime import datetime
 from functools import wraps
 from typing import List, Union, Callable, Tuple, Any, Optional, TypeVar, cast, Set, TYPE_CHECKING
-from ul_api_utils.resources.sockets import socket_io
 from flask import Response, request, Flask, url_for as flask_url_for, _app_ctx_stack
 from pydantic import BaseModel
 from redis.connection import parse_url
@@ -36,6 +35,7 @@ from ul_api_utils.resources.health_check.resource import init_health_check_resou
 from ul_api_utils.resources.not_implemented import not_implemented_handler
 from ul_api_utils.resources.permissions import load_permissions
 from ul_api_utils.resources.rate_limitter import init_rate_limiter
+from ul_api_utils.resources.socketio import init_socketio
 from ul_api_utils.resources.swagger import load_swagger, ApiSdkResource
 from ul_api_utils.sentry import sentry
 from ul_api_utils.utils.api_encoding import ApiEncoding
@@ -50,6 +50,7 @@ from ul_api_utils.utils.load_modules import load_modules_by_template
 from ul_api_utils.utils.uuid_converter import UUID4Converter
 
 if TYPE_CHECKING:
+    import flask_socketio  # type: ignore # lib without mypy stubs
     import flask_sqlalchemy
     from flask_mongoengine import MongoEngine      # type: ignore # lib without mypy stubs
     from ul_db_utils.modules.postgres_modules.db import DbConfig
@@ -105,6 +106,7 @@ class ApiSdk:
         '_templates_dir',
         '_fn_registry',
         '_flask_app_cache',
+        '_sio',
         '_limiter_enabled',
         '_cache',
         '_db',
@@ -120,7 +122,7 @@ class ApiSdk:
         self._flask_app_cache: Optional[Flask] = None
         self._limiter_enabled = False
         self._cache = None
-
+        self._sio: Optional['flask_socketio.SocketIO'] = None
         self._templates_dir = os.path.join(APPLICATION_DIR, 'templates')
 
         self._fn_registry: List[ApiSdkResource] = []
@@ -130,8 +132,14 @@ class ApiSdk:
     def config(self) -> ApiSdkConfig:
         return self._config
 
+    @property
+    def socket(self) -> 'flask_socketio.SocketIO':
+        assert self._sio is not None, "SocketIO is not configured, try adding SocketIOConfig to your ApiSdk first."
+        return self._sio
+
     def init_with_flask(self, app_name: str, *, db_config: Optional['MongoDbConfig'] | Optional['DbConfig'] = None) -> Flask:
         self._initialized_flask_name = try_init(self, app_name)
+        self._sio = init_socketio(self._config.server_socketio_config, self._config.client_socketio_config)
 
         if db_config is not None and type(db_config).__name__ == 'MongoDbConfig':
             from ul_db_utils.utils.waiting_for_mongo import waiting_for_mongo
@@ -199,15 +207,6 @@ class ApiSdk:
 
         load_swagger(self, self._fn_registry, self._config.api_route_path_prefix)
 
-        if self.config.sockets_config:
-            socket_io.init_app(
-                self._flask_app,
-                message_queue=self.config.sockets_config.message_queue,
-                async_mode=SocketAsyncModesEnum.GEVENT.value,
-                channel=self.config.sockets_config.channel,
-                cors_allowed_origins=self.config.sockets_config.cors_allowed_origins,
-            )
-
         return self._flask_app
 
     @property
@@ -255,6 +254,19 @@ class ApiSdk:
             debugger_enabled=self._debugger_enabled_with_pin,
         ))
 
+        if self._config.server_socketio_config:
+            assert self._sio  # mypy
+            self._sio.init_app(
+                flask_app,
+                message_queue=self._config.server_socketio_config.message_queue,
+                async_mode=SocketAsyncModesEnum.GEVENT.value,
+                channel=self._config.server_socketio_config.channel,
+                cors_allowed_origins=self._config.server_socketio_config.cors_allowed_origins,
+                logger=self._config.server_socketio_config.logs_enabled,
+                engineio_logger=self._config.server_socketio_config.engineio_logs_enabled,
+            )
+            load_modules_by_template([os.path.join(APPLICATION_DIR, 'sockets', '*')])
+
         return flask_app
 
     @property

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils/modules/api_sdk_config.py

@@ -1,7 +1,7 @@
 from enum import Enum
-from typing import List, Optional, Callable, Union
+from typing import List, Optional, Callable, Union, Any
 
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel, Extra, root_validator
 
 from ul_api_utils.access import PermissionRegistry, PermissionDefinition
 from ul_api_utils.modules.api_sdk_jwt import ApiSdkJwt
@@ -40,6 +40,8 @@ class SocketIOConfig(BaseModel):
     message_queue: str
     channel: Optional[str] = "flask-socketio"
     cors_allowed_origins: Optional[str] = "*"
+    logs_enabled: Optional[bool] = False
+    engineio_logs_enabled: Optional[bool] = False
 
 
 class ApiSdkConfig(BaseModel):
@@ -54,7 +56,8 @@ class ApiSdkConfig(BaseModel):
     http_auth: Optional[ApiSdkHttpAuth] = None
 
     static_url_path: Optional[str] = None
-    sockets_config: Optional[SocketIOConfig] = None
+    server_socketio_config: Optional[SocketIOConfig] = None
+    client_socketio_config: Optional[SocketIOConfig] = None
     web_error_template: Optional[str] = None
 
     rate_limit: Union[str, List[str]] = '100/minute'  # [count (int)] [per|/] [second|minute|hour|day|month|year][s]
@@ -68,6 +71,26 @@ class ApiSdkConfig(BaseModel):
 
     api_route_path_prefix: str = '/api'
 
+    @staticmethod
+    def validate_socketio(values: dict[str, Any]) -> None:
+        """
+        ApiSdk instance could be either a Socket.IO server or Socket.IO client.
+        Client do not need the flask_app process attached to it, but server does.
+
+        Client should use the same config as server (message_queue).
+        Validate that ApiSdk instance couldn't be a server and a client simultaneously.
+        """
+        server_conf, client_conf = values.get("server_socketio_config"), values.get("client_socketio_config")
+        service = values["service_name"]
+        error_msg = f"Can't create ApiSdkConfig for {service}. ApiSdk cannot be a socketio server and client simultaneously"
+        if all([server_conf, client_conf]):
+            raise AssertionError(error_msg)
+
+    @root_validator
+    def validator(cls, values: dict[str, Any]) -> dict[str, Any]:
+        cls.validate_socketio(values)
+        return values
+
     class Config:
         extra = Extra.forbid
         allow_mutation = False

ul-api-utils-7.10.3/ul_api_utils/resources/socketio.py

@@ -0,0 +1,20 @@
+from flask_socketio import SocketIO  # type: ignore
+
+from ul_api_utils.modules.api_sdk_config import SocketIOConfig, SocketAsyncModesEnum
+
+
+def init_socketio(server_config: SocketIOConfig | None, client_config: SocketIOConfig | None) -> SocketIO | None:
+    socketio = None
+    if server_config is not None:
+        socketio = SocketIO()
+
+    if client_config is not None:
+        socketio = SocketIO(
+            message_queue=client_config.message_queue,
+            async_mode=SocketAsyncModesEnum.GEVENT.value,
+            channel=client_config.channel,
+            cors_allowed_origins=client_config.cors_allowed_origins,
+            logger=client_config.logs_enabled,
+            engineio_logger=client_config.engineio_logs_enabled,
+        )
+    return socketio

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 7.10.1
+Version: 7.10.3
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils.egg-info/SOURCES.txt

@@ -10,6 +10,12 @@ example/rate_limit_load.py
 example/models/__init__.py
 example/routes/__init__.py
 example/routes/api_some.py
+example/sockets/__init__.py
+example/sockets/on_connect.py
+example/sockets/on_disconnect.py
+example/sockets/on_json.py
+example/sockets/on_message.py
+example/sockets/on_open.py
 example/workers/__init__.py
 example/workers/worker.py
 ul_api_utils/__init__.py
@@ -81,7 +87,7 @@ ul_api_utils/resources/debugger_scripts.py
 ul_api_utils/resources/not_implemented.py
 ul_api_utils/resources/permissions.py
 ul_api_utils/resources/rate_limitter.py
-ul_api_utils/resources/sockets.py
+ul_api_utils/resources/socketio.py
 ul_api_utils/resources/swagger.py
 ul_api_utils/resources/health_check/__init__.py
 ul_api_utils/resources/health_check/const.py

{ul-api-utils-7.10.1 → ul-api-utils-7.10.3}/ul_api_utils.egg-info/requires.txt

@@ -12,6 +12,7 @@ pycryptodome==3.15.0
 pyjwt==2.4.0
 gunicorn==20.1.0
 gevent==24.2.1
+gevent-websocket==0.10.1
 pyyaml==6.0
 requests==2.28.1
 cryptography==38.0.1

ul-api-utils-7.10.1/ul_api_utils/resources/sockets.py

@@ -1,3 +0,0 @@
-from flask_socketio import SocketIO  # type: ignore
-
-socket_io = SocketIO()