[New Concept]: Decorators by mathstrains21 · Pull Request #2838 · exercism/python · GitHub

Adds concept / concept exercise for #2356. This is in a WIP state and is up for any feedback to come in earlier!

Notes:

error messages have been designed in line with python 3.9. I believe the error messages in question have not been changed between 3.6 and 3.9. I am aware that 3.10 changed many error messages, but I do not know whether the ones used in this concept have been changed. If you would like me to check/update these to be inline with 3.10 then please say! (I chose 3.9 as it is the version currently used by the test runner and I believe that 3.8, which the track itself uses, doesn't make a difference anyway.

In line with the above, should I be basing code samples off 3.8 or 3.9? (I assume when the track updates code samples would have to be updated to)

I will edit this as I add things that are useful to note and when I mark this PR as ready for review!

Similar suggestion for vertical white space, though, of course, there is only one EOL missing at the end of the file.

Instead of the merge of main into this branch, it would be better to rebase this branch onto main. Feel free to do a force push to this branch as well, it is yours to work with.

Instead of the merge of main into this branch, it would be better to rebase this branch onto main. Feel free to do a force push to this branch as well, it is yours to work with.

@kotp
For rebasing can I confirm that this is what I should do after pulling the changes into main?:

git checkout decorators
git rebase main

Hi! I have got to the point of returning a different function in decorators, and am struggling to decide how to introduce it.
Most decorators doing this would use *args and **kwargs, but I feel I don't want to use this syntax for the first example with the inner function. Could someone suggest a good introduction please?

Edit: Having once again read the RealPython article linked in #2356 I have an idea as to what to do. I will attempt to write it and will commit for feedback once done!
Edit2: (Now ready for feedback on this part)

On 22/01/06 01:52AM, mathstrains21 wrote: > Instead of the merge of main into this branch, it would be better to rebase this branch onto main. Feel free to do a force push to this branch as well, it is yours to work with. @kotp For rebasing can I confirm that this is what I should do: ```cmd git checkout decorators git rebase main ```

You might want to make sure that main is fetched. I usually do: ``` git fetch --all git checkout decorators git rebase origin/main ``` You could checkout main and do a `git pull origin main` and then do your two steps, results are the same.

Is there any tool we are using that will validate the python code in code blocks?

Overall, I think this needs some re-arranging for clarity. I'd also suggest dividing the decorator examples into categories -- so that you have an explicitly titled section for (these are just quick examples - not requests) decorators that take arguments and decorators that extend behavior vs decorators that change behavior or decorators that register, etc.

I also think this topic is complex enough that having real-world examples to anchor need/understanding is helpful. So while a few simple examples are good in the ramp-up, something like building up to the logging decorator Aaron Maxwell describes here I think would really help students understand the power of what they can do with them.

Apologies, @mathstrains21 - I didn't see your comment from yesterday until just now, so my comments are for the whole thing, and not that particular section. 😱 I agree that the first example should be without *args and **kwargs -- but it is perfectly fine to have follow-on examples that do use them. I think our intent is to introduce *args and **kwargs in an exercise ahead of this one. But it is also fine to simply say here that they are a way of having arbitrary arguments, and to link to the docs as a way of explaining.

I did link to additional articles and authors that I think have some good decorator examples, but rather than have you plow through all the review comments, I will also just link them here:

David Beazley, in his Practical Python Programming course: function decorators
Bob Belderbos from PyBit.es: decorators by example & decorator optional arguments
Bob Belderbos on codementor.io: advanced python decorators
Aaron Maxwell on O'Riellys blog: 5 reasons you need to learn decorators

An additional article from Dan Bader, that has a good structure, I think: python-decorators

On Fri, Jan 7, 2022 at 12:18 PM mathstrains21 ***@***.***> wrote: Is there any tool we are using that will validate the python code in code blocks? — Reply to this email directly, view it on GitHub <#2838 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABNGCFUCVQEP5WPF4XK427DUU5C7VANCNFSM5LE7B2AQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because your review was requested.Message ID: ***@***.***>

Apologies, This note is not showing on the GH comments for the PR, so it got buried in my email notifications. Currently, no - we don't have a specific tool. Do you have any suggestions? I have a note on my to do list to figure out a tool for this and incorporate it as part of our CI -- but haven't had the time to really investigate. -Bethany Edited to add the following links/packages I found and am considering trying out. The last one looks pretty promising: [doctest](https://docs.python.org/3/library/doctest.html) [mkcodes](https://github.com/ryneeverett/mkcodes) [pmdoctest](https://tmarktaylor.github.io/phmdoctest/)

On 22/01/07 12:18PM, mathstrains21 wrote: Is there any tool we are using that will validate the python code in code blocks?

I am not sure how to take the question, but I use an editor that I can focus on the block, set the file type to python, and can get syntax highlighting, and linting.

Apologies, @mathstrains21 - I didn't see your comment from yesterday until just now, so my comments are for the whole thing, and not that particular section. 😱 I agree that the first example should be without *args and **kwargs -- but it is perfectly fine to have follow-on examples that do use them. I think our intent is to introduce *args and **kwargs in an exercise ahead of this one. But it is also fine to simply say here that they are a way of having arbitrary arguments, and to link to the docs as a way of explaining.

Ok! That is roughly what I am doing anyway!

Overall, I think this needs some re-arranging for clarity. I'd also suggest dividing the decorator examples into categories -- so that you have an explicitly titled section for (these are just quick examples - not requests) decorators that take arguments and decorators that extend behavior vs decorators that change behavior or decorators that register, etc.

I also think this topic is complex enough that having real-world examples to anchor need/understanding is helpful. So while a few simple examples are good in the ramp-up, something like building up to the logging decorator Aaron Maxwell describes here I think would really help students understand the power of what they can do with them.

Have looked through your review, will review it in more detail this afternoon and start doing the rearranging!

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Requested change is the "decorater" typo. Others are suggestions, are, well, suggestive.

Why? We might want to explain what the problem is being presented to the parser when there is no parenthesis. Or pose it as a "Getting to Deep Dive Python" point…

Next commit will include , as you would in calling any function:

This suggests that it either must or may return the original passed in function indirectly. This could be clarified.

The last line will be changed in the next commit to

The inner_function may or may not return the original, passed-in function.

This does not, for me, clarify the prior sentence.

The whole paragraph will be rephrased in the next commit to

The inner function returns either func or, if planet equals Pluto, it will print that Pluto is not a planet.
It could be coded to raise a ValueError instead.
So, the inner function wraps func, and returns either func or does something that substitutes what func would do.
The decorator returns its inner function.
The inner_function may or may not return the original, passed-in function.
Depending on what code conditionally executes in the wrapper function or inner_function, func may be returned, an error could be raised, or a value of func's return type could be returned.

It states and then repeats itself to hopefully be more reinforcing than obfuscatory.

Co-authored-by: Victor Goff <keeperotphones@gmail.com>

@kotp Thank you for your substantive observations! Please let me know if I have not addressed them successfully.

Or is it?

https://www.youtube.com/watch?v=ED7O4peJ6lw

This comment was marked as resolved.

Sign in to view

kotp reviewed Jan 4, 2022

View reviewed changes

Comment thread concepts/decorators/about.md Outdated

Comment thread concepts/decorators/about.md Outdated

IsaacG reviewed Jan 4, 2022

View reviewed changes

Comment thread concepts/decorators/about.md Outdated

Comment thread concepts/decorators/about.md Outdated

Comment thread concepts/decorators/about.md Outdated

Comment thread concepts/decorators/about.md Outdated

mathstrains21 force-pushed the decorators branch 5 times, most recently from e1f6969 to 80ca0df Compare January 6, 2022 10:31

mathstrains21 force-pushed the decorators branch 7 times, most recently from ec61cf4 to ca00367 Compare January 7, 2022 18:47

BethanyG self-requested a review January 7, 2022 18:54

mathstrains21 requested a review from kotp January 7, 2022 20:18

BethanyG reviewed Jan 7, 2022

View reviewed changes

mathstrains21 force-pushed the decorators branch from ca00367 to 0ce5a0b Compare January 8, 2022 12:21

bobahop and others added 15 commits June 15, 2022 16:28

Update concepts/decorators/about.md

bea08e9

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

936193d

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

bc3d624

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

99c8662

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

6721bd4

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

89e5971

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

f7d7bd4

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

844d117

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

7f7cc5b

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

324c224

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

0634ecc

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update concepts/decorators/about.md

cc93f0a

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

Update about.md

467d18c

Update concepts/decorators/about.md

19c4cc6

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

White space "corrections"

3a59ddd

kotp force-pushed the decorators branch from 97e34b4 to 3a59ddd Compare June 15, 2022 20:39

kotp suggested changes Jun 15, 2022

View reviewed changes

bobahop and others added 5 commits June 16, 2022 06:20

Update concepts/decorators/about.md

26a5434

Co-authored-by: Victor Goff <keeperotphones@gmail.com>

Update concepts/decorators/about.md

970ddd5

Co-authored-by: Victor Goff <keeperotphones@gmail.com>

Update concepts/decorators/about.md

1dffa4d

Co-authored-by: Victor Goff <keeperotphones@gmail.com>

Update concepts/decorators/about.md

a1066e0

Co-authored-by: Victor Goff <keeperotphones@gmail.com>

Update about.md

fa7101f

kotp reviewed Jun 16, 2022

View reviewed changes

kotp approved these changes Jun 16, 2022

View reviewed changes

BethanyG merged commit 4718195 into exercism:main Jun 16, 2022

This was referenced Jul 14, 2022

Document reputation label exercism/docs#347

Merged

Consider correct reputation amounts for different labels exercism/exercism#6440

Closed

Consider correct reputation amounts for different labels exercism/exercism#6441

Closed

mathstrains21 deleted the decorators branch April 3, 2023 14:16

+              It could be coded to raise a `ValueError` instead.
+              So, the inner function wraps `func`, and returns either `func` or does something that substitutes what `func` would do.
+              The decorator returns its _inner function_.
+              It does not _directly_ return the original, passed-in function.

+              So, the inner function wraps `func`, and returns either `func` or does something that substitutes what `func` would do.
+              The decorator returns its _inner function_.
+              It does not _directly_ return the original, passed-in function.
+              Depending on what happens in the wrapper function, `func` may or may not be returned.

+              ...
+              >>> my_func("Pluto")
+              Entering my_func with Pluto argument
+              Pluto is not a planet!

+                  pass
+              ```
+              If a decorator has defined default arguments, you must use parenthesis in the `@decorator()` call for the decorator to work:

[New Concept]: Decorators by mathstrains21 · Pull Request #2838 · exercism/python · GitHub

Repository navigation

[New Concept]: Decorators - #2838

[New Concept]: Decorators#2838BethanyG merged 49 commits intoexercism:mainexercism/python:mainfrom mathstrains21:decoratorsmathstrains21/exercism-python:decoratorsCopy head branch name to clipboard

Conversation

mathstrains21 commented Jan 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

kotp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kotp commented Jan 6, 2022

Uh oh!

mathstrains21 commented Jan 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mathstrains21 commented Jan 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kotp commented Jan 6, 2022 via email • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mathstrains21 commented Jan 7, 2022

Uh oh!

BethanyG left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BethanyG commented Jan 7, 2022

Uh oh!

BethanyG commented Jan 7, 2022

Uh oh!

BethanyG commented Jan 7, 2022 via email • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kotp commented Jan 8, 2022 via email

Uh oh!

mathstrains21 commented Jan 8, 2022

Uh oh!

mathstrains21 commented Jan 8, 2022

Uh oh!

kotp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kotp Jun 15, 2022

Choose a reason for hiding this comment

Uh oh!

bobahop Jun 16, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kotp Jun 15, 2022

Choose a reason for hiding this comment

Uh oh!

bobahop Jun 16, 2022

Choose a reason for hiding this comment

Uh oh!

kotp Jun 15, 2022

Choose a reason for hiding this comment

Uh oh!

bobahop Jun 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

[New Concept]: Decorators#2838
BethanyG merged 49 commits into
exercism:mainfrom
mathstrains21:decorators

mathstrains21 commented Jan 3, 2022 •
edited
Loading

mathstrains21 commented Jan 6, 2022 •
edited
Loading

mathstrains21 commented Jan 6, 2022 •
edited
Loading

kotp commented Jan 6, 2022 via email •
edited
Loading

BethanyG commented Jan 7, 2022 via email •
edited
Loading

bobahop Jun 16, 2022 •
edited
Loading