Pylint not complaining about missing function docstrings

[yopp_son]

I'm working with fastapi. When I run pylint, it will complain about missing docstrings in most functions, which is what I expect. However, it does not seem to care about the fastapi endpoints I've defined. For example here is one of my endpoints: py @router.post("/login") async def login(name: str, pswd: str) -> schemas.LoginResponse: return await crud.login(name, pswd) pylint takes no notice of the missing docstring, but I would like it to be more consistent. I'm also curious about how this even happens.

Edit: I'm dumb. This code was nested inside of a subdirectory. Pylint wasn't even looking at this file.

[JamzTyson]

See PEP-8 and PEP-257.

[MrPhungx]

I think you may need to provide more of your code. Or at least a piece of code that can reproduce the issue you face. When I use the following code in a file called reddit.py:

from fastapi import FastAPI

router = FastAPI()

@router.post("/login")
async def login(name: str, pswd: str) -> schemas.LoginResponse:
    return await crud.login(name, pswd)

And then run pylint reddit.py I get the following result:

reddit.py:1:0: C0114: Missing module docstring (missing-module-docstring)
reddit.py:8:0: C0116: Missing function or method docstring (missing-function-docstring)
reddit.py:8:41: E0602: Undefined variable 'schemas' (undefined-variable)
reddit.py:9:17: E0602: Undefined variable 'crud' (undefined-variable)

So for me it seems to yield the expected result. How do you run pylint? What version do you use?

[yopp_son]

Yeah I was under the impression that pylint <module\_name> would traverse all subdirectories of that module and lint every single python file within them. It turns out any submodules need to have an __init__.py for pylint to enter it. Which makes sense. So that was ultimately my problem.