The following issues were found

docs_src/app_testing/main.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def read_main():
    return {"msg": "Hello World"}

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def read_main():
    return {"msg": "Hello World"}

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.get("/")
async def read_main():
    return {"msg": "Hello World"}

            

Reported by Pylint.

docs_src/using_request_directly/tutorial001.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI, Request

app = FastAPI()


@app.get("/items/{item_id}")
def read_root(item_id: str, request: Request):
    client_host = request.client.host
    return {"client_host": client_host, "item_id": item_id}

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI, Request

app = FastAPI()


@app.get("/items/{item_id}")
def read_root(item_id: str, request: Request):
    client_host = request.client.host
    return {"client_host": client_host, "item_id": item_id}

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.get("/items/{item_id}")
def read_root(item_id: str, request: Request):
    client_host = request.client.host
    return {"client_host": client_host, "item_id": item_id}

            

Reported by Pylint.

docs_src/metadata/tutorial003.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url=None)


@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI(docs_url="/documentation", redoc_url=None)


@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.get("/items/")
async def read_items():
    return [{"name": "Foo"}]

            

Reported by Pylint.

docs_src/response_status_code/tutorial002.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI, status

app = FastAPI()


@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI, status

app = FastAPI()


@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

            

Reported by Pylint.

docs_src/middleware/tutorial001.py
3 issues
Unable to import 'fastapi'
Error

Line: 3 Column: 1

              import time

from fastapi import FastAPI, Request

app = FastAPI()


@app.middleware("http")
async def add_process_time_header(request: Request, call_next):

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              import time

from fastapi import FastAPI, Request

app = FastAPI()


@app.middleware("http")
async def add_process_time_header(request: Request, call_next):

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 9 Column: 1

              

@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
    start_time = time.time()
    response = await call_next(request)
    process_time = time.time() - start_time
    response.headers["X-Process-Time"] = str(process_time)
    return response

            

Reported by Pylint.

docs_src/path_operation_advanced_configuration/tutorial001.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", operation_id="some_specific_id_you_define")
async def read_items():
    return [{"item_id": "Foo"}]

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", operation_id="some_specific_id_you_define")
async def read_items():
    return [{"item_id": "Foo"}]

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.get("/items/", operation_id="some_specific_id_you_define")
async def read_items():
    return [{"item_id": "Foo"}]

            

Reported by Pylint.

docs_src/static_files/tutorial001.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

app.mount("/static", StaticFiles(directory="static"), name="static")

            

Reported by Pylint.

Unable to import 'fastapi.staticfiles'
Error

Line: 2 Column: 1

              from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

app.mount("/static", StaticFiles(directory="static"), name="static")

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

app.mount("/static", StaticFiles(directory="static"), name="static")

            

Reported by Pylint.

docs_src/response_cookies/tutorial002.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI, Response

app = FastAPI()


@app.post("/cookie-and-object/")
def create_cookie(response: Response):
    response.set_cookie(key="fakesession", value="fake-cookie-session-value")
    return {"message": "Come to the dark side, we have cookies"}

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI, Response

app = FastAPI()


@app.post("/cookie-and-object/")
def create_cookie(response: Response):
    response.set_cookie(key="fakesession", value="fake-cookie-session-value")
    return {"message": "Come to the dark side, we have cookies"}

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.post("/cookie-and-object/")
def create_cookie(response: Response):
    response.set_cookie(key="fakesession", value="fake-cookie-session-value")
    return {"message": "Come to the dark side, we have cookies"}

            

Reported by Pylint.

docs_src/path_operation_advanced_configuration/tutorial003.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", include_in_schema=False)
async def read_items():
    return [{"item_id": "Foo"}]

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", include_in_schema=False)
async def read_items():
    return [{"item_id": "Foo"}]

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.get("/items/", include_in_schema=False)
async def read_items():
    return [{"item_id": "Foo"}]

            

Reported by Pylint.

docs_src/path_operation_advanced_configuration/tutorial005.py
3 issues
Unable to import 'fastapi'
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", openapi_extra={"x-aperture-labs-portal": "blue"})
async def read_items():
    return [{"item_id": "portal-gun"}]

            

Reported by Pylint.

Missing module docstring
Error

Line: 1 Column: 1

              from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", openapi_extra={"x-aperture-labs-portal": "blue"})
async def read_items():
    return [{"item_id": "portal-gun"}]

            

Reported by Pylint.

Missing function or method docstring
Error

Line: 7 Column: 1

              

@app.get("/items/", openapi_extra={"x-aperture-labs-portal": "blue"})
async def read_items():
    return [{"item_id": "portal-gun"}]

            

Reported by Pylint.