add server component and requirement.txt etc.

jcppython · jcppython · commit 08218fa2bff2 · 2022-05-02T22:48:06.000+08:00
diff --git a/demos/jserver.py b/demos/jserver.py
@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+File: jserver.py
+Author: jcppython(jcppython@outlook.com)
+Date: 2022/05/01 20:50:18
+"""
+
+import argparse
+
+import jserve.server
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description='the demo of jserve')
+    parser.add_argument('--conf', type=str, required=True)
+    parser.add_argument('--workdir', type=str, required=True)
+    args = parser.parse_args()
+
+    server = server.create(args.workdir, args.conf)
+    server.run()
+
+
diff --git a/jserve/configure.py b/jserve/configure.py
@@ -13,12 +13,22 @@
 
 options = None
 
-__fixed_sserver_conf = "conf/sserver.conf"
-__fixed_sserver_logname = "app"
+def init(workdir, conf):
+    r""" 初始化配置
+    """
+    global options
+
+    if options is not None:
+        raise Exception("you can't init configure twice")
+
+    with open(conf) as f:
+        options = json.load(f)
+
+    __buildin_option(workdir)
+
 
 def add_option(path, value):
-    """
-    添加指定配置
+    r""" 添加配置
 
     Args:
 
@@ -41,30 +51,13 @@ def add_option(path, value):
             p = p[key]
 
 
-def __buildin_option(workdir, category):
+def __buildin_option(workdir):
     """
     填充内置配置项
     """
     global options
 
-    options['app']['name'] = category
     add_option('env.workdir', workdir)
     options['log']['name'] = __fixed_sserver_logname
     options['log']['path'] = os.path.join(options['env']['workdir'], options['log']['path'])
     options['log']['level'] = getattr(logging, options['log']['level'].upper())
-
-
-def init(workdir, category):
-    """
-    创建配置
-    """
-    global options
-
-    if options is not None:
-        raise Exception("you can't init configure twice")
-
-    with open("{}/{}/{}".format(workdir, category, __fixed_sserver_conf)) as f:
-        options = json.load(f)
-
-    __buildin_option(workdir, category)
-
diff --git a/jserve/http/http.py b/jserve/http/http.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+File: http.py
+Author: jcppython(jcppython@outlook.com)
+Date: 2022/05/02 17:50:18
+"""
+
+from abc import abstractmethod
+
+class Http(object):
+    r""" http 服务
+    """
+
+    def __init__(self):
+        r""" 初始化服务
+        """
+        self._routes = ()
+
+    @abstractmethod
+    def add_route(self, route, handler):
+        r""" 添加请求处理路由
+        """
+        pass
+
+    @abstractmethod
+    def run(self):
+        r""" 运行服务
+        """
+        pass
+
diff --git a/jserve/http/tornado.py b/jserve/http/tornado.py
@@ -1,4 +1,4 @@
-# !/usr/bin/env python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 """
@@ -7,32 +7,38 @@
 Date: 2022/05/02 01:50:18
 """
 
-import os
-import logging
-import asyncio
-import socketio
-import tornado
-import tornado.web
-import tornado.options
-import tornado.platform.asyncio
-
 import log
-import configure
-import ssocketio
+import http
 
-class Server(object):
-    r""" App 服务
+class Tornado(http.Http):
+    r""" 基于 tornado 的 http 服务
     """
 
-    @classmethod
-    def run(cls, port, routes):
+    def __init__(self):
+        r"""
+        """
+        self.__enable_log()
+        self._routes = ()
+
+    def add_route(self, route, handler):
+        r""" 添加请求处理路由
+        """
+        self._routes.append((route, handler))
+
+    def run(self):
         r""" 需要捕获异常
         """
+
         tornado.platform.asyncio.AsyncIOMainLoop().install()
 
-        cls.__enable_log()
-        app = cls.__create_app(routes)
-        app.listen(port)
+        self._app = tornado.web.Application(
+            self._routes,
+            settings = dict(
+                debug=True,
+                autoescape=None
+            )
+        )
+        self._app.listen(port)
 
         loop = asyncio.get_event_loop()
         try:
@@ -45,11 +51,10 @@ def run(cls, port, routes):
         finally:
             loop.close()
 
