fix: Make default filter, sort and split_str a no-op, plus various improvements

.github/workflows/test.yml

@@ -31,11 +31,11 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ~/.local
-          key: poetry-${{ steps.setup-python.outputs.python-version }}-1.2.2-0
+          key: poetry-${{ steps.setup-python.outputs.python-version }}-1.3.2-0
 
       - uses: snok/install-poetry@v1
         with:
-          version: 1.2.2
+          version: 1.3.2
           virtualenvs-create: true
           virtualenvs-in-project: true
 
@@ -85,11 +85,11 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.local
-          key: poetry-${{ steps.setup-python.outputs.python-version }}-1.2.2-0
+          key: poetry-${{ steps.setup-python.outputs.python-version }}-1.3.2-0
 
       - uses: snok/install-poetry@v1
         with:
-          version: 1.2.2
+          version: 1.3.2
           virtualenvs-create: true
           virtualenvs-in-project: true
 

.gitignore

@@ -1,8 +1,24 @@
 *.sqlite-journal
 .DS_Store
-.coverage
 .pypirc
-coverage.xml
 dist/
 fastapi_filter.sqlite
 poetry.toml
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Unit test / coverage reports
+test-results/
+junit.xml
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+*.cover
+.hypothesis/
+.pytest_cache/

fastapi_filter/base/filter.py

@@ -14,23 +14,22 @@ class BaseFilterModel(BaseModel, extra=Extra.forbid):
 
     Provides the interface for filtering and ordering.
 
+    ## Ordering
 
-    # Ordering
-
-    ## Query string examples:
+    ### Query string examples::
 
         >>> "?order_by=-created_at"
         >>> "?order_by=created_at,updated_at"
         >>> "?order_by=+created_at,-name"
 
-    ## Limitation
+    ### Limitation
 
     Sorting doesn't support related fields, you can only use the attributes of the targeted model/collection.
     For example, you can't use `related_model__attribute`.
 
-    # Filtering
+    ## Filtering
 
-    ## Query string examples:
+    ### Query string examples::
 
         >>> "?my_field__gt=12&my_other_field=Tomato"
         >>> "?my_field__in=12,13,15&my_other_field__not_in=Tomato,Pepper"
@@ -44,7 +43,7 @@ class Constants:  # pragma: no cover
         prefix: str
 
     def filter(self, query):  # pragma: no cover
-        ...
+        return query
 
     @property
     def filtering_fields(self):
@@ -53,7 +52,7 @@ def filtering_fields(self):
         return fields.items()
 
     def sort(self, query):  # pragma: no cover
-        ...
+        return query
 
     @property
     def ordering_values(self):
@@ -68,7 +67,7 @@ def ordering_values(self):
 
     @validator("*", pre=True)
     def split_str(cls, value, field):  # pragma: no cover
-        ...
+        return value
 
     @validator("*", pre=True, allow_reuse=True, check_fields=False)
     def strip_order_by_values(cls, value, values, field):
@@ -126,10 +125,9 @@ def validate_order_by(cls, value, values, field):
 def with_prefix(prefix: str, Filter: Type[BaseFilterModel]):
     """Allow re-using existing filter under a prefix.
 
-    Example:
-        ```python
-        from pydantic import BaseModel
+    Example::
 
+        from pydantic import BaseModel
         from fastapi_filter.filter import FilterDepends
 
         class NumberFilter(BaseModel):
@@ -138,28 +136,26 @@ class NumberFilter(BaseModel):
         class MainFilter(BaseModel):
             name: str
             number_filter: Optional[Filter] = FilterDepends(with_prefix("number_filter", Filter))
-        ```
 
     As a result, you'll get the following filters:
         * name
         * number_filter__count
 
-    # Limitation
+    ## Limitation
 
     The alias generator is the last to be picked in order of prevalence. So if one of the fields has a `Query` as
     default and declares an alias already, this will be picked first and you won't get the prefix.
 
-    Example:
-        ```python
-         from pydantic import BaseModel
+    Example::
+
+        from pydantic import BaseModel
 
         class NumberFilter(BaseModel):
             count: Optional[int] = Query(default=10, alias=counter)
 
         class MainFilter(BaseModel):
             name: str
             number_filter: Optional[Filter] = FilterDepends(with_prefix("number_filter", Filter))
-        ```
 
     As a result, you'll get the following filters:
         * name

fastapi_filter/contrib/mongoengine/filter.py

@@ -8,8 +8,8 @@
 class Filter(BaseFilterModel):
     """Base filter for mongoengine related filters.
 
-    Example:
-        ```python
+    Example::
+
         class MyModel:
             id: PrimaryKey()
             name: StringField(null=True)
@@ -25,7 +25,6 @@ class MyModelFilter(Filter):
             name__ne: Optional[str]
             name__nin: Optional[list[str]]
             name__isnull: Optional[bool]
-        ```
     """
 
     def sort(self, query: QuerySet) -> QuerySet:

fastapi_filter/contrib/sqlalchemy/filter.py

@@ -36,16 +36,15 @@
 class Filter(BaseFilterModel):
     """Base filter for orm related filters.
 
-    All children must set:
-        ```python
+    All children must set::
+
         class Constants(Filter.Constants):
             model = MyModel
-        ```
 
     It can handle regular field names and Django style operators.
 
-    Example:
-        ```python
+    Example::
+
         class MyModel:
             id: PrimaryKey()
             name: StringField(nullable=True)