doomemacs/modules/lang/python/README.org

lang/python

• Description
  • Module Flags
  • Plugins
• Prerequisites
  • Language Server Protocol Support
• Features
  • Keybindings
• Configuration

Description

Adds Python support to Doom Emacs.

• Syntax checking (flycheck)
• Snippets
• Run tests (nose, pytest)
• Auto-format (black), requires :editor format

Module Flags

• +lsp Language Server Protocol support
• +pyenv Python virtual environment support via pyenv
• +conda Python virtual environment support via Conda
• +poetry Python packaging, dependency management, and virtual environment support via Poetry
• +cython Cython files support via Cython-mode

Plugins

• anaconda-mode*
• pyimport*
• py-isort*
• nose*
• python-pytest*
• pip-requirements*
• pipenv*

• :editor format

  • format-all*

• +conda

  • conda*

• +pyenv

  • pyenv*

• +poetry

  • poetry*

• +lsp and :tools lsp

  • lsp
  • lsp-python-ms*

• +cython

  • Cython-mode
  • :checkers syntax Flycheck-cython

Prerequisites

This module has no direct prerequisites. Here are some of its soft dependencies.

• To run tests inside of Emacs:

  • pip install pytest
  • pip install nose

• The :editor format module uses Black for python files

  • pip install black

• pyimport requires Python's module pyflakes:

  • pip install pyflakes

• py-isort requires isort to be installed:

  • pip install isort

• Python virtual environments install instructions at:

  • pyenv
  • Conda
  • Poetry
• pipenv requires pipenv
• cython requires Cython

Language Server Protocol Support

This module must be enabled with the +lsp flag, and the :tools lsp module must be enabled. LSP will try pyls then mspyls; the first that is available.

To use Python Language Server (pyls) install it with pip install 'python-language-server[all]'

To use mspyls, install it with M-x lsp-install-server and add this to your private config.el:

(after! lsp-python-ms
  (set-lsp-priority! 'mspyls 1))

To use pyright, install it from your shell with with npm i -g pyright.

Features

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 :editor format-all in init.el file.

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 has the following variables to set extra arguments to ipython and jupyter shells:

;; ~/.doom.d/config.el
(setq +python-ipython-repl-args '("-i" "--simple-prompt" "--no-color-info"))
(setq +python-jupyter-repl-args '("--simple-prompt"))