個人學(xué)習(xí)記錄,若有侵權(quán),請聯(lián)系刪除。
一、介紹
isort是一個實用的Python庫,用于按照字母表順序?qū)mports進行排序,并自動按類型(標(biāo)準(zhǔn)庫/第三方庫/自己的模塊/.......)劃分部分。它為各種編輯器提供了命令行程序、python庫和插件以快速對所有導(dǎo)入進行排序。它需要python3.7+才能運行,但也支持格式化python2代碼。
(資料圖)
先看官網(wǎng)提供的例子,了解isort的魅力之處
使用isort格式化后
二、安裝
安裝isort跟安裝其他第三庫的方式是一樣,只需在命令行中輸入:
三、使用
1、特定文件
示例:未使用isort時的代碼文件learning.py
①方法一:在文件的路徑下新建一個py文件,運行成功后即可將對應(yīng)的文件導(dǎo)入模塊進行排序
②方法二:在命令行使用命令
通過上述操作即可獲取排序后的文件
2、遞歸目錄
使用以下指令可以對目錄下的所有文件導(dǎo)入模塊進行排序
或
3、查看建議的更改而不修改文件
示例
四、vscode
在vscode進行配置,保存時即對導(dǎo)入模塊進行排序
1、安裝isort,方法見二
2、對vscode的setting進行配置
①使用快捷鍵Ctrl + Shift + P,搜索Preferences: Open Settings(UI)
②搜索OnSave,點擊Edit in setting.json
③修改setting.json的配置
五、操作注釋
在單個文件中配置isort流的最基本方法是操作注釋。這些注釋在解析過程中由isort解析器拾取和解釋。
1、isort: skip_file:跳過整個文件
2、isort: skip?
如果與導(dǎo)入語句放在同一行(或a的延續(xù)內(nèi)),isort將不會對此導(dǎo)入進行排序
3、isort: off
關(guān)閉isort解析。語句后的每一行都將保持不變地傳遞,直到注釋或文件結(jié)束
4、isort: on
重新打開isort解析。這只有在文件中存在更高的注釋時才有意義,允許在其他排序的導(dǎo)入塊周圍擁有未排序的導(dǎo)入塊。
5、isort:split
告知isort當(dāng)前排序部分已完成,并且所有將來的導(dǎo)入都屬于新的排序分組。
6、dont-add-imports
不自動將導(dǎo)入添加到此文件,即使設(shè)置了--add-imports也是如此
7、dont-add-import
不自動添加特定的導(dǎo)入,即使--add-imports也是如此
8、isort -a
向所有文件添加導(dǎo)入
僅將導(dǎo)入添加到已導(dǎo)入的文件
9、isort --rm
從多個文件中刪除導(dǎo)入