Skip to content

Commit bb49604

Browse files
ikostanikostan
committed
Diamond
1 parent 800fc65 commit bb49604

File tree

6 files changed

+375
-0
lines changed

6 files changed

+375
-0
lines changed

‎diamond/.exercism/config.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"authors": [
3+
"behrtam"
4+
],
5+
"contributors": [
6+
"BethanyG",
7+
"cmccandless",
8+
"Dog",
9+
"ikhadykin",
10+
"lucasdpau",
11+
"N-Parsons",
12+
"pheanex",
13+
"rjsabatini",
14+
"tqa236"
15+
],
16+
"files": {
17+
"solution": [
18+
"diamond.py"
19+
],
20+
"test": [
21+
"diamond_test.py"
22+
],
23+
"example": [
24+
".meta/example.py"
25+
]
26+
},
27+
"blurb": "Given a letter, print a diamond starting with 'A' with the supplied letter at the widest point.",
28+
"source": "Seb Rose",
29+
"source_url": "https://web.archive.org/web/20220807163751/http://claysnow.co.uk/recycling-tests-in-tdd/"
30+
}

‎diamond/.exercism/metadata.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"track":"python","exercise":"diamond","id":"ea3ca14936c94d34bd8495f82d9c81f8","url":"https://exercism.org/tracks/python/exercises/diamond","handle":"myFirstCode","is_requester":true,"auto_approve":false}

