Added gunicorn support (#178)

Author: s3rius

fastapi_template/cli.py

@@ -9,10 +9,15 @@
 from prompt_toolkit.validation import ValidationError, Validator
 from termcolor import colored
 
-from fastapi_template.input_model import (SKIP_ENTRY, BaseMenuModel,
-                                          BuilderContext, Database, MenuEntry,
-                                          MultiselectMenuModel,
-                                          SingularMenuModel)
+from fastapi_template.input_model import (
+    SKIP_ENTRY,
+    BaseMenuModel,
+    BuilderContext,
+    Database,
+    MenuEntry,
+    MultiselectMenuModel,
+    SingularMenuModel,
+)
 
 
 class SnakeCaseValidator(Validator):
@@ -509,6 +514,17 @@ def checker(ctx: BuilderContext) -> bool:
                 )
             ),
         ),
+        MenuEntry(
+            code="gunicorn",
+            cli_name="gunicorn",
+            user_view="Add gunicorn server",
+            description=(
+                "This option adds {what} server for running application.\n"
+                "It's more performant than uvicorn, and recommended for production.".format(
+                    what=colored("gunicorn", color="green")
+                )
+            ),
+        ),
     ],
 )
 

fastapi_template/template/cookiecutter.json

@@ -62,6 +62,9 @@
     "pydanticv1": {
         "type": "bool"
     },
+    "gunicorn": {
+        "type": "bool"
+    },
     "_extensions": [
         "cookiecutter.extensions.RandomStringExtension"
     ],

fastapi_template/template/{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -26,19 +26,19 @@ repos:
 
     - repo: local
       hooks:
-          - id: black
-            name: Format with Black
-            entry: poetry run black
-            language: system
-            types: [python]
-
           - id: autoflake
             name: autoflake
             entry: poetry run autoflake
             language: system
             types: [python]
             args: [--in-place, --remove-all-unused-imports, --remove-duplicate-keys]
 
+          - id: black
+            name: Format with Black
+            entry: poetry run black
+            language: system
+            types: [python]
+
           - id: isort
             name: isort
             entry: poetry run isort

fastapi_template/template/{{cookiecutter.project_name}}/conditional_files.json

@@ -215,5 +215,11 @@
         "resources": [
             "{{cookiecutter.project_name}}/tkq.py"
         ]
+    },
+    "Gunicorn support":{
+        "enabled": "{{cookiecutter.gunicorn}}",
+        "resources": [
+            "{{cookiecutter.project_name}}/gunicorn_runner.py"
+        ]
     }
 }

fastapi_template/template/{{cookiecutter.project_name}}/pyproject.toml

@@ -14,6 +14,9 @@ readme = "README.md"
 python = "^3.9"
 fastapi = "^0.100.0"
 uvicorn = { version = "^0.22.0", extras = ["standard"] }
+{%- if cookiecutter.gunicorn == "True" %}
+gunicorn = "^21.2.0"
+{%- endif %}
 {%- if cookiecutter.pydanticv1 == "True" %}
 pydantic = { version = "^1", extras=["dotenv"] }
 {%- else %}

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/__main__.py

@@ -2,6 +2,10 @@
 import shutil
 
 import uvicorn
+
+{%- if cookiecutter.gunicorn == "True" %}
+from {{cookiecutter.project_name}}.gunicorn_runner import GunicornApplication
+{%- endif %}
 from {{cookiecutter.project_name}}.settings import settings
 
 {%- if cookiecutter.prometheus_enabled == "True" %}
@@ -39,6 +43,32 @@ def main() -> None:
     {%- if cookiecutter.orm == "piccolo" %}
     os.environ['PICCOLO_CONF'] = "{{cookiecutter.project_name}}.piccolo_conf"
     {%- endif %}
