ul-api-utils 7.9.5__py3-none-any.whl → 7.9.6__py3-none-any.whl

example/conf.py

@@ -10,6 +10,8 @@ from example.permissions import permissions
 sdk = ApiSdk(ApiSdkConfig(
     sockets_config=SocketIOConfig(
         message_queue='redis://localhost:16379',
+        logs_enabled=True,
+        engineio_logs_enabled=False,
     ),
     service_name='example_service',
     permissions=permissions,

example/main.py

@@ -1,3 +1,7 @@
+# from gevent import monkey
+#
+# monkey.patch_all()
+
 import os
 
 if int(os.environ.get('PROFILE_MEM', '0')):

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))

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

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

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)

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)

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/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/modules/api_sdk.py

@@ -8,7 +8,7 @@ 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_socketio import SocketIO  # type: ignore
 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
@@ -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
     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,7 +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:
+        if self.config.sockets_config:
+            self._sio = SocketIO()
         self._initialized_flask_name = try_init(self, app_name)
 
         if db_config is not None and type(db_config).__name__ == 'MongoDbConfig':
@@ -199,17 +208,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,
-                logger=self.config.sockets_config.logs_enabled,
-                engineio_logger=self.config.sockets_config.engineio_logs_enabled,
-            )
-
         return self._flask_app
 
     @property
@@ -257,6 +255,19 @@ class ApiSdk:
             debugger_enabled=self._debugger_enabled_with_pin,
         ))
 
+        if self.config.sockets_config:
+            assert self._sio  # mypy
+            self._sio.init_app(
+                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,
+                logger=self.config.sockets_config.logs_enabled,
+                engineio_logger=self.config.sockets_config.engineio_logs_enabled,
+            )
+            load_modules_by_template([os.path.join(APPLICATION_DIR, 'sockets', '*')])
+
         return flask_app
 
     @property

{ul_api_utils-7.9.5.dist-info → ul_api_utils-7.9.6.dist-info}/METADATA

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

{ul_api_utils-7.9.5.dist-info → ul_api_utils-7.9.6.dist-info}/RECORD

@@ -1,12 +1,18 @@
 example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/conf.py,sha256=tdt3X2gLdTDf_0oMErMpAqqYjIEhpmG5GrOLHqzJH7Y,1018
-example/main.py,sha256=8jOO1VliFr92UoCLDInzSDPRLluzPuO-MMkzHc5Xd2w,419
+example/conf.py,sha256=3dAGM78iFiMhrhgFJjn9xkqLjOpOPITRoYYSILaYXAA,1082
+example/main.py,sha256=y24aWpD4d3d9HIn8Gx2wE_5-MJeiv--iVe5FeRSWAcg,471
 example/permissions.py,sha256=i8_zOOPdra3oMXZfyTspewRYNdn21PCqOD1ATG69Itk,277
 example/pure_flask_example.py,sha256=A7cbcjTr28FS1sVNAsQbj1N9EgEFIXDB4aRwOV6_tbU,1329
 example/rate_limit_load.py,sha256=U2Bgp8UztT4TNKdv9NVioxWfE68aCsC7uKz7xPCy6XM,225
 example/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 example/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/routes/api_some.py,sha256=Gkyb3r1AT7Fg8cAhJk7StTS5aGb-vylvyEuXx7g3Yc4,13316
+example/routes/api_some.py,sha256=fnFO1uFQx-oypCqPNkUfueABrTsAWLdB5spRnhWSZ58,12790
+example/sockets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+example/sockets/on_connect.py,sha256=3sluHnVT_-e2Oa4YsRZUJIc2L4VnMSJu5rgI_mkg8BQ,411
+example/sockets/on_disconnect.py,sha256=ev0uJutqmTSsbrBcQIRudBX-6g7uSmZj8Imuf6pVIMU,277
+example/sockets/on_json.py,sha256=sTh0Pqu5iITmnRRjc6-rns1VFlEN_xo33_4lUF5VzNk,200
+example/sockets/on_message.py,sha256=Lj0kxEQc3UiQ9Y5_G8_fA48i5eJneEk8Bb2CYNASGc0,168
+example/sockets/on_open.py,sha256=1xfgVqoTuOPxHyBC_rFuj60096gjgbg6rNfCvUqUN8A,405
 example/workers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 example/workers/worker.py,sha256=flMYq50OhLtNSaA2qyDJSMeXSNXIqhdBIsaxcmO5-xQ,681
 ul_api_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -33,7 +39,7 @@ ul_api_utils/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 ul_api_utils/commands/cmd_enc_keys.py,sha256=-Tblh6lI7G6M5YVwbVQqZmXhBMiIpB3a7b0Lv1MFufk,8453
 ul_api_utils/commands/cmd_gen_api_user_token.py,sha256=Vg7oEYHvof7DSLat9yJ_k5AYL9ZOC4Jvd38DBn5U-R0,2730
 ul_api_utils/commands/cmd_gen_new_api_user.py,sha256=ICZbKqz2D6DRvjwtNM08rNjIlWN3qClcUQw5L8FxRBY,4549
