Django(76)isort工具对import导入进行排序「建议收藏」

Django(76)isort工具对import导入进行排序「建议收藏」前言我们在开发项目时经常会进行导包有import*格式的,还有from*import*格式的,最后就会显示的很乱,那么有没有什么工具能对导包进行一键排序呢?答案是有的,使用isort工具i

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

前言

我们在开发项目时经常会进行导包有import *格式的,还有from * import *格式的,最后就会显示的很乱,那么有没有什么工具能对导包进行一键排序呢?答案是有的,使用isort工具
 

isort介绍

isort 是一个 Python 实用库,用于按字母顺序对imports导入进行排序,并自动分为部分和类型。它为各种编辑器提供命令行实用程序、Python库和插件,以快速对所有导入进行排序。它需要 Python 3.6+ 才能运行,但也支持格式化 Python 2 代码。
 

作用展示

下面有一段比较混乱的代码如下:

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")

使用isort排序后

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")

 

安装命令

最普通的方式

pip install isort

安装支持requirements.txt的方式

pip install isort[requirements_deprecated_finder]

安装支持Pipfile的方式

pip install isort[pipfile_deprecated_finder]

安装支持以上2种根式的方式

pip install isort[requirements_deprecated_finder,pipfile_deprecated_finder]

使用poetry的安装方式

poetry add isort

 

配置信息

isort有许多配置信息,这里我们围绕与black包(代码格式化的第三方包)的配合
 

Black Compatibility

大多数情况下isort都是与black配合使用,我们只需将isort配置中的profile设置为black
 
对于正式使用isortblack的项目,建议在项目存储库根目录下的配置文件中设置black配置文件。这样,它独立于用户如何调用isort(预提交、CLI或编辑器集成),black配置文件将自动应用。
 
例如,您的pyproject.toml文件如下所示

[tool.isort]
profile = "black"

 

Config Files

isort支持各种标准配置格式,以允许将自定义快速集成到任何项目中。
 
pyproject.toml [preferred format]

[tool.isort]
profile = "hug"
src_paths = ["isort", "test"]

 

实战项目配置

演示项目以poetry配置为例子
 

1.使用poetry安装

poetry add isort

 

2.在pyproject.toml中添加如下配置

[tool.isort]
profile = "black"
skip = ["migrations"]

因为是使用Django框架,所以我们需要跳过migrations目录
 

3.将 isort 配置为 PyCharmexternal 工具,以便在代码开发时随时格式化导入排序
过程有2步,
1.配置File Watchers,为了每个文件保存时运行isort
2.配置external tools

  • 确保已安装File Watchers插件
  • 打开Preferences or Settings -> Tools -> File Watchers,点击+按钮,创建一个新的watcher
    • Name: isort
    • File Type: Python
    • Scope: Project Files
    • Program: $PyInterpreterDirectory$/isort 注意:此示例使用的虚拟环境,如果你没有使用虚拟环境,可通过which isort查找到路径并填写真实的路径
    • Arguments: –profile black $FilePath$
    • Output paths to refresh: $FilePath$
    • Working directory: $ProjectFileDir$
    • In Advanced Options
      • 取消勾选 “Auto-save edited files to trigger the watcher”
      • 取消勾选 “Trigger the watcher on external changes”

Django(76)isort工具对import导入进行排序「建议收藏」

  • 打开Preferences or Settings -> Tools -> External Tools,点击+按钮,创建一个新的tools
    • Name: isort
    • Description: Sort imports in current file
    • Program: $PyInterpreterDirectory$/isort 注意:此示例使用的虚拟环境,如果你没有使用虚拟环境,可通过which isort查找到路径并填写真实的路径
    • Arguments: –profile black $FilePath$
    • Working directory: $ProjectFileDir$
    • In Advanced Options: 按钮全部勾选

Django(76)isort工具对import导入进行排序「建议收藏」

接下来我们查看演示效果
Django(76)isort工具对import导入进行排序「建议收藏」

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/164814.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)
blank

相关推荐

  • linux下U盘文件系统类型的识别以及挂载

    手上有装好文件系统的CF一只,插上卡套,类比于U盘。1.先进入/mnt/目录新建一个usb目录cd/mnt/mkidrusb2.fdisk-l,然后插上U盘,fdisk-l查看是否有新的硬盘添加上来了?这时候我若是挂载是不知道sdb的文件类型的,也不清楚该挂载sdbx几。不需挂载就能查看的命令:

  • MySQL:两表取交集、并集、差集「建议收藏」

    MySQL:两表取交集、并集、差集「建议收藏」创建两个表:CREATETABLEa_student(idINTNOTNULLPRIMARYKEYAUTO_INCREMENTCOMMENT'主键',sno

  • 安防监控系统的几个基础小知识

    安防监控系统的几个基础小知识  问题一:摄像机装多高?  我在和客户沟通的时,很多时候都建议客户室内不低于2.5米,室外不低于3.5米,这些数字虽然简单但考虑到了室内的高度及镜头下压的角度,也考虑到了室外安装时照射的长度及防人为破坏的因素。  问题二:支架安装有何建议?  在装摄像机的时候都会有壁装和吊装两种选择,超市等室内环境吊装比较多,室外一般选择壁装。一般轻巧些的机器比如中维世纪的JVS-N81-HY用04、05…

  • CBOW全称_skip的形式

    CBOW全称_skip的形式skip-gram结构是利用中间词预测邻近词cbow模型是利用上下文词预测中间词一、CBOW1、CBOW之所以叫连续词袋模型,是因为在每个窗口内它也不考虑词序信息,因为它是直接把上下文的词向量相加了,自然就损失了词序信息。CBOW抛弃了词序信息,指的就是在每个窗口内部上下文直接相加而没有考虑词序。2、CBOW过程简单介绍如下(实际算法会用到哈夫曼编码等降维技巧,这里仅以理解为目的简介基本原理):输入为C个V维的vector。其中C为上下文窗口的大小,V为原始编码空间的规模。例如,

  • Laravel5.5 支付宝手机网站支付的教程

    Laravel5.5 支付宝手机网站支付的教程

    2021年10月24日
  • Mybatis教程(实战看这一篇就够了)

    Mybatis教程(实战看这一篇就够了)Mybatis教程。Mybatis实战详细教程。Mybatis是一款优秀的持久层框架。其封装了JDBC操作,免去了开发人员编写JDBC代码以及设置参数和获取结果集的重复性工作。通过编写简单的XML或Java注解即可映射数据库CRUD操作。本专栏从原始的JDBC谈起,深入浅出讲解Mybatis实战技能。

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号