[New Concept Exercise]: Dataclasses in Python

[BethanyG]

This issue describes how to implement the dataclasses concept exercise for the Python track. The related concept documents issue can be found here.

Additionally, the old concept exercise issue had some discussion attached to it and this concept exercise has been reduced in scope to only dataclasses as a result. You can find the old issue & discussion here.

✅ Getting started

If you have not yet created or contributed to a concept exercise, this issue will require some upfront reading to give you the needed background knowledge. Some good example exercises to look at in the repo:

💡Example Exercises💡 (click to expand)

1. Little Sister's Vocabulary
2. Meltdown Mitigation
3. Making the Grade
4. Ellen's Alien Game

We also recommend completing one or more of the concept exercises (they're called "learning exercises") on the website.

Please please read the docs before starting. Posting PRs without reading these docs will be a lot more frustrating for you during the review cycle, and exhaust Exercism's maintainers' time. So, before diving into the implementation, please go through the following documents:

General Contributing Docs:

• Contributing to Exercism | Exercism and GitHub | - Contributor Pull Request Guide
• What are those Weird Task Tags about?
• Exercism Formatting and Style Guide
• Exercism Markdown Specification
• Reputation

Documents on Language Tracks and Concept Exercises

• Building Language Tracks: An Overview
• What are Concept Exercises?
• Concept Exercise Specifications
• Concept Exercise Stories

🎯 Goal

The goal of this concept exercise is to teach an understanding/use/creation of dataclasses in Python.

💡Learning objectives

• more fully understand the uses (and possible abuses) of classes in Python
• learn some good use-cases for dataclasses over standard classes
• understand when and when not to use a dataclasses
• create/use dataclasses and the @dataclass decorator
• learn some additional methods from the dataclass module
  • dataclasses.fields
  • dataclasses.asdict & dataclasses.astuple
  • dataclasses.replace
  • default factory functions
  • inheritance

And, if it makes sense and is possible to fit into the exercise:

• Contrast dataclasses with an alternative, collections.namedtuple
  • pros and cons of each method for creating data-focused classes
  • speed, memory, and typing use considerations

🤔 Concepts & Related Concepts

• classes
• class attributes
• class members
• dataclasses, @dataclass
• decorators
• collections.namedtuples()

🚫 Topics that are Out of scope

Concepts & Subjects that are Out of Scope (click to expand)

• class-inheritance, multiple-inheritance, __super()__, class mixins (these all have their own exercises)
• class-composition -- (beyond the composition needed for the decorators in this exercise)
• collections module, outside of what is needed to contrast dataclasses with collections.namedtuple (the collections module will get its own exercise)
• comprehensions
• coroutines
• decorators outside of @dataclass
• descriptors (these will get their own exercise)
• generators
• higher-order functions
• using a class as a decorator, beyond the methods made available for dataclasses
• type aliases
• type annotations, beyond what is used in dataclasses

↩️ Prerequisites

These are the concepts/concept exercises the student should be familiar with before taking on/learning this concept.

• basics
• booleans
• classes
• class-customization
• class-inheritance
• class-composition
• comparisons
• decorators
• dicts
• higher-order functions
• iteration
• lists
• numbers
• sequences
• sets
• strings
• tuples

Prereqs (click to expand)

📚 Resources for Writing and Reference

Resources (click to expand)

• classes (Python tutorial)
• Python Docs: dataclasses
• Python Docs: collections.namedtuple()
• PEP 0557
• PEP 0526
• Real Python: Data Classes in Python 3.7+ (Guide)
• Dan Bader: Writing Clean Python with Namedtuples
• Trey Hunner: Easier Classes - Python Classes without All the Cruft
• SO: What are data classes and how are they different?
• DataClass vs NamedTuple vs Object: A Battle of Performance in Python -- warning, this is a subscription service, so not great for links.json
• Real Python: Object-Oriented Programming in Python 3

Exercise Ideas & Stories

Should you need inspiration for an exercise story, you can find a collection here. You can also port an exercise from another track, but please make sure to only to include tasks that actually make sense in Python and that add value for a student. Remove/replace/add tasks as needed to make the concept clear/workable.

📁 Exercise Files to Be Created

File Detail for this Exercise (click to collapse)

Exercise introduction.md For more information, see Exercise introduction.md This can summarize/paraphrase the linked concept documents if they have already been created (either the about or the introduction). The summary does need to have enough information and examples for the student to complete all the tasks outlined for this concept exercise. Exercise instructions.md For more information, see instructions.md Instructions for an exercise usually center on a story that sets up the code challenge to be solved. You can create your own story, or fork one from the ones listed here. Please make sure to give credit to the original authors if you use a story or fork an exercise. Exercise Exemplar.py Solution For more information, see exemplar implementation. This file should not use syntax or datas structures not introduced in this exercise or in this exercise's prerequisites. It will be used as an "ideal" solution for the challenge, so make sure it conforms to PEP8 and other formatting conventions, and does not use single letter variable names. It should also include proper module and function-level docstrings. However, it should NOT include typehinting or type aliases. <Exercise>.py (Stub) for Implementation For more information, see stub implementation. This file should provide the expected function names imported for testing, and optionally TODO comments and or docstrings to aid the student in their implementation. TODOs and docstrings are not required. <Exercise>_Test.py Files For more information, see Tests. Additionally, please note that Python associates exercise tasks to tests via a Pytest Marker, and uses unittest subtests as a form of test paramaterization. See the test file for Little Sisters Vocab for examples of how these techniques work. Exercise Hints.md For more information on writing hints see hints.md Hints should provide enough information to get most students "un-stuck" and moving toward a solution. They should not provide a student with a direct solution. You can refer to one or more of the resources linked in this issue above, or analogous resources from a trusted source. We prefer using links within the Python Docs as the primary go-to, but other resources listed above are also good. Please try to avoid paid or subscription-based links if possible. Exercise Metadata Files Under .meta/config.json For more information on exercise .meta/ files and formatting, see concept exercise metadata files .meta/config.json - see this link for the fields and formatting of this file. .meta/design.md - see this link for the formatting of this file. Please use the Goal, Learning Objectives,Concepts, Prerequisites and , Out of Scope sections from this issue.

♾️ Exercise Metadata - Track

For more information on concept exercises and formatting for the Python track config.json , please see config.json. The track config.json file can be found in the root of the Python repo.

You can use the below for the exercise UUID. You can also generate a new one via exercism configlet, uuidgenerator.net, or any other favorite method. The UUID must be a valid V4 UUID.

• Exercise UUID : 807b22ac-cc2c-43ea-b342-c5250227004a
• concepts should be filled in from the Concepts section in this issue
• prerequisites should be filled in from the Prerequisites section in this issue

🎶 Implementation Notes

• As a reminder, code in the .meta/examplar.py file should only use syntax & concepts introduced in this exercise or one of its prerequisite exercises. We run all our examplar.py files through PyLint, but do not strictly require module docstrings. We do require function docstrings similar to PEP257. See this concept exercise exemplar.py for an example.

• Please do not use comprehensions, generator expressions, or other syntax not previously covered either in the introduction to this exercise, or to one of its prerequisites. Please also follow PEP8 guidelines.

• In General, tests should be written using unittest.TestCase and the test file should be named <EXERCISE-NAME>_test.py.

  • All asserts should contain a "user friendly" failure message (these will display on the webiste to students, so be as clear as you can).
  • We use a PyTest custom mark to link test cases to exercise task numbers.
  • We also use unittest.subtest to parameterize test input where/when needed. Here is an example testfile that shows all three of these in action.

• While we do use PyTest as our test runner and for some implementation tests, please check with a maintainer before using a PyTest-specific test method, fixture, or feature.

• Our markdown and JSON files are checked against prettier . We recommend setting prettier up locally and running it prior to submitting your PR to avoid any CI errors.

🆘 Next Steps & Getting Help

1. If you'd like to work on this issue, comment saying "I'd like to work on this" (there is no real need to wait for a response, just go ahead, we'll assign you and put a [claimed] label on the issue).
2. If you have any questions while implementing, please post the questions as comments in here, or contact one of the maintainers on our Slack channel.

[SarvarRaxmonov]

I'd like to work on this

[BethanyG]

@SarvarRaxmonov - That's awesome to hear! 🎉 I will assign you. Just a a note -- there is a related issue for writing up the concept of dataclasses. You can find that here. And check the pre-existing discussion under the old issue here.

You don't have to write up the concept (I or someone else can do that) -- but the intro should at least parallel what is gone over in the introduction for this exercise, so we'll want a little coordination for that. 😄

Assigning this to you...and let me know either here or in our exercism forums if you have any questions or issues.

[github-actions[bot]]

This issue has been automatically marked as abandoned 🏚 because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[BethanyG]

That's it. I am turning off the bot, dangit.

[okaram]

@SarvarRaxmonov you're working on this exercise, right?

[BethanyG]

@okaram -- These issues are not open for community contribution at this time. Thanks.