Adding the type guard decorator

mewbotorg / mewbot

Bot go mew~

Other

0 stars 4 forks source link

Adding the type guard decorator #203

Closed ajCameron closed 1 year ago

ajCameron commented 1 year ago

in api - seemed the most appropriate place for it
(if nothing else, because it needed less cross module imports)
added extensive docs including example code
selected the option which didn't confuse pycharm - as that seems to be harder to fix
included a test suite hitting 100% of the module
decorator not currently applied to the examples - would seem beyond the scope of a single pull request
Not over sold on the name - but felt descriptive was better

ajCameron commented 1 year ago

I ... am kinda amazed that worked on all versions....

ajCameron commented 1 year ago

...

....

huh.

javajawa commented 1 year ago

@ajCameron I've made some changes -- mostly I've made the two test groups identical except for the from __future__ import annotations, and increased the number of tested combinations. If you're happy with what I've done, I'll rebase away most of the commits (I don't think the history is relevant outside of this PR, especially with #206 being raised) and then merge

javajawa commented 1 year ago

I have updated and squashed the merge, with a lot of simplification now we don't require python 3.9 support. However, I have not checked that all the test cases are accurately named, or have correct comments.

ajCameron commented 1 year ago

I'm very happy with the direction - I'll aim to have a more thorough look over it tomorrow or Sunday.

sonarcloud[bot] commented 1 year ago

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication