Exercism Python Track
Exercism exercises in Python
Contributing Guide
Please see the Exercism contributing guide and the Python track contributing guide
Working on the Exercises
We welcome both improvements to the existing exercises and new exercises. A list of missing exercise can be found here: exercism#417 (comment)
Conventions
- We use minimalistic stub files for all exercises (#272).
- We use
unittest
(Python Standard Library) and no 3rd-party-framework. - We use the parameter order
self.assertEqual(actual, expected)
(#440). - We use context managers (
with self.assertRaises(\<exception type\>):
) for testing for exceptions (#477). - We use an established utility method to confirm that expected exceptions contain a non-empty message. This method must be included for any test class with an exception-based test case (#1080).
- We use
assertIs(actual, True)
andassertIs(actual, False)
rather thanassertTrue(actual)
orassertFalse(actual)
(#419). - We use a comment string in the test file to reference the version of the exercise's
canonical-data.json
that tests were adapted from (wording can be found in: #784).
Testing
All exercises must be compatible with Python versions 2.7 and 3.4 upwards.
To test a single exercise (e.g., with Python 2.7):
python2.7 test/check-exercises.py [exercise-name]
To test all exercises (e.g., with Python 3):
python3 test/check-exercises.py
Code Style
The Python code in this repo is meant to follow the PEP8 style guide (a stylized version http://pep8.org).
This repo uses flake8 with default settings to enforce the coding standard.
CI build
This repo uses travis-ci
in the following configuration: travis.yml
It will automatically check the code style, the problem configuration, and run the unittests with all supported Python versions.
Pull Requests
We ❤️ pull requests! We even 💖 them if they contain well written commit messages!
Please write the first line of your commit message in the following style:
exercise-name: Change some things
Please try to follow the The seven rules of a great Git commit message like to capitalize the subject line and use the imperative mood. If there are more details to add, put those into the body of the commit message.
If you're interested, Tim Pope even has an entire blog post on good commit messages.
If you're new to Git, take a look at this short guide.
License
This repository uses the MIT License.