Pythonの静的解析ツールisortを使ってみよう

https://gyazo.com/c8883d3826d33871a05fc96fc8012721

isortについて

重要度が低いと思われるかもしれませんが、コードを書く人による「揺らぎ」のないコードになることは重要です。

変換前：

code: python

from my_lib import Object

import os

from my_lib import Object3

from my_lib import Object2

import sys

from third_party import lib15, lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8, lib9, lib10, lib11, lib12, lib13, lib14

import sys

from __future__ import absolute_import

from third_party import lib3

print("Hey")

print("yo")

変換後：

code: python

from __future__ import absolute_import

import os

import sys

from third_party import (lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8,

lib9, lib10, lib11, lib12, lib13, lib14, lib15)

from my_lib import Object, Object2, Object3

print("Hey")

print("yo")

インストール

isort は pip コマンドでインストールすることができます。

code: bash

$ pip install isort

code: bash

isortをPipfileに対応させてインストールします。

code: bash

両方のフォーマットをサポートしたisortをインストールします。

code: bash

コマンドラインから使用する

特定のファイルに対して実行するためには、次のように isort を実行します。

code: bash

$ isort mypythonfile.py mypythonfile2.py

ディレクトリを指定すると、そのディレクトリ以下に再帰的に適用されます。

code: bash

$ isort .

code: bash

