docsig

Posted:
Edited:

Check signature params for proper documentation in your Python code

Supports reStructuredText ( Sphinx ), NumPy , and Google

Code | PyPI | Docs | pre-commit

Find docsig source, docsig releases, docsig documentation, and docsig pre-commit hook

Contributing

If you are interested in contributing to docsig please read about contributing here

Installation 

$ pip install docsig

Usage

Commandline 

usage: docsig [-h] [-v] [-l] [-c | -C] [-D] [-m] [-o] [-p] [-P] [-i] [-a] [-k]
                         [-n] [-S] [-s STR] [-d LIST] [-t LIST]
                         [path [path ...]]

Check signature params for proper documentation

positional arguments:
  path                                 directories or files to check

optional arguments:
  -h, --help                           show this help message and exit
  -v, --version                        show program's version number and exit
  -l, --list-checks                    display a list of all checks and their messages
  -c, --check-class                    check class docstrings
  -C, --check-class-constructor        check __init__ methods. Note: mutually
                                       incompatible with -c
  -D, --check-dunders                  check dunder methods
  -m, --check-protected-class-methods  check public methods belonging to protected
                                       classes
  -o, --check-overridden               check overridden methods
  -p, --check-protected                check protected functions and classes
  -P, --check-property-returns         check property return values
  -i, --ignore-no-params               ignore docstrings where parameters are not
                                       documented
  -a, --ignore-args                    ignore args prefixed with an asterisk
  -k, --ignore-kwargs                  ignore kwargs prefixed with two asterisks
  -n, --no-ansi                        disable ansi output
  -S, --summary                        print a summarised report
  -s STR, --string STR                 string to parse instead of files
  -d LIST, --disable LIST              comma separated list of rules to disable
  -t LIST, --target LIST               comma separated list of rules to target

Options can also be configured with the pyproject.toml file

If you find the output is too verbose then the report can be configured to display a summary 

[tool.docsig]
check-dunders = false
check-overridden = false
check-protected = false
summary = true
disable = [
    "E101",
    "E102",
    "E103",
]
target = [
    "E102",
    "E103",
    "E104",
]

API 

>>> from docsig import docsig

>>> string = """
... def function(param1, param2, param3) -> None:
...     '''
...
...     :param param1: About param1.
...     :param param2: About param2.
...     :param param3: About param3.
...     '''
...     """
>>> docsig(string=string)
0

>>> string = """
... def function(param1, param2) -> None:
...     '''
...
...     :param param1: About param1.
...     :param param2: About param2.
...     :param param3: About param3.
...     '''
... """
>>> docsig(string=string)
2
-
def function(✓param1, ✓param2, ✖None) -> ✓None:
    """
    :param param1: ✓
    :param param2: ✓
    :param param3: ✖
    """
<BLANKLINE>
E102: includes parameters that do not exist (params-do-not-exist)
<BLANKLINE>
1

A full list of checks can be found here

Message Control

To control checks docsig accepts disable and enable directives

To disable individual function checks add an inline comment similar to the example below 

>>> string = """
... def function_1(param1, param2, param3) -> None:  # docsig: disable
...     '''
...
...     :param param2: Fails.
...     :param param3: Fails.
...     :param param1: Fails.
...     '''
...
... def function_2(param1, param2) -> None:
...     '''
...
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
...
... def function_3(param1, param2, param3) -> None:
...     '''
...
...     :param param1: Fails.
...     :param param2: Fails.
...     '''
... """
>>> docsig(string=string)
10
--
def function_2(✓param1, ✓param2, ✖None) -> ✓None:
    """
    :param param1: ✓
    :param param2: ✓
    :param param3: ✖
    """
<BLANKLINE>
E102: includes parameters that do not exist (params-do-not-exist)
<BLANKLINE>
18
--
def function_3(✓param1, ✓param2, ✖param3) -> ✓None:
    """
    :param param1: ✓
    :param param2: ✓
    :param None: ✖
    """
<BLANKLINE>
E103: parameters missing (params-missing)
<BLANKLINE>
1

To disable all function checks add a module level comment similar to the example below 

>>> string = """
... # docsig: disable
... def function_1(param1, param2, param3) -> None:
...     '''
...
...     :param param2: Fails.
...     :param param3: Fails.
...     :param param1: Fails.
...     '''
...
... def function_2(param1, param2) -> None:
...     '''
...
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
...
... def function_3(param1, param2, param3) -> None:
...     '''
...
...     :param param1: Fails.
...     :param param2: Fails.
...     '''
... """
>>> docsig(string=string)
0

To disable multiple function checks add a module level disable and enable comment similar to the example below 

