如何在GitHub Workflow的Pylint中禁用所有文档字符串警告?
解决GitHub Actions中Pylint禁用文档字符串警告的问题
你可以直接把禁用规则添加到pylint.yml的命令行参数里,也可以调整pylintrc的位置让它生效,两种方案如下:
方案一:直接在命令行参数中指定禁用规则
修改pylint.yml里的Analysing the code with pylint步骤,在pylint命令后加上--disable参数,把需要禁用的三个文档字符串警告列出来:
name: Pylint on: [push] jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: ["3.8", "3.9", "3.10"] steps: - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v3 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip pip install pylint - name: Analysing the code with pylint run: | pylint --disable=missing-module-docstring,missing-function-docstring,missing-class-docstring $(git ls-files '*.py')
方案二:正确放置pylintrc文件
你之前把pylintrc放在workflows目录导致失败,是因为Pylint默认会在仓库根目录、用户主目录等位置搜索配置文件,不会扫描workflows子目录。
解决方法:把你的pylintrc文件移动到仓库根目录(和.github文件夹同级),pylint.yml的内容不需要修改,Pylint会自动加载根目录的配置文件。
pylintrc内容保持不变:
[MESSAGES CONTROL] disable=missing-module-docstring, missing-function-docstring, missing-class-docstring
内容的提问来源于stack exchange,提问作者Nickotine
相关产品推荐
相关产品推荐

