Merge branch 'release/0.3.6'

Author: SystemLight

README.md

@@ -5,6 +5,7 @@
 [![codebeat badge](https://codebeat.co/badges/da82dbdb-eceb-4166-b9e9-2d290c5f608f)](https://codebeat.co/projects/github-com-systemlight-madtornado-master)
 [![Build Status](https://travis-ci.org/SystemLight/madtornado.svg?branch=master)](https://travis-ci.org/SystemLight/madtornado)
 [![Documentation Status](https://readthedocs.org/projects/madtornado/badge/?version=stable)](https://madtornado.readthedocs.io/zh/latest/?badge=latest)
+[![Gitter](https://badges.gitter.im/systemlight-madtornado/community.svg)](https://gitter.im/systemlight-madtornado/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 Madtornado is a project templates for Tornado framework and quickly generate the Tornado project.  
 PyPI page: https://pypi.python.org/pypi/madtornado

README.zh.md

@@ -5,9 +5,11 @@
 [![codebeat badge](https://codebeat.co/badges/da82dbdb-eceb-4166-b9e9-2d290c5f608f)](https://codebeat.co/projects/github-com-systemlight-madtornado-master)
 [![Build Status](https://travis-ci.org/SystemLight/madtornado.svg?branch=master)](https://travis-ci.org/SystemLight/madtornado)
 [![Documentation Status](https://readthedocs.org/projects/madtornado/badge/?version=latest)](https://madtornado.readthedocs.io/zh/latest/?badge=latest)
+[![Gitter](https://badges.gitter.im/systemlight-madtornado/community.svg)](https://gitter.im/systemlight-madtornado/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 madtornado是一个tornado框架的快速构建工具   
-PyPI page: https://pypi.python.org/pypi/madtornado
+PyPI page: https://pypi.python.org/pypi/madtornado  
+[原生tornado文档参考](https://www.osgeo.cn/tornado/index.html)
 
 # 拥有的特性
 
@@ -21,9 +23,10 @@ PyPI page: https://pypi.python.org/pypi/madtornado
 - 拓展了tornado handler的方法，如果你想使用原生的tornado handler请继承RequestHandler，否则请继承handler.inheritHandler里面的Base
 - 开箱即用，通过在ancient下的view中编写模块，内置两个前台和后台模块，可以自行增加或删除，也可以通过（注意需要在madtornado根目录下运行）sea -np快速创建
 - 内置sea命令行工具，不仅能快速创建madtornado项目，还同时包含一些快捷操作和madtornado进行交互便于开发
+- 手机端测试查找地址，通过扫控制台打印的二维码快速定位，需要配置network_index指定打印的网卡，0代表不打印二维码
 
 # 未来计划添加特性
-- 优化手机端测试查找地址，通过扫控制台打印的二维码快速定位
+
 - 强化虚拟主机配置能力
 - 增强sql模块处理能力，采用链式查找方式，更加灵活
 - 增加注册路由描述功能，帮助生成网站地图时添加描述信息 
@@ -104,6 +107,8 @@ class IndexHandler(BaseHandler):
 
 ```
 sea --new_recp %madtornado_project%\ancient\view\reception.py
+或者使用下面的简化版，但是要在madtornado根目录下执行且reception是指定要添加路由的模块的名称
+sea -nr reception
 ```
 
 ## 目录说明
@@ -124,22 +129,22 @@ sea --new_recp %madtornado_project%\ancient\view\reception.py
     server.py   程序主入口，通过运行该文件来启动madtornado提供web服务吧
 ```
 
-#### ancient
+#### ancient下包说明
 
 ```
-custom
+custom 自定义模板引擎方法的模块存放位置
 
-handlers
+handlers  路由核心模块，view中的路由一般会继承该包下inheritHandler中的Base类，且你可以在这里更换Base变量指向来让全局的路由更换基类
 
-model
+model  存放模型的位置
 
-module
+module  存放模块的位置，包含拓展的sql，file等操作模块
 
-rig
+rig  存放一些额外工具的地方，其中register是路由注册模块，通过引入该模块，让路由可以被注册到路由表中
 
-user
+user  使用者独立的空间，你可以根据喜好放置任何内容
 
-view
+view  核心工作区域，你可以把所有路由写入一个模块中也可以把不同路由按照模块进行区分，内置三个模块示例均可删除，其中upload.py是大文件分块上传示例，可以直接把注册代码的注释取消掉即可使用
 ```
 
 # 通过配置文件配置madtornado

madtornado/ancient/custom/uiMethod.py

@@ -2,6 +2,10 @@ def hello_method(self):
     return 'hello uiMethod'
 
 
+def hello_func(self, content):
+    return "<div>{}</h1>".format(content)
+
+
 def static_url(self, path):
     """
 

madtornado/ancient/module/__init__.py

@@ -0,0 +1,15 @@
+from .asyncMysql import Component as AsyncMysql
+from .syncFile import Component as SyncFile
+from .syncJwt import Component as SyncJwt
+from .syncMemcached import Component as SyncMemcached
+from .syncMysql import Component as SyncMysql
+from .syncSqlite import Component as SyncSqlite
+
+__all__ = [
+    AsyncMysql,
+    SyncFile,
+    SyncJwt,
+    SyncMemcached,
+    SyncMysql,
+    SyncSqlite,
+]

madtornado/ancient/module/asyncMysql.py

@@ -8,7 +8,7 @@
 SQL_CONTENT = TypeVar("SQL_CONTENT", int, float, str, bool)
 
 option = parser.options("db")
-print("[asyncMysql] is imported.\n")
+print("[asyncMysql] is imported.")
 
 
 class Component:
@@ -49,6 +49,13 @@ def __init__(self):
         self.is_return_dict = False
         self.switch = False
 
+    async def __aenter__(self):
+        await self.on()
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self.off()
+
     def set_return_dict(self, is_return_dict: bool = True) -> None:
         """
 
@@ -70,9 +77,13 @@ async def on(self) -> None:
 
             db=Component()
             db.on()
-            db.select_tw("table")
+            result = await db.select_tw("table")
             db.off()
 
+            # 与上述使用方法一致
+            async with Component() as com:
+                result = await com.select_tcw("table")
+
         快捷使用方法::
 
             with Component() as db:

madtornado/ancient/module/syncFile.py

@@ -4,7 +4,7 @@
 import shutil
 import uuid
 import hashlib
-from typing import Iterable, Tuple, Optional
+from typing import Iterable, Tuple, Optional, Union
 
 option = parser.options("file")
 print("[syncFile] is imported.\n")
@@ -25,10 +25,11 @@ class Component:
     """
 
     def __init__(self, path="", top_path=None):
-        if top_path:
-            self.root_path = self.ajoin(top_path, path)
-        else:
-            self.root_path = self.ajoin(option["path"], path)
+        if not top_path:
+            top_path = option["path"]
+
+        self.root_path = self.ajoin(top_path, path)
+        self.rel_root_path = self.join(top_path, path)
 
         self.write_chunk = self.read_chunk = 65536
         self.write_fp = self.read_fp = None
@@ -59,7 +60,18 @@ def join(*args) -> str:
         return os.path.normpath(os.path.join(*args))
 
     @staticmethod
-    def ensure_dir(path: str) -> bool:
+    def touch(path: str) -> None:
+        """
+
+        快速创建一个空文件
+
+        :param path: 文件路径
+        :return: None
+
+        """
+        open(path, "wb").close()
+
+    def ensure_dir(self, path: Union[str] = None) -> bool:
         """
 
         确保文件夹存在，不存在则创建它
@@ -68,24 +80,15 @@ def ensure_dir(path: str) -> bool:
         :return: 返回判断之前是否存在该文件
 
         """
+        if path is None:
+            path = self.root_path
+
         if os.path.exists(path):
             return True
         else:
             os.makedirs(path)
             return False
 
-    @staticmethod
-    def touch(path: str) -> None:
-        """
-
-        快速创建一个空文件
-
-        :param path: 文件路径
-        :return: None
-
-        """
-        open(path, "wb").close()
-
     def get_safe_path(self, *args) -> str:
         """
 
@@ -246,7 +249,7 @@ def receive_file(self, files, arg_name="image", is_only=True, file_name=None) ->
         :param arg_name: 参数名称
         :param is_only: 是否生成唯一ID文件名
         :param file_name: 当is_only=False时，提供的自定义文件名称，如果不提供则来自上传的文件名，拓展名以上传文件为准无需附加
-        :return: (文件名称[不携带拓展名]，文件保存本地地址，文件拓展名)
+        :return: (文件名称[不携带拓展名]，文件拓展名，文件相对服务器保存路径)
 
         """
         file_list = files.get(arg_name, None)
@@ -273,4 +276,56 @@ def receive_file(self, files, arg_name="image", is_only=True, file_name=None) ->
         save_path = self.get_safe_path(name + source_ext)
         self.write(save_path, source_file.body)
 
-        return name, source_ext, save_path
+        return name, source_ext, self.join(self.rel_root_path, name + source_ext)
+
+    @staticmethod
+    def rollback_receive_file(path: str) -> None:
+        """
+
+        有时接收文件后将接收的文件名传入到数据库中，如果这时数据库错误需要回退操作，那么你可以使用该方法删除接收的文件，实现回退
+
+        :param path: 文件路径
+        :return: None
+
+        """
+        try:
+            os.remove(path)
+        except FileNotFoundError:
+            pass
+
+
+def insert2fp(file_path, offset, content, per_size=2048):
+    """
+
+    允许你在文件指定位置进行内容插入
+
+    :param file_path: 文件路径
+    :param offset: 文件偏移位置
+    :param content: 插入的内容
+    :param per_size: 每片读取大小限制
+    :return: None
+
+    """
+    copies = offset // per_size
+
+    f_dir, f_name = os.path.split(file_path)
+    temp_path = os.path.join(f_dir, f_name + ".temp")
+
+    with open(temp_path, "w") as w_fp:
+        with open(file_path, "r") as fp:
+            fp.seek(0)
+
+            for c in range(1, copies + 1 + int(offset % per_size > 0)):
+                if c * per_size >= offset:
+                    result = fp.read(offset - fp.tell())
+                else:
+                    result = fp.read(per_size)
+                w_fp.write(result)
+
+            w_fp.write(content)
+
+            for c in fp:
+                w_fp.write(c)
+
+    os.remove(file_path)
+    os.rename(temp_path, file_path)

madtornado/ancient/module/syncJwt.py

@@ -6,7 +6,7 @@
 from typing import Optional, Dict
 
 option = parser.options("token")
-print("[syncJwt] is imported.\n")
+print("[syncJwt] is imported.")
 
 
 class Component:
@@ -16,9 +16,6 @@ def __init__(self):
         self.secret = option["secret"]
         self.algorithm = option["algorithm"]
 
-    def __enter__(self):
-        return self
-
     def decode(self, payload: str or bytes) -> Dict:
         """
 

madtornado/ancient/module/syncMemcached.py

@@ -5,7 +5,7 @@
 import json
 
 option = parser.options("cache")
-print("[syncMemcached] is imported.\n")
+print("[syncMemcached] is imported.")
 
 
 class Component:

madtornado/ancient/module/syncMysql.py

@@ -8,7 +8,7 @@
 SQL_CONTENT = TypeVar("SQL_CONTENT", int, float, str, bool)
 
 option = parser.options("db")
-print("[syncMysql] is imported.\n")
+print("[syncMysql] is imported.")
 
 
 class Component:

madtornado/ancient/module/syncSqlite.py

@@ -8,7 +8,7 @@
 SQL_CONTENT = TypeVar("SQL_CONTENT", int, float, str, bool)
 
 option = parser.options("db")
-print("[syncSqlite] is imported.\n")
+print("[syncSqlite] is imported.")
 
 
 def dict_factory(cursor, row):