Adds default reads/writes to burr actions #269
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ce6ca20
to
7a3e145
Compare
ba5b4bd
to
72f8262
Compare
This allows you to specify defaults if your action does not write. In the majority of cases they will be none, but this allows simple (static) arbitrary values. This specifically helps with the branching case -- e.g. where you have two options, and want to null out anything it doesn't write. For instance, an error and a result -- you'll only ever produce one or the other. This works both in the function and class-based approaches -- in the function-based it is part of the two decorators (@action/@streaming_action). In the class-based it is part of the class, overriding the default_reads and default_writes property function We add a bunch of new tests for default (as the code to handle multiple action types is fairly dispersed, for now), and also make the naming of the other tests/content more consistent. Note that this does not currently work with settings defaults to append/increment operations -- it will produce strange behavior. This is documented in all appropriate signatures. This also does not work (or even make sense) in the case that the function writes a default that it also reads. In that case, it will clobber the current value with the write value. To avoid this, we just error out if that is the case beforehand.
72f8262
to
308be71
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows you to specify defaults if your action does not write. In the majority of cases they will be none, but this allows simple (static) arbitrary values. This specifically helps with the branching case -- e.g. where you have two options, and want to null out anything it doesn't write. For instance, an error and a result -- you'll only ever produce one or the other.
This works both in the function and class-based approaches -- in the function-based it is part of the two decorators
(@action/@streaming_action). In the class-based it is part of the class, overriding the default_reads and default_writes property function
[Short description explaining the high-level reason for the pull request]
Changes
How I tested this
Notes
Checklist