Conversation
…operties for plugin details
…lt class and send_results function for JsonRPC compatibility
…ethod for JsonRPCRequest
…tions in Result class
…g in add_action method
…erit from pyFlowLauncherObject
… in plugin_manifest.py
…s for better structure
…d remove logger initialization
…es for consistency
…prove Result handling
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
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.
This pull request introduces several key improvements and refactors to the pyflowlauncher codebase, focusing on standardizing data models, improving type safety, and modernizing the manifest handling. The changes also update the plugin and method base classes for better logging and extensibility, and revise example scripts to match the new conventions.
Summary of most important changes:
Data Model Standardization and Type Safety
pyflowlauncher/models/json_rpc.py,pyflowlauncher/models/result.py, andpyflowlauncher/models/plugin_manifest.pyto formalize JSON-RPC requests/responses, plugin manifest, and result objects. This improves type safety and code clarity throughout the project. [1] [2] [3]Plugin Manifest Refactor
pyflowlauncher/manifest.pyto use a newManifestdataclass, supporting loading, saving, and conversion from/to JSON, and aligning with the newPluginMetadataTypedDict. The manifest is now accessed via cached properties in thePluginclass. [1] [2]Plugin and Method Base Classes
pyFlowLauncherObjectbase class inpyflowlauncher/base.py, providing a standardized logger setup for all core objects. UpdatedPluginandMethodclasses to inherit from this base for consistent logging and easier debugging. [1] [2] [3]Pluginclass, including automatic method registration and more robust action creation. [1] [2] [3]API and Example Updates
docs/examples/guide/directory to use the new TypedDict models and updated field names (e.g.,title,subtitle,iconinstead ofTitle,SubTitle,IcoPath). [1] [2] [3] [4] [5] [6]pyflowlauncher/api.pyto use the newJsonRPCRequesttype and updated all API action creators to follow the new naming and structure conventions.These changes significantly improve maintainability, type safety, and ease of use for plugin developers, while modernizing the codebase for future enhancements.