[Python] Add tuples concept exercise #1824

BethanyG · 2020-07-04T00:11:13Z

Related Issue: #1097.

New tuples concept exercise.

Since this is my very first and I didn't use the spiffy exercise creatormatic, would really like a through critique. 😄

cmccandless · 2020-07-04T03:51:05Z

languages/python/exercises/concept/tuples/tuples_test.py

+    def test_clean_up(self):
+
+        input_data = (
+                                ("Scrimshaw Whale's Tooth", '2A', 'Deserted Docks', ('2', 'A'), 'Blue'),


Minor nitpick: there's inconsistency between this line (which uses double quotes for this string literal) and other lines (which use single quotes, and escape the embedded apostrophe). I recommend making the others match this to avoid escaping quotes.

Yup. Thank you for catching that! The quotes were a nightmare when it came to checking results from std.out. Next time, I won't name something with an apostrophe int it! 😆 Fixed in latest push.

I find running black on my code to be useful. Among other minor style changes, it would've converted all strings to use double quotes, unless they contain a double quote, then it uses single quotes.

Yeah. Somehow, in my long twisty path I've developed a habit of single quotes. It may be time to remedy that .. and to set up Black to work with Pycharm.

In VS Code, I have flake8 run on file save and alert me of violations, then I manually run black to fix the violations it can. I don't like editors modifying my files implicitly.

I don't use PyCharm, but I'm sure there's a way to set up something similar.

…d cleaned up bloat.

…as learning objective.

ErikSchierboom

@BethanyG Thanks a ton for working on this! This is a great first exercise PR, congrats! You said you'd like a thorough review, so I've obliged :)

Note that I've approved this PR so feel free to merge this and apply and feedback comments in a follow-up PR.

languages/python/exercises/concept/tuples/tuples.py

ErikSchierboom · 2020-07-07T08:17:00Z

languages/python/exercises/concept/tuples/tuples_test.py

+    finally:
+        sys.stdout, sys.stderr = old_out, old_err
+
+class TuplesTest(unittest.TestCase):


By default, all tests currently run. One of the things our test suites aim for is to have the student solve the exercise in a TDD-like way, where you focus on getting one test passing at a time.

Writing this, I wanted to point you to the existing v2 Python test suites for an example, but it turns out that none of the tests are skipped there (see the bob tests or change tests). An an example of what a TDD-like test suite looks like, see this C# test suite or this Elixir test suite.