+    {%- if cookiecutter.gunicorn == "True" %}
+    if settings.reload:
+        uvicorn.run(
+            "{{cookiecutter.project_name}}.web.application:get_app",
+            workers=settings.workers_count,
+            host=settings.host,
+            port=settings.port,
+            reload=settings.reload,
+            log_level=settings.log_level.value.lower(),
+            factory=True,
+        )
+    else:
+        # We choose gunicorn only if reload
+        # option is not used, because reload
+        # feature doen't work with Uvicorn workers.
+        GunicornApplication(
+            "{{cookiecutter.project_name}}.web.application:get_app",
+            host=settings.host,
+            port=settings.port,
+            workers=settings.workers_count,
+            factory=True,
+            accesslog="-",
+            loglevel=settings.log_level.value.lower(),
+            access_log_format='%r "-" %s "-" %Tf',  # noqa: WPS323
+        ).run()
+    {%- else %}
     uvicorn.run(
         "{{cookiecutter.project_name}}.web.application:get_app",
         workers=settings.workers_count,
@@ -48,7 +78,7 @@ def main() -> None:
         log_level=settings.log_level.value.lower(),
         factory=True,
     )
-
+    {%- endif %}
 
 if __name__ == "__main__":
     main()

fastapi_template/template/{{cookiecutter.project_name}}/{{cookiecutter.project_name}}/gunicorn_runner.py

@@ -0,0 +1,80 @@
+from typing import Any
+
+from gunicorn.app.base import BaseApplication
+from gunicorn.util import import_app
+from uvicorn.workers import UvicornWorker as BaseUvicornWorker
+
+try:
+    import uvloop  # noqa: WPS433 (Found nested import)
+except ImportError:
+    uvloop = None  # type: ignore  # noqa: WPS440 (variables overlap)
+
+
+
+class UvicornWorker(BaseUvicornWorker):
+    """
+    Configuration for uvicorn workers.
+
+    This class is subclassing UvicornWorker and defines
+    some parameters class-wide, because it's impossible,
+    to pass these parameters through gunicorn.
+    """
+
+    CONFIG_KWARGS = {  # noqa: WPS115 (upper-case constant in a class)
+        "loop": "uvloop" if uvloop is not None else "asyncio",
+        "http": "httptools",
+        "lifespan": "on",
+        "factory": True,
+        "proxy_headers": False,
+    }
+
+
+class GunicornApplication(BaseApplication):
+    """
+    Custom gunicorn application.
+
+    This class is used to start guncicorn
+    with custom uvicorn workers.
+    """
+
+    def __init__(  # noqa: WPS211 (Too many args)
+        self,
+        app: str,
+        host: str,
+        port: int,
+        workers: int,
+        **kwargs: Any,
+    ):
+        self.options = {
+            "bind": f"{host}:{port}",
+            "workers": workers,
+            "worker_class": "{{cookiecutter.project_name}}.gunicorn_runner.UvicornWorker",
+            **kwargs
+        }
+        self.app = app
+        super().__init__()
+
+    def load_config(self) -> None:
+        """
+        Load config for web server.
+
+        This function is used to set parameters to gunicorn
+        main process. It only sets parameters that
+        gunicorn can handle. If you pass unknown
+        parameter to it, it crash with error.
+        """
+        for key, value in self.options.items():
+            if key in self.cfg.settings and value is not None:
+                self.cfg.set(key.lower(), value)
+
+    def load(self) -> str:
+        """
+        Load actual application.
+
+        Gunicorn loads application based on this
+        function's returns. We return python's path to
+        the app's factory.
+
+        :returns: python path to app factory.
+        """
+        return import_app(self.app)

fastapi_template/tests/test_generator.py

@@ -29,7 +29,7 @@ def init_context(
         if entry.code == orm:
             if entry.pydantic_v1:
                 context.pydanticv1 = True
-    
+
     if api is not None:
         context.api_type = api
         if api == "graphql":
@@ -186,6 +186,11 @@ def test_telemetry_pre_commit(default_context: BuilderContext):
     run_default_check(default_context, without_pytest=True)
 
 
+def test_gunicorn(default_context: BuilderContext):
+    default_context.gunicorn = True
+    run_default_check(default_context, without_pytest=True)
+
+
 # @pytest.mark.parametrize("api", ["rest", "graphql"])
 # def test_kafka(default_context: BuilderContext, api: str):
 #     default_context.enable_kafka = True