Rules: Verify the default values of Options.
#2403
Merged
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
Since `Option.verify()` can handle normalization of option names, this allows options to define defaults which rely on that normalization. For example, it allows a world to exclude certain locations by default. This also makes it easier to catch errors if a world author accidentally sets an invalid default.
ScootyPuffJr1
added
is: enhancement
alwaysintreble
approved these changes
Oct 30, 2023
beauxq
reviewed
Jan 5, 2024
Co-authored-by: Doug Hoskisson <[email protected]>
PoryGone
added
the
waiting-on: peer-review
NewSoupVi
approved these changes
Mar 30, 2024
Comment on lines
436
to
+437
| else: | ||
| setattr(ret, option_key, option.from_any(option.default)) # call the from_any here to support default "random" | ||
| player_option.verify(AutoWorldRegister.world_types[ret.game], ret.name, plando_options) |
There was a problem hiding this comment.
I did not know try -> except -> else existed. Reading up on it, it seems kind of not necessary in this case, as the except block re-raises the Exception anyway, which exits the function, meaning there is no scenario in which "you need to prevent something running after the except". But maybe I'm missing nuance, and hey, it's not wrong or anything, it just took me by surprise. Also it mirrors the old code so I guess it's fine
Exempt-Medic
added
waiting-on: core-review
nex3
changed the title
Options.Options.
Merged
jnschurig
pushed a commit
to Tranquilite0/Archipelago-SoulBlazer
that referenced
this pull request
Jun 13, 2024
* Verify the default values of `Option`s. Since `Option.verify()` can handle normalization of option names, this allows options to define defaults which rely on that normalization. For example, it allows a world to exclude certain locations by default. This also makes it easier to catch errors if a world author accidentally sets an invalid default. * Update Generate.py Co-authored-by: Doug Hoskisson <[email protected]> --------- Co-authored-by: Doug Hoskisson <[email protected]> Co-authored-by: NewSoupVi <[email protected]>
qwint
pushed a commit
to qwint/Archipelago
that referenced
this pull request
Jun 24, 2024
* Verify the default values of `Option`s. Since `Option.verify()` can handle normalization of option names, this allows options to define defaults which rely on that normalization. For example, it allows a world to exclude certain locations by default. This also makes it easier to catch errors if a world author accidentally sets an invalid default. * Update Generate.py Co-authored-by: Doug Hoskisson <[email protected]> --------- Co-authored-by: Doug Hoskisson <[email protected]> Co-authored-by: NewSoupVi <[email protected]>
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.
What is this fixing or adding?
Since
Option.verify()can handle normalization of option names, this allows options to define defaults which rely on that normalization. For example, it allows a world to exclude certain locations by default.This also makes it easier to catch errors if a world author accidentally sets an invalid default.
How was this tested?
I set up a world to exclude a name group by default, ran a generation with default options, and verified that all locations in that group were excluded.