Skip to content

v0.10.0#13

Merged
Garulf merged 37 commits into
mainfrom
dev
May 31, 2026
Merged

v0.10.0#13
Garulf merged 37 commits into
mainfrom
dev

Conversation

@Garulf

@Garulf Garulf commented May 31, 2026

Copy link
Copy Markdown
Owner

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

  • Introduced new TypedDict-based models in pyflowlauncher/models/json_rpc.py, pyflowlauncher/models/result.py, and pyflowlauncher/models/plugin_manifest.py to formalize JSON-RPC requests/responses, plugin manifest, and result objects. This improves type safety and code clarity throughout the project. [1] [2] [3]
  • Updated all references and imports across the codebase and examples to use the new TypedDict models, replacing previous loosely-typed or custom classes. [1] [2] [3] [4] [5]

Plugin Manifest Refactor

  • Completely refactored pyflowlauncher/manifest.py to use a new Manifest dataclass, supporting loading, saving, and conversion from/to JSON, and aligning with the new PluginMetadata TypedDict. The manifest is now accessed via cached properties in the Plugin class. [1] [2]

Plugin and Method Base Classes

  • Added a new pyFlowLauncherObject base class in pyflowlauncher/base.py, providing a standardized logger setup for all core objects. Updated Plugin and Method classes to inherit from this base for consistent logging and easier debugging. [1] [2] [3]
  • Improved method registration and event handling in the Plugin class, including automatic method registration and more robust action creation. [1] [2] [3]

API and Example Updates

  • Updated all example scripts in the docs/examples/guide/ directory to use the new TypedDict models and updated field names (e.g., title, subtitle, icon instead of Title, SubTitle, IcoPath). [1] [2] [3] [4] [5] [6]
  • Refactored pyflowlauncher/api.py to use the new JsonRPCRequest type 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.

Garulf added 30 commits May 9, 2026 23:01
…lt class and send_results function for JsonRPC compatibility
@Garulf Garulf merged commit e3c5903 into main May 31, 2026
5 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant