primeiro commit com exercicios de Exercism realizados até esta data
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"authors": [
|
||||
"michaelkunc"
|
||||
],
|
||||
"contributors": [
|
||||
"AnAccountForReportingBugs",
|
||||
"behrtam",
|
||||
"BethanyG",
|
||||
"cmccandless",
|
||||
"Dog",
|
||||
"fortrieb",
|
||||
"ikhadykin",
|
||||
"kytrinyx",
|
||||
"mpatibandla",
|
||||
"N-Parsons",
|
||||
"patricksjackson",
|
||||
"pheanex",
|
||||
"subkrish",
|
||||
"tqa236"
|
||||
],
|
||||
"files": {
|
||||
"solution": [
|
||||
"binary_search.py"
|
||||
],
|
||||
"test": [
|
||||
"binary_search_test.py"
|
||||
],
|
||||
"example": [
|
||||
".meta/example.py"
|
||||
]
|
||||
},
|
||||
"blurb": "Implement a binary search algorithm.",
|
||||
"source": "Wikipedia",
|
||||
"source_url": "https://en.wikipedia.org/wiki/Binary_search_algorithm"
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
{"track":"python","exercise":"binary-search","id":"b5256f28c8a741168d520136d8106a26","url":"https://exercism.org/tracks/python/exercises/binary-search","handle":"sanctushck","is_requester":true,"auto_approve":false}
|
||||
@@ -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 binary_search.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.
|
||||
@@ -0,0 +1,88 @@
|
||||
# Binary Search
|
||||
|
||||
Welcome to Binary Search on Exercism's Python Track.
|
||||
If you need help running the tests or submitting your code, check out `HELP.md`.
|
||||
|
||||
## Introduction
|
||||
|
||||
You have stumbled upon a group of mathematicians who are also singer-songwriters.
|
||||
They have written a song for each of their favorite numbers, and, as you can imagine, they have a lot of favorite numbers (like [0][zero] or [73][seventy-three] or [6174][kaprekars-constant]).
|
||||
|
||||
You are curious to hear the song for your favorite number, but with so many songs to wade through, finding the right song could take a while.
|
||||
Fortunately, they have organized their songs in a playlist sorted by the title — which is simply the number that the song is about.
|
||||
|
||||
You realize that you can use a binary search algorithm to quickly find a song given the title.
|
||||
|
||||
[zero]: https://en.wikipedia.org/wiki/0
|
||||
[seventy-three]: https://en.wikipedia.org/wiki/73_(number)
|
||||
[kaprekars-constant]: https://en.wikipedia.org/wiki/6174_(number)
|
||||
|
||||
## Instructions
|
||||
|
||||
Your task is to implement a binary search algorithm.
|
||||
|
||||
A binary search algorithm finds an item in a list by repeatedly splitting it in half, only keeping the half which contains the item we're looking for.
|
||||
It allows us to quickly narrow down the possible locations of our item until we find it, or until we've eliminated all possible locations.
|
||||
|
||||
~~~~exercism/caution
|
||||
Binary search only works when a list has been sorted.
|
||||
~~~~
|
||||
|
||||
The algorithm looks like this:
|
||||
|
||||
- Find the middle element of a _sorted_ list and compare it with the item we're looking for.
|
||||
- If the middle element is our item, then we're done!
|
||||
- If the middle element is greater than our item, we can eliminate that element and all the elements **after** it.
|
||||
- If the middle element is less than our item, we can eliminate that element and all the elements **before** it.
|
||||
- If every element of the list has been eliminated then the item is not in the list.
|
||||
- Otherwise, repeat the process on the part of the list that has not been eliminated.
|
||||
|
||||
Here's an example:
|
||||
|
||||
Let's say we're looking for the number 23 in the following sorted list: `[4, 8, 12, 16, 23, 28, 32]`.
|
||||
|
||||
- We start by comparing 23 with the middle element, 16.
|
||||
- Since 23 is greater than 16, we can eliminate the left half of the list, leaving us with `[23, 28, 32]`.
|
||||
- We then compare 23 with the new middle element, 28.
|
||||
- Since 23 is less than 28, we can eliminate the right half of the list: `[23]`.
|
||||
- We've found our item.
|
||||
|
||||
## 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 the given value is not found within the array. The tests will only pass if you both `raise` the `exception` and include a message with it.
|
||||
|
||||
To raise a `ValueError` with a message, write the message as an argument to the `exception` type:
|
||||
|
||||
```python
|
||||
# example when value is not found in the array.
|
||||
raise ValueError("value not in array")
|
||||
```
|
||||
|
||||
## Source
|
||||
|
||||
### Created by
|
||||
|
||||
- @michaelkunc
|
||||
|
||||
### Contributed to by
|
||||
|
||||
- @AnAccountForReportingBugs
|
||||
- @behrtam
|
||||
- @BethanyG
|
||||
- @cmccandless
|
||||
- @Dog
|
||||
- @fortrieb
|
||||
- @ikhadykin
|
||||
- @kytrinyx
|
||||
- @mpatibandla
|
||||
- @N-Parsons
|
||||
- @patricksjackson
|
||||
- @pheanex
|
||||
- @subkrish
|
||||
- @tqa236
|
||||
|
||||
### Based on
|
||||
|
||||
Wikipedia - https://en.wikipedia.org/wiki/Binary_search_algorithm
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,28 @@
|
||||
# iterative version of the code
|
||||
# def find(search_list: list[int], value: int) -> int:
|
||||
# left: int = 0
|
||||
# right: int = len(search_list) - 1
|
||||
# search_list.sort()
|
||||
# while left <= right:
|
||||
# middle_index: int = (left + right) // 2
|
||||
# if value < search_list[middle_index]:
|
||||
# right = middle_index - 1
|
||||
# elif value > search_list[middle_index]:
|
||||
# left = middle_index + 1
|
||||
# else:
|
||||
# return middle_index
|
||||
# raise ValueError(f"value not in array")
|
||||
|
||||
|
||||
# recursive version of the code
|
||||
def find(search_list: list[int], value: int) -> int:
|
||||
middle_index: int = (len(search_list) - 1) // 2
|
||||
search_list.sort()
|
||||
if search_list == []:
|
||||
raise ValueError("value not in array")
|
||||
if value < search_list[middle_index]:
|
||||
return find(search_list[:middle_index], value)
|
||||
elif value > search_list[middle_index]:
|
||||
return (middle_index + 1) + find(search_list[middle_index + 1:], value)
|
||||
else:
|
||||
return middle_index
|
||||
@@ -0,0 +1,67 @@
|
||||
# These tests are auto-generated with test data from:
|
||||
# https://github.com/exercism/problem-specifications/tree/main/exercises/binary-search/canonical-data.json
|
||||
# File last updated on 2023-07-20
|
||||
|
||||
import unittest
|
||||
|
||||
from binary_search import (
|
||||
find,
|
||||
)
|
||||
|
||||
|
||||
class BinarySearchTest(unittest.TestCase):
|
||||
def test_finds_a_value_in_an_array_with_one_element(self):
|
||||
self.assertEqual(find([6], 6), 0)
|
||||
|
||||
def test_finds_a_value_in_the_middle_of_an_array(self):
|
||||
self.assertEqual(find([1, 3, 4, 6, 8, 9, 11], 6), 3)
|
||||
|
||||
def test_finds_a_value_at_the_beginning_of_an_array(self):
|
||||
self.assertEqual(find([1, 3, 4, 6, 8, 9, 11], 1), 0)
|
||||
|
||||
def test_finds_a_value_at_the_end_of_an_array(self):
|
||||
self.assertEqual(find([1, 3, 4, 6, 8, 9, 11], 11), 6)
|
||||
|
||||
def test_finds_a_value_in_an_array_of_odd_length(self):
|
||||
self.assertEqual(
|
||||
find([1, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 634], 144), 9
|
||||
)
|
||||
|
||||
def test_finds_a_value_in_an_array_of_even_length(self):
|
||||
self.assertEqual(
|
||||
find([1, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377], 21), 5)
|
||||
|
||||
def test_identifies_that_a_value_is_not_included_in_the_array(self):
|
||||
with self.assertRaises(ValueError) as err:
|
||||
find([1, 3, 4, 6, 8, 9, 11], 7)
|
||||
|
||||
self.assertEqual(type(err.exception), ValueError)
|
||||
self.assertEqual(err.exception.args[0], "value not in array")
|
||||
|
||||
def test_a_value_smaller_than_the_array_s_smallest_value_is_not_found(self):
|
||||
with self.assertRaises(ValueError) as err:
|
||||
find([1, 3, 4, 6, 8, 9, 11], 0)
|
||||
|
||||
self.assertEqual(type(err.exception), ValueError)
|
||||
self.assertEqual(err.exception.args[0], "value not in array")
|
||||
|
||||
def test_a_value_larger_than_the_array_s_largest_value_is_not_found(self):
|
||||
with self.assertRaises(ValueError) as err:
|
||||
find([1, 3, 4, 6, 8, 9, 11], 13)
|
||||
|
||||
self.assertEqual(type(err.exception), ValueError)
|
||||
self.assertEqual(err.exception.args[0], "value not in array")
|
||||
|
||||
def test_nothing_is_found_in_an_empty_array(self):
|
||||
with self.assertRaises(ValueError) as err:
|
||||
find([], 1)
|
||||
|
||||
self.assertEqual(type(err.exception), ValueError)
|
||||
self.assertEqual(err.exception.args[0], "value not in array")
|
||||
|
||||
def test_nothing_is_found_when_the_left_and_right_bounds_cross(self):
|
||||
with self.assertRaises(ValueError) as err:
|
||||
find([1, 2], 0)
|
||||
|
||||
self.assertEqual(type(err.exception), ValueError)
|
||||
self.assertEqual(err.exception.args[0], "value not in array")
|
||||
Binary file not shown.
Reference in New Issue
Block a user