跳到主要内容

用于贡献pandas的代码检查器

项目描述

Build Status Coverage

pandas-dev-flaker

用于贡献pandas的flake8插件。

注意:这不是针对pandas使用的代码检查器,而是针对pandas开发的。如果您需要针对pandas使用的代码检查器,请参阅pandas-vet

安装

pip install pandas-dev-flaker

flake8代码

代码 描述
PDF001 从'collections.abc'中发现导入(使用'from collections import abc')
PDF002 使用了内建的'filter'函数
PDF003 使用了内建的'exec'函数
PDF004 使用了'foo.__class__',(使用'type(foo)'代替)
PDF005 连接字符串前有前置空格
PDF006 找到格式化值'{foo!r}'(相反,使用'repr(foo)')
PDF007 由'black'格式化器不必要地拆分了行
PDF008 发现"os.remove"(使用'tm.ensure_clean'代替)
PDF009 在'pytest.raises'中使用时没有'match='
PDF010 在上下文管理器外使用'pytest.raises'
PDF011 发现'pytest.warns'(使用'pandas._testing.assert_produces_warning')
PDF012 发现'pytest.xfail'(使用'pytest.mark.xfail'代替)
PDF013 发现从'conftest'的导入
PDF014 发现从'pandas._testing'的导入(使用'import pandas._testing as tm')
PDF015 从'pandas.testing'的导入(使用'import pandas._testing as tm')
PDF016 发现'unittest.mock'(使用'pytest.monkeypatch'代替)
PDF017 使用了'pd.api.types'(从'pandas.api.types'导入)
PDF018 从 'pandas.core' 导入了 'common' 没有使用 'com' 别名
PDF019 在同一个文件中找到了 'pd.foo' 和 'foo'
PDF020 在模块间找到了私有导入
PDF021 找到了 'np.bool' 或 'np.object'(请使用 'np.bool_' 或 'np.object_' 代替)
PDF022 找到了从 'numpy.random' 的导入
PDF023 找到了赋值给单字母变量的操作
PDF024 找到了使用生成器表达式的字符串 join()
PDF025 找到了 'np.testing' 或 'np.array_equal'(请使用 'pandas._testing' 代替)
PDF026 在类型提示中找到了 Series 和 AnyArrayLike 之间的联合

贡献

有关如何开始的说明,请参阅 contributing.md

每个新的 linter 规则都应该位于 pandas-dev-flaker/_plugins 内的单独文件中。请在 pandas-dev-flaker/tests 中为每个 linter 规则提供两组测试 - 一组用于当 linter 规则预期通过时,另一组用于当它预期失败时。

信誉

一些方法是从 pyupgrade 中的方法简化而来。一些检查是从 pandas 存储库中取出的。请在其 LICENSES 文件夹中找到它们的许可证。

作为 pre-commit 钩子

有关说明,请参阅 pre-commit

示例 .pre-commit-config.yaml

-   repo: https://github.com/pycqa/flake8
    rev: 3.9.0
    hooks:
    -   id: flake8
        additional_dependencies: [pandas-dev-flaker==0.5.0]

项目详情


下载文件

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

源分发

pandas_dev_flaker-0.5.0.tar.gz (12.3 kB 查看哈希值)

上传时间

构建分发

pandas_dev_flaker-0.5.0-py2.py3-none-any.whl (23.7 kB 查看哈希值)

上传时间 Python 2 Python 3

支持者

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