Python raindrops

.github/citools/python/python-lint-refurb

@@ -20,10 +20,19 @@ main() {
 	print_ruler
 
 	# shellcheck disable=SC2048,SC2068,SC2086
-	run_command refurb ${@:-./src}
+	run_command refurb --quiet --ignore 183 ${@:-./src}
 
 	print_ruler
 
+	local -a codes
+	local code
+	# shellcheck disable=SC2048,SC2068,SC2086
+	mapfile -t codes < <(refurb --quiet --ignore 183 ${@:-./src} |& sed -r -e 's/^.*\[(FURB[0-9]+)\].*$/\1/g')
+	for code in "${codes[@]}"; do
+		run_command refurb --explain "${code}"
+		print_ruler
+	done
+
 	echo Exit code: "${retval}"
 	return "${retval}"
 }

python/README.md

@@ -39,3 +39,4 @@
 - [leap](./leap/README.md)
 - [mecha-munch-management](./mecha-munch-management/README.md)
 - [plane-tickets](./plane-tickets/README.md)
+- [raindrops](./raindrops/README.md)

python/raindrops/.coverage

@@ -0,0 +1 @@
+!coverage.py: This is a private format, don't read it directly!{"arcs":{"/home/vpayno/git_vpayno/exercism-workspace/python/raindrops/test/__init__.py":[[0,0],[0,-1]],"/home/vpayno/git_vpayno/exercism-workspace/python/raindrops/raindrops.py":[[0,1],[1,4],[4,-1],[4,11],[11,13],[13,16],[16,19],[19,22],[22,23],[23,25],[25,-4],[13,14],[14,16],[16,17],[17,19],[19,20],[20,22],[22,25]]}}

python/raindrops/.coverage.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" ?>
+<coverage branch-rate="1" branches-covered="8" branches-valid="8" complexity="0" line-rate="0.9167" lines-covered="11" lines-valid="12" timestamp="1712626748859" version="4.5.4">
+	<!-- Generated by coverage.py: https://coverage.readthedocs.io -->
+	<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
+	<sources>
+		<source>/home/vpayno/git_vpayno/exercism-workspace/python/raindrops</source>
+	</sources>
+	<packages>
+		<package branch-rate="1" complexity="0" line-rate="0.9167" name=".">
+			<classes>
+				<class branch-rate="1" complexity="0" filename="raindrops.py" line-rate="0.9167" name="raindrops.py">
+					<methods/>
+					<lines>
+						<line hits="0" number="0"/>
+						<line hits="1" number="4"/>
+						<line hits="1" number="11"/>
+						<line branch="true" condition-coverage="100% (2/2)" hits="1" number="13"/>
+						<line hits="1" number="14"/>
+						<line branch="true" condition-coverage="100% (2/2)" hits="1" number="16"/>
+						<line hits="1" number="17"/>
+						<line branch="true" condition-coverage="100% (2/2)" hits="1" number="19"/>
+						<line hits="1" number="20"/>
+						<line branch="true" condition-coverage="100% (2/2)" hits="1" number="22"/>
+						<line hits="1" number="23"/>
+						<line hits="1" number="25"/>
+					</lines>
+				</class>
+			</classes>
+		</package>
+		<package branch-rate="1" complexity="0" line-rate="1" name="test">
+			<classes>
+				<class branch-rate="1" complexity="0" filename="test/__init__.py" line-rate="1" name="__init__.py">
+					<methods/>
+					<lines/>
+				</class>
+			</classes>
+		</package>
+	</packages>
+</coverage>

python/raindrops/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = __init__.py, *_test.py

python/raindrops/.exercism/config.json

