Code Quality#
We use a variety of tools to check for errors and vulnerabilities, and to enforce a coding standard and coding style.
To check the quality of your pull request, go to the top level of the edx- platform codebase and run the following command.
paver run_quality
Most other repos use the command
make quality
The following topics provide additional details on the tools that we use.
Clean Code#
Here are the primary tools we use to keep our code clean.
We use pylint for static analysis and to uncover trouble spots in our code.
Our codebase is far from perfect, but the goal is to steadily improve its quality over time. Using linting tools, we can ensure that pull requests do not introduce new quality violations, and also clean up existing violations in the process of introducing other changes.
To run our linting tools in the edx-platform codebase, go to the top level directory and run the following command.
.. code-block:: bash
paver run_quality
You can also use the paver run_pep8 and paver run_pylint commands to
run only pep8 or pylint.
Although we try to be vigilant in resolving all quality violations, some Pylint violations are too challenging to resolve, so we opt to ignore them via use of a pragma. A pragma tells Pylint to ignore the violation in the given line. An example is.
self.assertEquals(msg, form._errors['course_id'][0]) # pylint: disable=protected-access
The pragma starts with a # two spaces after the end of the line. We prefer
that you use the full name of the error (pylint: disable=unused-argument
as opposed to pylint: disable=W0613), to make more clear what you are
disabling in the line.
Quality checks in other repos may use other commands, such as
make quality
Check the repo’s Makefile or README for more information.
Safe Code#
To keep our code safe from Cross Site Scripting (XSS) vulnerabilities,
the XSS Linter is also run as part of paver run_quality.
To run the XSS Linter against your current branch, run the following command.
paver run_xsslint
For more options for running the XSS Linter, or instructions for fixing violations, see XSS Linter.
Maintenance chart
Review Date |
Working Group Reviewer |
Release |
Test situation |