$ isort **/*.py

code: bash

$ isort --diff mypythonfile.py

最後に、isortをプロジェクトに対してアトミックに実行し、シンタックスエラーが発生しない場合にのみ変更を適用します。

code: bash

$ isort --atomic .

code: bash

% isort --help

(以下略)

Pythonスクリプトの中から実行する

isort は python スクリプトの中から呼び出して実行することもできます。

code: python

import isort

isort.file("pythonfile.py")

もしくは次のように実行します。

code: python

import isort

sorted_code = isort.code("import b\nimport a\n")

テキストエディタkへのisortのインストール

マルチライン出力モード

"multi_line_output"という設定があります。この設定は、インポートデータが行数制限を超えたときに、どのように折り返すかを定義するもので、12種類の設定が可能です。

インデント

インデントの表示方法を変更するには、インデントのプロパティを以下のフォーマットで変更します。

スペースの数：4は、標準的な4スペースのインデントになります。

タブ

引用符で囲まれたそのままの文字列

例えば、以下のようになります。

code: python

" "

は4に相当します。

複数行のインポートをインテリジェントにバランスする

isort 3.1.0 では、バランスのとれた複数行のインポートをサポートしています。この機能を有効にすると、 isort はインポートの長さを動的に変更し、最もバランスの取れたグリッドを作成しますが、 定義された最大インポート長には達しません。

例えば、変換例をみてみあしょう。

変換前：

code: python

from __future__ import (absolute_import, division,

print_function, unicode_literals)

変換後：

code: python

from __future__ import (absolute_import, division, print_function,

unicode_literals)

カスタムセクションとオーダー

isort には、インポートファイルの構成、順序、セクションでのまとめ方など、ほぼすべての面で変更できる設定オプションがあります。

これらのオプションの概要はこちらをご覧ください。

インポートの処理をスキップする (設定外)

code: python

import module # isort:skip

code: python

from xyz import (abc, # isort:skip

yo,

hey)

isort がファイル全体をスキップするには、モジュールの doc 文字列に isort:skip_file を追加します。

code: python

""" my_module.py

Best module ever

isort:skip_file

"""

import b

import a

アクションコメント

一つのファイルの中でisortの流れを設定する最も基本的な方法は、アクションコメントです。これらのコメントは、isort パーサーが解析時に読み取って解釈します。

isort: skip_file

isortにファイル全体をスキップするように指示します。

使用例

code: python

# !/bin/python3

# isort: skip_file

import os

import sys

...

これは、ファイルの中でできるだけ高い位置に配置する必要があります。isort はストリーミングアーキテクチャを採用しているので、 コメントに到達する前に既に作業が完了していることがあります。通常、これは問題ありませんが、 --diff やコマンドラインからの対話型オプションを使用している場合には、 混乱する可能性があります。

isort: skip

isort が import 文と同じ行に置かれた場合 (または import 文の続きに置かれた場合)、 isort はその import をソートしません。具体的には、isort が import 文を import として認識しないようにします。その結果、この行はコードとして扱われ、ファイルの import セクションの下に押し込まれます。

使用例

code: python

import b

import a # isort: skip <- this will now stay below b

isort: off

使用例

code: python

import e

import f

# isort: off

import b

import a

isort: on

使用例

code: python

import e

import f

# isort: off

import b

import a

# isort: on

import c

import d

isort: split

isortに、現在のソートセクションが終了し、今後のインポートはすべて新しいソートグループに属することを伝えます。

使用例

code: python

import e

import f

# isort: split

import a

import b

import c

import d

また、インラインで使用することで、あるインポートが上下のインポートと位置を入れ替えることを防ぐことができます。

code: python

import c

import b # isort: split

import a

isort: dont-add-imports

isort: dont-add-imports: IMPORT_LINE

複数のファイルからインポートを追加・削除する

isortは、インポートを自動的に追加/削除するように実行または設定することができます。

複数ファイルへのインポートの追加

isort では、インポートが正しく配置されていることを確認しながら、複数のファイルにインポートステートメントを簡単に追加することができます。

すべてのファイルにインポートを追加するには

code: bash

$ isort -a "from __future__ import print_function" *.py

すでにインポートがあるファイルにのみインポートを追加する場合。

code: bash

$ isort -a "from __future__ import print_function" --append-only *.py

複数のファイルからインポートを削除する

isortでは、元々のフォーマットを気にすることなく、複数のファイルからインポートを簡単に削除することができます。

コマンドラインから次のように実行する場合。

code: bash

$ isort --rm "os.system" *.py

black との互換性

Black との互換性は isort プロジェクトにとって非常に重要であり、バージョン 5 から組み込まれています。isortをblackと一緒に使うために必要なのは、isortのプロファイルを "black "に設定することだけです。

ヒント：プロファイル以外にも、skip_gitignore (isort は git のインストールが必要なのでデフォルトでは有効ではありません) や line_length を設定するのが一般的です。これは black のデフォルトである 88 から逸脱するためです。

コマンドライン

code: bash

$ isort --profile black *.py

code: .travis.yml

language: python

python:

- "3.6"

- "3.7"

- "3.8"

install:

- pip install -r requirements-dev.txt

- pip install isort black

- pip install coveralls

script:

- pytest my-package

- isort --profile black my-package

- black --check --diff my-package

after_success:

- coveralls

詳細は「組み込みプロファイル」を参照してください。

設定ファイル (例えば .isort.cfg) の使用

isort と black の両方を公式に使用するプロジェクトでは、プロジェクトのリポジトリのルートにある設定ファイルで black のプロファイルを設定することをおすすめします。そうすれば、ユーザーがどのようにisortを呼び出すか（プリコミット、CLI、エディタ統合）に関わらず、ブラックプロファイルが自動的に適用されます。

例えば、pyproject.tomlファイルは以下のようになります。

code: pyproject.toml

profile = "black"

multi_line_output = 3

詳細は「設定ファイル」を参照してください。

pre-commitとの統合

isortをpre-commitに統合する際に、プロファイルを直接設定することもできます。

code: pre-commit

rev: 5.6.4

hooks:

- id: isort

これを利用して、プレコミットのgit hookを作成することができます。（「Gitフック」を参照）

これにより、プロジェクト全体で一定レベルのコード品質を確保することができます。

コードの検証にisortを使う

code: bash

$ isort **/*.py -c -v

SUCCESS: /home/timothy/Projects/Open_Source/isort/isort_kate_plugin.py Everything Looks Good!

ERROR: /home/timothy/Projects/Open_Source/isort/isort/isort.py Imports are incorrectly sorted.

設定ファイル

ヒント:i sort が決定した設定を調べて、どのコンフィグファイルを使用したかを知るには次のように実行します。

code: bash

$ isort . --show-config

.isort.cfg (好ましいフォーマット)

isortプロジェクトの設定ファイルの例を示します。

code: isort.cfg

profile=hug

src_paths=isort,test

pyproject.toml (推奨フォーマット)

