Merge tag '3.3.1' into develop

3.3.1

Author: s3rius

.github/workflows/test.yml

@@ -6,6 +6,9 @@ on:
       - master
     tags-ignore:
       - "*"
+  pull_request:
+    branches:    
+      - 'release/**'
 
 jobs:
   pre_job:

README.md

@@ -90,8 +90,8 @@ optional arguments:
   --kube                Add kubernetes configs
   --dummy, --dummy-model
                         Add dummy model
-  --routers             Add exmaple routers
-  --swagger             Eanble self-hosted swagger
+  --routers             Add example routers
+  --swagger             Enable self-hosted swagger
   --force               Owerrite directory if it exists
   --quite               Do not ask for feature during generation
 ```

fastapi_template/cli.py

@@ -1,13 +1,16 @@
 import re
 from argparse import ArgumentParser
 from operator import attrgetter
+from termcolor import cprint
 
 from prompt_toolkit import prompt
 from prompt_toolkit.document import Document
 from prompt_toolkit.shortcuts import checkboxlist_dialog, radiolist_dialog
 from prompt_toolkit.validation import ValidationError, Validator
 
 from fastapi_template.input_model import (
+    SUPPORTED_ORMS,
+    ORMS_WITHOUT_MIGRATIONS,
     ORM,
     BuilderContext,
     DB_INFO,
@@ -99,14 +102,14 @@ def parse_args():
     )
     parser.add_argument(
         "--routers",
-        help="Add exmaple routers",
+        help="Add example routers",
         action="store_true",
         default=None,
         dest="enable_routers",
     )
     parser.add_argument(
         "--swagger",
-        help="Eanble self-hosted swagger",
+        help="Enable self-hosted swagger",
         action="store_true",
         default=None,
         dest="self_hosted_swagger",
@@ -199,10 +202,19 @@ def read_user_input(current_context: BuilderContext) -> BuilderContext:
         current_context.orm = radiolist_dialog(
             "ORM",
             text="Which ORM do you want?",
-            values=[(orm, orm.value) for orm in list(ORM) if orm != ORM.none],
+            values=[(orm, orm.value) for orm in SUPPORTED_ORMS[current_context.db]],
         ).run()
         if current_context.orm is None:
             raise KeyboardInterrupt()
+    if (
+        current_context.orm is not None 
+        and current_context.orm != ORM.none 
+        and current_context.orm not in SUPPORTED_ORMS.get(current_context.db, [])
+    ):
+        cprint("This ORM is not supported by chosen database.", "red")
+        raise KeyboardInterrupt()
+    if current_context.orm in ORMS_WITHOUT_MIGRATIONS:
+        current_context.enable_migrations = False
     if current_context.ci_type is None:
         current_context.ci_type = radiolist_dialog(
             "CI",

fastapi_template/input_model.py

@@ -24,6 +24,7 @@ class ORM(enum.Enum):
     ormar = "ormar"
     sqlalchemy = "sqlalchemy"
     tortoise = "tortoise"
+    psycopg = "psycopg"
 
 
 class Database(BaseModel):
@@ -69,6 +70,28 @@ class Database(BaseModel):
     ),
 }
 
+SUPPORTED_ORMS = {
+    DatabaseType.postgresql: [
+        ORM.ormar,
+        ORM.psycopg,
+        ORM.tortoise,
+        ORM.sqlalchemy,
+    ],
+    DatabaseType.sqlite: [
+        ORM.ormar,
+        ORM.tortoise,
+        ORM.sqlalchemy,
+    ],
+    DatabaseType.mysql: [
+        ORM.ormar,
+        ORM.tortoise,
+        ORM.sqlalchemy,
+    ]
+}
+
+ORMS_WITHOUT_MIGRATIONS = [
+    ORM.psycopg,
+]
 
 class BuilderContext(BaseModel):
     """Options for project generation."""

fastapi_template/template/{{cookiecutter.project_name}}/.flake8

@@ -60,6 +60,10 @@ ignore =
   WPS404,
   ;  not perform function calls in argument defaults (for dependency injection)
   B008,
+  ; Model should define verbose_name in its Meta inner class
+  DJ10,
+  ; Model should define verbose_name_plural in its Meta inner class
+  DJ11,
 
 per-file-ignores =
   ; all tests

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

@@ -80,6 +80,8 @@
             "{{cookiecutter.project_name}}/db_ormar/models/dummy_model.py",
             "{{cookiecutter.project_name}}/db_tortoise/dao",
             "{{cookiecutter.project_name}}/db_tortoise/models/dummy_model.py",
+            "{{cookiecutter.project_name}}/db_psycopg/dao",
+            "{{cookiecutter.project_name}}/db_psycopg/models/dummy_model.py",
             "{{cookiecutter.project_name}}/tests/test_dummy.py",
             "{{cookiecutter.project_name}}/db_sa/migrations/versions/2021-08-16-16-55_2b7380507a71.py",
             "{{cookiecutter.project_name}}/db_ormar/migrations/versions/2021-08-16-16-55_2b7380507a71.py",
@@ -114,6 +116,12 @@
             "{{cookiecutter.project_name}}/db_ormar"
         ]
     },
+    "PsycoPG": {
+        "enabled": "{{cookiecutter.orm == 'psycopg'}}",
+        "resources": [
+            "{{cookiecutter.project_name}}/db_psycopg"
+        ]
+    },
     "Postgresql DB": {
         "enabled": "{{cookiecutter.db_info.name == 'postgresql'}}",
         "resources": [

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

@@ -12,89 +12,91 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.9"
-fastapi = "^0.68.0"
-uvicorn = "^0.15.0"
-pydantic = {version = "^1.8.2", extras = ["dotenv"]}
-yarl = "^1.6.3"
-ujson = "^4.2.0"
+fastapi = "^0.75.0"
+uvicorn = "^0.17.0"
+pydantic = {version = "^1.9.0", extras = ["dotenv"]}
+yarl = "^1.7.2"
+ujson = "^5.1.0"
 {%- if cookiecutter.orm == "sqlalchemy" %}
 SQLAlchemy = {version = "^1.4", extras = ["mypy", "asyncio"]}
 {%- if cookiecutter.enable_migrations == "True" %}
-alembic = "^1.6.5"
+alembic = "^1.7.7"
 {%- endif %}
 {%- if cookiecutter.db_info.name == "postgresql" %}
-asyncpg = {version = "^0.24.0", extras = ["sa"]}
+asyncpg = {version = "^0.25.0", extras = ["sa"]}
 {%- elif cookiecutter.db_info.name == "sqlite" %}
 aiosqlite = "^0.17.0"
 {%- elif cookiecutter.db_info.name == "mysql" %}
-aiomysql = "^0.0.21"
-mysqlclient = "^2.0.3"
+aiomysql = "^0.0.22"
+mysqlclient = "^2.1.0"
 {%- endif %}
 {%- endif %}
 {%- if cookiecutter.orm == "tortoise" %}
-tortoise-orm = "^0.17.7"
+tortoise-orm = "^0.19.0"
 {%- if cookiecutter.enable_migrations == "True" %}
-aerich = "^0.5.8"
+aerich = "^0.6.2"
 {%- endif %}
 {%- if cookiecutter.db_info.name == "postgresql" %}
-asyncpg = "^0.24.0"
+asyncpg = "^0.25.0"
 {%- elif cookiecutter.db_info.name == "sqlite" %}
 aiosqlite = "^0.17.0"
 {%- elif cookiecutter.db_info.name == "mysql" %}
 aiomysql = "^0.0.21"
 mysqlclient = "^2.0.3"
-cryptography = "^3.4.8"
+cryptography = "^36.0.2"
 {%- endif %}
 {%- endif %}
 {%- if cookiecutter.orm == "ormar" %}
-ormar = "^0.10.20"
+ormar = "^0.11.0"
 {%- if cookiecutter.enable_migrations == "True" %}
-alembic = "^1.6.5"
+alembic = "^1.7.7"
 {%- endif %}
 {%- if cookiecutter.db_info.name == "postgresql" %}
-asyncpg = "^0.24.0"
-psycopg2-binary = "^2.9.1"
+asyncpg = "^0.25.0"
+psycopg2-binary = "^2.9.3"
 {%- elif cookiecutter.db_info.name == "sqlite" %}
 aiosqlite = "^0.17.0"
 {%- elif cookiecutter.db_info.name == "mysql" %}
-aiomysql = "^0.0.21"
-mysqlclient = "^2.0.3"
+aiomysql = "^0.0.22"
+mysqlclient = "^2.1.0"
 {%- endif %}
 {%- endif %}
 {%- if cookiecutter.enable_redis == "True" %}
-aioredis = {version = "^2.0.0", extras = ["hiredis"]}
+aioredis = {version = "^2.0.1", extras = ["hiredis"]}
 {%- endif %}
 {%- if cookiecutter.self_hosted_swagger == 'True' %}
-aiofiles = "^0.7.0"
+aiofiles = "^0.8.0"
+{%- endif %}
+{%- if cookiecutter.orm == "psycopg" %}
+psycopg = { version = "^3.0.11", extras = ["binary", "pool"] }
 {%- endif %}
 httptools = "^0.3.0"
-async-exit-stack = "^1.0.1"
-async-generator = "^1.10"
 
 [tool.poetry.dev-dependencies]
-pytest = "^6.0"
-flake8 = "^3.9.2"
+pytest = "^7.0"
+flake8 = "^4.0.1"
 mypy = "^0.910"
 isort = "^5.9.3"
 yesqa = "^1.2.3"
 pre-commit = "^2.11.0"
-wemake-python-styleguide = "^0.15.3"
-black = "==21.7b0"
+wemake-python-styleguide = "^0.16.1"
+black = "^22.3.0"
 autoflake = "^1.4"
 {%- if cookiecutter.orm == "sqlalchemy" %}
 SQLAlchemy = {version = "^1.4", extras = ["mypy"]}
 {%- endif %}
-pytest-cov = "^2.12.1"
-pytest-asyncio = "^0.15.1"
-nest-asyncio = "^1.5.1"
+pytest-cov = "^3.0.0"
+anyio = "^3.5.0"
 pytest-env = "^0.6.2"
 {%- if cookiecutter.enable_redis == "True" %}
-fakeredis = "^1.6.1"
+fakeredis = "^1.7.1"
 {%- endif %}
 requests = "^2.26.0"
 {%- if cookiecutter.orm == "tortoise" %}
 asynctest = "^0.13.0"
+nest-asyncio = "^1.5.5"
 {%- endif %}
+httpx = "^0.22.0"
 
 
 [tool.isort]
@@ -120,6 +122,7 @@ plugins = ["sqlalchemy.ext.mypy.plugin"]
 filterwarnings = [
     "error",
     "ignore::DeprecationWarning",
+    "ignore:.*unclosed.*:ResourceWarning",
 ]
 {%- if cookiecutter.db_info.name != "none" %}
 env = [
@@ -131,6 +134,15 @@ env = [
 ]
 {%- endif %}
 
+{%- if cookiecutter.orm == "tortoise" %}
+{%- if cookiecutter.enable_migrations == "True" %}
+[tool.aerich]
+tortoise_orm = "{{cookiecutter.project_name}}.db.config.TORTOISE_CONFIG"
+location = "./{{cookiecutter.project_name}}/db/migrations"
+src_folder = "./{{cookiecutter.project_name}}"
+{%- endif %}
+{%- endif %}
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

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

@@ -2,6 +2,7 @@
     "{{cookiecutter.project_name}}/db": [
         "{{cookiecutter.project_name}}/db_sa",
         "{{cookiecutter.project_name}}/db_ormar",
-        "{{cookiecutter.project_name}}/db_tortoise"
+        "{{cookiecutter.project_name}}/db_tortoise",
+        "{{cookiecutter.project_name}}/db_psycopg"
     ]
 }