>>> string = """
... # docsig: disable
... def function_1(param1, param2, param3) -> None:
...     '''
...
...     :param param2: Fails.
...     :param param3: Fails.
...     :param param1: Fails.
...     '''
...
... def function_2(param1, param2) -> None:
...     '''
...
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
... # docsig: enable
...
... def function_3(param1, param2, param3) -> None:
...     '''
...
...     :param param1: Fails.
...     :param param2: Fails.
...     '''
... """
>>> docsig(string=string)
20
--
def function_3(✓param1, ✓param2, ✖param3) -> ✓None:
    """
    :param param1: ✓
    :param param2: ✓
    :param None: ✖
    """
<BLANKLINE>
E103: parameters missing (params-missing)
<BLANKLINE>
1

The same can be done for disabling individual rules 

>>> string = """
... # docsig: disable=E101
... def function_1(param1, param2, param3) -> int:
...     '''E105.
...
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
...
... def function_2(param1, param2, param3) -> None:  # docsig: disable=E102,E106
...     '''E101,E102,E106.
...
...     :param param1: Fails.
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
...
... def function_3(param1, param2, param3) -> None:
...     '''E101,E102,E106,E107.
...
...     :param param1: Fails.
...     :param param1: Fails.
...     :param param2: Fails.
...     :param: Fails.
...     '''
... """
>>> docsig(string=string)
3
-
def function_1(✓param1, ✓param2, ✓param3) -> ✖int:
    """
    :param param1: ✓
    :param param2: ✓
    :param param3: ✓
    :return: ✖
    """
<BLANKLINE>
E105: return missing from docstring (return-missing)
<BLANKLINE>
20
--
def function_3(✓param1, ✖param2, ✖param3, ✖None) -> ✓None:
    """
    :param param1: ✓
    :param param1: ✖
    :param param2: ✖
    :param None: ✖
    """
<BLANKLINE>
E102: includes parameters that do not exist (params-do-not-exist)
E106: duplicate parameters found (duplicate-params-found)
E107: parameter appears to be incorrectly documented (param-incorrectly-documented)
<BLANKLINE>
1

Individual rules can also be re-enabled

Module level directives will be evaluated separately to inline directives and providing no rules will disable and enable all rules 

>>> string = """
... # docsig: disable
... def function_1(param1, param2, param3) -> int:
...     '''E105.
...
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
...
... def function_2(param1, param2, param3) -> None:  # docsig: enable=E102,E106
...     '''E101,E102,E106.
...
...     :param param1: Fails.
...     :param param1: Fails.
...     :param param2: Fails.
...     :param param3: Fails.
...     '''
...
... def function_3(param1, param2, param3) -> None:
...     '''E101,E102,E106,E107.
...
...     :param param1: Fails.
...     :param param1: Fails.
...     :param param2: Fails.
...     :param: Fails.
...     '''
... """
>>> docsig(string=string)
11
--
def function_2(✓param1, ✖param2, ✖param3, ✖None) -> ✓None:
    """
    :param param1: ✓
    :param param1: ✖
    :param param2: ✖
    :param param3: ✖
    """
<BLANKLINE>
E102: includes parameters that do not exist (params-do-not-exist)
E106: duplicate parameters found (duplicate-params-found)
<BLANKLINE>
1

Classes

Checking a class docstring is not enabled by default, as there are two mutually exclusive choices to choose from.

This check will either check the documentation of __init__ , or check documentation of __init__ under the class docstring, and not under __init__ itself 

>>> string = """
... class Klass:
...     def __init__(self, param1, param2) -> None:
...         '''
...
...         :param param1: About param1.
...         :param param2: About param2.
...         :param param3: About param3.
...         '''
... """
>>> docsig(string=string, check_class_constructor=True)
3 in Klass
----------
class Klass:
    """
    :param param1: ✓
    :param param2: ✓
    :param param3: ✖
    """
<BLANKLINE>
    def __init__(✓param1, ✓param2, ✖None) -> ✓None:
<BLANKLINE>
E102: includes parameters that do not exist (params-do-not-exist)
<BLANKLINE>
1

>>> string = """
... class Klass:
...     '''
...
...     :param param1: About param1.
...     :param param2: About param2.
...     :param param3: About param3.
...     '''
...     def __init__(self, param1, param2) -> None:
...         pass
... """
>>> docsig(string=string, check_class=True)
9 in Klass
----------
class Klass:
    """
    :param param1: ✓
    :param param2: ✓
    :param param3: ✖
    """
<BLANKLINE>
    def __init__(✓param1, ✓param2, ✖None) -> ✓None:
<BLANKLINE>
E102: includes parameters that do not exist (params-do-not-exist)
<BLANKLINE>
1

Checking class docstrings can be permanently enabled in the pyproject.toml file 

[tool.docsig]
check-class-constructor = true

Or 

[tool.docsig]
check-class = true

pre-commit

docsig can be used as a pre-commit hook

It can be added to your .pre-commit-config.yaml as follows: 

repos:
  - repo: https://github.com/jshwi/docsig
    rev: v0.44.1
    hooks:
      - id: docsig
        args:
          - "--check-class"
          - "--check-dunders"
          - "--check-overridden"
          - "--check-protected"
          - "--summary"