Python largest series product

python/README.md

@@ -32,3 +32,4 @@
 - [ellens-alien-game](./ellens-alien-game/README.md)
 - [word-count](./word-count/README.md)
 - [sum-of-multiples](./sum-of-multiples/README.md)
+- [largest-series-product](./largest-series-product/README.md)

python/largest-series-product

@@ -0,0 +1 @@
+largest_series_product

python/largest_series_product/.coverage.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" ?>
+<coverage version="7.2.3" timestamp="1687926787618" lines-valid="27" lines-covered="27" line-rate="1" branches-valid="18" branches-covered="17" branch-rate="0.9444" complexity="0">
+	<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.2.3 -->
+	<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
+	<sources>
+		<source>/home/vpayno/git_vpayno/exercism-workspace/python/largest_series_product</source>
+	</sources>
+	<packages>
+		<package name="." line-rate="1" branch-rate="0.9444" complexity="0">
+			<classes>
+				<class name="largest_series_product.py" filename="largest_series_product.py" complexity="0" line-rate="1" branch-rate="0.9444">
+					<methods/>
+					<lines>
+						<line number="3" hits="1"/>
+						<line number="4" hits="1"/>
+						<line number="7" hits="1"/>
+						<line number="15" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="17" hits="1"/>
+						<line number="19" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="20" hits="1"/>
+						<line number="22" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="23" hits="1"/>
+						<line number="25" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="26" hits="1"/>
+						<line number="28" hits="1"/>
+						<line number="29" hits="1"/>
+						<line number="30" hits="1"/>
+						<line number="31" hits="1"/>
+						<line number="33" hits="1" branch="true" condition-coverage="50% (1/2)" missing-branches="40"/>
+						<line number="34" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="35" hits="1"/>
+						<line number="37" hits="1"/>
+						<line number="38" hits="1"/>
+						<line number="40" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="41" hits="1"/>
+						<line number="42" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="43" hits="1"/>
+						<line number="45" hits="1" branch="true" condition-coverage="100% (2/2)"/>
+						<line number="46" hits="1"/>
+						<line number="48" hits="1"/>
+					</lines>
+				</class>
+			</classes>
+		</package>
+	</packages>
+</coverage>

python/largest_series_product/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = __init__.py, *_test.py

python/largest_series_product/.exercism/config.json

@@ -0,0 +1,33 @@
+{
+  "authors": [
+    "sjakobi"
+  ],
+  "contributors": [
+    "alexpjohnson",
+    "behrtam",
+    "cmccandless",
+    "Dog",
+    "fortrieb",
+    "iandexter",
+    "ikhadykin",
+    "kytrinyx",
+    "N-Parsons",
+    "petertseng",
+    "pheanex",
+    "tqa236"
+  ],
+  "files": {
+    "solution": [
+      "largest_series_product.py"
+    ],
+    "test": [
+      "largest_series_product_test.py"
+    ],
+    "example": [
+      ".meta/example.py"
+    ]
+  },
+  "blurb": "Given a string of digits, calculate the largest product for a contiguous substring of digits of length n.",
+  "source": "A variation on Problem 8 at Project Euler",
+  "source_url": "https://projecteuler.net/problem=8"
+}

python/largest_series_product/.exercism/metadata.json

@@ -0,0 +1 @@
+{"track":"python","exercise":"largest-series-product","id":"15a5c99e56cc4f0ca11bedfc66b21e4a","url":"https://exercism.org/tracks/python/exercises/largest-series-product","handle":"vpayno","is_requester":true,"auto_approve":false}

python/largest_series_product/HELP.md

