diff --git a/matching-brackets/.exercism/config.json b/matching-brackets/.exercism/config.json deleted file mode 100644 index b07c1ab..0000000 --- a/matching-brackets/.exercism/config.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "authors": [ - "behrtam" - ], - "contributors": [ - "atg-abhishek", - "BethanyG", - "cmccandless", - "Dog", - "ikhadykin", - "kylecjo", - "N-Parsons", - "Nishant23", - "pheanex", - "thomasjpfan", - "tqa236", - "yawpitch" - ], - "files": { - "solution": [ - "matching_brackets.py" - ], - "test": [ - "matching_brackets_test.py" - ], - "example": [ - ".meta/example.py" - ] - }, - "blurb": "Make sure the brackets and braces all match.", - "source": "Ginna Baker" -} diff --git a/matching-brackets/.exercism/metadata.json b/matching-brackets/.exercism/metadata.json deleted file mode 100644 index a9aab6a..0000000 --- a/matching-brackets/.exercism/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{"track":"python","exercise":"matching-brackets","id":"857dec420e5f4b0b8053e024aa163131","url":"https://exercism.org/tracks/python/exercises/matching-brackets","handle":"myFirstCode","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/matching-brackets/HELP.md b/matching-brackets/HELP.md deleted file mode 100644 index 35275ae..0000000 --- a/matching-brackets/HELP.md +++ /dev/null @@ -1,130 +0,0 @@ -# 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 matching_brackets.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/matching-brackets/README.md b/matching-brackets/README.md deleted file mode 100644 index 92246ad..0000000 --- a/matching-brackets/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# Matching Brackets - -Welcome to Matching Brackets on Exercism's Python Track. -If you need help running the tests or submitting your code, check out `HELP.md`. - -## Introduction - -You're given the opportunity to write software for the Bracketeer™, an ancient but powerful mainframe. -The software that runs on it is written in a proprietary language. -Much of its syntax is familiar, but you notice _lots_ of brackets, braces and parentheses. -Despite the Bracketeer™ being powerful, it lacks flexibility. -If the source code has any unbalanced brackets, braces or parentheses, the Bracketeer™ crashes and must be rebooted. -To avoid such a scenario, you start writing code that can verify that brackets, braces, and parentheses are balanced before attempting to run it on the Bracketeer™. - -## Instructions - -Given a string containing brackets `[]`, braces `{}`, parentheses `()`, or any combination thereof, verify that any and all pairs are matched and nested correctly. -Any other characters should be ignored. -For example, `"{what is (42)}?"` is balanced and `"[text}"` is not. - -## Source - -### Created by - -- @behrtam - -### Contributed to by - -- @atg-abhishek -- @BethanyG -- @cmccandless -- @Dog -- @ikhadykin -- @kylecjo -- @N-Parsons -- @Nishant23 -- @pheanex -- @thomasjpfan -- @tqa236 -- @yawpitch - -### Based on - -Ginna Baker \ No newline at end of file diff --git a/matching-brackets/matching_brackets.py b/matching-brackets/matching_brackets.py deleted file mode 100644 index c8e8f56..0000000 --- a/matching-brackets/matching_brackets.py +++ /dev/null @@ -1,2 +0,0 @@ -def is_paired(input_string): - pass diff --git a/matching-brackets/matching_brackets_test.py b/matching-brackets/matching_brackets_test.py deleted file mode 100644 index a8321d9..0000000 --- a/matching-brackets/matching_brackets_test.py +++ /dev/null @@ -1,76 +0,0 @@ -# These tests are auto-generated with test data from: -# https://github.com/exercism/problem-specifications/tree/main/exercises/matching-brackets/canonical-data.json -# File last updated on 2023-07-19 - -import unittest - -from matching_brackets import ( - is_paired, -) - - -class MatchingBracketsTest(unittest.TestCase): - def test_paired_square_brackets(self): - self.assertEqual(is_paired("[]"), True) - - def test_empty_string(self): - self.assertEqual(is_paired(""), True) - - def test_unpaired_brackets(self): - self.assertEqual(is_paired("[["), False) - - def test_wrong_ordered_brackets(self): - self.assertEqual(is_paired("}{"), False) - - def test_wrong_closing_bracket(self): - self.assertEqual(is_paired("{]"), False) - - def test_paired_with_whitespace(self): - self.assertEqual(is_paired("{ }"), True) - - def test_partially_paired_brackets(self): - self.assertEqual(is_paired("{[])"), False) - - def test_simple_nested_brackets(self): - self.assertEqual(is_paired("{[]}"), True) - - def test_several_paired_brackets(self): - self.assertEqual(is_paired("{}[]"), True) - - def test_paired_and_nested_brackets(self): - self.assertEqual(is_paired("([{}({}[])])"), True) - - def test_unopened_closing_brackets(self): - self.assertEqual(is_paired("{[)][]}"), False) - - def test_unpaired_and_nested_brackets(self): - self.assertEqual(is_paired("([{])"), False) - - def test_paired_and_wrong_nested_brackets(self): - self.assertEqual(is_paired("[({]})"), False) - - def test_paired_and_wrong_nested_brackets_but_innermost_are_correct(self): - self.assertEqual(is_paired("[({}])"), False) - - def test_paired_and_incomplete_brackets(self): - self.assertEqual(is_paired("{}["), False) - - def test_too_many_closing_brackets(self): - self.assertEqual(is_paired("[]]"), False) - - def test_early_unexpected_brackets(self): - self.assertEqual(is_paired(")()"), False) - - def test_early_mismatched_brackets(self): - self.assertEqual(is_paired("{)()"), False) - - def test_math_expression(self): - self.assertEqual(is_paired("(((185 + 223.85) * 15) - 543)/2"), True) - - def test_complex_latex_expression(self): - self.assertEqual( - is_paired( - "\\left(\\begin{array}{cc} \\frac{1}{3} & x\\\\ \\mathrm{e}^{x} &... x^2 \\end{array}\\right)" - ), - True, - ) diff --git a/pig-latin/pig_latin.py b/pig-latin/pig_latin.py index 8e28962..da00162 100644 --- a/pig-latin/pig_latin.py +++ b/pig-latin/pig_latin.py @@ -8,59 +8,40 @@ consonants: the other 21 letters of the English alphabet """ -import logging - def translate(text: str) -> str: """ - Translate text from English to Pig Latin. + Translate English text to Pig Latin. - :param text: - :return: + :param text: The English text to translate + :return: The text translated to Pig Latin """ - # Setup logging (console handler for visibility) - logging.basicConfig(level=logging.INFO, format="%(message)s") - logger = logging.getLogger(__name__) - logger.info("Translating text: %s", text) - words: list = text.split(" ") - return " ".join(process_text(word, logger) for word in words) + words: list[str] = text.split(" ") + return " ".join(process_word(word) for word in words) -def process_text(text: str, logger: logging.Logger) -> str: +def process_word(text: str) -> str: """ - Convert a string based on 4 rules of Pig Latin. + Process a single word and convert it to Pig Latin using the four translation rules. - :param logger: - :param text: - :return: + :param text: The English word to convert + :return: The word converted to Pig Latin """ if not text: - logger.info("Skipping empty word: '%s'", text) return "" - logger.info("Processing word: %s", text) # Rule 1 - if is_rule_1(text): + if is_vowel(text[0]) or text[:2] in ("xr", "yt"): # If a word begins with a vowel, # or starts with "xr" or "yt", # add an "ay" sound to the end of the word. - logger.info("Applied Rule #1 to '%s'", text) return f"{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. - logger.info("Applied Rule #2 to '%s'", text) - i = get_last_consonant_indx(text) - return f"{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. - logger.info("Applied Rule #3 to '%s'", text) i = text.index("qu") return f"{text[i + 2 :]}{text[: i + 2]}ay" @@ -69,36 +50,17 @@ def process_text(text: str, logger: logging.Logger) -> str: # 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. - logger.info("Applied Rule #4 to '%s'", text) i = text.index("y") return f"{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. + # Rule 2 + if not is_vowel(text[0]): + # 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_consonant_cluster_length(text) + return f"{text[i + 1 :]}{text[: i + 1]}ay" - :param text: - :return: - """ - return is_consonant(text[0]) and not is_rule_3(text) and not is_rule_4(text) + raise ValueError(f"Unhandled word in Pig Latin translation: '{text}'") def is_rule_3(text: str) -> bool: @@ -136,34 +98,24 @@ def is_rule_4(text: str) -> bool: def is_vowel(char: str) -> bool: """ - Test that char in vowels: the letters a, e, i, o, and u. + Check if a character is a vowel (a, e, i, o, or u). - :param char: - :return: + :param char: The character to check + :return: True if the character is a vowel, False otherwise """ 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: +def get_consonant_cluster_length(text: str) -> int: """ - Get last index of consonant inside the string. + Find the length of the consonant cluster at the beginning of a word. - :param text: - :return: + :param text: The word to analyze + :return: The index of the last consonant in the initial consonant cluster """ i = 0 for n, char in enumerate(text): - if is_consonant(char): + if not is_vowel(char): i = n else: break diff --git a/solutions/python/pig-latin/13/pig_latin.py b/solutions/python/pig-latin/13/pig_latin.py new file mode 100644 index 0000000..da00162 --- /dev/null +++ b/solutions/python/pig-latin/13/pig_latin.py @@ -0,0 +1,123 @@ +""" +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 English text to Pig Latin. + + :param text: The English text to translate + :return: The text translated to Pig Latin + """ + words: list[str] = text.split(" ") + return " ".join(process_word(word) for word in words) + + +def process_word(text: str) -> str: + """ + Process a single word and convert it to Pig Latin using the four translation rules. + + :param text: The English word to convert + :return: The word converted to Pig Latin + """ + if not text: + return "" + + # Rule 1 + if is_vowel(text[0]) or text[:2] in ("xr", "yt"): + # If a word begins with a vowel, + # or starts with "xr" or "yt", + # add an "ay" sound to the end of the word. + return f"{text}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 f"{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 f"{text[i:]}{text[:i]}ay" + + # Rule 2 + if not is_vowel(text[0]): + # 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_consonant_cluster_length(text) + return f"{text[i + 1 :]}{text[: i + 1]}ay" + + raise ValueError(f"Unhandled word in Pig Latin translation: '{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: + """ + Check if a character is a vowel (a, e, i, o, or u). + + :param char: The character to check + :return: True if the character is a vowel, False otherwise + """ + return char in "aeiou" + + +def get_consonant_cluster_length(text: str) -> int: + """ + Find the length of the consonant cluster at the beginning of a word. + + :param text: The word to analyze + :return: The index of the last consonant in the initial consonant cluster + """ + i = 0 + for n, char in enumerate(text): + if not is_vowel(char): + i = n + else: + break + + return i