Emacs の Python の開発環境をググってみたけれど、自分向けの記事がなかったので自分向けの環境を自分で作ったという記事です。

前提

$ brew cask install emacs

やること

目標は自分が VSCode を使うときに利用している機能はすべて Emacs でも行えるようにすること。

よく知らないけど Language Server Protocol ってやつでなんとかなるんじゃないかな、と思ったので、 LSP を試すことにした。

base 環境で下記コマンドを実行した。今回はコードフォーマッタに black も利用してみたかったので、pyls-black もインストールしている。

pip install python-language-server
pip install pyls-black

次のパッケージを使う

なおわたしはパッケージマネージャは package.el を利用し、パッケージの設定には use-package を使っていて、コード補完には company を使っている。

Python の Language Server を使うために Emacs の lsp-mode を使う。eglot という別の実装もあるようだが、わたしは調査をしきれていない。

https://github.com/emacs-lsp/lsp-mode#installation などを参考に、 lsp-mode や lsp-ui, company-lsp の3つをインストール。下記のような設定をする。

(use-package lsp-mode
  :commands lsp)
(use-package company-lsp)
(use-package lsp-ui
  :config
  (add-hook 'lsp-mode-hook 'lsp-ui-mode))

(use-package company
  :config
  (global-company-mode)
  (push 'company-lsp company-backends))

lsp-mode が python-mode で有効になるように hook を設定する。

(use-package python-mode
  :config
  (add-hook 'python-mode-hook #'lsp))

conda の仮想環境を Emacs から activate するために用いる。 M-x package-install RET conda をし、

(use-package conda
   :init
   (custom-set-variables '(conda-anaconda-home "~/miniconda3")))

などと書くと設定完了。

若干手動操作が多いが、

が実現できた。

lsp についてよく知らなかったけれど、かなりカバー範囲が広いようだということがわかった。コード補完のみならず、lint や format、ドキュメントの表示までもカバー範囲のようだ。

定義ジャンプがこの設定ではできないようなのだけど、わたしの設定が足りないのか否かはわかっていない。ただ大きなプロジェクトを Emacs で開発するモチベーションは現段階では湧いていないのでそのときは素直に VSCode を使おうと思う。

参考になるかはわからないけれど、わたしの Emacs の設定。