Je suis très satisfait de ma configuration actuelle d'emacs pour Python, mais j'ai trouvé la configuration un peu délicate. Je documenterai ma configuration ici pour mon futur moi et pour tout autre Pythonista à la recherche d'une configuration Emacs solide.

Pourquoi basé sur le droit d'auteur ?

Jusqu'à présent, j'ai utilisé mypy --strict sur la ligne de commande pour tous mes besoins de vérification de type, mais mypy est assez lent même pour de très petites bases de code, et même en mode --strict, ce n'est tout simplement pas aussi aussi strict que cela puisse être. Ce n'est pas non plus un serveur de langue, comme je le souhaite pour ma configuration Emacs.

basedpyright est un fork de pyright avec d'excellentes améliorations en termes de vérification et de fiabilité. Il s'agit d'un vérificateur de type rapide et merveilleusement strict, doté en outre de bonnes capacités de peluchage.

Les seuls inconvénients que je rencontre sont qu'il ne fonctionne pas aussi bien que mypy avec les clients boto3-stubs pour AWS et qu'il utilise un # pyright non standard : ignorer les commentaires au lieu du # type standard : ignorer les commentaires, mais Je peux vivre avec ces problèmes en faveur d'une expérience de vérification de type rigoureusement stricte.

Configurer vos projets Poetry pour qu'ils fonctionnent avec basedpyright ou pyright

Si vous avez des projets existants qui utilisent la poésie, vous voudrez jouer un peu avec votre environnement virtuel.

Allez à la racine de chacun de vos projets et exécutez la commande suivante :

poetry config --local virtualenvs.in-project true

Cela créera un fichier poetry.toml s'il n'en existe pas déjà un et ajoutera un paramètre correspondant.

Cependant, cela ne déplacera pas réellement votre environnement virtuel existant. Pour que cette modification prenne effet, vous devez supprimer votre environnement virtuel existant, que vous pouvez trouver en exécutant

poetry env info --path

N'oubliez pas d'ajouter le chemin .venv à votre .gitignore et la configuration de tout autre outil que vous pourriez utiliser, comme pycodestyle, ou vous vous retrouverez avec tout un gâchis.

Ensuite, vous devez ajouter une section de configuration à votre pyproject.toml pour indiquer à basedpyright où rechercher votre environnement virtuel.

[tool.pyright]
venv=".venv"
venvPath="."

Vous pouvez également le faire dans le fichier pyrightconfig.json si, contrairement à moi, vous ne vous sentez pas déjà complètement dépassé par les fichiers de configuration des différents outils de développement Python.

Installation de basedpyright en tant que serveur de langue

Une chose très intéressante à propos de basedpyright sur pyright est qu'il construit la dépendance nodejs comme une roue, vous pouvez donc être assuré que basedpyright devrait fonctionner sur votre machine, que nodejs soit installé ou non.

Pour l'isolation, c'est généralement une bonne idée d'installer des packages Python exécutables en utilisant pipx au lieu de pip. Allons-y et faisons-le.

pipx install basedpyright

Pour un contrôle d'intégrité, envisagez d'exécuter

basedpyright --version

L'installation de basedpyright vous donne également accès à la commande basedpyright-langserver, mais celle-ci n'est pas vraiment écrite pour que les utilisateurs puissent interagir avec, donc si vous exécutezbasedpyright-langserver oubasedpyright-langserver --version ou quelque chose du genre, vous obtiendrez une trace de pile nodejs.

Configurer Emacs pour utiliser basedpyright-langserver

Je suppose qu'en tant que lecteur, vous savez comment installer les packages à partir de MELPA et avez une méthode privilégiée pour le faire. Voici tous les forfaits dont vous avez besoin :

• entreprise
• mode lsp
• lsp-pyright
• lsp-ui
• mode python

Installez-les, puis ouvrez votre ~/.emacs ou votre ~/.emacs.d/init.el et ajoutez ce qui suit :

;; lsp global settings
(add-hook 'after-init-hook 'global-company-mode)
(setq lsp-auto-guess-root t)

;; python
(require 'lsp-mode)
(setq lsp-pyright-langserver-command "basedpyright")
(add-hook 'python-mode-hook (lambda () (require 'lsp-pyright) (lsp)))

Cela devrait être tout ce dont vous avez besoin.

Un conseil général pour le débogage du mode lsp

Si vous avez l'impression d'avoir tout configuré correctement et que vous rencontrez toujours des difficultés pour obtenir le mode lsp pour trouver les packages qui devraient être disponibles dans Poetry, vous pouvez essayer d'entrer et de supprimer votre ~/.emacs.d/.lsp-session-v1. Cela aura pour effet de faire oublier à lsp-mode la racine du projet et de le forcer à la rechercher à nouveau.

Bon codage !

J'espère que cela vous a donné une bonne longueur d'avance sur votre environnement de développement Python. Si vous avez des questions, eh bien, je suis un débutant avec tout cela, et je ne peux probablement pas vous aider, mais j'envisagerai les demandes de fusion si vous avez des trucs ou astuces supplémentaires pour utiliser basedpyright avec emacs.