@@ -0,0 +1,32 @@
+{
+  "authors": [],
+  "contributors": [
+    "behrtam",
+    "BethanyG",
+    "bsoyka",
+    "cmccandless",
+    "Dog",
+    "ikhadykin",
+    "kytrinyx",
+    "lowks",
+    "N-Parsons",
+    "pheanex",
+    "sjakobi",
+    "tqa236",
+    "yawpitch"
+  ],
+  "files": {
+    "solution": [
+      "raindrops.py"
+    ],
+    "test": [
+      "raindrops_test.py"
+    ],
+    "example": [
+      ".meta/example.py"
+    ]
+  },
+  "blurb": "Convert a number into its corresponding raindrop sounds - Pling, Plang and Plong.",
+  "source": "A variation on FizzBuzz, a famous technical interview question that is intended to weed out potential candidates. That question is itself derived from Fizz Buzz, a popular children's game for teaching division.",
+  "source_url": "https://en.wikipedia.org/wiki/Fizz_buzz"
+}

python/raindrops/.exercism/metadata.json

@@ -0,0 +1 @@
+{"track":"python","exercise":"raindrops","id":"954a4e30d0eb49f9bb1ff7a14982fb08","url":"https://exercism.org/tracks/python/exercises/raindrops","handle":"vpayno","is_requester":true,"auto_approve":false}

python/raindrops/.pylintrc

@@ -0,0 +1 @@
+../.pylintrc

python/raindrops/HELP.md

@@ -0,0 +1,130 @@
+# Help
+
+## Running the tests
+
+We use [pytest][pytest: Getting Started Guide] as our website test runner.
+You will need to install `pytest` on your development machine if you want to run tests for the Python track locally.
+You should also install the following `pytest` plugins:
+
+- [pytest-cache][pytest-cache]
+- [pytest-subtests][pytest-subtests]
+
+Extended information can be found in our website [Python testing guide][Python track tests page].
+
+
+### Running Tests
+
+To run the included tests, navigate to the folder where the exercise is stored using `cd` in your terminal (_replace `{exercise-folder-location}` below with your path_).
+Test files usually end in `_test.py`, and are the same tests that run on the website when a solution is uploaded.
+
+Linux/MacOS
+```bash
+$ cd {path/to/exercise-folder-location}
+```
+
+Windows
+```powershell
+PS C:\Users\foobar> cd {path\to\exercise-folder-location}
+```
+
+<br>
+
+Next, run the `pytest` command in your terminal, replacing `{exercise_test.py}` with the name of the test file:
+
+Linux/MacOS
+```bash
+$ python3 -m pytest -o markers=task {exercise_test.py}
+==================== 7 passed in 0.08s ====================
+```
+
+Windows
+```powershell
+PS C:\Users\foobar> py -m pytest -o markers=task {exercise_test.py}
+==================== 7 passed in 0.08s ====================
+```
+
+
+### Common options
+- `-o` : override default `pytest.ini` (_you can use this to avoid marker warnings_)
+- `-v` : enable verbose output.
+- `-x` : stop running tests on first failure.
+- `--ff` : run failures from previous test before running other test cases.
+
+For additional options, use `python3 -m pytest -h` or `py -m pytest -h`.
+
+
+### Fixing warnings
+
+If you do not use `pytest -o markers=task` when invoking `pytest`, you might receive a `PytestUnknownMarkWarning` for tests that use our new syntax:
+
+```bash
+PytestUnknownMarkWarning: Unknown pytest.mark.task - is this a typo?  You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/mark.html
+```
+
+To avoid typing `pytest -o markers=task` for every test you run, you can use a `pytest.ini` configuration file.
+We have made one that can be downloaded from the top level of the Python track directory: [pytest.ini][pytest.ini].
+
+You can also create your own `pytest.ini` file with the following content:
+
+```ini
+[pytest]
+markers =
+    task: A concept exercise task.
+```
+
+Placing the `pytest.ini` file in the _root_ or _working_ directory for your Python track exercises will register the marks and stop the warnings.
+More information on pytest marks can be found in the `pytest` documentation on [marking test functions][pytest: marking test functions with attributes] and the `pytest` documentation on [working with custom markers][pytest: working with custom markers].
+
+Information on customizing pytest configurations can be found in the `pytest` documentation on [configuration file formats][pytest: configuration file formats].
+
+
+### Extending your IDE or Code Editor
+
+Many IDEs and code editors have built-in support for using `pytest` and other code quality tools.
+Some community-sourced options can be found on our [Python track tools page][Python track tools page].
+
+[Pytest: Getting Started Guide]: https://docs.pytest.org/en/latest/getting-started.html
+[Python track tools page]: https://exercism.org/docs/tracks/python/tools
+[Python track tests page]: https://exercism.org/docs/tracks/python/tests
+[pytest-cache]:http://pythonhosted.org/pytest-cache/
+[pytest-subtests]:https://github.com/pytest-dev/pytest-subtests
+[pytest.ini]: https://github.com/exercism/python/blob/main/pytest.ini
+[pytest: configuration file formats]: https://docs.pytest.org/en/6.2.x/customize.html#configuration-file-formats
+[pytest: marking test functions with attributes]: https://docs.pytest.org/en/6.2.x/mark.html#raising-errors-on-unknown-marks
+[pytest: working with custom markers]: https://docs.pytest.org/en/6.2.x/example/markers.html#working-with-custom-markers
+
+## Submitting your solution
+
+You can submit your solution using the `exercism submit raindrops.py` command.
+This command will upload your solution to the Exercism website and print the solution page's URL.
+
+It's possible to submit an incomplete solution which allows you to:
+
+- See how others have completed the exercise
+- Request help from a mentor
+
+## Need to get help?
+
+If you'd like help solving the exercise, check the following pages:
+
+- The [Python track's documentation](https://exercism.org/docs/tracks/python)
+- The [Python track's programming category on the forum](https://forum.exercism.org/c/programming/python)
+- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
+- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
+
+Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
+
+Below are some resources for getting help if you run into trouble:
+
+- [The PSF](https://www.python.org) hosts Python downloads, documentation, and community resources.
+- [The Exercism Community on Discord](https://exercism.org/r/discord)
+- [Python Community on Discord](https://pythondiscord.com/) is a very helpful and active community.
+- [/r/learnpython/](https://www.reddit.com/r/learnpython/) is a subreddit designed for Python learners.
+- [#python on Libera.chat](https://www.python.org/community/irc/) this is where the core developers for the language hang out and get work done.
+- [Python Community Forums](https://discuss.python.org/)
+- [Free Code Camp Community Forums](https://forum.freecodecamp.org/)
+- [CodeNewbie Community Help Tag](https://community.codenewbie.org/t/help)
+- [Pythontutor](http://pythontutor.com/) for stepping through small code snippets visually.
+
+Additionally, [StackOverflow](http://stackoverflow.com/questions/tagged/python) is a good spot to search for your problem/question to see if it has been answered already.
+ If not - you can always [ask](https://stackoverflow.com/help/how-to-ask) or [answer](https://stackoverflow.com/help/how-to-answer) someone else's question.

python/raindrops/README.md

@@ -0,0 +1,80 @@
+# Raindrops
+
+Welcome to Raindrops on Exercism's Python Track.
+If you need help running the tests or submitting your code, check out `HELP.md`.
+
+## Introduction
+
+Raindrops is a slightly more complex version of the FizzBuzz challenge, a classic interview question.
+
+## Instructions
+
+Your task is to convert a number into its corresponding raindrop sounds.
+
+If a given number:
+
+- is divisible by 3, add "Pling" to the result.
+- is divisible by 5, add "Plang" to the result.
+- is divisible by 7, add "Plong" to the result.
+- **is not** divisible by 3, 5, or 7, the result should be the number as a string.
+
+## Examples
+
+- 28 is divisible by 7, but not 3 or 5, so the result would be `"Plong"`.
+- 30 is divisible by 3 and 5, but not 7, so the result would be `"PlingPlang"`.
+- 34 is not divisible by 3, 5, or 7, so the result would be `"34"`.
+
+~~~~exercism/note
+A common way to test if one number is evenly divisible by another is to compare the [remainder][remainder] or [modulus][modulo] to zero.
+Most languages provide operators or functions for one (or both) of these.
+
+[remainder]: https://exercism.org/docs/programming/operators/remainder
+[modulo]: https://en.wikipedia.org/wiki/Modulo_operation
+~~~~
+
+## How this Exercise is Structured in Python
+
+This exercise is best solved with Python's `%` ([modulo][modulo]) operator, which returns the remainder of positive integer division.
+It has a method equivalent, `operator.mod()` in the [operator module][operator-mod].
+
+
+Python also offers additional 'remainder' methods in the [math module][math-module].
+[`math.fmod()`][fmod] behaves like `%`, but operates on floats.
+[`math.remainder()`][remainder] implements a "step closest to zero" algorithm for the remainder of division.
+While we encourage you to get familiar with these methods, neither of these will exactly match the result of `%`, and are not recommended for use with this exercise.
+
+The built-in function [`divmod()`][divmod] will also give a remainder than matches `%` if used with two positive integers, but returns a `tuple` that needs to be unpacked.
+
+[divmod]: https://docs.python.org/3/library/functions.html#divmod
+[fmod]: https://docs.python.org/3/library/math.html#math.fmod
+[math-module]: https://docs.python.org/3/library/math.html
+[modulo]: https://www.programiz.com/python-programming/operators#arithmetic
+[operator-mod]: https://docs.python.org/3/library/operator.html#operator.mod
+[remainder]: https://docs.python.org/3/library/math.html#math.remainder
+
+## Source
+
+### Contributed to by
+
+- @behrtam
+- @BethanyG
+- @bsoyka
+- @cmccandless
+- @Dog
+- @ikhadykin
+- @kytrinyx
+- @lowks
+- @N-Parsons
+- @pheanex
+- @sjakobi
+- @tqa236
+- @yawpitch
+
+### Based on
+
+A variation on FizzBuzz, a famous technical interview question that is intended to weed out potential candidates. That question is itself derived from Fizz Buzz, a popular children's game for teaching division. - https://en.wikipedia.org/wiki/Fizz_buzz
+
+### My Solution
+
+- [my solution](./raindrops.py)
+- [run-tests](./run-tests-python.txt)

python/raindrops/pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+pythonpath = .
+addopts = --doctest-modules
+markers =
+    task: exercise task/step

python/raindrops/raindrops.py

@@ -0,0 +1,25 @@
+"""Raindrops exercism: https://exercism.org/tracks/python/exercises/raindrops"""
+
+
+def convert(number: int) -> str:
+    """Converts a number to the sound of rain drops.
+
+    :param number: positive integer
+    :return: string with rain sounds or the number if it can't be converted
+    """
+
+    sounds: list[str] = []
+
+    if number % 3 == 0:
+        sounds.append("Pling")
+
+    if number % 5 == 0:
+        sounds.append("Plang")
+
+    if number % 7 == 0:
+        sounds.append("Plong")
+
+    if not sounds:
+        sounds.append(f"{number}")
+
+    return "".join(sounds)

python/raindrops/raindrops.py,cover

@@ -0,0 +1,25 @@
+> """Raindrops exercism: https://exercism.org/tracks/python/exercises/raindrops"""
+
+
+> def convert(number: int) -> str:
+>     """Converts a number to the sound of rain drops.
+
+>     :param number: positive integer
+>     :return: string with rain sounds or the number if it can't be converted
+>     """
+
+>     sounds: list[str] = []
+
+>     if number % 3 == 0:
+>         sounds.append("Pling")
+
+>     if number % 5 == 0:
+>         sounds.append("Plang")
+
+>     if number % 7 == 0:
+>         sounds.append("Plong")
+
+>     if not sounds:
+>         sounds.append(f"{number}")
+
+>     return "".join(sounds)