diff --git a/resistor-color-duo/.exercism/config.json b/resistor-color-duo/.exercism/config.json new file mode 100644 index 0000000..f8177d2 --- /dev/null +++ b/resistor-color-duo/.exercism/config.json @@ -0,0 +1,27 @@ +{ + "authors": [ + "ee7" + ], + "contributors": [ + "alirezaghey", + "BethanyG", + "cmccandless", + "Dog", + "xitanggg", + "yawpitch" + ], + "files": { + "solution": [ + "resistor_color_duo.py" + ], + "test": [ + "resistor_color_duo_test.py" + ], + "example": [ + ".meta/example.py" + ] + }, + "blurb": "Convert color codes, as used on resistors, to a numeric value.", + "source": "Maud de Vries, Erik Schierboom", + "source_url": "https://github.com/exercism/problem-specifications/issues/1464" +} diff --git a/resistor-color-duo/.exercism/metadata.json b/resistor-color-duo/.exercism/metadata.json new file mode 100644 index 0000000..ed5de1c --- /dev/null +++ b/resistor-color-duo/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"python","exercise":"resistor-color-duo","id":"c9790bbb82f24673ad13143e1ced89d0","url":"https://exercism.org/tracks/python/exercises/resistor-color-duo","handle":"myFirstCode","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/resistor-color-duo/HELP.md b/resistor-color-duo/HELP.md new file mode 100644 index 0000000..b9f3bb1 --- /dev/null +++ b/resistor-color-duo/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} +``` + +
+ +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 resistor_color_duo.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. \ No newline at end of file diff --git a/resistor-color-duo/README.md b/resistor-color-duo/README.md new file mode 100644 index 0000000..5dac4aa --- /dev/null +++ b/resistor-color-duo/README.md @@ -0,0 +1,57 @@ +# Resistor Color Duo + +Welcome to Resistor Color Duo on Exercism's Python Track. +If you need help running the tests or submitting your code, check out `HELP.md`. + +## Instructions + +If you want to build something using a Raspberry Pi, you'll probably use _resistors_. +For this exercise, you need to know two things about them: + +- Each resistor has a resistance value. +- Resistors are small - so small in fact that if you printed the resistance value on them, it would be hard to read. + +To get around this problem, manufacturers print color-coded bands onto the resistors to denote their resistance values. +Each band has a position and a numeric value. + +The first 2 bands of a resistor have a simple encoding scheme: each color maps to a single number. +For example, if they printed a brown band (value 1) followed by a green band (value 5), it would translate to the number 15. + +In this exercise you are going to create a helpful program so that you don't have to remember the values of the bands. +The program will take color names as input and output a two digit number, even if the input is more than two colors! + +The band colors are encoded as follows: + +- black: 0 +- brown: 1 +- red: 2 +- orange: 3 +- yellow: 4 +- green: 5 +- blue: 6 +- violet: 7 +- grey: 8 +- white: 9 + +From the example above: +brown-green should return 15, and +brown-green-violet should return 15 too, ignoring the third color. + +## Source + +### Created by + +- @ee7 + +### Contributed to by + +- @alirezaghey +- @BethanyG +- @cmccandless +- @Dog +- @xitanggg +- @yawpitch + +### Based on + +Maud de Vries, Erik Schierboom - https://github.com/exercism/problem-specifications/issues/1464 \ No newline at end of file diff --git a/resistor-color-duo/resistor_color_duo.py b/resistor-color-duo/resistor_color_duo.py new file mode 100644 index 0000000..f509c98 --- /dev/null +++ b/resistor-color-duo/resistor_color_duo.py @@ -0,0 +1,30 @@ +""" +In this exercise you are going to create a helpful program so that +you don't have to remember the values of the bands. The program will +take color names as input and output a two digit number, even if the +input is more than two colors! +""" + +COLORS: tuple = ( + "black", + "brown", + "red", + "orange", + "yellow", + "green", + "blue", + "violet", + "grey", + "white", +) + + +def value(colors: list) -> int: + """ + Take color names as input and output a two digit number, + even if the input is more than two colors. + + :param colors: list of color names + :return: two-digit number + """ + return int("".join(str(COLORS.index(color)) for color in colors[:2])) diff --git a/resistor-color-duo/resistor_color_duo_test.py b/resistor-color-duo/resistor_color_duo_test.py new file mode 100644 index 0000000..668cd65 --- /dev/null +++ b/resistor-color-duo/resistor_color_duo_test.py @@ -0,0 +1,33 @@ +# pylint: disable=C0301, C0114, C0115, C0116, R0904 +# These tests are auto-generated with test data from: +# https://github.com/exercism/problem-specifications/tree/main/exercises/resistor-color-duo/canonical-data.json +# File last updated on 2023-07-19 + +import unittest + +from resistor_color_duo import ( + value, +) + + +class ResistorColorDuoTest(unittest.TestCase): + def test_brown_and_black(self): + self.assertEqual(value(["brown", "black"]), 10) + + def test_blue_and_grey(self): + self.assertEqual(value(["blue", "grey"]), 68) + + def test_yellow_and_violet(self): + self.assertEqual(value(["yellow", "violet"]), 47) + + def test_white_and_red(self): + self.assertEqual(value(["white", "red"]), 92) + + def test_orange_and_orange(self): + self.assertEqual(value(["orange", "orange"]), 33) + + def test_ignore_additional_colors(self): + self.assertEqual(value(["green", "brown", "orange"]), 51) + + def test_black_and_brown_one_digit(self): + self.assertEqual(value(["black", "brown"]), 1)