Matching Brackets

matching-brackets/.exercism/config.json

@@ -0,0 +1,32 @@
+{
+  "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"
+}

matching-brackets/.exercism/metadata.json

@@ -0,0 +1 @@
+{"track":"python","exercise":"matching-brackets","id":"857dec420e5f4b0b8053e024aa163131","url":"https://exercism.org/tracks/python/exercises/matching-brackets","handle":"myFirstCode","is_requester":true,"auto_approve":false}

matching-brackets/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 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.

matching-brackets/README.md

@@ -0,0 +1,44 @@
+# 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

matching-brackets/matching_brackets.py

@@ -0,0 +1,2 @@
+def is_paired(input_string):
+    pass

matching-brackets/matching_brackets_test.py

@@ -0,0 +1,76 @@
+# 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,
+        )