Merge pull request #132 from ikostan/main

ikostan · web-flow · commit d07216e529cd · 2025-09-16T21:27:32.000-07:00
Merge from master
diff --git a/sublist/.exercism/config.json b/sublist/.exercism/config.json
@@ -0,0 +1,34 @@
+{
+  "authors": [
+    "betegelse"
+  ],
+  "contributors": [
+    "anunciado",
+    "behrtam",
+    "cmccandless",
+    "csabella",
+    "Dog",
+    "dvermd",
+    "Grociu",
+    "ikhadykin",
+    "kytrinyx",
+    "N-Parsons",
+    "patricksjackson",
+    "Peque",
+    "pheanex",
+    "sjakobi",
+    "tqa236"
+  ],
+  "files": {
+    "solution": [
+      "sublist.py"
+    ],
+    "test": [
+      "sublist_test.py"
+    ],
+    "example": [
+      ".meta/example.py"
+    ]
+  },
+  "blurb": "Write a function to determine if a list is a sublist of another list."
+}
diff --git a/sublist/.exercism/metadata.json b/sublist/.exercism/metadata.json
@@ -0,0 +1 @@
+{"track":"python","exercise":"sublist","id":"8bae0f24bdd44482848cb6021113f869","url":"https://exercism.org/tracks/python/exercises/sublist","handle":"myFirstCode","is_requester":true,"auto_approve":false}
diff --git a/sublist/HELP.md b/sublist/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 sublist.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.
diff --git a/sublist/README.md b/sublist/README.md
@@ -0,0 +1,54 @@
+# Sublist
+
+Welcome to Sublist on Exercism's Python Track.
+If you need help running the tests or submitting your code, check out `HELP.md`.
+
+## Instructions
+
+Given any two lists `A` and `B`, determine if:
+
+- List `A` is equal to list `B`; or
+- List `A` contains list `B` (`A` is a superlist of `B`); or
+- List `A` is contained by list `B` (`A` is a sublist of `B`); or
+- None of the above is true, thus lists `A` and `B` are unequal
+
+Specifically, list `A` is equal to list `B` if both lists have the same values in the same order.
+List `A` is a superlist of `B` if `A` contains a contiguous sub-sequence of values equal to `B`.
+List `A` is a sublist of `B` if `B` contains a contiguous sub-sequence of values equal to `A`.
+
+Examples:
+
+- If `A = []` and `B = []` (both lists are empty), then `A` and `B` are equal
+- If `A = [1, 2, 3]` and `B = []`, then `A` is a superlist of `B`
+- If `A = []` and `B = [1, 2, 3]`, then `A` is a sublist of `B`
+- If `A = [1, 2, 3]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [3, 4, 5]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [3, 4]` and `B = [1, 2, 3, 4, 5]`, then `A` is a sublist of `B`
+- If `A = [1, 2, 3]` and `B = [1, 2, 3]`, then `A` and `B` are equal
+- If `A = [1, 2, 3, 4, 5]` and `B = [2, 3, 4]`, then `A` is a superlist of `B`
+- If `A = [1, 2, 4]` and `B = [1, 2, 3, 4, 5]`, then `A` and `B` are unequal
+- If `A = [1, 2, 3]` and `B = [1, 3, 2]`, then `A` and `B` are unequal
+
+## Source
+
+### Created by
+
+- @betegelse
+
+### Contributed to by
+
+- @anunciado
+- @behrtam
+- @cmccandless
+- @csabella
+- @Dog
+- @dvermd
+- @Grociu
+- @ikhadykin
+- @kytrinyx
+- @N-Parsons
+- @patricksjackson
+- @Peque
+- @pheanex
+- @sjakobi
+- @tqa236
diff --git a/sublist/sublist.py b/sublist/sublist.py
@@ -0,0 +1,23 @@
+"""
+This exercise stub and the test suite contain several enumerated constants.
+
+Enumerated constants can be done with a NAME assigned to an arbitrary,
+but unique value. An integer is traditionally used because it’s memory
+efficient.
+
+It is a common practice to export both constants and functions that work with
+those constants (ex. the constants in the os, subprocess and re modules).
+
+You can learn more here: https://en.wikipedia.org/wiki/Enumerated_type
+"""
+
+# Possible sublist categories.
+# Change the values as you see fit.
+SUBLIST = None
+SUPERLIST = None
+EQUAL = None
+UNEQUAL = None
+
+
+def sublist(list_one, list_two):
+    pass
diff --git a/sublist/sublist_test.py b/sublist/sublist_test.py
@@ -0,0 +1,91 @@
+# pylint: disable=C0301
+# These tests are auto-generated with test data from:
+# https://github.com/exercism/problem-specifications/tree/main/exercises/sublist/canonical-data.json
+# File last updated on 2023-07-19
+
+import unittest
+
+from sublist import (
+    sublist,
+    SUBLIST,
+    SUPERLIST,
+    EQUAL,
+    UNEQUAL,
+)
+
+
+class SublistTest(unittest.TestCase):
+    def test_empty_lists(self):
+        self.assertEqual(sublist([], []), EQUAL)
+
+    def test_empty_list_within_non_empty_list(self):
+        self.assertEqual(sublist([], [1, 2, 3]), SUBLIST)
+
+    def test_non_empty_list_contains_empty_list(self):
+        self.assertEqual(sublist([1, 2, 3], []), SUPERLIST)
+
+    def test_list_equals_itself(self):
+        self.assertEqual(sublist([1, 2, 3], [1, 2, 3]), EQUAL)
+
+    def test_different_lists(self):
+        self.assertEqual(sublist([1, 2, 3], [2, 3, 4]), UNEQUAL)
+
+    def test_false_start(self):
+        self.assertEqual(sublist([1, 2, 5], [0, 1, 2, 3, 1, 2, 5, 6]), SUBLIST)
+
+    def test_consecutive(self):
+        self.assertEqual(sublist([1, 1, 2], [0, 1, 1, 1, 2, 1, 2]), SUBLIST)
+
+    def test_sublist_at_start(self):
+        self.assertEqual(sublist([0, 1, 2], [0, 1, 2, 3, 4, 5]), SUBLIST)
+
+    def test_sublist_in_middle(self):
+        self.assertEqual(sublist([2, 3, 4], [0, 1, 2, 3, 4, 5]), SUBLIST)
+
+    def test_sublist_at_end(self):
+        self.assertEqual(sublist([3, 4, 5], [0, 1, 2, 3, 4, 5]), SUBLIST)
+
+    def test_at_start_of_superlist(self):
+        self.assertEqual(sublist([0, 1, 2, 3, 4, 5], [0, 1, 2]), SUPERLIST)
+
+    def test_in_middle_of_superlist(self):
+        self.assertEqual(sublist([0, 1, 2, 3, 4, 5], [2, 3]), SUPERLIST)
+
+    def test_at_end_of_superlist(self):
+        self.assertEqual(sublist([0, 1, 2, 3, 4, 5], [3, 4, 5]), SUPERLIST)
+
+    def test_first_list_missing_element_from_second_list(self):
+        self.assertEqual(sublist([1, 3], [1, 2, 3]), UNEQUAL)
+
+    def test_second_list_missing_element_from_first_list(self):
+        self.assertEqual(sublist([1, 2, 3], [1, 3]), UNEQUAL)
+
+    def test_first_list_missing_additional_digits_from_second_list(self):
+        self.assertEqual(sublist([1, 2], [1, 22]), UNEQUAL)
+
+    def test_order_matters_to_a_list(self):
+        self.assertEqual(sublist([1, 2, 3], [3, 2, 1]), UNEQUAL)
+
+    def test_same_digits_but_different_numbers(self):
+        self.assertEqual(sublist([1, 0, 1], [10, 1]), UNEQUAL)
+
+    # Additional tests for this track
+    def test_unique_return_values(self):
+        self.assertEqual(len(set([SUBLIST, SUPERLIST, EQUAL, UNEQUAL])), 4)
+
+    def test_inner_spaces(self):
+        self.assertEqual(sublist(["a c"], ["a", "c"]), UNEQUAL)
+
+    def test_large_lists(self):
+        self.assertEqual(
+            sublist(
+                list(range(1000)) * 1000 + list(range(1000, 1100)),
+                list(range(900, 1050)),
+            ),
+            SUPERLIST,
+        )
+
+    def test_spread_sublist(self):
+        self.assertEqual(
+            sublist(list(range(3, 200, 3)), list(range(15, 200, 15))), UNEQUAL
+        )

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"track":"python","exercise":"sublist","id":"8bae0f24bdd44482848cb6021113f869","url":"https://exercism.org/tracks/python/exercises/sublist","handle":"myFirstCode","is_requester":true,"auto_approve":false}`