reactive-python · Archmonger · Dec 28, 2022 · Nov 15, 2022 · Nov 15, 2022 · Nov 15, 2022
@@ -7,5 +7,5 @@ A summary of the changes.
 Please update this checklist as you complete each item:
 
 -   [ ] Tests have been included for all bug fixes or added functionality.
--   [ ] The `changelog.rst` has been updated with any significant changes, if necessary.
+-   [ ] The changelog has been updated with any significant changes, if necessary.
 -   [ ] GitHub Issues which may be closed by this PR have been linked.
@@ -22,7 +22,17 @@ Using the following categories, list your changes in this order:
 
 ## [Unreleased]
 
--   Nothing (yet)
+### Added
+
+-   Add `options: QueryOptions` parameter to `use_query` to allow for configuration of this hook.
+
+### Changed
+
+-   By default, `use_query` will recursively prefetch all many-to-many or many-to-one relationships to prevent `SynchronousOnlyOperation` exceptions.
+
+### Removed
+
+-   `django_idom.hooks._fetch_lazy_fields` has been deleted. The equivalent replacement is `django_idom.utils.django_query_postprocessor`.
 
 ## [2.1.0] - 2022-11-01
 

@@ -30,7 +30,7 @@ You will need a file to define your [IDOM](https://github.com/idom-team/idom) co
 <!--py-header-end-->
 <!--py-code-start-->
 
-```python linenums="1"
+```python
 from idom import component, html
 
 @component
@@ -51,7 +51,7 @@ Additionally, you can pass in keyword arguments into your component function. Fo
 <!--html-header-end-->
 <!--html-code-start-->
 
-```jinja linenums="1"
+```jinja
 {% load idom %}
 <!DOCTYPE html>
 <html>

@@ -1,6 +1,6 @@
 <!--todo-model-start-->
 
-```python linenums="1"
+```python
 from django.db import models
 
 class TodoItem(models.Model):

@@ -0,0 +1,13 @@
+<!--orm-excp-start-->
+
+Due to Django's ORM design, database queries must be deferred using hooks. Otherwise, you will see a `SynchronousOnlyOperation` exception.
+
+These `SynchronousOnlyOperation` exceptions may be resolved in a future version of Django containing an asynchronous ORM. However, it is best practice to always perform ORM calls in the background via hooks.
+
+<!--orm-excp-end-->
+
+<!--orm-fetch-start-->
+
+By default, automatic recursive fetching of `ManyToMany` or `ForeignKey` fields is enabled within the default `QueryOptions.postprocessor`. This is needed to prevent `SynchronousOnlyOperation` exceptions when accessing these fields within your IDOM components.
+
+<!--orm-fetch-end-->
@@ -6,6 +6,7 @@ changelog
 async
 pre
 prefetch
+prefetching
 preloader
 whitespace
 refetch
@@ -22,3 +23,5 @@ unstyled
 py
 idom
 asgi
+postfixed
+postprocessing
@@ -8,7 +8,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
 === "components.py"
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
     from django.http import HttpResponse
     from django_idom.components import view_to_component
@@ -39,7 +39,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     | Type | Description |
     | --- | --- |
-    | `_ViewComponentConstructor` | A function that takes `request: HttpRequest | None, *args: Any, key: Key | None, **kwargs: Any` and returns an IDOM component. |
+    | `_ViewComponentConstructor` | A function that takes `request, *args, key, **kwargs` and returns an IDOM component. All parameters are directly provided to your view, besides `key` which is used by IDOM. |
 
 ??? Warning "Potential information exposure when using `compatibility = True`"
 
@@ -88,7 +88,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse
         from django.views import View
@@ -112,7 +112,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse
         from django_idom.components import view_to_component
@@ -135,7 +135,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse, HttpRequest
         from django_idom.components import view_to_component
@@ -164,7 +164,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse
         from django_idom.components import view_to_component
@@ -196,11 +196,9 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     In these scenarios, you may want to rely on best-fit parsing by setting the `strict_parsing` parameter to `False`.
 
-    Note that best-fit parsing is designed to be similar to how web browsers would handle non-standard or broken HTML.
-
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse
         from django_idom.components import view_to_component
@@ -216,7 +214,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
             )
         ```
 
-
+    _Note: Best-fit parsing is designed to be similar to how web browsers would handle non-standard or broken HTML._
 
     ---
 
@@ -226,11 +224,11 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     Any view can be rendered within compatibility mode. However, the `transforms`, `strict_parsing`, `request`, `args`, and `kwargs` arguments do not apply to compatibility mode.
 
-    Please note that by default the iframe is unstyled, and thus won't look pretty until you add some CSS.
+
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse
         from django_idom.components import view_to_component
@@ -246,6 +244,8 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
             )
         ```
 
+    _Note: By default the `compatibility` iframe is unstyled, and thus won't look pretty until you add some CSS._
+
     ---
 
     <font size="4">**`transforms`**</font>
@@ -258,7 +258,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from idom import component, html
         from django.http import HttpResponse
         from django_idom.components import view_to_component
@@ -285,7 +285,7 @@ Allows you to defer loading a CSS stylesheet until a component begins rendering.
 
 === "components.py"
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
     from django_idom.components import django_css
 
@@ -322,7 +322,7 @@ Allows you to defer loading a CSS stylesheet until a component begins rendering.
 
     Here's an example on what you should avoid doing for Django static files:
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
     from django.templatetags.static import static
 
@@ -340,7 +340,7 @@ Allows you to defer loading a CSS stylesheet until a component begins rendering.
 
     For external CSS, substitute `django_css` with `html.link`.
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
 
     @component
@@ -363,7 +363,7 @@ Allows you to defer loading JavaScript until a component begins rendering. This
 
 === "components.py"
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
     from django_idom.components import django_js
 
@@ -400,7 +400,7 @@ Allows you to defer loading JavaScript until a component begins rendering. This
 
     Here's an example on what you should avoid doing for Django static files:
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
     from django.templatetags.static import static
 
@@ -418,7 +418,7 @@ Allows you to defer loading JavaScript until a component begins rendering. This
 
     For external JavaScript, substitute `django_js` with `html.script`.
 
-    ```python linenums="1"
+    ```python
     from idom import component, html
 
     @component

@@ -14,7 +14,7 @@ This decorator can be used with or without parentheses.
 
 === "components.py"
 
-    ```python linenums="1"
+    ```python
     from django_idom.decorators import auth_required
     from django_idom.hooks import use_websocket
     from idom import component, html
@@ -48,7 +48,7 @@ This decorator can be used with or without parentheses.
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from django_idom.decorators import auth_required
         from idom import component, html
 
@@ -68,7 +68,7 @@ This decorator can be used with or without parentheses.
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from django_idom.decorators import auth_required
         from django_idom.hooks import use_websocket
         from idom import component, html
@@ -85,7 +85,7 @@ This decorator can be used with or without parentheses.
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from django_idom.decorators import auth_required
         from django_idom.hooks import use_websocket
         from idom import component, html
@@ -105,7 +105,7 @@ This decorator can be used with or without parentheses.
 
     === "models.py"
 
-        ```python linenums="1"
+        ```python
         from django.contrib.auth.models import AbstractBaseUser
 
         class CustomUserModel(AbstractBaseUser):
@@ -118,7 +118,7 @@ This decorator can be used with or without parentheses.
 
     === "components.py"
 
-        ```python linenums="1"
+        ```python
         from django_idom.decorators import auth_required
         from django_idom.hooks import use_websocket
         from idom import component, html