fastapi-scaff 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

fastapi_scaff/__init__.py

@@ -7,4 +7,4 @@
 @history
 """
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"

fastapi_scaff/__main__.py

@@ -16,7 +16,6 @@ from pathlib import Path
 from . import __version__
 
 here = Path(__file__).absolute().parent
-
 prog = "fastapi-scaff"
 
 

fastapi_scaff/_project_tpl.json

@@ -2,12 +2,12 @@
     ".gitignore": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n#  Usually these files are written by a python script from a template\n#  before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\ncover/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\n.pybuilder/\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n#   For a library or package, you might want to ignore these files since the code is\n#   intended to run in multiple environments; otherwise, check them in:\n# .python-version\n\n# pipenv\n#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n#   However, in case of collaboration, if having platform-specific dependencies or dependencies\n#   having no cross-platform support, pipenv may install dependencies that don't work, or not\n#   install all needed dependencies.\n#Pipfile.lock\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n#.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n# pytype static type analyzer\n.pytype/\n\n# Cython debug symbols\ncython_debug/\n\n# Append\n.idea\n.vscode\n*.sqlite\n",
     "LICENSE": "Copyright (c) 2024 axiner\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
     "README.md": "# fastapi-scaff\n\n## What is this?\n\n- by: axiner\n- fastapi-scaff\n- This is a fastapi scaff.\n    - new project\n    - add api\n    - about project:\n        - auto init project (conf, db, log...)\n        - auto register router\n        - auto register middleware\n        - ...\n    - more documents: [\u8bf7\u70b9\u51fb\u94fe\u63a5](https://blog.csdn.net/atpuxiner/article/details/144291336?fromshare=blogdetail&sharetype=blogdetail&sharerId=144291336&sharerefer=PC&sharesource=atpuxiner&sharefrom=from_link)\n\n## Project structure\n\n- ABD: ABD\u6a21\u5f0f\n    - A api\n    - B business\n    - D datatype\n- \u8c03\u7528\u8fc7\u7a0b: main.py(initializer) -> (middleware) - router - api - business - (datatype)\n- \u7ed3\u6784\u5982\u4e0b: (\u547d\u540d\u7ecf\u8fc7\u591a\u6b21\u4fee\u6539\u6572\u5b9a\uff0c\u7b80\u6d01\u6613\u61c2\uff0cABD\u76ee\u5f55\u8d34\u5408\u907f\u514d\u6742\u4e71\u65e0\u7ae0)\n  ```\n  \u2514\u2500\u2500 fastapi-scaff\n      \u251c\u2500\u2500 app                         (\u5e94\u7528)\n      \u2502   \u251c\u2500\u2500 api                     \u251c\u2500\u2500 (api)\n      \u2502   \u2502   \u2514\u2500\u2500 v1                  \u2502   \u2514\u2500\u2500 (v1)\n      \u2502   \u251c\u2500\u2500 business                \u251c\u2500\u2500 (\u4e1a\u52a1)\n      \u2502   \u251c\u2500\u2500 datatype                \u251c\u2500\u2500 (\u6570\u636e\u7c7b\u578b)\n      \u2502   \u251c\u2500\u2500 initializer             \u251c\u2500\u2500 (\u521d\u59cb\u5316)\n      \u2502   \u2502   \u251c\u2500\u2500 conf                \u2502   \u251c\u2500\u2500 (\u914d\u7f6e)\n      \u2502   \u2502   \u251c\u2500\u2500 db                  \u2502   \u251c\u2500\u2500 (\u6570\u636e\u5e93)\n      \u2502   \u2502   \u251c\u2500\u2500 log                 \u2502   \u251c\u2500\u2500 (\u65e5\u5fd7)\n      \u2502   \u2502   \u2514\u2500\u2500 ...                 \u2502   \u2514\u2500\u2500 (...)\n      \u2502   \u251c\u2500\u2500 middleware              \u251c\u2500\u2500 (\u4e2d\u95f4\u4ef6)\n      \u2502   \u251c\u2500\u2500 router                  \u251c\u2500\u2500 (\u8def\u7531)\n      \u2502   \u251c\u2500\u2500 utils                   \u251c\u2500\u2500 (utils)\n      \u2502   \u2514\u2500\u2500 main.py                 \u2514\u2500\u2500 (main.py)\n      \u251c\u2500\u2500 config                      (\u914d\u7f6e\u76ee\u5f55)\n      \u251c\u2500\u2500 deploy                      (\u90e8\u7f72\u76ee\u5f55)\n      \u251c\u2500\u2500 docs                        (\u6587\u6863\u76ee\u5f55)\n      \u251c\u2500\u2500 log                         (\u65e5\u5fd7\u76ee\u5f55)\n      \u251c\u2500\u2500 .gitignore\n      \u251c\u2500\u2500 LICENSE\n      \u251c\u2500\u2500 README.md\n      \u251c\u2500\u2500 requirements.txt\n      \u2514\u2500\u2500 runserver.py\n  ```\n\n## Installation\n\nThis package can be installed using pip (Python>=3.11):\n> pip install fastapi-scaff\n\n## Scaff usage\n\n- 1\uff09help document\n    - `fastapi-scaff -h`\n- 2\uff09new project\n    - `fastapi-scaff new <myproj>`\n- 3\uff09add api\n    - `cd to project root dir`\n    - `fastapi-scaff add <myapi>`\n\n## Project run\n\n- 1\uff09cd to project root dir\n- 2\uff09modify the configuration, such as for the database\n- 3\uff09`pip install -r requirements.txt`\n- 4\uff09`python runserver.py`\n    - more parameters see:\n      - about uvicorn: [click here](https://www.uvicorn.org/)\n      - about gunicorn: [click here](https://docs.gunicorn.org/en/stable/)\n\n## License\n\nThis project is released under the MIT License (MIT). See [LICENSE](LICENSE)\n",
-    "requirements.txt": "# -*- coding: utf-8 -*-\n# Python>=3.11\nfastapi==0.115.12\nuvicorn==0.34.0\ntoollib==1.7.3\npython-dotenv==1.1.0\nPyYAML==6.0.2\nloguru==0.7.3\nSQLAlchemy==2.0.40\naiosqlite==0.21.0\nredis==5.2.1\nPyJWT==2.10.1\nbcrypt==4.3.0\n",
+    "requirements.txt": "# -*- coding: utf-8 -*-\n# Python>=3.11\nfastapi==0.116.1\nuvicorn==0.35.0\norjson==3.11.1\ntoollib==1.7.4\npython-dotenv==1.1.1\nPyYAML==6.0.2\nloguru==0.7.3\nSQLAlchemy==2.0.42\naiosqlite==0.21.0\nredis==6.4.0\nPyJWT==2.10.1\nbcrypt==4.3.0\n",
     "runserver.py": "\"\"\"\n@author axiner\n@version v1.0.0\n@created 2024/07/29 22:22\n@abstract runserver\uff08\u66f4\u591a\u53c2\u6570\u8bf7\u81ea\u884c\u6307\u5b9a\uff09\n@description\n@history\n\"\"\"\nimport argparse\nimport subprocess\nimport sys\n\nimport uvicorn\n\n\ndef run_by_unicorn(\n        host: str,\n        port: int,\n        workers: int,\n        log_level: str,\n        is_reload: bool,\n):\n    log_config = {\n        \"version\": 1,\n        \"disable_existing_loggers\": False,\n        \"formatters\": {\n            \"default\": {\n                \"()\": \"uvicorn.logging.DefaultFormatter\",\n                \"fmt\": \"%(asctime)s %(levelname)s %(filename)s:%(lineno)d %(message)s\",\n                \"use_colors\": None\n            },\n            \"access\": {\n                \"()\": \"uvicorn.logging.AccessFormatter\",\n                \"fmt\": \"%(asctime)s %(levelname)s %(client_addr)s - \\\"%(request_line)s\\\" %(status_code)s\"\n            }\n        },\n        \"handlers\": {\n            \"default\": {\n                \"formatter\": \"default\",\n                \"class\": \"logging.StreamHandler\",\n                \"stream\": \"ext://sys.stderr\"\n            },\n            \"access\": {\n                \"formatter\": \"access\",\n                \"class\": \"logging.StreamHandler\",\n                \"stream\": \"ext://sys.stdout\"\n            }\n        },\n        \"loggers\": {\n            \"uvicorn\": {\n                \"handlers\": [\n                    \"default\"\n                ],\n                \"level\": \"INFO\",\n                \"propagate\": False\n            },\n            \"uvicorn.error\": {\n                \"level\": \"INFO\"\n            },\n            \"uvicorn.access\": {\n                \"handlers\": [\n                    \"access\"\n                ],\n                \"level\": \"INFO\",\n                \"propagate\": False\n            }\n        }\n    }\n    uvicorn.run(\n        app=\"app.main:app\",\n        host=host,\n        port=port,\n        workers=workers,\n        log_level=log_level,\n        log_config=log_config,\n        reload=is_reload,\n    )\n\n\ndef run_by_gunicorn(\n        host: str,\n        port: int,\n        workers: int,\n        log_level: str,\n        is_reload: bool,\n):\n    cmd = (\n        \"gunicorn app.main:app \"\n        \"--worker-class=uvicorn.workers.UvicornWorker \"\n        \"--bind={host}:{port} \"\n        \"--workers={workers} \"\n        \"--log-level={log_level} \"\n        \"--access-logfile=- \"\n        \"--error-logfile=- \"\n        .format(\n            host=host,\n            port=port,\n            workers=workers,\n            log_level=log_level,\n        )\n    )\n    if is_reload:\n        cmd += f\" --reload\"\n    subprocess.run(cmd, shell=True)\n\n\ndef main(\n        host: str,\n        port: int,\n        workers: int,\n        log_level: str,\n        is_reload: bool,\n        is_gunicorn: bool,\n):\n    parser = argparse.ArgumentParser()\n    parser.add_argument(\"--host\", type=str, metavar=\"\", help=\"host\")\n    parser.add_argument(\"--port\", type=int, metavar=\"\", help=\"port\")\n    parser.add_argument(\"--workers\", type=int, metavar=\"\", help=\"\u8fdb\u7a0b\u6570\")\n    parser.add_argument(\"--log-level\", type=str, metavar=\"\", help=\"\u65e5\u5fd7\u7b49\u7ea7\")\n    parser.add_argument(\"--is-reload\", action=\"store_true\", help=\"\u662f\u5426reload\")\n    parser.add_argument(\"--is-gunicorn\", action=\"store_true\", help=\"\u662f\u5426gunicorn\")\n    args = parser.parse_args()\n    kwargs = {\n        \"host\": args.host or host,\n        \"port\": args.port or port,\n        \"workers\": args.workers or workers,\n        \"log_level\": args.log_level or log_level,\n        \"is_reload\": args.is_reload or is_reload,\n    }\n    if (args.is_gunicorn or is_gunicorn) and not sys.platform.lower().startswith(\"win\"):\n        try:\n            import gunicorn  # noqa\n        except ImportError:\n            sys.stderr.write(\"gunicorn\u672a\u627e\u5230\uff0c\u6b63\u5728\u5c1d\u8bd5\u81ea\u52a8\u5b89\u88c5...\\n\")\n            try:\n                subprocess.run(\n                    [\"pip\", \"install\", \"gunicorn\"],\n                    check=True,\n                    stdout=subprocess.PIPE,\n                    stderr=subprocess.PIPE)\n                sys.stderr.write(\"gunicorn\u5b89\u88c5\u6210\u529f\\n\")\n            except subprocess.CalledProcessError as e:\n                sys.stderr.write(f\"gunicorn\u5b89\u88c5\u5931\u8d25: {e.stderr.decode().strip()}\\n\")\n                raise\n        run_by_gunicorn(**kwargs)\n    else:\n        run_by_unicorn(**kwargs)\n\n\nif __name__ == '__main__':\n    main(\n        host=\"0.0.0.0\",\n        port=8000,\n        workers=3,\n        log_level=\"debug\",\n        is_reload=False,  # \u9002\u7528\u4e8edev\n        is_gunicorn=False,  # \u4e0d\u652f\u6301win\n    )\n",
-    "app/main.py": "\"\"\"\n@author axiner\n@version v1.0.0\n@created 2024/07/29 22:22\n@abstract main\n@description\n@history\n\"\"\"\nfrom contextlib import asynccontextmanager\nfrom fastapi import FastAPI\n\nfrom app import (\n    router,\n    middleware,\n)\nfrom app.initializer import g\n\ng.setup()\n# #\nopenapi_url = \"/openapi.json\"\ndocs_url = \"/docs\"\nredoc_url = \"/redoc\"\nif g.config.is_disable_docs is True:\n    openapi_url, docs_url, redoc_url = None, None, None\n\n\n@asynccontextmanager\nasync def lifespan(app_: FastAPI):\n    g.logger.info(f\"Application using config file '{g.config.yamlname}'\")\n    g.logger.info(f\"Application name '{g.config.appname}'\")\n    g.logger.info(f\"Application version '{g.config.appversion}'\")\n    # #\n    g.logger.info(\"Application server running\")\n    yield\n    g.logger.info(\"Application server shutdown\")\n\n\napp = FastAPI(\n    title=g.config.appname,\n    version=g.config.appversion,\n    debug=g.config.debug,\n    openapi_url=openapi_url,\n    docs_url=docs_url,\n    redoc_url=redoc_url,\n    lifespan=lifespan,\n)\n# #\nrouter.register_routers(app)\nmiddleware.register_middlewares(app)\n",
+    "app/main.py": "\"\"\"\n@author axiner\n@version v1.0.0\n@created 2024/07/29 22:22\n@abstract main\n@description\n@history\n\"\"\"\nfrom contextlib import asynccontextmanager\nfrom fastapi import FastAPI\nfrom fastapi.responses import ORJSONResponse\n\nfrom app import (\n    router,\n    middleware,\n)\nfrom app.initializer import g\n\ng.setup()\n# #\nopenapi_url = \"/openapi.json\"\ndocs_url = \"/docs\"\nredoc_url = \"/redoc\"\nif g.config.is_disable_docs is True:\n    openapi_url, docs_url, redoc_url = None, None, None\n\n\n@asynccontextmanager\nasync def lifespan(app_: FastAPI):\n    g.logger.info(f\"Application using config file '{g.config.yamlname}'\")\n    g.logger.info(f\"Application name '{g.config.appname}'\")\n    g.logger.info(f\"Application version '{g.config.appversion}'\")\n    # #\n    g.logger.info(\"Application server running\")\n    yield\n    g.logger.info(\"Application server shutdown\")\n\n\napp = FastAPI(\n    title=g.config.appname,\n    version=g.config.appversion,\n    debug=g.config.debug,\n    openapi_url=openapi_url,\n    docs_url=docs_url,\n    redoc_url=redoc_url,\n    lifespan=lifespan,\n    default_response_class=ORJSONResponse,\n)\n# #\nrouter.register_routers(app)\nmiddleware.register_middlewares(app)\n",
     "app/__init__.py": "\"\"\"\n@author axiner\n@version v1.0.0\n@created 2024/07/29 22:22\n@abstract app\n@description\n@history\n\"\"\"\nfrom pathlib import Path\n\nAPP_DIR = Path(__file__).absolute().parent\n",
     "app/api/exception.py": "from typing import Any\n\nfrom app.api.status import Status\n\n\nclass CustomException(Exception):\n\n    def __init__(\n            self,\n            msg: str = None,\n            code: int = None,\n            data: Any = None,\n            status: Status = Status.FAILURE,\n    ):\n        self.msg = msg or status.msg\n        self.code = code or status.code\n        self.data = data\n        self.status = status\n\n    def __str__(self) -> str:\n        return f\"{self.code} {self.msg}\"\n\n    def __repr__(self) -> str:\n        return f\"<{self.__class__.__name__}: ({self.code!r}, {self.msg!r})>\"\n",
-    "app/api/response.py": "from typing import Mapping, get_type_hints\n\nfrom starlette.background import BackgroundTask\nfrom starlette.responses import JSONResponse, StreamingResponse, ContentStream\nfrom toollib.utils import now2timestamp, map_jsontype\n\nfrom app.api.status import Status\n\n\nclass Response:\n\n    @staticmethod\n    def success(\n            data: dict | list | str | None = None,\n            msg: str = None,\n            code: int = None,\n            status: Status = Status.SUCCESS,\n            status_code: int = 200,\n            headers: Mapping[str, str] | None = None,\n            media_type: str | None = None,\n            background: BackgroundTask | None = None,\n    ) -> JSONResponse:\n        return JSONResponse(\n            content={\n                \"time\": now2timestamp(),\n                \"msg\": msg or status.msg,\n                \"code\": code or status.code,\n                \"data\": data,\n            },\n            status_code=status_code,\n            headers=headers,\n            media_type=media_type,\n            background=background,\n        )\n\n    @staticmethod\n    def failure(\n            msg: str = None,\n            code: int = None,\n            error: str | Exception | None = None,\n            data: dict | list | str | None = None,\n            status: Status = Status.FAILURE,\n            status_code: int = 200,\n            headers: Mapping[str, str] | None = None,\n            media_type: str | None = None,\n            background: BackgroundTask | None = None,\n    ) -> JSONResponse:\n        return JSONResponse(\n            content={\n                \"time\": now2timestamp(),\n                \"msg\": msg or status.msg,\n                \"code\": code or status.code,\n                \"error\": str(error) if error else None,\n                \"data\": data,\n            },\n            status_code=status_code,\n            headers=headers,\n            media_type=media_type,\n            background=background,\n        )\n\n    @staticmethod\n    def stream(\n            content: ContentStream,\n            status_code: int = 200,\n            headers: Mapping[str, str] | None = None,\n            media_type: str | None = None,\n            background: BackgroundTask | None = None,\n    ) -> StreamingResponse:\n        return StreamingResponse(\n            content=content,\n            status_code=status_code,\n            headers=headers,\n            media_type=media_type,\n            background=background,\n        )\n\n\ndef response_docs(\n        model=None,  # \u6a21\u578b(BaseModel): \u81ea\u52a8\u4ece\u6a21\u578b\u4e2d\u89e3\u6790\u5b57\u6bb5\u4e0e\u7c7b\u578b\n        data: dict | str = None,  # \u6570\u636e(dict/str): \u76f4\u63a5\u7ed9\u5b9a\u5b57\u6bb5\u4e0e\u7c7b\u578b/\u7c7b\u578b\n        is_listwrap: bool = False,\n        listwrap_key: str = None,\n        listwrap_key_extra: dict = None,\n        docs_extra: dict = None,\n):\n    \"\"\"\u54cd\u5e94\u6587\u6863\"\"\"\n\n    def _data_from_model(model_, default: str = \"\u672a\u77e5\") -> dict:\n        \"\"\"\u6570\u636e\u6a21\u677f\"\"\"\n        data_ = {}\n        if hasattr(model_, \"response_fields\"):\n            all_fields = set(model_.response_fields())\n        else:\n            all_fields = set(model_.model_fields.keys())\n        type_hints = get_type_hints(model_)\n        for field_name in all_fields:\n            try:\n                t = type_hints.get(field_name)\n                t = str(t).replace(\"<class '\", \"\").replace(\"'>\", \"\") if t else default\n            except Exception:\n                t = default\n            data_[field_name] = t\n        return data_\n\n    final_data = {}\n    if model:\n        final_data = _data_from_model(model)\n    if data:\n        if isinstance(data, dict):\n            final_data.update(data)\n        else:\n            final_data = data\n    if is_listwrap:\n        final_data = [final_data] if not isinstance(final_data, list) else final_data\n        if listwrap_key:\n            final_data = {listwrap_key: final_data}\n            if listwrap_key_extra:\n                final_data.update(listwrap_key_extra)\n\n    def _format_value(value):\n        if isinstance(value, str):\n            _value = value.split(\"|\")\n            if len(_value) > 1:\n                return \" | \".join([map_jsontype(_v.strip(), is_keep_integer=True) for _v in _value])\n            return map_jsontype(value, is_keep_integer=True)\n        elif isinstance(value, dict):\n            return {k: _format_value(v) for k, v in value.items()}\n        elif isinstance(value, (list, tuple)):\n            return [_format_value(item) for item in value]\n        else:\n            return str(value)\n\n    format_data = _format_value(final_data)\n\n    docs = {\n        200: {\n            \"description\": \"\u64cd\u4f5c\u6210\u529f\u3010code\u4e3a0 & http\u72b6\u6001\u7801200\u3011\",\n            \"content\": {\n                \"application/json\": {\n                    \"example\": {\n                        \"time\": \"integer\",\n                        \"msg\": \"string\",\n                        \"code\": \"integer\",\n                        \"data\": format_data\n                    }\n                }\n            }\n        },\n        422: {\n            \"description\": \"\u64cd\u4f5c\u5931\u8d25\u3010code\u975e0 & http\u72b6\u6001\u7801200\u3011\",\n            \"content\": {\n                \"application/json\": {\n                    \"example\": {\n                        \"time\": \"integer\",\n                        \"msg\": \"string\",\n                        \"code\": \"integer\",\n                        \"error\": \"string\",\n                        \"data\": \"object | array | ...\",\n                    }\n                }\n            }\n        },\n    }\n    if docs_extra:\n        docs.update(docs_extra)\n    return docs\n",
+    "app/api/response.py": "import json\nfrom typing import Mapping, get_type_hints, Any\n\nfrom fastapi.encoders import jsonable_encoder\nfrom starlette.background import BackgroundTask\nfrom starlette.responses import JSONResponse, StreamingResponse, ContentStream\nfrom toollib.utils import now2timestamp, map_jsontype\n\nfrom app.api.status import Status\n\n\nclass Response:\n\n    @staticmethod\n    def success(\n            data: dict | list | str | None = None,\n            msg: str = None,\n            code: int = None,\n            status: Status = Status.SUCCESS,\n            is_encode_data: bool = False,\n            status_code: int = 200,\n            headers: Mapping[str, str] | None = None,\n            media_type: str | None = None,\n            background: BackgroundTask | None = None,\n    ) -> JSONResponse:\n        return JSONResponse(\n            content={\n                \"time\": now2timestamp(),\n                \"msg\": msg or status.msg,\n                \"code\": code or status.code,\n                \"data\": Response.encode_data(data) if is_encode_data else data,\n            },\n            status_code=status_code,\n            headers=headers,\n            media_type=media_type,\n            background=background,\n        )\n\n    @staticmethod\n    def failure(\n            msg: str = None,\n            code: int = None,\n            error: str | Exception | None = None,\n            data: dict | list | str | None = None,\n            status: Status = Status.FAILURE,\n            is_encode_data: bool = False,\n            status_code: int = 200,\n            headers: Mapping[str, str] | None = None,\n            media_type: str | None = None,\n            background: BackgroundTask | None = None,\n    ) -> JSONResponse:\n        return JSONResponse(\n            content={\n                \"time\": now2timestamp(),\n                \"msg\": msg or status.msg,\n                \"code\": code or status.code,\n                \"error\": str(error) if error else None,\n                \"data\": Response.encode_data(data) if is_encode_data else data,\n            },\n            status_code=status_code,\n            headers=headers,\n            media_type=media_type,\n            background=background,\n        )\n\n    @staticmethod\n    def encode_data(data: Any) -> Any:\n        if data is None or isinstance(data, (str, int, float, bool)):\n            return data\n        if isinstance(data, (dict, list)):\n            try:\n                json.dumps(data)\n                return data\n            except (TypeError, OverflowError):\n                pass\n        return jsonable_encoder(data)\n\n    @staticmethod\n    def stream(\n            content: ContentStream,\n            status_code: int = 200,\n            headers: Mapping[str, str] | None = None,\n            media_type: str | None = None,\n            background: BackgroundTask | None = None,\n    ) -> StreamingResponse:\n        return StreamingResponse(\n            content=content,\n            status_code=status_code,\n            headers=headers,\n            media_type=media_type,\n            background=background,\n        )\n\n\ndef response_docs(\n        model=None,  # \u6a21\u578b(BaseModel): \u81ea\u52a8\u4ece\u6a21\u578b\u4e2d\u89e3\u6790\u5b57\u6bb5\u4e0e\u7c7b\u578b\n        data: dict | str = None,  # \u6570\u636e(dict/str): \u76f4\u63a5\u7ed9\u5b9a\u5b57\u6bb5\u4e0e\u7c7b\u578b/\u7c7b\u578b\n        is_listwrap: bool = False,\n        listwrap_key: str = None,\n        listwrap_key_extra: dict = None,\n        docs_extra: dict = None,\n):\n    \"\"\"\u54cd\u5e94\u6587\u6863\"\"\"\n\n    def _data_from_model(model_, default: str = \"\u672a\u77e5\") -> dict:\n        \"\"\"\u6570\u636e\u6a21\u677f\"\"\"\n        data_ = {}\n        if hasattr(model_, \"response_fields\"):\n            all_fields = set(model_.response_fields())\n        else:\n            all_fields = set(model_.model_fields.keys())\n        type_hints = get_type_hints(model_)\n        for field_name in all_fields:\n            try:\n                t = type_hints.get(field_name)\n                t = str(t).replace(\"<class '\", \"\").replace(\"'>\", \"\") if t else default\n            except Exception:\n                t = default\n            data_[field_name] = t\n        return data_\n\n    final_data = {}\n    if model:\n        final_data = _data_from_model(model)\n    if data:\n        if isinstance(data, dict):\n            final_data.update(data)\n        else:\n            final_data = data\n    if is_listwrap:\n        final_data = [final_data] if not isinstance(final_data, list) else final_data\n        if listwrap_key:\n            final_data = {listwrap_key: final_data}\n            if listwrap_key_extra:\n                final_data.update(listwrap_key_extra)\n\n    def _format_value(value):\n        if isinstance(value, str):\n            _value = value.split(\"|\")\n            if len(_value) > 1:\n                return \" | \".join([map_jsontype(_v.strip(), is_keep_integer=True) for _v in _value])\n            return map_jsontype(value, is_keep_integer=True)\n        elif isinstance(value, dict):\n            return {k: _format_value(v) for k, v in value.items()}\n        elif isinstance(value, (list, tuple)):\n            return [_format_value(item) for item in value]\n        else:\n            return str(value)\n\n    format_data = _format_value(final_data)\n\n    docs = {\n        200: {\n            \"description\": \"\u64cd\u4f5c\u6210\u529f\u3010code\u4e3a0 & http\u72b6\u6001\u7801200\u3011\",\n            \"content\": {\n                \"application/json\": {\n                    \"example\": {\n                        \"time\": \"integer\",\n                        \"msg\": \"string\",\n                        \"code\": \"integer\",\n                        \"data\": format_data\n                    }\n                }\n            }\n        },\n        422: {\n            \"description\": \"\u64cd\u4f5c\u5931\u8d25\u3010code\u975e0 & http\u72b6\u6001\u7801200\u3011\",\n            \"content\": {\n                \"application/json\": {\n                    \"example\": {\n                        \"time\": \"integer\",\n                        \"msg\": \"string\",\n                        \"code\": \"integer\",\n                        \"error\": \"string\",\n                        \"data\": \"object | array | ...\",\n                    }\n                }\n            }\n        },\n    }\n    if docs_extra:\n        docs.update(docs_extra)\n    return docs\n",
     "app/api/status.py": "from enum import Enum\n\n\nclass Status(Enum):\n    SUCCESS = (0, '\u64cd\u4f5c\u6210\u529f')\n    FAILURE = (1, '\u64cd\u4f5c\u5931\u8d25')\n\n    PARAMS_ERROR = (400, '\u53c2\u6570\u9519\u8bef')\n    UNAUTHORIZED_ERROR = (401, '\u8ba4\u8bc1\u5931\u8d25')\n    # \u5efa\u8bae\uff1a\u4e1a\u52a1\u6a21\u5757\u9519\u8bef\u7801\u4ece10000\u5f00\u59cb\n    RECORD_NOT_EXIST_ERROR = (10000, '\u8bb0\u5f55\u4e0d\u5b58\u5728')\n    RECORD_EXISTS_ERROR = (10001, '\u8bb0\u5f55\u5df2\u5b58\u5728')\n\n    @property\n    def code(self):\n        return self.value[0]\n\n    @property\n    def msg(self):\n        return self.value[1]\n\n    @classmethod\n    def collect_status(cls):\n        text = \"\"\n        for s in cls:\n            text += f\"{s.code} {s.msg}\\n\"\n        return text\n",
     "app/api/__init__.py": "\"\"\"\napi\n\"\"\"\n",
     "app/api/default/ping.py": "from fastapi import APIRouter\n\nping_router = APIRouter()\n\n\n@ping_router.get(\n    path=\"/ping\",\n    summary=\"ping\",\n)\ndef ping():\n    return \"pong\"\n",

{fastapi_scaff-0.0.1.dist-info → fastapi_scaff-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-scaff
-Version: 0.0.1
+Version: 0.0.2
 Summary: This is a fastapi scaff.
 Author-email: axiner <atpuxiner@163.com>
 Project-URL: Homepage, https://github.com/atpuxiner/fastapi-scaff

fastapi_scaff-0.0.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+fastapi_scaff/__init__.py,sha256=IzKcRDbur6wzuLt7OSQ4hdbr5012FPaGduzPWkKc12M,120
+fastapi_scaff/__main__.py,sha256=N0DahVWdXUgQjtHuXsXavbzSKpctlRSeDXDBXy7Xsdk,12138
+fastapi_scaff/_api_tpl.json,sha256=qUS4OWcsHmpRDZCQSSRjj-faMgHiiohBAgr98XbLNgQ,5169
+fastapi_scaff/_project_tpl.json,sha256=FKaaM2YkWFEjax-wl4Yzm3maQ5dIPWw4gnV-7LMGrZI,68551
+fastapi_scaff-0.0.2.dist-info/licenses/LICENSE,sha256=A5H6q7zd1QrL3iVs1KLsBOG0ImV-t9PpPspM4x-4Ea8,1069
+fastapi_scaff-0.0.2.dist-info/METADATA,sha256=azS6zQ5CmUmXhsK-p4MPDJ8A7U_NpmUUHBDhwOk_uvM,3339
+fastapi_scaff-0.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_scaff-0.0.2.dist-info/entry_points.txt,sha256=kzs28nmpRWVCmWmZav3X7u7YOIOEir3sCkLnvQKTJbY,62
+fastapi_scaff-0.0.2.dist-info/top_level.txt,sha256=LeyfUxMRhdbRHcYoH37ftfdspyZ8V3Uut2YBaTCzq2k,14
+fastapi_scaff-0.0.2.dist-info/RECORD,,

fastapi_scaff-0.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-fastapi_scaff/__init__.py,sha256=FPXqnjzjXjySWwbd2puvZ-1kluvz--bnp944RtPbjsk,120
-fastapi_scaff/__main__.py,sha256=Q9juuExsTZN1ApBjflJv1RTBDkL0715AMEwP-FwuGEc,12140
-fastapi_scaff/_api_tpl.json,sha256=qUS4OWcsHmpRDZCQSSRjj-faMgHiiohBAgr98XbLNgQ,5169
-fastapi_scaff/_project_tpl.json,sha256=0tr9-N0pRd2-_e5_oY0XzJ3dsD_FmqBbbk0XJ0a_Cck,67804
-fastapi_scaff-0.0.1.dist-info/licenses/LICENSE,sha256=A5H6q7zd1QrL3iVs1KLsBOG0ImV-t9PpPspM4x-4Ea8,1069
-fastapi_scaff-0.0.1.dist-info/METADATA,sha256=ZqRMhr4qOqRoTV4-3o9op2WfyFMwLdXHp0qAXEqYkqE,3339
-fastapi_scaff-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fastapi_scaff-0.0.1.dist-info/entry_points.txt,sha256=kzs28nmpRWVCmWmZav3X7u7YOIOEir3sCkLnvQKTJbY,62
-fastapi_scaff-0.0.1.dist-info/top_level.txt,sha256=LeyfUxMRhdbRHcYoH37ftfdspyZ8V3Uut2YBaTCzq2k,14
-fastapi_scaff-0.0.1.dist-info/RECORD,,