Python Docstring Formatter

Ian Sanders

|
5,765 installs
|
7,334 downloads
| (1) | Free
Format docstrings in Python using PEP 257 standards.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Python Docstring Formatter Extension

Simple extension that implements docformatter as a native VSCode formatter. The formatter uses PEP 257 as a guide.

Features

See https://pypi.org/project/docformatter/ for the full feature list. This extension uses that project as a backend with few modifications.

All relevant flags are implemented as extension settings.

How to Use

If you already have a Python formatting extension installed, you will need to pick this one when you want to format a file. In a Python file in VSCode, ctrl+shift+p to open the command pallette, run the command Format Document With... and select Python Docstring Formatter.

Note: The Python Docstring Formatter option will only appear for saved files, not unsaved files, even if the unsaved files are in Python language mode.

Requirements

This extension requires pip and/or the docformatter module to be installed. Upon activating, the extension will automatically give the option to run pip install --upgrade docformatter if necessary. If you prefer to install the formatter program in another way, you may do so. Just make sure that the docformatter command is recognized by your terminal.

Extension Settings

All relevant flags from the original docformatter program are implemented as settings:

  • docstringFormatter.wrapSummariesLength (number, default 79): Wrap long summary lines at this length; set to 0 to disable wrapping.
  • docstringFormatter.wrapDescriptionsLength (number, default 72): Wrap descriptions at this length; set to 0 to disable wrapping.
  • docstringFormatter.preSummaryNewline (boolean, default false): Add a newline before the summary of a multi-line docstring.
  • docstringFormatter.makeSummaryMultiline (boolean, default false): Add a newline before and after the summary of a one-line docstring.
  • docstringFormatter.forceWrap (boolean, default false): Force descriptions to be wrapped even if it may result in a mess.

Release Notes

See CHANGELOG.md for release notes.