feat(dialogs): Incorporate DialogDependencies #2219
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
alexrecuenco
force-pushed
the
dialog-dependencies
branch
from
cb2609d to
a942ffb
Compare
alexrecuenco
commented
Mar 23, 2025
| @@ -14,6 +14,9 @@ | |||
| from .dialog import Dialog | |||
| from .dialog_state import DialogState | |||
|
|
|||
| if TYPE_CHECKING: | |||
| from .dialog_context import DialogContext | |||
There was a problem hiding this comment.
This line is necessary for the -> "DialogContext" used below, otherwise intellisense has a hard time understanding that the object returned is a DialogContext. It has no runtime impact because of TYPE_CHECKING being False at runtime
Dialog dependencies is a feature in - [botbuilder-js](https://github.com/microsoft/botbuilder-js/blob/87d0ad1a889a38396e761f10614c78a4526590d1/libraries/botbuilder-dialogs/src/dialogSet.ts#L169), - and in [botbuilder-dotnet](https://github.com/microsoft/botbuilder-dotnet/blob/bc17a5db2c717fec0d4c109d884bea88d29f75cb/libraries/Microsoft.Bot.Builder.Dialogs/DialogSet.cs#L147). To maintain feature parity, and because this functionality is extremely useful this PR brings it to `botbuilder-python`. Tecnically in the `botbuilder-js` and dotnet implementations dialogs that are found to conflict get stored with a different ID, but I am sure that would likely be a breaking change (and IMO a very counter-intuitive way of working). If you are adding dialog dependencies and they conflict, the logic as it was would be retained. Note that, although by making it a `@runtime_checkable` Protocol with DialogDependencies one can check `isinstance(object, DialogDependencies)`, the recommendation from the python docs is: "check against a runtime-checkable protocol can be surprisingly slow" — [python typing](https://docs.python.org/3/library/typing.html#typing.Protocol) For that reason we use `hasattr` and `callable` instead. Also, note that protocol is avaialble from python 3.8 onwards, which is already the minimum version for this library. The purpose of using Iterable instead of List is just to keep it generic. Since python has the concepts of `tuple`, `List`, etc and to keep it as a structural type.
alexrecuenco
force-pushed
the
dialog-dependencies
branch
from
a942ffb to
56299f4
Compare
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.
Fixes #2218
Description
Dialog dependencies is a feature in
To maintain feature parity, and because this functionality is extremely useful this PR brings it to
botbuilder-python.Specific Changes
Tecnically in the
botbuilder-jsand dotnet implementations dialogs that are found to conflict get stored with a different ID, but I am sure that would likely be a breaking change (and IMO a very counter-intuitive way of working).If you are adding dialog dependencies and they conflict, the logic as it was would be retained.
Note that, although by making it a
@runtime_checkableProtocol with DialogDependencies one can checkisinstance(object, DialogDependencies), the recommendation from the python docs is:"check against a runtime-checkable protocol can be surprisingly slow" — python typing
For that reason we use
hasattrandcallableinstead.Also, note that protocol is avaialble from python 3.8 onwards, which is already the minimum version for this library.
The purpose of using Iterable instead of List is just to keep it generic. Since python has the concepts of
tuple,List, etc and to keep it as a structural type.Testing
repo: https://github.com/pylint-dev/pylintwould be nice