This might be something to discuss with the other Python maintainers, but I assume there is some good reason for it (ping me in the discussion as I'm very interested). It does look like pytest allows skipping tests: https://docs.pytest.org/en/latest/skipping.html#skipping-test-functions

Here's the discussion on that:
exercism/python#1853

Ah I see. If I read that discussion correctly, the main reason for not using skipped tests is that the canonical data ordering might not be the TDD ordering that is appropriate to Python, right? If so, that would mean that you could do skipped tests for Concept Exercises, as the ordering of the tests is completely up to the Python maintainers. Right?

That is correct.

ErikSchierboom · 2020-07-07T08:24:14Z

languages/python/exercises/concept/tuples/.meta/example.py

+    # alt return coordinate[0], coordinate[1]
+    return tuple(coordinate)


I'd suggest only having one option here (the most idiomatic one), as this file will be shown to mentors and having two options might be confusing.

Both are idiomatic (for better or worse). But since we're trying to get the student to practice different ways of making tuples, I'll re-read in the am and make sure I have one task that uses one method, and another that uses the constructor.

return (coordinate[0], coordinate[1]) seems most natural to me

I'll re-read in the am and make sure I have one task that uses one method, and another that uses the constructor.

Brilliant!

ErikSchierboom · 2020-07-07T08:30:38Z

languages/python/exercises/concept/tuples/.meta/example.py

+def clean_up(combined_record_group):
+    for item in combined_record_group:
+        clean_record = item[0], item[2], item[3], item[4]
+        print(clean_record)


Does this print to the console? If so, could you convert this to returning a value (or modifying the input) instead of printing to the console? In general, exercises don't print to the console as that makes writing the tests harder and will interfere with capturing meaning console output for in-browser debugging purposes.

It does indeed print to the console. Not at all ideal, but I'm struggling here because tuples are immutable. The point of this last task was to iterate through a tuple and do something with the data (in this case 'dropping' an element from each 'record' within the outer tuple) -- but making a new tuple of tuples iteratively via the + operator means that the data gets unpacked -- so the nested tuples become un-nested. 😞

Alternatively, the inner tuples could be added into a list that is then converted -- but lists are neither required / taught for this exercise. The input could be changed to something weird like double-wrapped tuples (three layers of nesting as opposed to two) so that the + doesn't completely unpack them - but that seems very contrived. Maybe if this required a tuple of each team members records as input with the output being a combined tuple....

Hum. Suggestions here? I will sleep on it and try to think of an alternate first thing in the morning. 😁

The point of this last task was to iterate through a tuple and do something with the data

Maybe outputting the combined records in a new string format? Would something like that work?

Maybe outputting the combined records in a new string format? Would something like that work?

This is similar to what we do in the tournament exercise, and would be preferable here.

Yes! Making a string and compiling a 'report' seems like a much better solution - and strings are required knowledge for this exercise, so something with .format() or f-strings in a report would work well. I'll take a look at tournament and how the instructions read there, and change this task accordingly. thank you both for getting me un-stuck! 😀

Our pleasure!

ErikSchierboom · 2020-07-07T10:03:12Z

languages/python/exercises/concept/tuples/.docs/after.md

@@ -0,0 +1,145 @@
+In Python, a tuple is an immutable collection of items in _sequence_. Like most collections, tuples can hold any (or multiple) data type(s) -- including other tuples. Like any sequence, items are referenced by 0-based index number. Tuples support all [common sequence operations](https://docs.python.org/3/library/stdtypes.html#common-sequence-operations).


Is there a resource to link to for the tuple concept?

Added in https://github.com/exercism/v3/blob/master/languages/python/reference/concepts/builtin_types/tuple.md, which needs additional info. In particular, the whole homogenous vs heterogeneous data (as opposed to data type) is very confusing to most people. I have a note to add clarification links to docs and articles there - or generally more explanation.

languages/python/exercises/concept/tuples/.docs/after.md

ErikSchierboom · 2020-07-07T10:04:04Z

languages/python/exercises/concept/tuples/.docs/after.md

@@ -0,0 +1,145 @@
+In Python, a tuple is an immutable collection of items in _sequence_. Like most collections, tuples can hold any (or multiple) data type(s) -- including other tuples. Like any sequence, items are referenced by 0-based index number. Tuples support all [common sequence operations](https://docs.python.org/3/library/stdtypes.html#common-sequence-operations).


I really like this after.md document!

languages/python/exercises/concept/tuples/.meta/design.md

…d introduction.md file name spelling.

…ts and code examples.

…()-ing of content. Adjusted instructions accordingly.

… context handler decorator for re-routing stdout and extra imports.

ErikSchierboom

Excellent work! The final thing to do is to add an entry to the track's config.json file: https://github.com/exercism/v3/blob/master/languages/python/config.json

languages/python/exercises/concept/tuples/.docs/after.md

languages/python/exercises/concept/tuples/.docs/instructions.md

languages/python/exercises/concept/tuples/.meta/design.md

…for tuples.md refrence doc.

BethanyG · 2020-07-11T06:19:03Z

Mashing big, green button. 😱

BethanyG added 10 commits July 3, 2020 16:09

New tuples concept exercise design file.

14e16ef

New tuples concept exercise example implementation file.

b6561f0

New tuples concept exercise config file.

4fe62d6

New tuples concept exercist after file w TODO.

a96dd0b

New tuples concept exercist hints file.

54b711b

New tuples concept exercise introduction file.

ba79077

New tuples concept exercise instructions file.

2dd31c1

New tuples concept exercise boilerplate file.

3ce1f85

New tuples concept exercise cleaned boilerplate file.

92265e4

New tuples concept exercise tests.

2323534

BethanyG requested a review from a team as a code owner July 4, 2020 00:11

iHiD requested a review from ErikSchierboom July 4, 2020 00:28

cmccandless reviewed Jul 4, 2020

View reviewed changes

BethanyG added 7 commits July 3, 2020 22:12

Ran prettier to clean up file markdown formatting. Edited language an…

5a432df

…d cleaned up bloat.

Ran prettier to correct markdown formatting and dleted star operator …

5377eba

…as learning objective.

Removed tuple multiplication with star operator.

c1acea5

Edited to remove multiply function.

b3bee05

Edited to remove multiply function test case.

b9815cc

Fixed quoting on Scrimshaw Whale's tooth to match quoting style.

debacea

Ran prettier for config.json

172ba40

BethanyG linked an issue Jul 4, 2020 that may be closed by this pull request

[Python] Implement new Concept Exercise: tuples #1097

Closed

ErikSchierboom approved these changes Jul 7, 2020

View reviewed changes

BethanyG added 5 commits July 9, 2020 00:11

Edits and adjustments per PR feedback and style guides. Also correcte…

d7445f0

…d introduction.md file name spelling.

Edited for clarity and brevity per PR feedback. Removed excess concep…

72eb276

…ts and code examples.

Re-worked final task to be a returned report string rather than print…

734793b

…()-ing of content. Adjusted instructions accordingly.

Cleaned up per PR feedback. Removed excess lines.

14a46de

Changed final test to support altered task for report string. Removed…

55f231f

… context handler decorator for re-routing stdout and extra imports.

BethanyG requested review from ErikSchierboom and cmccandless July 9, 2020 07:20

Corrected terminal output code exxample for task 4.

a2a864d

ErikSchierboom approved these changes Jul 9, 2020

View reviewed changes

languages/python/exercises/concept/tuples/.docs/after.md Show resolved Hide resolved

languages/python/exercises/concept/tuples/.docs/instructions.md Show resolved Hide resolved

languages/python/exercises/concept/tuples/.meta/design.md Outdated Show resolved Hide resolved

BethanyG added 4 commits July 9, 2020 11:35

Removed print as a prerequisite of the exercise. Added absolute link …

f70a2ab

…for tuples.md refrence doc.

Removed excess PyTest config from test class.

2e00a38

Added tuples concept exercise information and uuid.

af5736f

Ran prettier on config file, since I forgot to.

8416783

BethanyG merged commit f925c3b into exercism:master Jul 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Python] Add tuples concept exercise #1824

[Python] Add tuples concept exercise #1824

BethanyG commented Jul 4, 2020

cmccandless Jul 4, 2020

BethanyG Jul 4, 2020 •

edited

Loading

cmccandless Jul 8, 2020

BethanyG Jul 9, 2020

cmccandless Jul 9, 2020

ErikSchierboom left a comment

ErikSchierboom Jul 7, 2020

cmccandless Jul 7, 2020

ErikSchierboom Jul 7, 2020

cmccandless Jul 8, 2020

ErikSchierboom Jul 7, 2020

BethanyG Jul 8, 2020

cmccandless Jul 8, 2020

ErikSchierboom Jul 8, 2020

ErikSchierboom Jul 7, 2020

BethanyG Jul 8, 2020

ErikSchierboom Jul 8, 2020

cmccandless Jul 8, 2020

BethanyG Jul 8, 2020

ErikSchierboom Jul 9, 2020

ErikSchierboom Jul 7, 2020

BethanyG Jul 8, 2020

ErikSchierboom Jul 7, 2020

ErikSchierboom left a comment

BethanyG commented Jul 11, 2020

		# alt return coordinate[0], coordinate[1]
		return tuple(coordinate)

		@@ -0,0 +1,145 @@
		In Python, a tuple is an immutable collection of items in _sequence_. Like most collections, tuples can hold any (or multiple) data type(s) -- including other tuples. Like any sequence, items are referenced by 0-based index number. Tuples support all [common sequence operations](https://docs.python.org/3/library/stdtypes.html#common-sequence-operations).

[Python] Add tuples concept exercise #1824

[Python] Add tuples concept exercise #1824

Conversation

BethanyG commented Jul 4, 2020

Choose a reason for hiding this comment

BethanyG Jul 4, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ErikSchierboom left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ErikSchierboom left a comment

Choose a reason for hiding this comment

BethanyG commented Jul 11, 2020

BethanyG Jul 4, 2020 •

edited

Loading