Add warning for removal of default in annotated Parameter args

argoproj-labs / hera

Hera is an Argo Python SDK. Hera aims to make construction and submission of various Argo Project resources easy and accessible to everyone! Hera abstracts away low-level setup details while still maintaining a consistent vocabulary with Argo. ⭐️ Remember to star!

https://hera.rtfd.io

Apache License 2.0

550 stars 105 forks source link

Add warning for removal of default in annotated Parameter args #1102

Closed elliotgunton closed 2 months ago

elliotgunton commented 2 months ago

Pull Request Checklist

[x] Groundwork for #812
[x] Tests added
[x] Documentation/examples added
[x] Good commit messages and/or PR title

Description of PR To complete #812 it would be preferable to give a version's warning of the backwards incompatible change, although I'm happy to make the change in one go.

This PR also fixes a serialization problem when setting the default via a Python function arg.

elliotgunton commented 2 months ago

@samj1912 / @flaviuvadan any preference on this change having a notice or just make the change directly? It's an experimental feature after all 👀

samj1912 commented 2 months ago

I would prefer to give a bit more notice. Let's also provide a couple of minor versions of bandwidth. The way I would prefer to go about removing things is as follows -

Give warning
Raise exception which can be turned off by a flag
Removed feature