isort が2番目に見る場所は、設定を置くのに同様に優れた選択肢である、pyproject.toml ファイル内です。この設定ファイルを使用する利点は、すべての Python ツールを設定するための標準的な場所になりつつあることです。つまり、他の開発者はここを見ることを知っているし、あなたはプロジェクトのルートをきれいに整理しておくことができます。唯一の欠点は、あなたが使っている他のツールがまだこのフォーマットをサポートしていないかもしれないということで、きれいさが損なわれてしまいます。

code: pyproject.toml

profile = "hug"

setup.cfg

setup.cfg は、pyproject.toml の前駆体と考えることができます。isort や新しいツールはどんどん pyproject.toml に移行していますが、この標準を使用している多くのツールに依存している場合、isort の設定をそこに置くのは自然なことでしょう。

code: setup.cfg

profile=hug

src_paths=isort,test

tox.ini

tox は、Python コミュニティで複数のテスト環境を指定するためによく使われるツールです。isort 検証は一般的にテストステップとして実行されるため、isort 設定を tox.ini ファイルの中に置くことを好む人もいます。

code: tox.ini

.editorconfig

code: .editorconfig

root = true

profile = hug

indent_style = space

indent_size = 4

skip = build,.tox,venv

src_paths=isort,test

カスタムコンフィグファイル

カスタムセクションと順序

isort には、インポートのセクション分けや、セクション内でのインポートの並べ方を設定するための多くの機能があります。

sections=FUTURE,STDLIB,FIRSTPARTY,THIRDPARTY,LOCALFOLDER

指定例

known_django=django

known_pandas=pandas,numpy

sections=FUTURE,STDLIB,DJANGO,THIRDPARTY,PANDAS,FIRSTPARTY,LOCALFOLDER

上記の設定をすると、指定された既知のモジュールを持つ2つの新しいセクションが作成されます。

指定例

sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER

no_lines_before=LOCALFOLDER

この例の場合では、FIRSTPARTYとLOCALFOLDERの両方のモジュールを組み合わせたセクションができます。

known_standard_library : STANDARD_LIBRARY

extra_standard_library : STANDARD_LIBRARY # 既知の標準ライブラリと同じですが、置き換えではなく追加されます。

known_future_library : FUTURE

known_first_party: FIRSTPARTY

known_third_party: THIRDPARTY

known_local_folder : LOCALFOLDER

これは、isort 6.0.0以降で後方互換性のある方法で変更される予定です。

インポートセクションの自動コメント化

指定例

import_heading_stdlib=Standard Library

import_heading_firstparty=My Stuff

この場合、以下のような出力になります。

code: pythohn

# Standard Library

import os

import sys

import django.settings

# My Stuff

import myproject.test

インポートの長さで並べ変える

code: python

from evn.util import (

Pool,

Dict,

Options,

Constant,

DecayDict,

UnexpectedCodePath,

)

length_sort_stdlib=1

isort のインポートからのセクションを制御する

code: pytohn

import b

from a import a

code: python

from a import a # This will now appear at top because a appears in the alphabet before b

import b

code: python

from b import b # If from first is set to True, all from imports will be placed before non-from imports.

import a

Gitフック

isort は、コミットする前に Python コードをチェックするための Git pre-commitスクリプトに統合できるフック関数を提供しています。

code: python

import sys

from isort.hooks import git_hook

sys.exit(git_hook(strict=True, modify=True, lazy=True, settings_file=""))

Githubアクション

使用方法

入力内容

isortVersion

オプションです。使用するisortのバージョン。デフォルトでは最新バージョンのisortを使用します。

sortPaths

オプションです。ソートするパスのリストで、プロジェクトのルートからの相対パスです。既定は .NET です。

configuration

requirementsFiles

オプションです。isort を実行する前にインストールする python の要件ファイルへのパスを指定します。複数の要件ファイルを指定する場合は、スペースで区切らなければなりません。カスタムパッケージのインストールが必要な場合は、このアクションを実行する前に、別のステップで依存関係をインストールする必要があります。

ヒント：サードパーティのライブラリが適切に分類されるように、isortを実行する前にプロジェクトの依存関係をインストールしておくことが重要です。

出力

isort-result

isort コマンドラインツールの出力

