README.org

:lang python

Description

This module adds Python support to Doom Emacs.

• Syntax checking (doom-package:flycheck)
• Snippets
• Run tests (doom-package:nose, doom-package:pytest)
• Auto-format (with black, requires doom-module::editor format)
• LSP integration (mspyls, pyls, or pyright)

Maintainers

• @hlissner

Become a maintainer?

Module flags

+conda

Enable python virtual environment support via Conda.

+cython

Enable support for Cython files support.

+lsp

Enable LSP support for python-mode. Requires doom-module::tools lsp and a langserver (supports mspyls, pyls, and pyright).

+poetry

Enable Python packaging, dependency management, and virtual environment support via Poetry.

+pyenv

Enable Python virtual environment support via pyenv

+pyright

Use the pyright LSP server instead of mspyls or pyls (requires doom-module:+lsp).

+tree-sitter

Leverages tree-sitter for better syntax highlighting and structural text editing. Requires doom-module::tools tree-sitter.

Packages

• doom-package:anaconda-mode
• doom-package:conda
• doom-package:nose
• doom-package:pipenv
• doom-package:pip-requirements
• doom-package:poetry if doom-module:+poetry
• doom-package:pyenv
• doom-package:pyimport
• doom-package:py-isort
• doom-package:python-pytest
• if doom-module:+cython
  • doom-package:cython-mode
  • doom-package:flycheck-cython if doom-module::checkers syntax
• if doom-module:+lsp
  • if doom-module:+pyright
    • doom-package:lsp-pyright
  • else
    • doom-package:lsp-python-ms

Hacks

• doom-package:anaconda-mode is configured to activate when doom-package:lsp-mode (or doom-package:eglot) don’t – or fail to.

Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no hard requirements, but softly depends on:

• For this module’s supported test runners:
  • $ pip install pytest
  • $ pip install nose
• The doom-module::editor format module uses Black for python files: $ pip install black
• doom-package:pyimport requires Python’s module pyflakes: $ pip install pyflakes
• doom-package:py-isort requires isort to be installed: pip install isort
• Python virtual environments install instructions at:
  • pyenv
  • Conda
  • Poetry
  • pipenv
• cython requires Cython

Language Server Protocol Support

For LSP support the doom-module::tools lsp module must be enabled, along with this module’s doom-module:+lsp flag. By default, it supports doom-package:mspyls and doom-package:pyls, in that order. With the doom-module:+pyright flag, it will try Pyright first.

Each of these servers must be installed on your system via your OS package manager or manually:

• *pyls* can be installed with $ pip install python-language-server[all].
• mspyls can be installed by typing M-x lsp-install-server RET mspyls.
• pyright can be installed with $ pip install pyright or $ npm i -g pyright.

Usage

🔨 This module’s usage documentation is incomplete. Complete it?

This module supports LSP. It requires installation of Python Language Server, Microsoft Language Server, or pyright, see LSP Support.

To enable support for auto-formatting with black enable doom-module::editor format.

Keybindings

Binding	Description
<localleader> c c	Compile Cython buffer
<localleader> i i	Insert mising imports
<localleader> i r	Remove unused imports
<localleader> i s	Sort imports
<localleader> i o	Optimize imports
<localleader> t r	nosetests-again
<localleader> t a	nosetests-all
<localleader> t s	nosetests-one
<localleader> t v	nosetests-module
<localleader> t A	nosetests-pdb-all
<localleader> t O	nosetests-pdb-one
<localleader> t V	nosetests-pdb-module
<localleader> t f	python-pytest-file
<localleader> t k	python-pytest-file-dwim
<localleader> t t	python-pytest-function
<localleader> t m	python-pytest-function-dwim
<localleader> t r	python-pytest-repeat
<localleader> t p	python-pytest-popup
<localleader> g d	anaconda-mode-find-definitions
<localleader> g h	anaconda-mode-show-doc
<localleader> g a	anaconda-mode-find-assignments
<localleader> g f	anaconda-mode-find-file
<localleader> g u	anaconda-mode-find-references

Configuration

🔨 This module’s configuration documentation is incomplete. Complete it?

This module has the following variables to set extra arguments to ipython and jupyter shells:

;; in $DOOMDIR/config.el
(setq +python-ipython-repl-args '("-i" "--simple-prompt" "--no-color-info"))
(setq +python-jupyter-repl-args '("--simple-prompt"))

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

Appendix

🔨 This module has no appendix yet. Write one?