ul-api-utils 7.8.4__tar.gz → 7.8.6__tar.gz

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/PKG-INFO

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

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/example/conf.py

@@ -3,10 +3,14 @@ import os
 from ul_db_utils.modules.db import DbConfig
 
 from ul_api_utils.modules.api_sdk import ApiSdk
-from ul_api_utils.modules.api_sdk_config import ApiSdkConfig, ApiSdkIdentifyTypeEnum, ApiSdkFlaskDebuggingPluginsEnabled
+from ul_api_utils.modules.api_sdk_config import ApiSdkConfig, ApiSdkIdentifyTypeEnum, \
+    ApiSdkFlaskDebuggingPluginsEnabled, SocketIOConfig
 from example.permissions import permissions
 
 sdk = ApiSdk(ApiSdkConfig(
+    sockets_config=SocketIOConfig(
+        message_queue='redis://localhost:16379',
+    ),
     service_name='example_service',
     permissions=permissions,
     cache_storage_uri='redis://localhost:16379',

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/example/routes/api_some.py

@@ -1,12 +1,16 @@
+import logging
 from time import sleep
 from datetime import datetime, timedelta
-from typing import List, Optional, Tuple
+from typing import List, Optional, Tuple, Any
 
+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.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
@@ -51,6 +55,9 @@ class Some2Query(ApiRequestQuery):
     some: QueryParamsSeparatedList[str] = ''        # type: ignore
 
 
+logger = logging.getLogger(__name__)
+
+
 @sdk.rest_api('POST', '/example-resource-simple', access=sdk.ACCESS_PUBLIC)
 @sdk.cache_api('REFRESH', 'example')
 def some5(api_resource: ApiResource, body: SomeBody) -> JsonApiResponse[List[RespObject]]:
@@ -314,3 +321,21 @@ 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.8.4 → ul-api-utils-7.8.6}/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.8.4',
+    version='7.8.6',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/ul_api_utils/commands/cmd_start.py

@@ -25,6 +25,7 @@ class CmdStart(Cmd):
     debug: bool
     max_requests: int
     max_requests_jitter: int
+    worker_class: str
 
     @property
     def app_rel_dir(self) -> str:
@@ -49,6 +50,7 @@ class CmdStart(Cmd):
         parser.add_argument('--debug', dest='debug', type=arg_str2bool, default=False, required=False)
         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)
 
     def run(self) -> None:
         env = os.environ.copy()
@@ -69,6 +71,7 @@ class CmdStart(Cmd):
         args = [
             f'-n={name}',
             f'-w={APPLICATION_GUNICORN_WORKERS}',
+            f'--worker-class={self.worker_class}',
             f'-b=0.0.0.0:{self.port}',
             f'--config={conf}',
             '--log-level=INFO',

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/ul_api_utils/modules/api_sdk.py

@@ -8,13 +8,12 @@ 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
 from ul_py_tool.utils.arg_files_glob import arg_files_print
 from werkzeug import Response as BaseResponse
-
 from ul_api_utils.access import PermissionDefinition, GLOBAL_PERMISSION__PRIVATE, GLOBAL_PERMISSION__PRIVATE_RT, \
     GLOBAL_PERMISSION__PUBLIC, PermissionRegistry
 from ul_api_utils.api_resource.api_resource import ApiResource
@@ -28,7 +27,7 @@ from ul_api_utils.debug import stat
 from ul_api_utils.debug.debugger import Debugger
 from ul_api_utils.errors import UserAbstractApiError, ResourceRuntimeApiError, ResponseTypeRuntimeApiError
 from ul_api_utils.internal_api.internal_api_check_context import internal_api_check_context
-from ul_api_utils.modules.api_sdk_config import ApiSdkConfig
+from ul_api_utils.modules.api_sdk_config import ApiSdkConfig, SocketAsyncModesEnum
 from ul_api_utils.modules.intermediate_state import try_init, try_configure
 from ul_api_utils.resources.caching import ULCache, TCacheMode, ULCacheMode, ULCacheConfig
 from ul_api_utils.resources.debugger_scripts import load_debugger_static_scripts
@@ -200,6 +199,15 @@ 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

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/ul_api_utils/modules/api_sdk_config.py

@@ -11,6 +11,13 @@ def join_route_paths(prev_sect: str, next_sect: str) -> str:
     return prev_sect.rstrip('/') + '/' + next_sect.lstrip('/')
 
 
+class SocketAsyncModesEnum(Enum):
+    THREADING = 'threading'
+    GEVENT = 'gevent'
+    EVENTLET = 'eventlet'
+    GEVENT_UWSGI = 'gevent_uwsgi'
+
+
 class ApiSdkIdentifyTypeEnum(Enum):
     DISABLED = 'DISABLED'
     CLIENT_IP = 'IP'
@@ -29,6 +36,12 @@ class ApiSdkFlaskDebuggingPluginsEnabled(BaseModel):
     flask_monitoring_dashboard: bool = False
 
 
+class SocketIOConfig(BaseModel):
+    message_queue: str
+    channel: Optional[str] = "flask-socketio"
+    cors_allowed_origins: Optional[str] = "*"
+
+
 class ApiSdkConfig(BaseModel):
     service_name: str
     permissions: Optional[Union[Callable[[], PermissionRegistry], PermissionRegistry]] = None
@@ -41,7 +54,7 @@ class ApiSdkConfig(BaseModel):
     http_auth: Optional[ApiSdkHttpAuth] = None
 
     static_url_path: Optional[str] = None
-
+    sockets_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]

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

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

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/ul_api_utils.egg-info/PKG-INFO

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

{ul-api-utils-7.8.4 → ul-api-utils-7.8.6}/ul_api_utils.egg-info/SOURCES.txt

@@ -81,6 +81,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/swagger.py
 ul_api_utils/resources/health_check/__init__.py
 ul_api_utils/resources/health_check/const.py