Merge pull request #46 from mts-ai/feature/custom-view-body-dependencies

context var for current atomic operation

Author: mahenzon

.github/workflows/documentation.yaml

@@ -20,6 +20,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install sphinx sphinx_rtd_theme
+          pip install -r docs/requirements.txt
       - name: Sphinx build
         run: |
           sphinx-build docs _build

.readthedocs.yaml

@@ -31,6 +31,6 @@ formats:
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/atomic_operations.rst

@@ -259,7 +259,12 @@ Notes
 
 
 .. note::
-    See `examples for SQLAlchemy <SQLA_examples>`_ in the repo, all examples are based on it.
+    See `examples for SQLAlchemy`_ in the repo, all examples are based on it.
+
+
+.. note::
+    Atomic Operations provide ``current_atomic_operation`` context variable.
+    Usage example can be found in tests `test_current_atomic_operation`_.
 
 
 .. warning::
@@ -271,4 +276,5 @@ Notes
 
     Includes in the response body are not supported (and not planned, until you PR it)
 
-.. _SQLA_examples: https://github.com/mts-ai/FastAPI-JSONAPI/tree/main/examples/api_for_sqlalchemy
+.. _`examples for SQLAlchemy`: https://github.com/mts-ai/FastAPI-JSONAPI/tree/main/examples/api_for_sqlalchemy
+.. _`test_current_atomic_operation`: https://github.com/mts-ai/FastAPI-JSONAPI/blob/main/tests/test_atomic/test_current_atomic_operation.py

docs/changelog.rst

@@ -1,6 +1,23 @@
 Changelog
 #########
 
+
+**2.3.0**
+*********
+
+Current Atomic Operation context var
+====================================
+
+* create context var for current atomic operation `#46 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/46>`_
+* create example and coverage for universal dependency both for generic views and atomic operations
+* tests refactoring
+
+Authors
+"""""""
+
+
+* `@mahenzon`_
+
 **2.2.2**
 *********
 
@@ -14,6 +31,7 @@ Authors
 
 * `@mahenzon`_
 
+
 **2.2.1**
 *********
 
@@ -63,8 +81,8 @@ Authors
 Generic views, process relationships
 ====================================
 
-Backward-incompatible changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. note::
+    Backward-incompatible changes
 
 * Automatically create all CRUD views based on schemas (see :ref:`example <minimal_api_example>`)
 * Allow to pass Client-Generated IDs (see :ref:`example <client_generated_id>`, `JSON:API doc <https://jsonapi.org/format/#crud-creating-client-ids>`_)

docs/conf.py

@@ -64,16 +64,16 @@
 # built documents.
 #
 # The short X.Y version.
-version = "2.2"
+version = "2.3"
 # The full version, including alpha/beta/rc tags.
-release = "2.2.2"
+release = "2.3.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -133,15 +133,9 @@
 # documentation.
 #
 html_theme_options = {
-    "github_user": "mts-ai",
-    "github_repo": "FastAPI-JSONAPI",
-    "github_banner": True,
-    "show_related": True,
-    "page_width": "1080px",
-    "fixed_sidebar": True,
-    "code_font_size": "0.8em",
-    "show_nav_level": 2,
-    "navigation_depth": 2,
+    "display_version": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -170,7 +164,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

docs/fastapi-jsonapi.rst

@@ -1,16 +1,16 @@
-fastapi_jsonapi package
-==========================
+Package fastapi_jsonapi index
+=============================
 
 fastapi_jsonapi.data_layers.fields.enum module
--------------------------------------------------------
+----------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.fields.enum
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.fields.mixins module
--------------------------------------------------------
+------------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.fields.mixins
     :members:
@@ -26,23 +26,23 @@ fastapi_jsonapi.data_layers.filtering.sqlalchemy module
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.filtering.tortoise_operation module
--------------------------------------------------------
+---------------------------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.filtering.tortoise_operation
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.filtering.tortoise_orm module
--------------------------------------------------------
+---------------------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.filtering.tortoise_orm
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.sorting.sqlalchemy module
--------------------------------------------------------
+-----------------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.sorting.sqlalchemy
     :members:
@@ -58,135 +58,95 @@ fastapi_jsonapi.data_layers.sorting.tortoise_orm module
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.base module
--------------------------------------------------------
+---------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.base
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_typing module
--------------------------------------------------------
+----------------------------------
 
 .. automodule:: fastapi_jsonapi.data_typing
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.orm module
--------------------------------------------------------
+--------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.orm
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.shared module
--------------------------------------------------------
+-----------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.shared
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.sqla_orm module
--------------------------------------------------------
+-------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.sqla_orm
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.data_layers.tortoise_orm module
--------------------------------------------------------
+-----------------------------------------------
 
 .. automodule:: fastapi_jsonapi.data_layers.tortoise_orm
     :members:
     :undoc-members:
     :show-inheritance:
 
-fastapi_jsonapi.exception.base module
--------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.exception.base
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-fastapi_jsonapi.exception.json_api module
--------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.exception.json_api
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-fastapi_jsonapi.exception.base module
--------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.exception.base
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 fastapi_jsonapi.api module
--------------------------------------------------------
+--------------------------
 
 .. automodule:: fastapi_jsonapi.api
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.jsonapi_typing module
--------------------------------------------------------
+-------------------------------------
 
 .. automodule:: fastapi_jsonapi.jsonapi_typing
     :members:
     :undoc-members:
     :show-inheritance:
 
-fastapi_jsonapi.methods module
--------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.methods
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-fastapi_jsonapi.openapi module
--------------------------------------------------------
-
-.. automodule:: fastapi_jsonapi.openapi
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 fastapi_jsonapi.querystring module
--------------------------------------------------------
+----------------------------------
 
 .. automodule:: fastapi_jsonapi.querystring
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.schema module
--------------------------------------------------------
+-----------------------------
 
 .. automodule:: fastapi_jsonapi.schema
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.signature module
--------------------------------------------------------
+--------------------------------
 
 .. automodule:: fastapi_jsonapi.signature
     :members:
     :undoc-members:
     :show-inheritance:
 
 fastapi_jsonapi.splitter module
--------------------------------------------------------
+-------------------------------
 
 .. automodule:: fastapi_jsonapi.splitter
     :members: