Skip to content

Add 'error_message' as an explicitly required parameter into the FailResult to avoid a footgun. #1000

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Aug 8, 2024
Merged

Add 'error_message' as an explicitly required parameter into the FailResult to avoid a footgun. #1000

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
46eee66
Add a safety which maps 'message' as a parameter to error_message. Mi…
JosephCatrambone Aug 8, 2024
26014a1
Make an explicit constructor for FailResult so that we don't get a fo…
JosephCatrambone Aug 8, 2024
153b466
Fix pyright complaint about param being passed to parent. Add to kwar…
JosephCatrambone Aug 8, 2024
f210314
Revert "Add a safety which maps 'message' as a parameter to error_mes…
JosephCatrambone Aug 8, 2024
8073871
Merge branch 'jc/gh_issue_997_alternative_validator_fix' into jc/gh_i…
JosephCatrambone Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions guardrails/classes/validation/validation_result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ class FailResult(ValidationResult, IFailResult):
"""
error_spans: Optional[List["ErrorSpan"]] = None

def __init__(self, error_message: str, **kwargs) -> None:
# This is a silly thing to force a friendly error message and to give type hints
# to IDEs who have a hard time figuring out the constructor parameters.
kwargs["error_message"] = error_message
super().__init__(**kwargs)

@classmethod
def from_interface(cls, i_fail_result: IFailResult) -> "FailResult":
error_spans = None
Expand Down