How do I disable missing docstring warnings at a file-level in Pylint

Question

Pylint throws errors that some of the files are missing docstrings  I try and add docstrings to each class  method and function  but it seems that Pylint also checks that files should have a docstring at the beginning of them  Can I disable this somehow  I would like to be notified of a docstring is missing inside a class  function or method  but it shouldn t be mandatory for a file to have a docstring   Is there a term for the legal jargon often found at the beginning of a proprietary source file  Any examples  I don t know whether it is a okay to post such a trivial question separately

User · Accepted Answer

It is nice for a Python module to have a docstring, explaining what the module does, what it provides, examples of how to use the classes. This is different from the comments that you often see at the beginning of a file giving the copyright and license information, which IMO should not go in the docstring (some even argue that they should disappear altogether, see e.g. Get Rid of Source Code Templates)

With Pylint 2.4 and above, you can differentiate between the various missing-docstring by using the three following sub-messages:

C0114 (missing-module-docstring)
C0115 (missing-class-docstring)
C0116 (missing-function-docstring)

So the following .pylintrc file should work:

[MASTER]
disable=
    C0114, # missing-module-docstring

For previous versions of Pylint, it does not have a separate code for the various place where docstrings can occur, so all you can do is disable C0111. The problem is that if you disable this at module scope, then it will be disabled everywhere in the module (i.e., you won't get any C line for missing function / class / method docstring. Which arguably is not nice.

So I suggest adding that small missing docstring, saying something like:

"""
high level support for doing this and that.
"""

Soon enough, you'll be finding useful things to put in there, such as providing examples of how to use the various classes / functions of the module which do not necessarily belong to the individual docstrings of the classes / functions (such as how these interact, or something like a quick start guide).

User · Answer

I found this here  You can add  quot --errors-only quot  flag for Pylint to disable warnings  To do this  go to settings  Edit the following line   quot python linting pylintArgs quot      As  quot python linting pylintArgs quot     quot --errors-only quot   And you are good to go

User · Answer

No  Pylint doesn t currently let you discriminate between doc-string warnings  However  you can use Flake8 for all Python code checking along with the doc-string extension to ignore this warning  Install the doc-string extension with pip  internally  it uses pydocstyle   pip install flake8 docstrings  You can then just use the --ignore D100 switch  For example  flake8 file py --ignore D100

User · Answer

Just put the following lines at the beginning of any file you want to disable these warnings for    pylint  disable missing-module-docstring   pylint  disable missing-class-docstring   pylint  disable missing-function-docstring

User · Answer

Ctrl   Shift   P  Then type and click on  gt  preferences configure language specific settings  and then type  quot python quot  after that  Paste the code          quot python linting pylintArgs quot               quot --load-plugins pylint django quot    quot --errors-only quot

User · Answer

I think the fix is relative easy without disabling this feature   def kos root           Return the pathname of the KOS root directory         global  kos root     if  kos root  return  kos root   All you need to do is add the triple double quotes string in every function

User · Answer

In my case  with Pylint 2 6 0  the missing docstring messages wouldn t disappear  even after explicitly disabling missing-module-docstring  missing-class-docstring and missing-function-docstring in my  pylintrc file  Finally  the following configuration worked for me   MESSAGES CONTROL   disable missing-docstring empty-docstring  Apparently  Pylint 2 6 0 still validates docstrings unless both checks are disabled

User · Answer

With Pylint 2 4 and above you can differentiate between the various missing-docstring by using the three following sub-messages   C0114  missing-module-docstring  C0115  missing-class-docstring  C0116  missing-function-docstring   So the following  pylintrc file should work   MASTER  disable      C0114    missing-module-docstring

User · Answer

Go to file  quot settings json quot  and disable the Python pydocstyle   quot python linting pydocstyleEnabled quot   false

User · Answer

Edit file  quot C  Users Your User AppData Roaming Code User settings json quot  and add these python linting pylintArgs lines at the end as shown below         quot team showWelcomeMessage quot   false       quot python dataScience sendSelectionToInteractiveWindow quot   true       quot git enableSmartCommit quot   true       quot powershell codeFormatting useCorrectCasing quot   true       quot files autoSave quot    quot onWindowChange quot        quot python linting pylintArgs quot              quot --load-plugins pylint django quot            quot --errors-only quot

User · Answer

I came looking for an answer because  as cerin said  in Django projects it is cumbersome and redundant to add module docstrings to every one of the files that Django automatically generates when creating a new application  So  as a workaround for the fact that Pylint doesn t let you specify a difference in docstring types  you can do this  pylint     py --msg-template   path    C   line 3d   column 2d    msg     grep docstring   grep -v module  You have to update the msg-template  so that when you grep you will still know the file name  This returns all the other missing-docstring types excluding modules  Then you can fix all of those errors  and afterwards just run  pylint     py --disable missing-docstring

[python] How do I disable "missing docstring" warnings at a file-level in Pylint?

Examples related to python

Examples related to pylint

Examples related to docstring