For now, don't pay attention to the rest, only the imports:
-```Python hl_lines="6 7 8"
+```Python hl_lines="3 4 5"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
This is not required by Couchbase, but is a good practice that will help you afterwards.
-```Python hl_lines="10"
+```Python hl_lines="9"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
* Set defaults for timeouts.
* Return it.
-```Python hl_lines="13 14 15 16 17 18 19 20 21 22"
+```Python hl_lines="12 13 14 15 16 17 18 19 20 21"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
First, let's create a `User` model:
-```Python hl_lines="25 26 27 28 29"
+```Python hl_lines="24 25 26 27 28"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
We don't create it as a subclass of Pydantic's `BaseModel` but as a subclass of our own `User`, because it will have all the attributes in `User` plus a couple more:
-```Python hl_lines="32 33 34"
+```Python hl_lines="31 32 33"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
By creating a function that is only dedicated to getting your user from a `username` (or any other parameter) independent of your *path operation function*, you can more easily re-use it in multiple parts and also add <abbr title="Automated test, written in code, that checks if another piece of code is working correctly.">unit tests</abbr> for it:
-```Python hl_lines="37 38 39 40 41 42 43"
+```Python hl_lines="36 37 38 39 40 41 42"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
### Create the `FastAPI` app
-```Python hl_lines="47"
+```Python hl_lines="46"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
Also, Couchbase recommends not using a single `Bucket` object in multiple "<abbr title="A sequence of code being executed by the program, while at the same time, or at intervals, there can be others being executed too.">thread</abbr>s", so, we can get just get the bucket directly and pass it to our utility functions:
-```Python hl_lines="50 51 52 53 54"
+```Python hl_lines="49 50 51 52 53"
{!../../../docs_src/nosql_databases/tutorial001.py!}
```
from typing import Optional
-from fastapi import FastAPI
-from pydantic import BaseModel
-
from couchbase import LOCKMODE_WAIT
from couchbase.bucket import Bucket
from couchbase.cluster import Cluster, PasswordAuthenticator
+from fastapi import FastAPI
+from pydantic import BaseModel
USERPROFILE_DOC_TYPE = "userprofile"
from pydantic.typing import ForwardRef, evaluate_forwardref
except ImportError: # pragma: nocover
# TODO: remove when removing support for Pydantic < 1.0.0
+ from pydantic import Schema as FieldInfo # type: ignore
from pydantic.fields import Field as ModelField # type: ignore
from pydantic.fields import Required, Shape # type: ignore
- from pydantic import Schema as FieldInfo # type: ignore
from pydantic.schema import get_annotation_from_schema # type: ignore
from pydantic.utils import ForwardRef, evaluate_forwardref # type: ignore
from typing import Optional
from fastapi.exceptions import HTTPException
-from fastapi.openapi.models import (
- HTTPBase as HTTPBaseModel,
- HTTPBearer as HTTPBearerModel,
-)
+from fastapi.openapi.models import HTTPBase as HTTPBaseModel
+from fastapi.openapi.models import HTTPBearer as HTTPBearerModel
from fastapi.security.base import SecurityBase
from fastapi.security.utils import get_authorization_scheme_param
from pydantic import BaseModel
from typing import List, Optional
from fastapi.exceptions import HTTPException
-from fastapi.openapi.models import OAuth2 as OAuth2Model, OAuthFlows as OAuthFlowsModel
+from fastapi.openapi.models import OAuth2 as OAuth2Model
+from fastapi.openapi.models import OAuthFlows as OAuthFlowsModel
from fastapi.param_functions import Form
from fastapi.security.base import SecurityBase
from fastapi.security.utils import get_authorization_scheme_param
PYDANTIC_1 = True
except ImportError: # pragma: nocover
# TODO: remove when removing support for Pydantic < 1.0.0
- from pydantic.fields import Field as ModelField # type: ignore
from pydantic import Schema as FieldInfo # type: ignore
+ from pydantic.fields import Field as ModelField # type: ignore
class UndefinedType: # type: ignore
def __repr__(self) -> str:
"async_exit_stack",
"async_generator"
]
+
+[tool.isort]
+profile = "black"
+known_third_party = ["fastapi", "pydantic", "starlette"]
set -x
# Sort imports one per line, so autoflake can remove unused imports
-isort --recursive --force-single-line-imports --thirdparty fastapi --apply fastapi tests docs_src scripts
+isort fastapi tests docs_src scripts --force-single-line-imports
sh ./scripts/format.sh
autoflake --remove-all-unused-imports --recursive --remove-unused-variables --in-place docs_src fastapi tests scripts --exclude=__init__.py
black fastapi tests docs_src scripts
-isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width 88 --recursive --thirdparty fastapi --thirdparty pydantic --thirdparty starlette --apply fastapi tests docs_src scripts
+isort fastapi tests docs_src scripts
mypy fastapi
black fastapi tests --check
-isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width 88 --recursive --check-only --thirdparty fastapi --thirdparty fastapi --thirdparty pydantic --thirdparty starlette fastapi tests
+isort fastapi tests docs_src scripts --check-only
from fastapi.testclient import TestClient
-from additional_responses.tutorial001 import app
+from docs_src.additional_responses.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from additional_responses.tutorial002 import app
+from docs_src.additional_responses.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from additional_responses.tutorial003 import app
+from docs_src.additional_responses.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from additional_responses.tutorial004 import app
+from docs_src.additional_responses.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from additional_status_codes.tutorial001 import app
+from docs_src.additional_status_codes.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from advanced_middleware.tutorial001 import app
+from docs_src.advanced_middleware.tutorial001 import app
def test_middleware():
from fastapi.testclient import TestClient
-from advanced_middleware.tutorial002 import app
+from docs_src.advanced_middleware.tutorial002 import app
def test_middleware():
from fastapi.responses import PlainTextResponse
from fastapi.testclient import TestClient
-from advanced_middleware.tutorial003 import app
+from docs_src.advanced_middleware.tutorial003 import app
@app.get("/large")
from fastapi.testclient import TestClient
-from async_sql_databases.tutorial001 import app
+from docs_src.async_sql_databases.tutorial001 import app
openapi_schema = {
"openapi": "3.0.2",
from fastapi.testclient import TestClient
-from background_tasks.tutorial001 import app
+from docs_src.background_tasks.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from background_tasks.tutorial002 import app
+from docs_src.background_tasks.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from behind_a_proxy.tutorial001 import app
+from docs_src.behind_a_proxy.tutorial001 import app
client = TestClient(app, root_path="/api/v1")
from fastapi.testclient import TestClient
-from behind_a_proxy.tutorial002 import app
+from docs_src.behind_a_proxy.tutorial002 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from bigger_applications.app.main import app
+from docs_src.bigger_applications.app.main import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from body.tutorial001 import app
+from docs_src.body.tutorial001 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from body_fields.tutorial001 import app
+from docs_src.body_fields.tutorial001 import app
# TODO: remove when removing support for Pydantic < 1.0.0
try:
import pytest
from fastapi.testclient import TestClient
-from body_multiple_params.tutorial001 import app
+from docs_src.body_multiple_params.tutorial001 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from body_multiple_params.tutorial003 import app
+from docs_src.body_multiple_params.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from body_nested_models.tutorial009 import app
+from docs_src.body_nested_models.tutorial009 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from body_updates.tutorial001 import app
+from docs_src.body_updates.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from conditional_openapi import tutorial001
+from docs_src.conditional_openapi import tutorial001
openapi_schema = {
"openapi": "3.0.2",
import pytest
from fastapi.testclient import TestClient
-from cookie_params.tutorial001 import app
+from docs_src.cookie_params.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from cors.tutorial001 import app
+from docs_src.cors.tutorial001 import app
def test_cors():
from fastapi import Request
from fastapi.testclient import TestClient
-from custom_request_and_route.tutorial001 import app
+from docs_src.custom_request_and_route.tutorial001 import app
@app.get("/check-class")
from fastapi.testclient import TestClient
-from custom_request_and_route.tutorial002 import app
+from docs_src.custom_request_and_route.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_request_and_route.tutorial003 import app
+from docs_src.custom_request_and_route.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_response.tutorial001b import app
+from docs_src.custom_response.tutorial001b import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_response.tutorial004 import app
+from docs_src.custom_response.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_response.tutorial005 import app
+from docs_src.custom_response.tutorial005 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_response.tutorial006 import app
+from docs_src.custom_response.tutorial006 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_response.tutorial007 import app
+from docs_src.custom_response.tutorial007 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from custom_response import tutorial008
-from custom_response.tutorial008 import app
+from docs_src.custom_response import tutorial008
+from docs_src.custom_response.tutorial008 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from dependencies.tutorial001 import app
+from docs_src.dependencies.tutorial001 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from dependencies.tutorial004 import app
+from docs_src.dependencies.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from dependencies.tutorial006 import app
+from docs_src.dependencies.tutorial006 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from events.tutorial001 import app
+from docs_src.events.tutorial001 import app
openapi_schema = {
"openapi": "3.0.2",
from fastapi.testclient import TestClient
-from events.tutorial002 import app
+from docs_src.events.tutorial002 import app
openapi_schema = {
"openapi": "3.0.2",
from fastapi.testclient import TestClient
-from extending_openapi.tutorial001 import app
+from docs_src.extending_openapi.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from extra_data_types.tutorial001 import app
+from docs_src.extra_data_types.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from extra_models.tutorial003 import app
+from docs_src.extra_models.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from extra_models.tutorial004 import app
+from docs_src.extra_models.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from extra_models.tutorial005 import app
+from docs_src.extra_models.tutorial005 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from first_steps.tutorial001 import app
+from docs_src.first_steps.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from handling_errors.tutorial001 import app
+from docs_src.handling_errors.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from handling_errors.tutorial002 import app
+from docs_src.handling_errors.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from handling_errors.tutorial003 import app
+from docs_src.handling_errors.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from handling_errors.tutorial004 import app
+from docs_src.handling_errors.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from handling_errors.tutorial005 import app
+from docs_src.handling_errors.tutorial005 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from handling_errors.tutorial006 import app
+from docs_src.handling_errors.tutorial006 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from header_params.tutorial001 import app
+from docs_src.header_params.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from metadata.tutorial001 import app
+from docs_src.metadata.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from metadata.tutorial004 import app
+from docs_src.metadata.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from openapi_callbacks.tutorial001 import app, invoice_notification
+from docs_src.openapi_callbacks.tutorial001 import app, invoice_notification
client = TestClient(app)
from fastapi.testclient import TestClient
-from path_operation_advanced_configuration.tutorial001 import app
+from docs_src.path_operation_advanced_configuration.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from path_operation_advanced_configuration.tutorial002 import app
+from docs_src.path_operation_advanced_configuration.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from path_operation_advanced_configuration.tutorial003 import app
+from docs_src.path_operation_advanced_configuration.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from path_operation_advanced_configuration.tutorial004 import app
+from docs_src.path_operation_advanced_configuration.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from path_operation_configuration.tutorial005 import app
+from docs_src.path_operation_configuration.tutorial005 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from path_operation_configuration.tutorial006 import app
+from docs_src.path_operation_configuration.tutorial006 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from path_params.tutorial004 import app
+from docs_src.path_params.tutorial004 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from path_params.tutorial005 import app
+from docs_src.path_params.tutorial005 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from query_params.tutorial005 import app
+from docs_src.query_params.tutorial005 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from query_params.tutorial006 import app
+from docs_src.query_params.tutorial006 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from query_params_str_validations.tutorial010 import app
+from docs_src.query_params_str_validations.tutorial010 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from query_params_str_validations.tutorial011 import app
+from docs_src.query_params_str_validations.tutorial011 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from query_params_str_validations.tutorial012 import app
+from docs_src.query_params_str_validations.tutorial012 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from query_params_str_validations.tutorial013 import app
+from docs_src.query_params_str_validations.tutorial013 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from request_files.tutorial001 import app
+from docs_src.request_files.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from request_files.tutorial002 import app
+from docs_src.request_files.tutorial002 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from request_forms.tutorial001 import app
+from docs_src.request_forms.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from request_forms_and_files.tutorial001 import app
+from docs_src.request_forms_and_files.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_change_status_code.tutorial001 import app
+from docs_src.response_change_status_code.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_cookies.tutorial001 import app
+from docs_src.response_cookies.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_cookies.tutorial002 import app
+from docs_src.response_cookies.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_headers.tutorial001 import app
+from docs_src.response_headers.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_headers.tutorial002 import app
+from docs_src.response_headers.tutorial002 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_model.tutorial003 import app
+from docs_src.response_model.tutorial003 import app
client = TestClient(app)
import pytest
from fastapi.testclient import TestClient
-from response_model.tutorial004 import app
+from docs_src.response_model.tutorial004 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_model.tutorial005 import app
+from docs_src.response_model.tutorial005 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from response_model.tutorial006 import app
+from docs_src.response_model.tutorial006 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from security.tutorial001 import app
+from docs_src.security.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from security.tutorial003 import app
+from docs_src.security.tutorial003 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from security.tutorial005 import (
+from docs_src.security.tutorial005 import (
app,
create_access_token,
fake_users_db,
from fastapi.testclient import TestClient
from requests.auth import HTTPBasicAuth
-from security.tutorial006 import app
+from docs_src.security.tutorial006 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from settings.app02 import main, test_main
+from docs_src.settings.app02 import main, test_main
client = TestClient(main.app)
from fastapi.testclient import TestClient
-from sub_applications.tutorial001 import app
+from docs_src.sub_applications.tutorial001 import app
client = TestClient(app)
from fastapi.testclient import TestClient
-from wsgi.tutorial001 import app
+from docs_src.wsgi.tutorial001 import app
client = TestClient(app)
projects / thirdparty / fastapi / fastapi.git / commitdiff
