flake8-sfs 1.0.0

介绍

这是一个MIT许可的flake8插件，用于强制执行Python字符串格式化首选项。您可以从Python包索引（PyPI）安装。

由于历史原因，Python编程语言累积了多种字符串格式化的方法。其中三种主要的是

• 百分比运算符（违规代码SFS1##），例如在这个示例中

>>> name = "Peter"
>>> price = 1.2
>>> print("Hello %s, do you have $%0.2f?" % (name, price))
Hello Peter, do you have $1.20?

• 格式化方法（违规代码SFS2##），自Python 2.6起可用，

>>> name = "Peter"
>>> price = 1.2
>>> print("Hello {}, do you have ${:0.2f}?".format(name, price))
Hello Peter, do you have $1.20?

• f-字符串（违规代码SFS3##），自Python 3.6起可用，

>>> name = "Peter"
>>> price = 1.2
>>> print(f"Hello {name}, do you have ${price:0.2f}?")

我们有很多选择，但引用Python之禅，“应该有一个 - 最好是唯一明显的方式来做这件事”。这个flake8插件的存在是为了让您定义项目中允许哪种样式。

默认情况下，此插件会对所有三种样式提出异议 - 我们预计您将做出明确的选择并配置要忽略的代码。请参见下面的用例。

Flake8验证代码

flake8早期版本假设验证代码使用单个字符前缀，这在插件生态系统中导致冲突问题。从v3.0版本开始，flake8支持更长的前缀，因此此插件使用SFS作为其前缀（代表String Format Style，字符串格式风格）。

前缀SFS1 - 百分比运算符

前缀SFS2 - 格式化方法

前缀SFS3 - f-strings

您可以在flake8中使用部分代码如SFS1来忽略所有SFS1##百分比格式化代码。

安装和用法

需要Python 3.7或更高版本。

我们建议使用pip安装插件，它会处理依赖项。

$ pip install flake8-sfs

或者，如果您使用Anaconda打包系统，以下命令将安装插件及其依赖项

$ conda install -c conda-forge flake8-sfs

当使用flake8时，新验证器应自动包含在内，可能会报告以SFS开头（如上定义）的附加验证代码。例如

$ flake8 example.py

您可以使用以下方式仅请求显示SFS代码

$ flake8 --select SFS example.py

您应该在flake8配置文件的选择或忽略列表中至少添加一些SFS验证代码。

配置

我们假设您熟悉flake8配置。

除非您的代码完全不执行字符串格式化（这很少见），否则您应该告诉flake8忽略此插件至少一个违规代码。例如

[flake8]
extend-ignore =
    # Ignore f-strings, we like them:
    SFS301,

请注意，flake8允许在多行上拆分逗号分隔的列表，并允许包含哈希注释行。

版本历史

开发者

此插件位于GitHub上：https://github.com/peterjc/flake8-sfs

开发者可以从git仓库安装插件，可选构建依赖项。

$ pip install -e .[develop]

一旦本地和在线测试通过，就进行一次新版本发布。

$ git tag vX.Y.Z
$ python -m build
$ git push origin master --tags
$ twine upload dist/flake8?sfs-X.Y.Z*

PyPI上传应触发自动拉取请求，更新flake8-sfs conda-forge配方。