No project description provided
Code quality checker package
cq in the root of your package.
$ cq requirements_setup_compatibility setup.py: setup.py: does not contain requirement 'coverage' that is in requirements.txt dumb_style_checker setup.py:20: Put exactly one space before and after `=` [... name='.........', ...]. package/api.py:191: Put exactly one space before and after `=` [... def fake_localtime(t=None): ...]. pyflakes-ext Hint: use `# NOQA` comment for disabling pyflakes on particular line ./tests/test_warnings.py:4: 'types' imported but unused mypy Hint: use `# type: ignore` for disabling mypy on particular line package/api.py:42: error: Need type annotation for 'freeze_factories' (hint: "freeze_factories: List[<type>] = ...") pylint Hint: use `# pylint: disable=<violation name>` for disabling line check. For a list of violations, see `pylint --list-msgs` package/api.py:56: [W0212(protected-access), ] Access to a protected member _uuid_generate_time of a client class
You can specify path to packages that you want to test, if you want to test whole library/app.
$ cq package_1 package_2
Checkers are run in threads. Some of them (e.g. pylint, mypy) spawn an external process so this checkers run in parallel.
To disable certain checker for the whole run add option
$ cq -d pylint -d branch_name_check
Warnings are hidden by default. To display them, run cq with
$ cq --show-warnings
If something takes too long use debug output, which will print timing for each checker:
$ cq --debug
Most of the checkers support disabling the error in the comment on the respective line. For example in
pylint you can use
# pylint: disable = protected-access
to disable protected access check in the current context.
cq --fix with the same options as regular
pylint- comprehensive linter
mypy- checks python typing
pyflakes-ext- another general linter
grammar_nazi- grammar/spelling errors
dumb_style_checker- basic python mistakes (e.g. use of print in a library)
requirements_setup_compatibility- validation of version compatibility between setup.py and requirements.txt
requirements-validator- requirements.txt validation
setup_check- setup.py validator
branch_name_check- check whether current branch name comply with Quantlane standards
orange- code formatter based on
isort- isort your imports, so you don't have to
safety- checks installed dependencies for known security vulnerabilities
You can override the packaged pylint rules in
.pylintrc in the root of your project (actually in
Pylint checker can output two types of issues: warning and error. Errors are in bold typeset. Warnings can (but should not) be ignored.
Config can be overridden by having
mypy.ini in the root of your project
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.