Improve error message for nodes failing validation #2313
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
ZanSara
changed the title
tstadel
approved these changes
Mar 17, 2022
haystack/nodes/_json_schema.py
Outdated
| @@ -113,7 +113,11 @@ class Config(BaseConfig): | |||
| extra = "forbid" # type: ignore | |||
|
|
|||
|
|
|||
| def find_subclasses_in_modules(importable_modules: List[str], include_base_classes: bool = False): | |||
| def is_valid_component_class(clazz): | |||
There was a problem hiding this comment.
Although the naming doesn't stem from you, according to PEP8 names conflicting with python keywords should be rather named with one trailing underscore. Any advantages of clazz here instead of class_ other than it looks a lot cooler? :-D
There was a problem hiding this comment.
None! I simply didn't know how to call it 😂 I didn't know about this rule btw, I won't have this naming problem again 😁
haystack/nodes/_json_schema.py
Outdated
| @@ -232,7 +233,7 @@ def get_json_schema( | |||
|
|
|||
| # Build the definitions and refs for the nodes | |||
| for _, node in possible_nodes: | |||
There was a problem hiding this comment.
We could also rename this to possible_node_classes and node_class for sake of consistency.
test/test_pipeline_yaml.py
Outdated
| @@ -1,14 +1,14 @@ | |||
| from abc import abstractmethod | |||
| from lib2to3.pytree import Base | |||
There was a problem hiding this comment.
VSCode's autoimport 🤦
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.
Problem:
See #2310. Even though the issue was trivial, the error message is actually misleading.
Solution:
Notes:
This PR actually fixes a bug in
_json_schema.py, which was interpreting a node instance as a node class and therefore failing theisabstract()check even on abstract classes. As a consequence, the check "node name must not start with Base" can be also safely removed.