-ul_api_utils/commands/cmd_generate_api_docs.py,sha256=cEBUOkn8iQIir78yXzHK_gy_hna2cP58x8N5DzCeZEA,9617
+ul_api_utils/commands/cmd_generate_api_docs.py,sha256=pafX88RjcSMFruSk6qy8Xfao3MXo1yolI4rkC_bmMSQ,9612
 ul_api_utils/commands/cmd_start.py,sha256=aMz6o6HBzLxWrNpV2_rayQ7Nb-VX3-DHgzOUk39R7NA,3623
 ul_api_utils/commands/cmd_worker_start.py,sha256=1tt4_mL8T8_q7i1bqnfjPSkSYlRNNNp8eJ-5rTYj36w,2593
 ul_api_utils/commands/start/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -57,7 +63,7 @@ ul_api_utils/internal_api/__tests__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQ
 ul_api_utils/internal_api/__tests__/internal_api.py,sha256=X2iopeso6vryszeeA__lcqXQVtz3Nwt3ngH7M4OuN1U,1116
 ul_api_utils/internal_api/__tests__/internal_api_content_type.py,sha256=mfiYPkzKtfZKFpi4RSnWAoCd6mRijr6sFsa2TF-s5t8,749
 ul_api_utils/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ul_api_utils/modules/api_sdk.py,sha256=tXjHuoJk2wb-uGnHEdiX_3Axmus4xy31d372sQ5J5_E,25806
+ul_api_utils/modules/api_sdk.py,sha256=XINEiQ_-f4E1xtlBSQz06plaKnOPCHEYBAW81_EROiM,26306
 ul_api_utils/modules/api_sdk_config.py,sha256=_yxctcD5TyTblMuLjBDna61ANGH49C8v-lnUUH939pE,2480
 ul_api_utils/modules/api_sdk_jwt.py,sha256=2XRfb0LxHUnldSL67S60v1uyoDpVPNaq4zofUtkeg88,15112
 ul_api_utils/modules/intermediate_state.py,sha256=7ZZ3Sypbb8LaSfrVhaXaWRDnj8oyy26NUbmFK7vr-y4,1270
@@ -72,7 +78,6 @@ ul_api_utils/resources/debugger_scripts.py,sha256=qqf6zeJ1aE_STNYX1j9-ZfBgB_jcQo
 ul_api_utils/resources/not_implemented.py,sha256=OQE5LGA4KqZDwP5Wtub3Aw-icwzbqCSKcEFoFp4w7_k,973
 ul_api_utils/resources/permissions.py,sha256=8c8cEPkm69zxgXbDiwUkW6Mi_496-MZXbPOxHITetKs,1436
 ul_api_utils/resources/rate_limitter.py,sha256=QMpaLu1LoFbvtIEhxF8HbAZIAW4oGKTClt7XEUsqx98,3358
-ul_api_utils/resources/sockets.py,sha256=gftL6QR762GetSrm8Yjh9kfoMAwH64ijqOBexXBz0BY,76
 ul_api_utils/resources/swagger.py,sha256=fK8S9X4YCSqe_weCzV_BcMPoL_NR073BsGUzn2ImbHI,5391
 ul_api_utils/resources/health_check/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/resources/health_check/const.py,sha256=QzVZP_ZKmVKleUACiOGjzP-v54FD7tEN6NEF4Jb50Ow,78
@@ -135,9 +140,9 @@ ul_api_utils/validators/validate_empty_object.py,sha256=3Ck_iwyJE_M5e7l6s1i88aqb
 ul_api_utils/validators/validate_uuid.py,sha256=EfvlRirv2EW0Z6w3s8E8rUa9GaI8qXZkBWhnPs8NFrA,257
 ul_api_utils/validators/__tests__/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ul_api_utils/validators/__tests__/test_custom_fields.py,sha256=QLZ7DFta01Z7DOK9Z5Iq4uf_CmvDkVReis-GAl_QN48,1447
-ul_api_utils-7.9.5.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
-ul_api_utils-7.9.5.dist-info/METADATA,sha256=VhYmob9m6kll54j9kOu24GfDSIkrc3DZNQUZnouD0Cs,14671
-ul_api_utils-7.9.5.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-ul_api_utils-7.9.5.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
-ul_api_utils-7.9.5.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
-ul_api_utils-7.9.5.dist-info/RECORD,,
+ul_api_utils-7.9.6.dist-info/LICENSE,sha256=6Qo8OdcqI8aGrswJKJYhST-bYqxVQBQ3ujKdTSdq-80,1062
+ul_api_utils-7.9.6.dist-info/METADATA,sha256=8kshvCkfnMTP55YXHYow-_2UOPleFmFg6L79FMnVl8g,14671
+ul_api_utils-7.9.6.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+ul_api_utils-7.9.6.dist-info/entry_points.txt,sha256=8tL3ySHWTyJMuV1hx1fHfN8zumDVOCOm63w3StphkXg,53
+ul_api_utils-7.9.6.dist-info/top_level.txt,sha256=1XsW8iOSFaH4LOzDcnNyxHpHrbKU3fSn-aIAxe04jmw,21
+ul_api_utils-7.9.6.dist-info/RECORD,,

ul_api_utils/resources/sockets.py

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