python

python copied to clipboard

     This repo does not generally accept Pull Requests unless they follow our contributing guidelines and are:

     1️⃣     Small, contained fixes for typos/grammar/punctuation/code syntax on [one] exercise,      2️⃣     Medium changes that have been agreed/discussed via a filed issue,      3️⃣     Contributions from our [help wanted][help-wanted] issue list,      4️⃣     Larger (previously agreed-upon) contributions from recent & regular (within the last 6 months) contributors.

    Pull Requests not in these categories will be closed. 😞

Verify: [ ]  The branch was updated & rebased with any (recent) upstream changes. [ ]  All prose was checked for spelling and grammar. [ ]  Files are formatted via yapf (yapf config) & conform to our coding standards [ ]  Files pass flake8 with flake8 config & pylint with pylint config. [ ]  Changed example.py/exemplar.py files still pass their associated test files. [ ]  Changed test files still work with associated example.py/exemplar.py files. Check that tests fail properly, as well as succeed. (e.g., make some tests fail on purpose to "test the tests" & failure messages). [ ]  All files have proper EOL. [ ]  If a JinJa2 template was modified/created, was the test file regenerated? Does the regenerated test file successfully test the exercises example.py file? [ ]  The branch passes all CI checks & configlet-lint.

• ❓ Are all required files still up-to-date & configured correctly for this change?_
• ❓ Does <exercise>/.meta/design.md need to be updated with new implementation/design decisions
• ❓ Do these changes require follow-on/supporting changes to related concept documents?

✨  Where applicable, check the following ✨




(as a reminder: Concept Exercise Anatomy) [ ] Exercise introduction.md [ ] Do all code examples compile, run, and return the shown output? [ ] Are all the code examples formatted per the Python docs? [ ] Exercise instructions.md [ ] Exercise hints.md [ ] Check that exercise design.md was fulfilled or edited appropriately [ ] Exercise exemplar.py [ ] Only uses syntax previously introduced or explained. [ ] Is correct and appropriate for the exercise and story. [ ] Exercise <exercise_name>.py (stub) [ ] Includes appropriate docstrings and function names. [ ] Includes pass for each function [ ] Includes an EOL at the end [ ] Exercise <exercise_name>_test.py [ ] Tests cover all (reasonable) inputs and scenarios [ ] At least one test for each task in the exercise [ ] If using subtests or fixtures they're formatted correctly for the runner [ ] Classnames are <ExerciseName>Test [ ] Test functions are test_<test_name> [ ] Exercise config.json --> valid UUID4 [ ] Corresponding concept introduction.md [ ] Corresponding concept about.md [ ] Concept config.json [ ] All Markdown Files : Prettier linting (for all markdown docs) [ ] All Code files: PyLint linting (except for test files) [ ] All files with text: Spell check & grammar review.

Is the exercise is in line with Practice Exercise Anatomy? [ ] .docs/instructions.md(required) Was this file updated and regenerated properly? [ ] .docs/introduction.md(optional) [ ] .docs/introduction.append.md(optional) [ ] .docs/instructions.append.md (optional) Are any additional instructions needed/provided?  (e.g. error handling or information on classes) [ ] .docs/hints.md(optional) Was this file regenerated properly? [ ] .meta/config.json (required) [ ] .meta/example.py (required) Does this pass all the current tests as written/generated? [ ] .meta/design.md (optional) [ ] .meta/template.j2 (template for generating tests from canonical data) Was a test file properly regenerated from this template? [ ] .meta/tests.toml Are there additional test cases to include or exclude? Are there any Python-specific test cases needed for this exercise? [ ] <exercise-slug>_test.py Does this file need to be regenerated? Does this file correctly test the example.py file? Does this file correctly report test failures and messages? [ ] <exercise-slug>.py (required) Does this stub have enough information to get  the student started coding a valid solution?

Is the exercise is in line with Concept Exercise Anatomy? [ ] Exercise introduction.md [ ] Do all code examples compile, run, and return the shown output? [ ] Are all the code examples formatted per the Python docs? [ ] Exercise instructions.md [ ] Exercise hints.md [ ] Check that exercise design.md was fulfilled or edited appropriately [ ] Exercise exemplar.py [ ] Only uses syntax previously introduced or explained. [ ] Is correct and appropriate for the exercise and story. [ ] Exercise <exercise_name>.py (stub) [ ] Includes appropriate docstrings and function names. [ ] Includes pass for each function [ ] Includes an EOL at the end [ ] Exercise <exercise_name>_test.py [ ] Tests cover all (reasonable) inputs and scenarios [ ] At least one test for each task in the exercise [ ] If using subtests or fixtures they're formatted correctly for the runner [ ] Classnames are <ExerciseName>Test [ ] Test functions are test_<test_name> [ ] Exercise config.json --> valid UUID4 [ ] Corresponding concept introduction.md [ ] Corresponding concept about.md [ ] Concept config.json [ ] All Markdown Files : Prettier linting (for all markdown docs) [ ] All Code files: Flake8 & PyLint linting [ ] All Code Examples: proper formatting and fencing. Verify they run in the REPL [ ] All files with text: Spell check & grammar review.