ancient.wood --- 预设视图模块

freedom

class ancient.wood.freedom.FreedomHandler(application, request, **kwargs)[源代码]

基类:ancient.handlers.inheritHandler.AbstractBaseHandler

delete(path)[源代码]

删除一个json文件

调用地址:

http://127.0.0.1:8095/freedom/*path.json

delete: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar.json http://127.0.0.1:8095/freedom/foo/bar.json
参数:path -- 查找路径
返回:None
get(path)[源代码]

返回指定路径下json文件内容,接受auto_create参数,是否当 文件不存在时自动创建相应json文件并返回

调用地址:

http://127.0.0.1:8095/freedom/*path.json

get: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar.json http://127.0.0.1:8095/freedom/foo/bar.json

可选参数:auto_create(当文件不存在时,是否自动创建空文件并返回)
参数:path -- 查找路径
返回:None
post(path)[源代码]

增加一个JSON文件,数据传入body并且以json格式传入

调用地址:

http://127.0.0.1:8095/freedom/*path.json

post: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar.json http://127.0.0.1:8095/freedom/foo/bar.json
参数:path -- 查找路径
返回:None
put(path)[源代码]

更新一个json文件

调用地址:

http://127.0.0.1:8095/freedom/*path.json

put: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar.json http://127.0.0.1:8095/freedom/foo/bar.json

body: 用JSON格式派发数据
参数:path -- 查找路径
返回:None
class ancient.wood.freedom.FreedomPathHandler(application, request, **kwargs)[源代码]

基类:ancient.handlers.inheritHandler.AbstractBaseHandler

delete(path)[源代码]

删除一个路径及其路径下的所有内容,危险操作

调用地址:

http://127.0.0.1:8095/freedom/*path

delete: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar http://127.0.0.1:8095/freedom/foo/bar
参数:path -- 查找路径
返回:None
get(path)[源代码]

获取路径下所有JSON文件列表

调用地址:

http://127.0.0.1:8095/freedom/*path

get: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar http://127.0.0.1:8095/freedom/foo/bar

可选参数:need_data(是否需要数据一起返回,*代表所有文件需要数据,如果只想取指定文件用逗号分隔)
参数:path -- 查找路径
返回:None
post(path)[源代码]

新增一个路径,递归添加

调用地址:

http://127.0.0.1:8095/freedom/*path

post: *path代表具体路径与本地磁盘空间进行映射如foo路径下的bar http://127.0.0.1:8095/freedom/foo/bar
参数:path -- 查找路径
返回:None
put(path)[源代码]

无内容

参数:path --
返回:
ancient.wood.freedom.create_json(path)[源代码]

创建JSON文件,如果路径不存在会递归创建路径

参数:path -- json文件创建路径
返回:json文件创建路径
ancient.wood.freedom.get_safe_path(self: ancient.handlers.inheritHandler.AbstractBaseHandler, *path)[源代码]

获取相对freedom的偏移路径,会判断请求路径是否安全,不会在 之外的路径产生返回

参数:
  • self -- AbstractBaseHandler
  • path -- 路径
返回:

正确的路径,否则触发400错误

upload

class ancient.wood.upload.ExistFileHandler(application, request, **kwargs)[源代码]

基类:ancient.handlers.baseHandler.BaseHandler

获取md5文件是否存在

文件分块上传接口:

http://127.0.0.1:8095/file/exist

get:访问

需要参数:md5,suffix

suffix标识后缀名,如png mp4 jpg等
get()[源代码]
class ancient.wood.upload.MergeFileHandler(application, request, **kwargs)[源代码]

基类:ancient.handlers.baseHandler.BaseHandler

文件分块上传合并文件接口:

http://127.0.0.1:8095/file/merge

post:访问

需要参数:md5,suffix

suffix标识后缀名,如png mp4 jpg等
post()[源代码]
class ancient.wood.upload.UploadFileHandler(application, request, **kwargs)[源代码]

基类:ancient.handlers.baseHandler.BaseHandler

该模块为内置路由解决方案,提供文件分块上传参考 如果需要可以取消掉路由注释,该路由模块将会自动注入到网站地图中

文件分块上传接口:

http://127.0.0.1:8095/file/upload

post:访问

需要参数:md5,file,block
post()[源代码]

文件上传接口方法实现,参数处理比较复杂,新版本可以更加简洁, 但是为了不破坏其它内容,并未修改逻辑

webhook

class ancient.wood.webhook.GogsWebHookHandler(application, request, **kwargs)[源代码]

基类:ancient.handlers.baseHandler.BaseHandler

允许你通过配置文件注册webhook以运行指定脚本程序,该指定脚本程序一般用于自动部署其它应用程序

访问地址:

/webhook/gogs/:name(注册到配置文件的名称)

配置举例:

[tornado-webhook]
gogs=gogs webhook 配置文件路径

{
  "注册name名称": {
    "shell": "C:\netcoreapps\update.bat", //执行脚本
    "analysis_execution": true, // 是否解析,当注册为windows服务时必须解析执行
    "app_port": 5000,  // 应用程序端口,用于自动部署该程序时自动重启该程序,可不填写,将不会重启应用
    "branch": [  // 当指定分支被推送时进行自动部署
      "master"
    ]
  }
}
get(name)[源代码]
ancient.wood.webhook.exec_hook(name_conf)[源代码]