feat: validation function for run() and run_async() parameters signature for (custom) components
#9322
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
github-actions
bot
added
topic:tests
topic:core
type:documentation
davidsbatista
changed the title
run() and run_async() parameters signature for (custom) components
Pull Request Test Coverage Report for Build 14732755474Details
💛 - Coveralls |
davidsbatista
requested review from
dfokina and
anakin87
and removed request for
a team
anakin87
approved these changes
Apr 29, 2025
|
|
||
|
|
||
| def test_different_param_names(): | ||
| with pytest.raises(ComponentError) as exc_info: |
There was a problem hiding this comment.
nit: you could use something like with pytest.raises(ComponentError, match="name mismatch")
in all tests if you want...
https://docs.pytest.org/en/stable/how-to/assert.html#matching-exception-messages
haystack/core/component/component.py
Outdated
| @@ -326,6 +329,48 @@ def _component_run_has_kwargs(component_cls: Type) -> bool: | |||
| ) | |||
|
|
|||
|
|
|||
| def _compare_method_signatures(run_sig: inspect.Signature, async_run_sig: inspect.Signature) -> str: | |||
There was a problem hiding this comment.
Suggested change
| def _compare_method_signatures(run_sig: inspect.Signature, async_run_sig: inspect.Signature) -> str: | |
| def _compare_run_methods_signatures(run_sig: inspect.Signature, async_run_sig: inspect.Signature) -> str: |
nit: maybe this could be a clearer name
davidsbatista
deleted the
detailed-message-show-difference-async-and-sync-args
branch
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.
Related Issues
Proposed Changes:
Component signature validation mismatches between
runandrun_asyncmethod signatures, this is bound to happen with custom components as all haystack core and integration components by design don't have this issue._compare_method_signaturesthat provides detailed information about signature mismatches about:How did you test it?
test_component_signature_validation.pywith comprehensive test cases cover all possible signature mismatch scenarios described aboveChecklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.