使用例

code: YAML

name: Run isort

on:

- push

jobs:

build:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v2

- uses: actions/setup-python@v2

with:

python-version: 3.8

- uses: jamescurtin/isort-action@master

with:

requirementsFiles: "requirements.txt requirements-test.txt"

マルチライン出力モード

code: python

from third_party import (lib1, lib2, lib3,

lib4, lib5, ...)

1 - Vertical

code: python

from third_party import (lib1,

lib2,

lib3

lib4,

lib5,

...)

2 - Hanging Indent

code: python

from third_party import \

lib1, lib2, lib3, \

lib4, lib5, lib6

3 - Vertical Hanging Indent

code: python

from third_party import (

lib1,

lib2,

lib3,

lib4,

)

4 - Hanging Grid

code: python

from third_party import (

lib1, lib2, lib3, lib4,

lib5, ...)

5 - Hanging Grid Grouped

code: python

from third_party import (

lib1, lib2, lib3, lib4,

lib5, ...

)

6 - Hanging Grid Grouped

モード5と同じです。非推奨です。

7 - NOQA

code: pytohn

from third_party import lib1, lib2, lib3, ... # NOQA

code: python

from third_party import lib1

from third_party import lib2

from third_party import lib3

...

8 - Vertical Hanging Indent Bracket

モード 3 - Vertical Hanging Indentと同じですが、最終行の閉じた括弧がインデントされます。

code: python

from third_party import (

lib1,

lib2,

lib3,

lib4,

)

9 - Vertical Prefix From Module Import

code: python

from third_party import lib1, lib2, lib3

from third_party import lib4, lib5, lib6

10 - Hanging Indent With Parentheses

モード 2 - Hanging Indent と同じですが、長い行の折り返しにバックスラッシュの代わりに括弧を使用します。

code: python

from third_party import (

lib1, lib2, lib3,

lib4, lib5, lib6)

11 - Backslash Grid

モード 0 - Gridと同じですが、インポートのグループ化には括弧の代わりにバックスラッシュを使用します。

code: python

from third_party import lib1, lib2, lib3, \

lib4, lib5

isortの組み込みプロファイル

一般的なプロジェクトやコードスタイルとの相互運用を容易にするために、以下のプロファイルがisortに組み込まれています。

black

multi_line_output: 3

include_trailing_comma: True

force_grid_wrap: 0

use_parentheses: True

ensure_newline_before_comments: True

line_length: 88

django

combine_as_imports: True

include_trailing_comma: True

multi_line_output: 5

line_length: 79

pycharm

multi_line_output: 3

force_grid_wrap: 2

lines_after_imports: 2

google

force_single_line: True

force_sort_within_sections: True

lexicographical: True

single_line_exclusions: ('typing',)

order_by_type: False

group_by_package: True

open_stack

force_single_line: True

force_sort_within_sections: True

lexicographical: True

plone

force_alphabetical_sort: True

force_single_line: True

lines_after_imports: 2

line_length: 200

attrs

atomic: True

force_grid_wrap: 0

include_trailing_comma: True

lines_after_imports: 2

lines_between_types: 1

multi_line_output: 3

use_parentheses: True

hug

multi_line_output: 3

include_trailing_comma: True

force_grid_wrap: 0

use_parentheses: True

line_length: 100

wemake

multi_line_output: 3

include_trailing_comma: True

use_parentheses: True

line_length: 80

appnexus

multi_line_output: 3

include_trailing_comma: True

force_grid_wrap: 0

use_parentheses: True

ensure_newline_before_comments: True

line_length: 88

force_sort_within_sections: True

order_by_type: False

case_sensitive: False

reverse_relative: True

sort_relative_in_force_sorted_sections: True

no_lines_before: 'LOCALFOLDER'

setuptoolsの統合

インストール時に、isort はプロジェクトで宣言された Python ファイルをチェックする setuptools コマンドを有効にします。

python setup.py isort をコマンドラインで実行すると、 py_modules と packages にリストアップされたファイルをチェックします。警告が出た場合、コマンドはエラーコードを表示して終了します。

code: bash

$ python setup.py isort

code: setup.py

setup(

name="project",

setup_requires=[

"isort"

]

)