Exercism's Python Analyzer

This is Exercism's automated analyzer for the Python track exercises. It is based on and uses PyLint.

It is run from a docker container using ./bin/run-in-docker.sh <exercise-slug> <path/to/solution/files/> <path/for/output/file/>. It will read the source code from <path/to/solution/files/> and write a .json file with an analysis to <path/for/output/file/>. Please note <path/to/solution/files/> & <path/for/output/file/> need to be relative to the location of this repo in your environment.

For example, from the python-analyzer/ (project root) directory:

./bin/run-in-docker.sh two_fer ~/solution-238382y7sds7fsadfasj23j/ ~/solution-238382y7sds7fsadfasj23j/output/

Or if you also have the Python content repo cloned alongside this repo and have a solution saved in the stub file. From the python-analyzer/ (project root) directory you can run:

./bin/run-in-docker.sh two_fer ../python/exercises/practice/two-fer/ ../python/exercises/practice/two-fer/

Running the Tests for the Analyzer

Unit tests require docker and can be run locally or from within GitHub via codespaces:

1. Build the analyzer image from the Dockerfile
2. Open a terminal in the root of your copy/local copy of this project.
3. From the python-analyzer/ (project root) directory run:

   ./bin/run-tests-in-docker.sh

Note

The PyLint portion of the Analyzer will respect the # pylint: disable=<rule_id>, # pylint: disable-next=<rule_id>, and # pylint: disable=all directives from within code files, but it is recommended that you use them sparingly.

For more details, see PyLint message control.