From 407789a568965f971bbe13a66f366afe1feccf23 Mon Sep 17 00:00:00 2001 From: BethanyG Date: Fri, 27 Feb 2026 17:25:48 -0800 Subject: [PATCH 1/3] Fixed no trailing line in bad.py and updated README with better instructions and links to PyLint. --- README.md | 30 +++++++++++++++---- .../messages/disallowed-name/bad.py | 2 +- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8e0d53a..ada1553 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,42 @@ This is Exercism's automated analyzer for the Python track exercises. It is based on and uses [PyLint][pylint-github]. -It is run from a docker container using `./bin/run-in-docker.sh $EXERCISM $PATH_TO_FILES $PATH_FOR_OUTPUT` and will read the source code from `$PATH_TO_FILES` and write a text file with an analysis to `$PATH_FOR_OUTPUT`. +It is run from a docker container using `./bin/run-in-docker.sh $EXERCISE_SLUG $PATH_TO_SOLUTION_FILES $PATH_FOR_OUTPUT_FILES` and will read the source code from `$PATH_TO_SOLUTION_FILES` and write a json file with an analysis to `$PATH_FOR_OUTPUT_FILES`. +Please note `$PATH_TO_SOLUTION_FILES` and `$PATH_FOR_OUTPUT_FILES` need to be **_relative_** to the location of this repo in your environment. For example: ```bash +# From python-analyzer (project root) directory ./bin/run-in-docker.sh two_fer ~/solution-238382y7sds7fsadfasj23j/ ~/solution-238382y7sds7fsadfasj23j/output/ ``` -Unit tests also require [docker][docker] and can be run locally or from within GitHub via [codespaces][codespaces]: +Or if you also have the Python content repo cloned alongside this repo and have a solution saved in the stub file: ```bash - -#run from the python-analyzer (project root) directory. -./bin/run-tests-in-docker.sh +# From python-analyzer (project root) directory +./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][docker] and can be run locally or from within GitHub via [codespaces][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. run + ```bash + #run from the python-analyzer (project root) directory. + ./bin/run-tests-in-docker.sh + ``` + +> [!NOTE] +> The PyLint portion of the Analyzer will respect the `# pylint: disable=`, `# pylint: disable-next=`, and `# pylint: disable=all` directives from within code files, but it is recommended that you use them sparingly. + +> For more details on PyLint message control, see [message_control](https://pylint.pycqa.org/en/latest/user_guide/messages/message_control.html#block-disables). + + [pylint-github]: https://github.com/pylint-dev/pylint [docker]: https://www.docker.com/ [codespaces]: https://github.com/features/codespaces diff --git a/lib/common/pylint_data/messages/disallowed-name/bad.py b/lib/common/pylint_data/messages/disallowed-name/bad.py index 272c7cb..109ee81 100644 --- a/lib/common/pylint_data/messages/disallowed-name/bad.py +++ b/lib/common/pylint_data/messages/disallowed-name/bad.py @@ -3,4 +3,4 @@ def foo(): # [disallowed-name] x = 15 # [disallowed-name] y = 12 # [disallowed-name] -result = x + y \ No newline at end of file +result = x + y From 6d563d71b69173c1f690e5d3f40c4c0f96cc1d7b Mon Sep 17 00:00:00 2001 From: BethanyG Date: Fri, 27 Feb 2026 17:42:13 -0800 Subject: [PATCH 2/3] More formatting fixes, --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ada1553..2d9392d 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,19 @@ This is Exercism's automated analyzer for the Python track exercises. It is based on and uses [PyLint][pylint-github]. -It is run from a docker container using `./bin/run-in-docker.sh $EXERCISE_SLUG $PATH_TO_SOLUTION_FILES $PATH_FOR_OUTPUT_FILES` and will read the source code from `$PATH_TO_SOLUTION_FILES` and write a json file with an analysis to `$PATH_FOR_OUTPUT_FILES`. -Please note `$PATH_TO_SOLUTION_FILES` and `$PATH_FOR_OUTPUT_FILES` need to be **_relative_** to the location of this repo in your environment. +It is run from a docker container using `./bin/run-in-docker.sh ` and will read the source code from `` and write a `.json` file with an analysis to ``. +Please note `` and `` need to be **_relative_** to the location of this repo in your environment. -For example: +For example, from the `python-analyzer/` (project root) directory: ```bash -# From 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: +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: ```bash -# From python-analyzer (project root) directory ./bin/run-in-docker.sh two_fer ../python/exercises/practice/two-fer/ ../python/exercises/practice/two-fer/ ``` @@ -25,18 +24,17 @@ Or if you also have the Python content repo cloned alongside this repo and have Unit tests require [docker][docker] and can be run locally or from within GitHub via [codespaces][codespaces]: -1, Build the analyzer image from the Dockerfile +1. Build the analyzer image from the Dockerfile 2. Open a terminal in the root of your copy/local copy of this project. -3. run +3. run from the `python-analyzer/` (project root) directory: ```bash - #run from the python-analyzer (project root) directory. ./bin/run-tests-in-docker.sh ``` > [!NOTE] > The PyLint portion of the Analyzer will respect the `# pylint: disable=`, `# pylint: disable-next=`, and `# pylint: disable=all` directives from within code files, but it is recommended that you use them sparingly. - -> For more details on PyLint message control, see [message_control](https://pylint.pycqa.org/en/latest/user_guide/messages/message_control.html#block-disables). +> +> For more details, see [PyLint message control](https://pylint.pycqa.org/en/latest/user_guide/messages/message_control.html#block-disables). [pylint-github]: https://github.com/pylint-dev/pylint From 093801868538f26986f77e891b641f0d1f3ad361 Mon Sep 17 00:00:00 2001 From: BethanyG Date: Fri, 27 Feb 2026 17:47:09 -0800 Subject: [PATCH 3/3] And more formatting fixes, --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2d9392d..8ec6671 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,9 @@ This is Exercism's automated analyzer for the Python track exercises. It is based on and uses [PyLint][pylint-github]. -It is run from a docker container using `./bin/run-in-docker.sh ` and will read the source code from `` and write a `.json` file with an analysis to ``. -Please note `` and `` need to be **_relative_** to the location of this repo in your environment. +It is run from a docker container using `./bin/run-in-docker.sh `. +It will read the source code from `` and write a `.json` file with an analysis to ``. +Please note `` & `` need to be **_relative_** to the location of this repo in your environment. For example, from the `python-analyzer/` (project root) directory: @@ -13,7 +14,7 @@ For example, from the `python-analyzer/` (project root) directory: ``` 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: +From the `python-analyzer/` (project root) directory you can run: ```bash ./bin/run-in-docker.sh two_fer ../python/exercises/practice/two-fer/ ../python/exercises/practice/two-fer/ @@ -26,11 +27,12 @@ Unit tests require [docker][docker] and can be run locally or from within GitHub 1. Build the analyzer image from the Dockerfile 2. Open a terminal in the root of your copy/local copy of this project. -3. run from the `python-analyzer/` (project root) directory: +3. From the `python-analyzer/` (project root) directory run: ```bash ./bin/run-tests-in-docker.sh ``` + > [!NOTE] > The PyLint portion of the Analyzer will respect the `# pylint: disable=`, `# pylint: disable-next=`, and `# pylint: disable=all` directives from within code files, but it is recommended that you use them sparingly. >