New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Define project-wide data models #485
Merged
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
Sinclert
added
the
internal
Refactoring without interface or functionality changes
label
Sep 30, 2021
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 PR completes the remaining tasks of issue #482: the migration of data model property definition from its current state (array-based) to an object oriented design (class-attributes).
🔍 - Scope
This PR introduces a set of data models that are used project-wide. Thanks to their definition, we could expect less bug-leading syntax like
object[0]
and more meaningful syntax likeobject.name
.🌿 - Additional Improvements:
Systematic
attributes.📝 - Commits methodology
Each commit within the refactor has a prefix indicating:
models
: refers to the creation of the data models.h5py
: refers to the adaptation of the HDF5 MadMiner interface functions.internal
: refers to the code base migration in order to use the newly defined models ✨ .tests
: refers to the small adaptations that tests needed to suffer after adapting the codebase.🔄 -Compatibility
There are multiple public-methods which change their expected arguments:
pass_if_not_parsed
torequired
.value_if_not_parsed
todefault
.overwrite_existing_file
.