6bd38e2c4d
Because of the python dev's propensity to use env managers, setting the
pyright executable globally doesn't make much sense, and could in fact
end up intrusively overriding a user's local settings.
A better approach may be to introduce an envvar here that can be set
from external .envrc or venv config files, or making
`lsp-pyright-langserver-command` a safe file-local variable (so it can
be set from .dir-locals.el or in the file-local variables of a python
file), but if I decide to do one or the other, I'd like to be consistent
about it across all python executables/external dependencies (and
possibly even to all :lang modules that depend on env managers), so I'll
defer implementing that until I have the time to give it more thought
and plan it better.
Amend: 1fa1eba5ac
:lang python
Description unfold
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 (
pyls,jedi,ruff,pyright, orbasedpyright)
Maintainers
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 (pyls,jedi,ruff, orpyright). - +poetry
- Enable Python packaging, dependency management, and virtual environment support via Poetry.
- +pyenv
- Enable Python virtual environment support via pyenv
- +pyright
- Add support for the pyright LSP server (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
-
- doom-package:cython-mode
- doom-package:flycheck-cython if doom-module::checkers syntax
Hacks
- doom-package:anaconda-mode is configured to activate when doom-package:lsp-mode (or doom-package:eglot) don't – or fail to.
TODO 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:
cythonrequires 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.
An alternative LSP server can be used by installing them through the lsp-install-server command, or an external package manager. For example:
- To install basedpyright:
$ pip install basedpyright - To install pyright:
$ pip install pyrightor$ npm i -g pyright. - To install pyls:
$ pip install python-language-server[all]. - To install mspyls:
M-x lsp-install-server RET mspyls.
Formatter
Formatting is handled using the doom-module::editor format module via black.
TODO 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 missing 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 |
TODO Configuration
This module's configuration documentation is incomplete. Complete it?
The arguments passed to the ipython or jupyter shells can be altered through these two variables:
;; 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?
TODO Appendix
This module has no appendix yet. Write one?