missing fields AE fix #322
Merged
Conversation
This file contains hidden or 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
ethanxia4
reviewed
Oct 29, 2025
convokit/model/corpus.py
Outdated
| pd.Series(columns).isin(utterances_df.columns).all() | ||
| ), "Utterances dataframe must contain all primary data fields" | ||
| len(missing_fields) == 0 | ||
| ), f"Utterances dataframe is missing the following required fields: {missing_fields}" |
There was a problem hiding this comment.
could use list(missing_fields) in assert error for slightly more readable formatting, other than that works great
|
@ethanxia4 just updated w/ list(missing_fields); lmk if there's anything else! thanks |
|
looks good! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This change updates the AssertionError that fails when users import utterances with missing fields. Previously, the AE just told the user that SOME fields were missing without specifying which fields were missing. This change provides the users with a list of missing fields upon AE failure, implemented by slightly changing the assertion itself.
Motivation and Context
It provides users with specific information to aid correct usage of the program. It addresses Issue #275 and is a feature enhancement.
How has this been tested?
Pre-commit formatting. Neglected some integration testing given that it's a small change on an error message. Happy to revisit testing if maintainers think that it warrants more scrutiny.