-    @classmethod
-    def __enable_log(cls):
-        """
-        启用日志
+    def __enable_log(self):
+        r""" 设置日志
         """
+
         config = [
             {
                 'logger': tornado.log.access_log,
@@ -70,19 +75,3 @@ def __enable_log(cls):
             d['logger'].addHandler(h)
             d['logger'].setLevel(configure.options['log']['level'])
 
-    @classmethod
-    def __create_app(cls, routes):
-        ssocketio.init(True, async_mode='tornado', cors_allowed_origins="*")
-        ssocketio.load_event("./event/")
-
-        routes.append(
-            (r"/socket.io/.*/", socketio.get_tornado_handler(ssocketio.sio))
-        )
-
-        return tornado.web.Application(
-            routes,
-            settings = dict(
-                debug=True,
-                autoescape=None
-            )
-        )
diff --git a/jserve/server.py b/jserve/server.py
@@ -0,0 +1,63 @@
+# !/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""
+File: jserve.py
+Author: jcppython(jcppython@outlook.com)
+Date: 2022/05/02 01:50:18
+"""
+
+import os
+import logging
+import asyncio
+import socketio
+
+import log
+import configure
+import sio
+import logging
+import traceback
+
+import http
+
+def create(workdir, conf):
+    r""" 创建 server 服务
+    """
+
+    configure.init(workdir, conf)
+
+    logger = logging.getLogger()
+    logger.setLevel(configure.options['log']['level'])
+    log.logDecorateStandard(logger, configure.options['log']['path'], configure.options['log']['name'])
+
+    return Server()
+
+
+class Server(object):
+    r""" jserve 服务接口
+    """
+
+    def __init__(self):
+        r""" 创建一个 server
+
+        Args:
+
+        workdir: string 服务运行目录，决定 log 等产出位置
+        conf: 服务配置文件
+        """
+
+        self._http_server = http.Http(conf['http'])
+
+        if 'sio' in kwargs:
+            self._http_server.add_route(
+                (r"/socket.io/.*/", sio.http_handler())
+            )
+
+    def run(self):
+        try:
+            self._http_server.run()
+        except Exception as e:
+            logger.error("{}\n{}".format("app exit by some fatal error", traceback.format_exc()))
+        finally:
+            logger.warning("app exit")
+
diff --git a/jserve/sio/jsocketio.py b/jserve/sio/jsocketio.py
@@ -1,4 +1,4 @@
-# !/usr/bin/env python3
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 """
@@ -31,6 +31,9 @@ def init(is_async=True, **kwargs):
 
     sio = __create_async_server(**kwargs) if is_async else __create_sync_server(**kwargs)
 
+    ssocketio.init(True, async_mode='tornado', cors_allowed_origins="*")
+    ssocketio.load_event("./event/")
+
 
 def load_event(path):
     r""" 遍历 path 目录 .py 模块，完成 @sio 事件的加载
@@ -54,10 +57,17 @@ def help_load(file):
             state, mod_name, path, file
         ))
 
+def http_handler(**kwargs):
+    """
+    """
+    sio.http_handler()
+    return socketio.get_tornado_handler(ssocketio.sio)
+
 
 def __config_server(kwargs, is_async=True):
     r""" 完成 server 创建的配置构建
 
+    https://python-socketio.readthedocs.io/en/latest/api.html#server-class
     https://python-socketio.readthedocs.io/en/latest/server.html#emitting-from-external-processes
     connect to the redis queue as an external process
     external_sio = socketio.RedisManager('redis://', write_only=True)
diff --git a/requirements-test.txt b/requirements-test.txt
@@ -0,0 +1 @@
+tox
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,2 @@
-socketio
+socketio
+tornado
diff --git a/setup.py b/setup.py
@@ -15,6 +15,7 @@ def read(*parts):
     # intentionally *not* adding an encoding option to open
     return codecs.open(os.path.join(here, *parts), 'r').read()
 
+
 def find_version(*file_paths):
     version_file = read(*file_paths)
     version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
@@ -23,6 +24,17 @@ def find_version(*file_paths):
         return version_match.group(1)
     raise RuntimeError("Unable to find version string.")
 
+
+def parse_requirements(filename):
+    """
+    读取 requirements.txt
+    """
+    with open(os.path.join(here, filename), 'r', encoding='utf-8') as file_:
+        lines = map(lambda x: x.strip('\n'), file_.readlines())
+    lines = filter(lambda x: x and not x.startswith('#') and not x.startswith('-'), lines)
+    return list(lines)
+
+
 class Tox(TestCommand):
     def finalize_options(self):
         TestCommand.finalize_options(self)
@@ -35,10 +47,12 @@ def run_tests(self):
         errcode = tox.cmdline(self.test_args)
         sys.exit(errcode)
 
+
 # Get the long description from the README file
-with open(os.path.join(here, "README.md")) as in_file:
+with open(os.path.join(here, "README.md"), 'r') as in_file:
     long_description = in_file.read()
 
+
 setup(
     name="jserve",
     version=find_version('jserve', '__init__.py'),
@@ -50,7 +64,10 @@ def run_tests(self):
     url="https://github.com/jcppython/jserve-python",
     packages=["jserve"],
     python_requires=">=3.6",
-    tests_require=['tox'],
+    install_requires=parse_requirements('requirements.txt'),
+    tests_require=(
+        parse_requirements('requirements.txt') +
+        parse_requirements('requirements-test.txt')),
     cmdclass = {'test': Tox},
     classifiers=[
         "Development Status :: 3 - Alpha",
