Sublime text3 へ Python のリンターをインストールする

6309 ワード
Python3 Mac SublimeText3 Mac テキストリンク

前略

どうも私です。
最近、Kindle で『月刊少女野崎くん』を全巻買いました。
その前は気づいたら『魔法使いの嫁』を全巻買っていました。
炬燵と Kindle と部屋と Sublime text3 と私。どうも散財気味な気がします。

現在、のんびりと Sublime text3 で Python の開発環境を整えている最中です。
リンター周りを整備しようと思ったので自身の備忘録がてら記事にしました。

どなたかの参考になれれば幸いです。

環境

  • macOS Sierra 10.12.6
  • Python 3.6.2

この記事でわかること

  • Sublime text3 でインストール可能なリンタープラグイン。
  • Sublime text3 にリンタープラグインをインストールする方法。

この記事では説明しないこと

  • インストールする上で "Package Control" と "pip コマンド" を使用します。
  • ですが、それぞれのインストール方法についてはこの記事では扱いません。

注意点

  • 2017/12/12 段階の情報です。

sublime text3 でインストール可能なリンタープラグイン

PEP8

  • 例の有名な python のコーディングスタイルガイドです。
  • 公式に触れたい方は"参考リンク"にありますのでどうぞどうぞ。
  • Sublime​Linter-pep​8 からインストール可能です。

PEP258

  • docstring に関するコーディングスタイルガイドです。
  • docstring とは「モジュールやファンクションやクラスやメソッドの最初に出てくる文」のことらしいです。
  • 公式に触れたい方は"参考リンク"にありますのでどうぞどうぞ。
  • Sublime​Linter-pydocstyle からインストール可能です。

PyFlakes

  • スタイルに対するチェックではなくファイル内のエラー等をチェックしてくれます。
  • 例えば、 未使用のモジュールや未使用の変数について注意してくれたりします。
  • Sublime​Linter-pyflakes からインストール可能です。

Flake8

  • 公式を読む限り flake8 は pep8 と PyFlakes と McCabe をラップしたものです。
  • SublimeLinter-flake8 からインストール可能です。

Pylint

  • コーディングスタイルガイドからエラーチェック、コードの品質評価まで行なってくれます。
  • 多分この子が一番厳しいと思います
  • Sublime​Linter-pylint からインストール可能です。

Sublime text3 にリンターをインストールする方法

  • ざっくりと流れを先に説明してしまうと以下の通りです。
    1. リンター用のフレームワークプラグインのインストール
    2. 各種リンタープラグインをお好みでインストール
    3. 自身の環境に pip コマンドを使用して対応するリンターのパッケージをインストール
    4. Sublime text3 の再起動

1. リンター用のフレームワークプラグインのインストール

  • SublimeLinter をインストールしましょう。
  • command + shift + pでコンソールを出して "Package Control: install Package" で "SublimeLinter" をインストールしましょう。
  • あとはいつもの Package Control の操作通りです。

2. 各種リンタープラグインをお好みでインストール

  • お好みのリンタープラグインを組み合わせて入れてしまえば問題ありません。
  • command + shift + pでコンソールを出して "Package Control: install Package" でインストールしたいリンターを検索しましょう。
  • あとはいつもの Package Control の操作通りです。

3. 自身の環境に pip コマンドを使用して対応するリンター用のパッケージをインストール

  • Sublime text3 のプラグインと python 側のパッケージの対応は下記の通りです。
  • インストール用のコマンドも一応記載しておきますが公式にもちゃんと記載があります。
  • うまくいかない場合は公式に回帰する方が良いと思われます。
### Sublime​Linter-pep​8 : pep8
$pip install pep8


### Sublime​Linter-pydocstyle : pydocstyle
$pip install pydocstyle


### Sublime​Linter-pyflakes : pyflakes
$pip install pyflakes


### SublimeLinter-flake8 : flake8
$pip install flake8


### Sublime​Linter-pylint : pylint
$pip install pylint

4. Sublime text3 の再起動

  • 現在開いている Sublime text3 を一度閉じて開き直せば OK です。
  • 以下のような感じでチェックが入るようになります。

個人的な設定...

  • 私自身は以下の2点を現在使用しております。
    • Sublime​Linter-pydocstyle
    • SublimeLinter-flake8

参考リンク