infrastructure/gitlab-ci
2
0
Fork 0
Code Issues 17 Pull Requests 1 Actions Projects Releases 21 Wiki Activity

build(pylint): added .pylintrc to exclude some rules

Browse Source 
.pylintrc had rules ignore docs strings for module, function and class. this can be customised by the end user.

!9 #7
This commit is contained in:
Jon Lockwood
2021-08-12 14:02:59 +09:30
parent 389bc08d76
commit 73e061e649
3 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
python/.gitlab-ci.yml
View File

@ -7,6 +7,7 @@
.PyLint: .PyLint:
variables: variables:
PYLINT_PATH: "/*/python-module/*/*.py" PYLINT_PATH: "/*/python-module/*/*.py"
PYLINT_RC_PATH: "/python/.pylintrc"
stage: validation stage: validation
before_script: before_script:
- if [ "0$JOB_ROOT_DIR" == "0" ]; then ROOT_DIR=gitlab-ci; else ROOT_DIR=$JOB_ROOT_DIR ; fi - if [ "0$JOB_ROOT_DIR" == "0" ]; then ROOT_DIR=gitlab-ci; else ROOT_DIR=$JOB_ROOT_DIR ; fi
@ -24,11 +25,13 @@
script: script:
- PYLINT_PATH=$ROOT_DIR$PYLINT_PATH - PYLINT_PATH=$ROOT_DIR$PYLINT_PATH
- echo "[DEBUG] PYLINT_PATH[$PYLINT_PATH]" - echo "[DEBUG] PYLINT_PATH[$PYLINT_PATH]"
- python3 -m pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.json" - PYLINT_RC_PATH=$ROOT_DIR$PYLINT_RC_PATH
- echo "[DEBUG] PYLINT_RC_PATH[$PYLINT_RC_PATH]"
- python3 -m pylint --rcfile PYLINT_RC_PATH --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.json"
- python3 -m pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html" - python3 -m pylint --rcfile PYLINT_RC_PATH --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html"
- PyPIScore=$(python3 -m pylint --exit-zero $PYLINT_PATH | sed -n 's/^Your code has been rated at \([-0-9./]*\).*/\1/p') - PyPIScore=$(python3 -m pylint --rcfile PYLINT_RC_PATH --exit-zero $PYLINT_PATH | sed -n 's/^Your code has been rated at \([-0-9./]*\).*/\1/p')
- *pylint_badge - *pylint_badge

5
python/.pylintrc Normal file
View File

@ -0,0 +1,5 @@
[MASTER]
disable=
C0114, # missing-module-docstring
C0115, # missing-class-docstring
C0116, # missing-function-docstring

2
python/README.md
View File

@ -61,6 +61,7 @@ include:
PyLint: PyLint:
variables: variables:
PYLINT_PATH: "/*/*.py" PYLINT_PATH: "/*/*.py"
PYLINT_RC_PATH: "."
extends: extends:
- .PyLint - .PyLint
image: python:3.6-slim image: python:3.6-slim
@ -72,6 +73,7 @@ PyLint:
| var name | Description | | var name | Description |
|:----:|:----| |:----:|:----|
| PYLINT_PATH | *The path you wish the linter to search for python files* | | PYLINT_PATH | *The path you wish the linter to search for python files* |
| PYLINT_RC_PATH | *The path to your `.pylintrc` file.* |
## Job Workflow ## Job Workflow