Run code analysis on a package¶
Follow these steps to check how any arbitrary package adheres to our Plone official guidelines.
See the very same script that Jenkins uses, below follows a more detailed step to step on how to run it and fix the errors.
Clone the repository and create a Python virtual environment:
git clone email@example.com:plone/plone.app.discussion.git cd plone.app.discussion virtualenv . source bin/activate
Create a cleanup branch, although not mandatory it’s always a good idea:
git checkout -b cleanup
Get the QA configuration and bootstrap:
wget https://raw.githubusercontent.com/plone/buildout.coredev/5.1/bootstrap.py -O bootstrap.py wget https://raw.githubusercontent.com/plone/buildout.coredev/5.1/experimental/qa.cfg -O qa.cfg wget https://raw.githubusercontent.com/plone/plone.recipe.codeanalysis/master/.isort.cfg -O .isort.cfg python bootstrap.py --setuptools-version 31.1.1 --buildout-version 2.8.0 -c qa.cfg
qa.cfg to the package:
- check that the
code-analysispart matches the top-level folder of the distribution
- remove the
jenkins = Trueline (so that
bin/code-analysisshows its report on the terminal)
Finally run buildout and code analysis:
bin/buildout -c qa.cfg bin/code-analysis
The first easy fixes can be easily solved with
pip install autopep8 isort isort plone/app/discussion/*.py autopep8 --in-place -r plone/app/discussion
By default autopep8 does white space only changes which are basically guaranteed safe.
Important exception: undo any changes made by autopep8 to Python skin scripts. For instance, it will change the double comment hashes at the top to single hashes, which completely break those Python scripts.
After committing the initial autopep8 run, you can run autopep8 in more aggressive mode, but you have to check these changes more carefully:
autopep8 --in-place --ignore W690,E711,E721 --aggressive
bin/code-analysis to see how much errors are still left to be fixed.
add a comment on
CHANGES.rst and commit all the changes in a single commit:
$EDITOR CHANGES.rst git commit -am"Cleanup"
Push the branch:
git push -u
Create a pull request on github and start a jenkins job to verify that your changes did not break anything. For that, see the docs about testing pull requests.
Lastly file an issue on jenkins.plone.org issue tracker so that Jenkins start monitoring the package.
Done! Thanks for cleaning one package!