跳转到主要内容

Flake8检查引号。

项目描述

Build Status

2.0.0版本的重大更新

根据PEP 8自动鼓励避免转义引号。要禁用此功能,请使用--no-avoid-escape(可以通过avoid-escape配置文件使用)。

0.3.0版本中的弃用通知

为了支持多行,我们将 --quotes 重命名为 --inline-quotes。请相应地调整您的配置。

用法

如果您正在使用 flake8,操作非常简单

pip install flake8-quotes

现在您无需担心像 @sectioneight 这样的人不断抱怨您使用双引号而不是单引号。

警告

此软件包添加了前缀为 Q0 的 flake8 警告。您可能希望在 flake8 配置文件中启用此警告。通常情况下,这将是项目根目录中的 .flake8 文件。

select = Q0

当前的警告集合是

代码

描述

Q000

移除错误的引号

Q001

从多行字符串中移除错误的引号

Q002

从文档字符串中移除错误的引号

Q003

将外部引号更改为避免转义内部引号

配置

默认情况下,我们期望单引号(')并查找不想要的引号(")。要期望引号(")并查找不想要的单引号('),请使用 CLI 选项

flake8 --inline-quotes '"'
# We also support "double" and "single"
# flake8 --inline-quotes 'double'
#
# We also support configuration for multiline quotes
# flake8 --inline-quotes '"' --multiline-quotes "'"
# We also support "'''"
# flake8 --inline-quotes '"' --multiline-quotes "'''"
#
# We also support docstring quotes similarly
# flake8 --inline-quotes '"' --docstring-quotes "'"
# flake8 --inline-quotes '"' --docstring-quotes "'''"

# We also support disabling escaping quotes
# flake8 --no-avoid-escape

或在 tox.ini/setup.cfg 中的配置选项。

[flake8]
inline-quotes = "
# We also support "double" and "single"
# inline-quotes = double
#
# We also support configuration for multiline quotes
# multiline-quotes = '
# We also support "'''"
# multiline-quotes = '''
#
# We also support docstring quotes similarly
# docstring-quotes = '
# docstring-quotes = '''
#
# We also support disabling escaping quotes
# avoid-escape = False

注意事项

我们遵循 PEP8 规范 来避免字符串中的反斜杠。因此,无论您使用何种配置(单引号或双引号),这些始终是有效的字符串

s = 'double "quotes" wrapped in singles are ignored'
s = "single 'quotes' wrapped in doubles are ignored"

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源代码分布

flake8-quotes-3.4.0.tar.gz (14.1 kB 查看哈希值)

上传时间 源代码

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页