Python Integrated Tools

Package requirements file

Type the name of the requirements file, or click the browse button, and select the desired requirements file from the file system using the Select Path dialog.

Path to Pipenv executable

This path is required for adding a Pipenv environment to the Python project. The path can be autodetected by the system if added to the PATH environmental variable. To discover the path, follow the OS-specific pipenv installation procedure. Examples:

• C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe (Windows)

• /Users/jetbrains/.loca/bin/pipenv (macOS)

Default test runner

Select the test run/debug configuration that PyCharm will suggest every time you choose Run on the context menu of a test case.

The possible options are:

• Unittests

• pytest

• Nosetests

• Twisted Trial

Detect tests in Jupyter Notebooks

Select this checkbox if you want to include Jupyter Notebook files in the scope of unit test detection.

Docstring format

Select the format of the documentation strings to be recognized by PyCharm.

Depending on the selected docstring format, PyCharm will generate the stub documentation comments and render text in the show quick documentation:

• Plain: on pressing or Space after opening quotes, an empty stub is generated; quick documentation shows as plain text.

• reStructuredText: on pressing or Space after opening quotes, stub doc comment is generated according to reStructuredText format; the quick documentation is rendered by Docutils.

• Epytext: on pressing or Space after opening quotes, stub doc comment is generated according to the epytext format; quick documentation is rendered by epydoc.

• NumPy: on pressing or Space after opening quotes, stub doc comment is generated according to the NumPy format; the quick documentation is rendered by Napoleon and Docutils.

• Google: on pressing or Space after opening quotes, stub doc comment is generated according to Google format; the quick documentation is rendered by Napoleon and Docutils.

All types of docstrings feature:

• Proper generation of docstrings

• Updates after applying intention actions and quick-fixes

• Coding assistance

• Autocompletion for section headers

note

The information provided in the docstrings is used for code insight.

Analyze Python code in docstrings

If this checkbox is selected, PyCharm highlights the code examples and performs syntax checks and code inspections.

If this checkbox is not selected, the code fragments inside docstrings are not analyzed.

Render external documentation for stdlib.

Enables showing documentation for standard library functions from http://docs.python.org in View | Quick Documentation.

Sphinx working directory

Specify here the path to the directory that contains .rst files.

note

For recognizing custom roles, point to the directory with conf.py.

Treat .txt files as reStructuredText

If this checkbox is selected, the files with .txt extension will be highlighted same way, as the files with .rst extension.