@@ -0,0 +1,129 @@
+# 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 largest_series_product.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)
+- [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.

python/largest_series_product/README.md

@@ -0,0 +1,86 @@
+# Largest Series Product
+
+Welcome to Largest Series Product on Exercism's Python Track.
+If you need help running the tests or submitting your code, check out `HELP.md`.
+
+## Introduction
+
+You work for a government agency that has intercepted a series of encrypted communication signals from a group of bank robbers.
+The signals contain a long sequence of digits.
+Your team needs to use various digital signal processing techniques to analyze the signals and identify any patterns that may indicate the planning of a heist.
+
+## Instructions
+
+Your task is to look for patterns in the long sequence of digits in the encrypted signal.
+
+The technique you're going to use here is called the largest series product.
+
+Let's define a few terms, first.
+
+- **input**: the sequence of digits that you need to analyze
+- **series**: a sequence of adjacent digits (those that are next to each other) that is contained within the input
+- **span**: how many digits long each series is
+- **product**: what you get when you multiply numbers together
+
+Let's work through an example, with the input `"63915"`.
+
+- To form a series, take adjacent digits in the original input.
+- If you are working with a span of `3`, there will be three possible series:
+  - `"639"`
+  - `"391"`
+  - `"915"`
+- Then we need to calculate the product of each series:
+  - The product of the series `"639"` is 162 (`6 × 3 × 9 = 162`)
+  - The product of the series `"391"` is 27 (`3 × 9 × 1 = 27`)
+  - The product of the series `"915"` is 45 (`9 × 1 × 5 = 45`)
+- 162 is bigger than both 27 and 45, so the largest series product of `"63915"` is from the series `"639"`.
+  So the answer is **162**.
+
+## Exception messages
+
+Sometimes it is necessary to [raise an exception](https://docs.python.org/3/tutorial/errors.html#raising-exceptions). When you do this, you should always include a **meaningful error message** to indicate what the source of the error is. This makes your code more readable and helps significantly with debugging. For situations where you know that the error source will be a certain type, you can choose to raise one of the [built in error types](https://docs.python.org/3/library/exceptions.html#base-classes), but should still include a meaningful message.
+
+This particular exercise requires that you use the [raise statement](https://docs.python.org/3/reference/simple_stmts.html#the-raise-statement) to "throw" a `ValueError` when your `largest_product()` function receives invalid input. The tests will only pass if you both `raise` the `exception` and include a message with it.  Feel free to reuse your code from the `series` exercise!
+
+To raise a `ValueError` with a message, write the message as an argument to the `exception` type:
+
+```python
+# span of numbers is longer than number series
+raise ValueError("span must be smaller than string length")
+
+# span of number is negative
+raise ValueError("span must not be negative")
+
+# series includes non-number input
+raise ValueError("digits input must only contain digits")
+```
+
+## Source
+
+### Created by
+
+- @sjakobi
+
+### Contributed to by
+
+- @alexpjohnson
+- @behrtam
+- @cmccandless
+- @Dog
+- @fortrieb
+- @iandexter
+- @ikhadykin
+- @kytrinyx
+- @N-Parsons
+- @petertseng
+- @pheanex
+- @tqa236
+
+### Based on
+
+A variation on Problem 8 at Project Euler - https://projecteuler.net/problem=8
+
+### My Solution
+
+- [my solution](./largest_series_product.py)
+- [run-tests](./run-tests-python.txt)

python/largest_series_product/largest_series_product.py

@@ -0,0 +1,48 @@
+""" Largest Series Product Python Exercism"""
+
+import re
+from typing import List
+
+
+def largest_product(series: str, size: int) -> int:
+    """Returns the largest product for a contiguous substring of digits of size n.
+
+    :param series: str - sequence of positive integers
+    :param size: int - length of sequence substring
+    :return: int - the largest product of the substrings in the sequence
+    """
+
+    if not series:
+        # this is catching a different test, test for this doesn't exist
+        raise ValueError("span must be smaller than string length")
+
+    if size <= 0:
+        raise ValueError("span must not be negative")
+
+    if len(series) < size:
+        raise ValueError("span must be smaller than string length")
+
+    if not re.match(r"^[0-9]+$", series):
+        raise ValueError("digits input must only contain digits")
+
+    result: int = 0
+    words: List[str] = []
+    word: str = ""
+    digits: str = series
+
+    for _ in range(len(series)):
+        if len(digits) < size:
+            break
+
+        words.append(digits[0:size])
+        digits = digits[1:]
+
+    for word in words.copy():
+        product = 1
+        for n in list(word):
+            product *= int(n)
+
+        if result < product:
+            result = product
+
+    return result