diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-15 05:49:24 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-15 05:49:24 +0000 |
| commit | 8a75ebe7989ebf67b66d00862223d7ba07427774 (patch) | |
| tree | ec376705d73817cc9da59c31b2e3dd62c3300454 | |
| parent | f95c011aaab0ee7540ca4a8a159618e7c7696b9e (diff) | |
automatic import of python-restfx
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-restfx.spec | 457 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 459 insertions, 0 deletions
@@ -0,0 +1 @@ +/restfx-0.31.4.tar.gz diff --git a/python-restfx.spec b/python-restfx.spec new file mode 100644 index 0000000..00fb365 --- /dev/null +++ b/python-restfx.spec @@ -0,0 +1,457 @@ +%global _empty_manifest_terminate_build 0 +Name: python-restfx +Version: 0.31.4 +Release: 1 +Summary: A RESTful framework for Python3. +License: MIT License +URL: https://gitee.com/wangankeji/restfx +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/7a/57/daaadba087dc70c16b25a3280c646b1ff7698c1eaa911e655c29fee7a10b/restfx-0.31.4.tar.gz +BuildArch: noarch + +Requires: python3-Werkzeug + +%description +# restfx + +Python3 的 RESTful 服务框架。 + +> 底层基于 [werkzeug](https://werkzeug.palletsprojects.com/) + +## 为什么要使用此框架 + +开发此框架的目标是 **提升开发效率**。 + +此框架解决了以下问题: + +- 没有繁锁的路由配置,免去路由注册。仅仅需要对模块根进行注册,模块下的所有路由都会自动被收集调用 +- 不需要对路由 url 进行显示配置,完全自动解析 +- 自动解析/校验请求参数,并填充到路由函数,省去繁锁的参数获取/类型校验。需要做的仅仅是编写一个函数,并添加函数参数的类型声明 +- 提供 **接口列表页面** 以及接口测试支持,让接口随码更新,不用手动维护API文档。 见[截图](#截图) +- 提供 [路由注入][2] 支持,以通过参数方式向路由指定请求参数外的数据/函数,从而避免一些频繁的 `import` 和重复代码 + +**此框架的弊端: 不支持将参数作为 url 路径的一部分** + +## 安装 + +```shell script +pip install restfx +``` + +`Since 0.7.1` 安装后,可以通过 CLI 工具 `restfx` 命令创建基本项目结构: + +```shell script +restfx create projectname +``` + +> 使用此命令,可能需要将 `restfx` 安装到全局环境中。 + +## 文档 + +使用文档见 [Gitee Wiki][1] + +## 创建应用 + +```python +import os + +import restfx + +if __name__ == '__main__': + root = os.path.dirname(__file__) + app = restfx.App(root, api_prefix='any/prefix', debug=True) + app.map_routes({ + 'x': 'test' + }) + app.map_static(static_map={}) + app.startup(host='127.0.0.1', port=9127) +``` + +### 编写路由 + +*test/api/demo.py* + +```python +from restfx import route +from restfx.http import HttpRequest, HttpFile + + +@route(module='测试名称-模块', name='测试名称-GET') +def get(request, param1, param2=None, param3: int = 5): + # request 会是 HttpRequest + return { + 'param1': param1, + 'param2': param2, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-POST_PARAM') +def get_param(param1, req: HttpRequest, from_=None, param3=5): + # req 会是 HttpRequest + return { + 'param1': param1, + 'from': from_, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-PUT_PARAM') +def put(request: str, param1, file: HttpFile, param3=5): + # request 会是请求参数,参数列表中没有 HttpRequest + return { + 'request': request, + 'param1': param1, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-DELETE_PARAM') +def delete(request, param1, from_=None, param3=5, **kwargs): + # 未在函数的参数列表中声明的请求参数,会出现在 kwargs 中 + return { + 'param1': param1, + 'from': from_, + 'param3': param3, + 'variable_args': kwargs + } + +``` + +## 截图 + +以下截图为接口列表,对应的路由声明源码见 + +- [test/test/api/__init__.py][11] +- [test/test/api/demo.py][12] + + +以下截图仅在 [Gitee仓库目录][3] 可见 + + + + + + +[1]: https://gitee.com/wangankeji/restfx/wikis +[2]: https://gitee.com/wangankeji/restfx/wikis/0B.%20%E8%B7%AF%E7%94%B1%E6%B3%A8%E5%85%A5?sort_id=3519061 +[3]: https://gitee.com/wangankeji/restfx#%E6%88%AA%E5%9B%BE +[11]: https://gitee.com/wangankeji/restfx/blob/master/test/test/api/__init__.py +[12]: https://gitee.com/wangankeji/restfx/blob/master/test/test/api/demo.py + + + + +%package -n python3-restfx +Summary: A RESTful framework for Python3. +Provides: python-restfx +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-restfx +# restfx + +Python3 的 RESTful 服务框架。 + +> 底层基于 [werkzeug](https://werkzeug.palletsprojects.com/) + +## 为什么要使用此框架 + +开发此框架的目标是 **提升开发效率**。 + +此框架解决了以下问题: + +- 没有繁锁的路由配置,免去路由注册。仅仅需要对模块根进行注册,模块下的所有路由都会自动被收集调用 +- 不需要对路由 url 进行显示配置,完全自动解析 +- 自动解析/校验请求参数,并填充到路由函数,省去繁锁的参数获取/类型校验。需要做的仅仅是编写一个函数,并添加函数参数的类型声明 +- 提供 **接口列表页面** 以及接口测试支持,让接口随码更新,不用手动维护API文档。 见[截图](#截图) +- 提供 [路由注入][2] 支持,以通过参数方式向路由指定请求参数外的数据/函数,从而避免一些频繁的 `import` 和重复代码 + +**此框架的弊端: 不支持将参数作为 url 路径的一部分** + +## 安装 + +```shell script +pip install restfx +``` + +`Since 0.7.1` 安装后,可以通过 CLI 工具 `restfx` 命令创建基本项目结构: + +```shell script +restfx create projectname +``` + +> 使用此命令,可能需要将 `restfx` 安装到全局环境中。 + +## 文档 + +使用文档见 [Gitee Wiki][1] + +## 创建应用 + +```python +import os + +import restfx + +if __name__ == '__main__': + root = os.path.dirname(__file__) + app = restfx.App(root, api_prefix='any/prefix', debug=True) + app.map_routes({ + 'x': 'test' + }) + app.map_static(static_map={}) + app.startup(host='127.0.0.1', port=9127) +``` + +### 编写路由 + +*test/api/demo.py* + +```python +from restfx import route +from restfx.http import HttpRequest, HttpFile + + +@route(module='测试名称-模块', name='测试名称-GET') +def get(request, param1, param2=None, param3: int = 5): + # request 会是 HttpRequest + return { + 'param1': param1, + 'param2': param2, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-POST_PARAM') +def get_param(param1, req: HttpRequest, from_=None, param3=5): + # req 会是 HttpRequest + return { + 'param1': param1, + 'from': from_, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-PUT_PARAM') +def put(request: str, param1, file: HttpFile, param3=5): + # request 会是请求参数,参数列表中没有 HttpRequest + return { + 'request': request, + 'param1': param1, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-DELETE_PARAM') +def delete(request, param1, from_=None, param3=5, **kwargs): + # 未在函数的参数列表中声明的请求参数,会出现在 kwargs 中 + return { + 'param1': param1, + 'from': from_, + 'param3': param3, + 'variable_args': kwargs + } + +``` + +## 截图 + +以下截图为接口列表,对应的路由声明源码见 + +- [test/test/api/__init__.py][11] +- [test/test/api/demo.py][12] + + +以下截图仅在 [Gitee仓库目录][3] 可见 + + + + + + +[1]: https://gitee.com/wangankeji/restfx/wikis +[2]: https://gitee.com/wangankeji/restfx/wikis/0B.%20%E8%B7%AF%E7%94%B1%E6%B3%A8%E5%85%A5?sort_id=3519061 +[3]: https://gitee.com/wangankeji/restfx#%E6%88%AA%E5%9B%BE +[11]: https://gitee.com/wangankeji/restfx/blob/master/test/test/api/__init__.py +[12]: https://gitee.com/wangankeji/restfx/blob/master/test/test/api/demo.py + + + + +%package help +Summary: Development documents and examples for restfx +Provides: python3-restfx-doc +%description help +# restfx + +Python3 的 RESTful 服务框架。 + +> 底层基于 [werkzeug](https://werkzeug.palletsprojects.com/) + +## 为什么要使用此框架 + +开发此框架的目标是 **提升开发效率**。 + +此框架解决了以下问题: + +- 没有繁锁的路由配置,免去路由注册。仅仅需要对模块根进行注册,模块下的所有路由都会自动被收集调用 +- 不需要对路由 url 进行显示配置,完全自动解析 +- 自动解析/校验请求参数,并填充到路由函数,省去繁锁的参数获取/类型校验。需要做的仅仅是编写一个函数,并添加函数参数的类型声明 +- 提供 **接口列表页面** 以及接口测试支持,让接口随码更新,不用手动维护API文档。 见[截图](#截图) +- 提供 [路由注入][2] 支持,以通过参数方式向路由指定请求参数外的数据/函数,从而避免一些频繁的 `import` 和重复代码 + +**此框架的弊端: 不支持将参数作为 url 路径的一部分** + +## 安装 + +```shell script +pip install restfx +``` + +`Since 0.7.1` 安装后,可以通过 CLI 工具 `restfx` 命令创建基本项目结构: + +```shell script +restfx create projectname +``` + +> 使用此命令,可能需要将 `restfx` 安装到全局环境中。 + +## 文档 + +使用文档见 [Gitee Wiki][1] + +## 创建应用 + +```python +import os + +import restfx + +if __name__ == '__main__': + root = os.path.dirname(__file__) + app = restfx.App(root, api_prefix='any/prefix', debug=True) + app.map_routes({ + 'x': 'test' + }) + app.map_static(static_map={}) + app.startup(host='127.0.0.1', port=9127) +``` + +### 编写路由 + +*test/api/demo.py* + +```python +from restfx import route +from restfx.http import HttpRequest, HttpFile + + +@route(module='测试名称-模块', name='测试名称-GET') +def get(request, param1, param2=None, param3: int = 5): + # request 会是 HttpRequest + return { + 'param1': param1, + 'param2': param2, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-POST_PARAM') +def get_param(param1, req: HttpRequest, from_=None, param3=5): + # req 会是 HttpRequest + return { + 'param1': param1, + 'from': from_, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-PUT_PARAM') +def put(request: str, param1, file: HttpFile, param3=5): + # request 会是请求参数,参数列表中没有 HttpRequest + return { + 'request': request, + 'param1': param1, + 'param3': param3, + } + + +@route(module='测试名称-模块', name='测试名称-DELETE_PARAM') +def delete(request, param1, from_=None, param3=5, **kwargs): + # 未在函数的参数列表中声明的请求参数,会出现在 kwargs 中 + return { + 'param1': param1, + 'from': from_, + 'param3': param3, + 'variable_args': kwargs + } + +``` + +## 截图 + +以下截图为接口列表,对应的路由声明源码见 + +- [test/test/api/__init__.py][11] +- [test/test/api/demo.py][12] + + +以下截图仅在 [Gitee仓库目录][3] 可见 + + + + + + +[1]: https://gitee.com/wangankeji/restfx/wikis +[2]: https://gitee.com/wangankeji/restfx/wikis/0B.%20%E8%B7%AF%E7%94%B1%E6%B3%A8%E5%85%A5?sort_id=3519061 +[3]: https://gitee.com/wangankeji/restfx#%E6%88%AA%E5%9B%BE +[11]: https://gitee.com/wangankeji/restfx/blob/master/test/test/api/__init__.py +[12]: https://gitee.com/wangankeji/restfx/blob/master/test/test/api/demo.py + + + + +%prep +%autosetup -n restfx-0.31.4 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-restfx -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 0.31.4-1 +- Package Spec generated @@ -0,0 +1 @@ +af8544bdb18e427e3c09f63366ffa314 restfx-0.31.4.tar.gz |
