Fail early when rounds' attributes are missing #2294
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
This commit improves the checks for the rounds' attributes by: 1. Failing early and not when the round is instantiated -> check moved from `AbstractRound` round's `__init__` to the `_MetaAbstractRound` metaclass. 2. Introduces the `extended_requirements` attribute to separate it from the `required_class_attributes` attribute which contains mandatory fields for any type of round.
Adamantios
force-pushed
the
fix/required-attributes
branch
from
c1eb718 to
ef84fd2
Compare
jmoreira-valory
approved these changes
Jan 17, 2025
OjusWiZard
approved these changes
Jan 17, 2025
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.
Proposed changes
Some base rounds require a number of base attributes to be defined by the superclasses. For example, none_type on CollectSameUntilThresholdRound.
If the superclass fails to initialize these attributes, the business logic will proceed without a warning. However, if during the execution variable is required to launch an event, it will crash the application when accessing that attribute.
Fixes
Closes #2246.
Types of changes
What types of changes does your code introduce? (A breaking change is a fix or feature that would cause existing functionality and APIs to not work as expected.)
Put an
xin the box that appliesChecklist
Put an
xin the boxes that apply.mainbranch (left side). Also you should start your branch off ourmain.Further comments
n/a