跳转到主要内容

Python 文档字符串样式检查器

项目描述

https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg Documentation Status https://img.shields.io/pypi/pyversions/pydocstyle.svg https://pepy.tech/badge/pydocstyle https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 Gitpod ready-to-code

pydocstyle 是一个用于检查Python文档字符串约定的静态分析工具。

pydocstyle 默认支持PEP 257的大部分内容,但不应该被视为参考实现。

pydocstyle 支持 Python 3.6+。

快速入门

安装

pip install pydocstyle

运行

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:27 in public function `get_user`:
    D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
    D201: No blank lines allowed before function docstring (found 1)
...

开发

您可以使用Gitpod在浏览器中直接运行预配置的云开发环境-

Open in Gitpod

在提交PR之前,请确保运行make all

项目详情


下载文件

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

源代码分发

pydocstyle-6.3.0.tar.gz (36.8 kB 查看哈希值)

上传时间 源代码

构建分发

pydocstyle-6.3.0-py3-none-any.whl (38.0 kB 查看哈希值)

上传时间 Python 3

由以下组织支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面