‎diamond/HELP.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Help
2+
3+
## Running the tests
4+
5+
We use [pytest][pytest: Getting Started Guide] as our website test runner.
6+
You will need to install `pytest` on your development machine if you want to run tests for the Python track locally.
7+
You should also install the following `pytest` plugins:
8+
9+
- [pytest-cache][pytest-cache]
10+
- [pytest-subtests][pytest-subtests]
11+
12+
Extended information can be found in our website [Python testing guide][Python track tests page].
13+
14+
15+
### Running Tests
16+
17+
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_).
18+
Test files usually end in `_test.py`, and are the same tests that run on the website when a solution is uploaded.
19+
20+
Linux/MacOS
21+
```bash
22+
$ cd {path/to/exercise-folder-location}
23+
```
24+
25+
Windows
26+
```powershell
27+
PS C:\Users\foobar> cd {path\to\exercise-folder-location}
28+
```
29+
30+
<br>
31+
32+
Next, run the `pytest` command in your terminal, replacing `{exercise_test.py}` with the name of the test file:
33+
34+
Linux/MacOS
35+
```bash
36+
$ python3 -m pytest -o markers=task {exercise_test.py}
37+
==================== 7 passed in 0.08s ====================
38+
```
39+
40+
Windows
41+
```powershell
42+
PS C:\Users\foobar> py -m pytest -o markers=task {exercise_test.py}
43+
==================== 7 passed in 0.08s ====================
44+
```
45+
46+
47+
### Common options
48+
- `-o` : override default `pytest.ini` (_you can use this to avoid marker warnings_)
49+
- `-v` : enable verbose output.
50+
- `-x` : stop running tests on first failure.
51+
- `--ff` : run failures from previous test before running other test cases.
52+
53+
For additional options, use `python3 -m pytest -h` or `py -m pytest -h`.
54+
55+
56+
### Fixing warnings
57+
58+
If you do not use `pytest -o markers=task` when invoking `pytest`, you might receive a `PytestUnknownMarkWarning` for tests that use our new syntax:
59+
60+
```bash
61+
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
62+
```
63+
64+
To avoid typing `pytest -o markers=task` for every test you run, you can use a `pytest.ini` configuration file.
65+
We have made one that can be downloaded from the top level of the Python track directory: [pytest.ini][pytest.ini].
66+
67+
You can also create your own `pytest.ini` file with the following content:
68+
69+
```ini
70+
[pytest]
71+
markers =
72+
task: A concept exercise task.
73+
```
74+
75+
Placing the `pytest.ini` file in the _root_ or _working_ directory for your Python track exercises will register the marks and stop the warnings.
76+
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].
77+
78+
Information on customizing pytest configurations can be found in the `pytest` documentation on [configuration file formats][pytest: configuration file formats].
79+
80+
81+
### Extending your IDE or Code Editor
82+
83+
Many IDEs and code editors have built-in support for using `pytest` and other code quality tools.
84+
Some community-sourced options can be found on our [Python track tools page][Python track tools page].
85+
86+
[Pytest: Getting Started Guide]: https://docs.pytest.org/en/latest/getting-started.html
87+
[Python track tools page]: https://exercism.org/docs/tracks/python/tools
88+
[Python track tests page]: https://exercism.org/docs/tracks/python/tests
89+
[pytest-cache]:http://pythonhosted.org/pytest-cache/
90+
[pytest-subtests]:https://github.com/pytest-dev/pytest-subtests
91+
[pytest.ini]: https://github.com/exercism/python/blob/main/pytest.ini
92+
[pytest: configuration file formats]: https://docs.pytest.org/en/6.2.x/customize.html#configuration-file-formats
93+
[pytest: marking test functions with attributes]: https://docs.pytest.org/en/6.2.x/mark.html#raising-errors-on-unknown-marks
94+
[pytest: working with custom markers]: https://docs.pytest.org/en/6.2.x/example/markers.html#working-with-custom-markers
95+
96+
## Submitting your solution
97+
98+
You can submit your solution using the `exercism submit diamond.py` command.
99+
This command will upload your solution to the Exercism website and print the solution page's URL.
100+
101+
It's possible to submit an incomplete solution which allows you to:
102+
103+
- See how others have completed the exercise
104+
- Request help from a mentor
105+
106+
## Need to get help?
107+
108+
If you'd like help solving the exercise, check the following pages:
109+
110+
- The [Python track's documentation](https://exercism.org/docs/tracks/python)
111+
- The [Python track's programming category on the forum](https://forum.exercism.org/c/programming/python)
112+
- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
113+
- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
114+
115+
Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
116+
117+
Below are some resources for getting help if you run into trouble:
118+
119+
- [The PSF](https://www.python.org) hosts Python downloads, documentation, and community resources.
120+
- [The Exercism Community on Discord](https://exercism.org/r/discord)
121+
- [Python Community on Discord](https://pythondiscord.com/) is a very helpful and active community.
122+
- [/r/learnpython/](https://www.reddit.com/r/learnpython/) is a subreddit designed for Python learners.
123+
- [#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.
124+
- [Python Community Forums](https://discuss.python.org/)
125+
- [Free Code Camp Community Forums](https://forum.freecodecamp.org/)
126+
- [CodeNewbie Community Help Tag](https://community.codenewbie.org/t/help)
127+
- [Pythontutor](http://pythontutor.com/) for stepping through small code snippets visually.
128+
129+
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.
130+
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.

‎diamond/README.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Diamond
2+
3+
Welcome to Diamond on Exercism's Python Track.
4+
If you need help running the tests or submitting your code, check out `HELP.md`.
5+
6+
## Instructions
7+
8+
The diamond kata takes as its input a letter, and outputs it in a diamond shape.
9+
Given a letter, it prints a diamond starting with 'A', with the supplied letter at the widest point.
10+
11+
## Requirements
12+
13+
- The first row contains one 'A'.
14+
- The last row contains one 'A'.
15+
- All rows, except the first and last, have exactly two identical letters.
16+
- All rows have as many trailing spaces as leading spaces. (This might be 0).
17+
- The diamond is horizontally symmetric.
18+
- The diamond is vertically symmetric.
19+
- The diamond has a square shape (width equals height).
20+
- The letters form a diamond shape.
21+
- The top half has the letters in ascending order.
22+
- The bottom half has the letters in descending order.
23+
- The four corners (containing the spaces) are triangles.
24+
25+
## Examples
26+
27+
In the following examples, spaces are indicated by `·` characters.
28+
29+
Diamond for letter 'A':
30+
31+
```text
32+
A
33+
```
34+
35+
Diamond for letter 'C':
36+
37+
```text
38+
··A··
39+
·B·B·
40+
C···C
41+
·B·B·
42+
··A··
43+
```
44+
45+
Diamond for letter 'E':
46+
47+
```text
48+
····A····
49+
···B·B···
50+
··C···C··
51+
·D·····D·
52+
E·······E
53+
·D·····D·
54+
··C···C··
55+
···B·B···
56+
····A····
57+
```
58+
59+
## Source
60+
61+
### Created by
62+
63+
- @behrtam
64+
65+
### Contributed to by
66+
67+
- @BethanyG
68+
- @cmccandless
69+
- @Dog
70+
- @ikhadykin
71+
- @lucasdpau
72+
- @N-Parsons
73+
- @pheanex
74+
- @rjsabatini
75+
- @tqa236
76+
77+
### Based on
78+
79+
Seb Rose - https://web.archive.org/web/20220807163751/http://claysnow.co.uk/recycling-tests-in-tdd/

‎diamond/diamond.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
"""
2+
The diamond kata takes as its input a letter, and outputs it in
3+
a diamond shape. Given a letter, it prints a diamond starting
4+
with 'A', with the supplied letter at the widest point.
5+
"""
6+
7+
import string
8+
9+
CHARS: str = string.ascii_uppercase
10+
11+
12+
def rows(letter: str) -> list:
13+
"""
14+
Return the diamond rows from 'A' to ``letter``.
15+
16+
Builds the upper half and mirrors it to form a symmetric diamond.
17+
18+
:param str letter: Uppercase letter (``'A'``-``'Z'``) marking the widest row.
19+
:returns: The full diamond as a list of strings, one per row.
20+
:rtype: list
21+
:raises ValueError: If ``letter`` is not an ASCII uppercase character.
22+
"""
23+
result: list = []
24+
letter_index: int = CHARS.index(letter)
25+
row_length: int = (letter_index * 2) + 1
26+
27+
for i, char in enumerate(CHARS[: letter_index + 1]):
28+
# All rows have as many trailing spaces as leading spaces.
29+
spaces: str = " " * (letter_index - i)
30+
# The first/last row contains one 'A'.
31+
if i == 0:
32+
result.append(spaces + char + spaces)
33+
else:
34+
middle: str = " " * (row_length - 2 - (len(spaces) * 2))
35+
# All rows, except the first and last, have exactly two identical letters.
36+
result.append(spaces + char + middle + char + spaces)
37+
# Mirror the list: the bottom half has the letters in descending order.
38+
result = result + result[::-1][1:]
39+
return result

‎diamond/diamond_test.py‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# pylint: disable=C0301, C0114, C0115, C0116, R0904
2+
# These tests are auto-generated with test data from:
3+
# https://github.com/exercism/problem-specifications/tree/main/exercises/diamond/canonical-data.json
4+
# File last updated on 2023-07-19
5+
6+
import unittest
7+
8+
from diamond import (
9+
rows,
10+
)
11+
12+
13+
class DiamondTest(unittest.TestCase):
14+
def test_degenerate_case_with_a_single_a_row(self):
15+
result = ["A"]
16+
self.assertEqual(rows("A"), result)
17+
18+
def test_degenerate_case_with_no_row_containing_3_distinct_groups_of_spaces(self):
19+
result = [" A ", "B B", " A "]
20+
self.assertEqual(rows("B"), result)
21+
22+
def test_smallest_non_degenerate_case_with_odd_diamond_side_length(self):
23+
result = [" A ",
24+
" B B ",
25+
"C C",
26+
" B B ",
27+
" A "]
28+
self.assertEqual(rows("C"), result)
29+
30+
def test_smallest_non_degenerate_case_with_even_diamond_side_length(self):
31+
result = [
32+
" A ",
33+
" B B ",
34+
" C C ",
35+
"D D",
36+
" C C ",
37+
" B B ",
38+
" A ",
39+
]
40+
self.assertEqual(rows("D"), result)
41+
42+
def test_largest_possible_diamond(self):
43+
result = [
44+
" A ",
45+
" B B ",
46+
" C C ",
47+
" D D ",
48+
" E E ",
49+
" F F ",
50+
" G G ",
51+
" H H ",
52+
" I I ",
53+
" J J ",
54+
" K K ",
55+
" L L ",
56+
" M M ",
57+
" N N ",
58+
" O O ",
59+
" P P ",
60+
" Q Q ",
61+
" R R ",
62+
" S S ",
63+
" T T ",
64+
" U U ",
65+
" V V ",
66+
" W W ",
67+
" X X ",
68+
" Y Y ",
69+
"Z Z",
70+
" Y Y ",
71+
" X X ",
72+
" W W ",
73+
" V V ",
74+
" U U ",
75+
" T T ",
76+
" S S ",
77+
" R R ",
78+
" Q Q ",
79+
" P P ",
80+
" O O ",
81+
" N N ",
82+
" M M ",
83+
" L L ",
84+
" K K ",
85+
" J J ",
86+
" I I ",
87+
" H H ",
88+
" G G ",
89+
" F F ",
90+
" E E ",
91+
" D D ",
92+
" C C ",
93+
" B B ",
94+
" A ",
95+
]
96+
self.assertEqual(rows("Z"), result)

0 commit comments

Comments
 (0)