Release v0.9 #393
Merged
Release v0.9 #393
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
* Move callback transitions to local node * Fix markdown parse mode for hash message * Expand documentation on extra fields
# Description ## Breaking Changes - Service changes: - Pipeline no longer has `optimization_warnings` option -- not necessary with the service changes - Pipeline service group now has an empty name - Removed `Pipeline.add_global_handler` -- use `Pipeline.services_pipeline.add_extra_handler` instead - Replaced async flags with `concurrent` flag for components - Removed `pipeline` from component and extra handler arguments. Use `ctx.pipeline` instead - Component start condition now accepts `BaseCondition` instead of functions - Changed the logic behind giving names to components with no name - Removed `GlobalExtraHandlerType`: `add_extra_handler` accepts `ExtraHandlerType` instead - Removed ServiceRuntimeInfo: now `Service` can be subclassed allowing access to its fields - Extra handler runtime info now does not contain `func` and `component` is the instance of the component ## Features - `ServiceFinished` condition now has an option to wait for the specified component to complete; Service states are now initialized before services are executed ## Documentation - Pipeline tutorials renamed to service tutorials and rewritten for more clarity ## Fixes - Service component timeout is now always applied - Unsuccessful stat extraction no longer fails the component ## Devel - `FrameworkData.service_states` now contains objects of a new class `ServiceState` - Added support for non-function callables for `wrap_sync_function_in_async` --------- Co-authored-by: Roman Zlobin <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
It appears this PR is a release PR (change its base from master if that is not the case).
Here's a release checklist:
- Update package version
- Update
poetry.lock - Change PR merge option
- Update template repo
- Search for objects to be deprecated
- Test parts not covered with pytest:
- web_api tutorials
- Test integrations with external services (telegram; stats)
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.
Changelog
This release includes a huge rework of core library features.
It is highly recommended to reread documentation relating to scripting.
(basic concepts user guide; script and pipeline (now service) tutorials)
Changes in bold indicate new changes compared to the previous pre-release (v1.0.0rc1).
Breaking Changes
Pipeline.from_script. Use__init__instead (Pydantic improvements #372)chatsky.conditions(Feat/core rework #381)chatsky.destinations(Feat/core rework #381)chatsky.processing(Feat/core rework #381)chatsky.responses(Feat/core rework #381)script.coremodule moved tochatsky.core(Feat/core rework #381)Pipelinemoved tochatsky.core(Feat/core rework #381)pipeline.servicesubmodule moved tochatsky.core.service(Feat/core rework #381)Transition.TRANSITIONSis now a list of such objects instead of a dict.Destination, condition and priority are all fields of this class. Priority is now separate from node label (Feat/core rework #381)
cnd.trueandcnd.false. Condition field ofTransitionnow acceptsTrueandFalseliterals.If condition field of
Transitionis not set, it defaults toTrue. (Feat/core rework #381)lbl.repeatrenamed todst.Current. Addeddst.FromHistoryto get labels from history pastdst.Previous. (Feat/core rework #381)BaseScriptFunction.e.g. custom response function now have to be subclassed from
BaseResponse. (Feat/core rework #381)chatsky.script.core.keywordsmoved tochatsky.core.script(Feat/core rework #381)PRE_TRANSITIONS_PROCESSINGrenamed toPRE_TRANSITION(Feat/core rework #381)PRE_RESPONSE_PROCESSINGrenamed toPRE_RESPONSE(Feat/core rework #381)chatsky.utils.turn_caching(Feat/core rework #381)0is now reserved for start label. Actual turns start at id 1.Context has method
initto init from a start label (Feat/core rework #381)proc.ExtractAll-- the function is unsafe as it overwrites the entire slot storage. it is still available as method of the slot manager (Feat/script parser #385)optimization_warningsoption -- not necessary with the service changesPipeline.add_global_handler-- usePipeline.services_pipeline.add_extra_handlerinsteadconcurrentflag for componentspipelinefrom component and extra handler arguments. Usectx.pipelineinsteadBaseConditioninstead of functionsGlobalExtraHandlerType:add_extra_handleracceptsExtraHandlerTypeinsteadServicecan be subclassed allowing access to its fieldsfuncandcomponentis the instance of the componentFeatures
RESPONSEcan now be a string. It will be converted toMessage(text=)automatically (Feat/core rework #381)Message) (Feat/core rework #381)Pipelinecan now be accessed viaContext.pipeline(Feat/core rework #381)NodeLabelclass to replace tuple node labels (Feat/core rework #381)Script.get_inherited_nodeto get a node that inherits global and local properties.ctx.current_nodeis obtained via this method (Feat/core rework #381)check_happy_pathto response_comparator, removed default comparators, removed context from signature;messages in
happy_pathcan now be any ofMessage,dict,str;printout_enableflag renamed toprintoutand madeFalseby default. (Feat/core rework #381)ModifyResponsebase processing class which allows modifying current node response. (Feat/core rework #381)ServiceFinishedcondition now has an option to wait for the specified component to complete; Service states are now initialized before services are executed (Service option update #378)Fixes
slot_name="0") (Feat/core rework #381)success_onlyflag (Feat/script parser #385)Documentation
responses.1_basicstutorial (Feat/core rework #381)Devel
Pipelineand all its components are nowBaseModels (Pydantic improvements #372)log_event_catcherfixture to help test captured logs (Feat/core rework #381)TYPE_CHECKINGexclude from coverage; now only certain exception raises are excluded from coverage (Feat/core rework #381)run_interactive_mode. Just usepipeline.run(). (Feat/core rework #381)InitTypesfor various BaseModels to indicate types that can be validated into that model (Feat/core rework #381)Actornow doesn't have any parameters (Feat/core rework #381)normalizationutils replaced with pydantic validators (Feat/core rework #381)Scriptcan now be validated from a script dict (without thescriptfield) (Feat/core rework #381)Context.cast. Usemodel_validateandmodel_validate_jsoninstead. (Feat/core rework #381)FrameworkData.service_statesnow contains objects of a new classServiceState(Service option update #378)wrap_sync_function_in_async(Service option update #378)