diff --git a/pig-latin/.exercism/config.json b/pig-latin/.exercism/config.json new file mode 100644 index 0000000..6dd8c46 --- /dev/null +++ b/pig-latin/.exercism/config.json @@ -0,0 +1,30 @@ +{ + "authors": [ + "behrtam" + ], + "contributors": [ + "akashsara", + "cmccandless", + "Dog", + "ikhadykin", + "N-Parsons", + "pheanex", + "Sukhj1nder", + "tqa236", + "yawpitch" + ], + "files": { + "solution": [ + "pig_latin.py" + ], + "test": [ + "pig_latin_test.py" + ], + "example": [ + ".meta/example.py" + ] + }, + "blurb": "Implement a program that translates from English to Pig Latin.", + "source": "The Pig Latin exercise at Test First Teaching by Ultrasaurus", + "source_url": "https://github.com/ultrasaurus/test-first-teaching/blob/master/learn_ruby/pig_latin/" +} diff --git a/pig-latin/.exercism/metadata.json b/pig-latin/.exercism/metadata.json new file mode 100644 index 0000000..f72dc4c --- /dev/null +++ b/pig-latin/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"python","exercise":"pig-latin","id":"578598faf1354089ab71fbe02723cbe4","url":"https://exercism.org/tracks/python/exercises/pig-latin","handle":"myFirstCode","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/pig-latin/HELP.md b/pig-latin/HELP.md new file mode 100644 index 0000000..2972102 --- /dev/null +++ b/pig-latin/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 pig_latin.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/pig-latin/README.md b/pig-latin/README.md new file mode 100644 index 0000000..06c2dc2 --- /dev/null +++ b/pig-latin/README.md @@ -0,0 +1,82 @@ +# Pig Latin + +Welcome to Pig Latin on Exercism's Python Track. +If you need help running the tests or submitting your code, check out `HELP.md`. + +## Introduction + +Your parents have challenged you and your sibling to a game of two-on-two basketball. +Confident they'll win, they let you score the first couple of points, but then start taking over the game. +Needing a little boost, you start speaking in [Pig Latin][pig-latin], which is a made-up children's language that's difficult for non-children to understand. +This will give you the edge to prevail over your parents! + +[pig-latin]: https://en.wikipedia.org/wiki/Pig_latin + +## Instructions + +Your task is to translate text from English to Pig Latin. +The translation is defined using four rules, which look at the pattern of vowels and consonants at the beginning of a word. +These rules look at each word's use of vowels and consonants: + +- vowels: the letters `a`, `e`, `i`, `o`, and `u` +- consonants: the other 21 letters of the English alphabet + +## Rule 1 + +If a word begins with a vowel, or starts with `"xr"` or `"yt"`, add an `"ay"` sound to the end of the word. + +For example: + +- `"apple"` -> `"appleay"` (starts with vowel) +- `"xray"` -> `"xrayay"` (starts with `"xr"`) +- `"yttria"` -> `"yttriaay"` (starts with `"yt"`) + +## Rule 2 + +If a word begins with one or more consonants, first move those consonants to the end of the word and then add an `"ay"` sound to the end of the word. + +For example: + +- `"pig"` -> `"igp"` -> `"igpay"` (starts with single consonant) +- `"chair"` -> `"airch"` -> `"airchay"` (starts with multiple consonants) +- `"thrush"` -> `"ushthr"` -> `"ushthray"` (starts with multiple consonants) + +## Rule 3 + +If a word starts with zero or more consonants followed by `"qu"`, first move those consonants (if any) and the `"qu"` part to the end of the word, and then add an `"ay"` sound to the end of the word. + +For example: + +- `"quick"` -> `"ickqu"` -> `"ickquay"` (starts with `"qu"`, no preceding consonants) +- `"square"` -> `"aresqu"` -> `"aresquay"` (starts with one consonant followed by `"qu`") + +## Rule 4 + +If a word starts with one or more consonants followed by `"y"`, first move the consonants preceding the `"y"`to the end of the word, and then add an `"ay"` sound to the end of the word. + +Some examples: + +- `"my"` -> `"ym"` -> `"ymay"` (starts with single consonant followed by `"y"`) +- `"rhythm"` -> `"ythmrh"` -> `"ythmrhay"` (starts with multiple consonants followed by `"y"`) + +## Source + +### Created by + +- @behrtam + +### Contributed to by + +- @akashsara +- @cmccandless +- @Dog +- @ikhadykin +- @N-Parsons +- @pheanex +- @Sukhj1nder +- @tqa236 +- @yawpitch + +### Based on + +The Pig Latin exercise at Test First Teaching by Ultrasaurus - https://github.com/ultrasaurus/test-first-teaching/blob/master/learn_ruby/pig_latin/ \ No newline at end of file diff --git a/pig-latin/pig_latin.py b/pig-latin/pig_latin.py new file mode 100644 index 0000000..73f5f37 --- /dev/null +++ b/pig-latin/pig_latin.py @@ -0,0 +1,155 @@ +""" +The task is to translate text from English to Pig Latin. +The translation is defined using four rules, which look at the pattern of vowels +and consonants at the beginning of a word. These rules look at each word's use +of vowels and consonants: + +vowels: the letters a, e, i, o, and u +consonants: the other 21 letters of the English alphabet +""" + + +def translate(text: str) -> str: + """ + Translate text from English to Pig Latin. + + :param text: + :return: + """ + words: list = text.split(" ") + return " ".join(process_text(word) for word in words) + + +def process_text(text: str) -> str: + """ + Convert a string based on 4 rules of Pig Latin. + + :param text: + :return: + """ + # Rule 1 + if is_rule_1(text): + # If a word begins with a vowel, + # or starts with "xr" or "yt", + # add an "ay" sound to the end of the word. + return text + "ay" + + # Rule 2 + if is_rule_2(text): + # If a word begins with one or more consonants, first move those consonants + # to the end of the word and then add an "ay" sound to the end of the word. + i = get_last_consonant_indx(text) + return text[i + 1 :] + text[: i + 1] + "ay" + + # Rule 3 + if is_rule_3(text): + # If a word starts with zero or more consonants followed by "qu", first move + # those consonants (if any) and the "qu" part to the end of the word, and then + # add an "ay" sound to the end of the word. + i = text.index("qu") + return text[i + 2 :] + text[: i + 2] + "ay" + + # Rule 4 + if is_rule_4(text): + # If a word starts with one or more consonants followed by "y", first move the + # consonants preceding the "y" to the end of the word, and then add an "ay" sound + # to the end of the word. + i = text.index("y") + return text[i:] + text[:i] + "ay" + + raise ValueError(f"Unhandled word in Pig Latin translation: '{text}'") + + +def is_rule_1(text: str) -> bool: + """ + Check if a word begins with a vowel, or starts with "xr" or "yt". + + :param text: + :return: + """ + if is_vowel(text[0]): + return True + if text[:2] in ("xr", "yt"): + return True + return False + + +def is_rule_2(text: str) -> bool: + """ + Check ff a word begins with one or more consonants. + No 'qu' or 'y' in it. + + :param text: + :return: + """ + return is_consonant(text[0]) and not is_rule_3(text) and not is_rule_4(text) + + +def is_rule_3(text: str) -> bool: + """ + Check if a word starts with zero or more consonants followed by "qu". + + :param text: + :return: + """ + if "qu" in text: + if text[:2] == "qu": + return True + + for char in text[: text.index("qu")]: + if is_vowel(char): + return False + return True + return False + + +def is_rule_4(text: str) -> bool: + """ + Check if a word starts with one or more consonants followed by "y". + + :param text: + :return: + """ + if "y" in text and text[0] != "y": + for char in text[: text.index("y")]: + if is_vowel(char): + return False + return True + return False + + +def is_vowel(char: str) -> bool: + """ + Test that char in vowels: the letters a, e, i, o, and u. + + :param char: + :return: + """ + return char in "aeiou" + + +def is_consonant(char: str) -> bool: + """ + Check that char is consonant (the other 21 letters of the English alphabet). + + :param char: + :return: + """ + return char.isalpha() and not is_vowel(char) + + +def get_last_consonant_indx(text: str) -> int: + """ + Get last index of consonant inside the string. + + :param text: + :return: + """ + i = 0 + for n, char in enumerate(text): + if is_consonant(char): + i = n + else: + break + + return i diff --git a/pig-latin/pig_latin_test.py b/pig-latin/pig_latin_test.py new file mode 100644 index 0000000..309f49c --- /dev/null +++ b/pig-latin/pig_latin_test.py @@ -0,0 +1,82 @@ +# pylint: disable=C0114, C0115, C0116, R0904 + +# These tests are auto-generated with test data from: +# https://github.com/exercism/problem-specifications/tree/main/exercises/pig-latin/canonical-data.json +# File last updated on 2025-01-10 + +import unittest + +from pig_latin import ( + translate, +) + + +class PigLatinTest(unittest.TestCase): + def test_word_beginning_with_a(self): + self.assertEqual(translate("apple"), "appleay") + + def test_word_beginning_with_e(self): + self.assertEqual(translate("ear"), "earay") + + def test_word_beginning_with_i(self): + self.assertEqual(translate("igloo"), "iglooay") + + def test_word_beginning_with_o(self): + self.assertEqual(translate("object"), "objectay") + + def test_word_beginning_with_u(self): + self.assertEqual(translate("under"), "underay") + + def test_word_beginning_with_a_vowel_and_followed_by_a_qu(self): + self.assertEqual(translate("equal"), "equalay") + + def test_word_beginning_with_p(self): + self.assertEqual(translate("pig"), "igpay") + + def test_word_beginning_with_k(self): + self.assertEqual(translate("koala"), "oalakay") + + def test_word_beginning_with_x(self): + self.assertEqual(translate("xenon"), "enonxay") + + def test_word_beginning_with_q_without_a_following_u(self): + self.assertEqual(translate("qat"), "atqay") + + def test_word_beginning_with_consonant_and_vowel_containing_qu(self): + self.assertEqual(translate("liquid"), "iquidlay") + + def test_word_beginning_with_ch(self): + self.assertEqual(translate("chair"), "airchay") + + def test_word_beginning_with_qu(self): + self.assertEqual(translate("queen"), "eenquay") + + def test_word_beginning_with_qu_and_a_preceding_consonant(self): + self.assertEqual(translate("square"), "aresquay") + + def test_word_beginning_with_th(self): + self.assertEqual(translate("therapy"), "erapythay") + + def test_word_beginning_with_thr(self): + self.assertEqual(translate("thrush"), "ushthray") + + def test_word_beginning_with_sch(self): + self.assertEqual(translate("school"), "oolschay") + + def test_word_beginning_with_yt(self): + self.assertEqual(translate("yttria"), "yttriaay") + + def test_word_beginning_with_xr(self): + self.assertEqual(translate("xray"), "xrayay") + + def test_y_is_treated_like_a_consonant_at_the_beginning_of_a_word(self): + self.assertEqual(translate("yellow"), "ellowyay") + + def test_y_is_treated_like_a_vowel_at_the_end_of_a_consonant_cluster(self): + self.assertEqual(translate("rhythm"), "ythmrhay") + + def test_y_as_second_letter_in_two_letter_word(self): + self.assertEqual(translate("my"), "ymay") + + def test_a_whole_phrase(self): + self.assertEqual(translate("quick fast run"), "ickquay astfay unray")