refactor(parameters): add overload signatures for get_parameter and get_parameters

[troyswanson]

Issue number: #3507

Summary

Changes

Adds overload signatures for the get_parameter and get_parameters functions depending on the arguments present. Also defines the literals that are available in the transform argument.

User experience

Type checkers should return the expected type based on the value in the transform argument.

• If None, return type should be str
• If "json", return type should be dict
• If "binary", return type should be bytes

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

No

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[boring-cyborg]

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[rubenfonseca]

Looking at this now

[heitorlessa]

great work!!! Only one missing... Literal["auto"]. It uses the parameter suffix to find the transformation method to use (.binary -> Binary, or .json -> JSON).

Example in get_parameters_by_name.

[rubenfonseca]

I've added the missing case. @heitorlessa please review when possible

[leandrodamascena]

APPROVED

Dismiss review

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (926ff86) 95.78% compared to head (f5cfcc2) 95.78%.
Report is 6 commits behind head on develop.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3534   +/-   ##
========================================
  Coverage    95.78%   95.78%           
========================================
  Files          210      210           
  Lines         9681     9681           
  Branches      1773     1773           
========================================
  Hits          9273     9273           
  Misses         294      294           
  Partials       114      114           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!