pyflowlauncher 0.6.2.dev0__tar.gz → 0.7.1.dev0__tar.gz

{pyflowlauncher-0.6.2.dev0 → pyflowlauncher-0.7.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflowlauncher
-Version: 0.6.2.dev0
+Version: 0.7.1.dev0
 Summary: Python library to help build Flow Launcher plugins.
 Author-email: William McAllister <dev.garulf@gmail.com>
 License: MIT
@@ -26,9 +26,11 @@ pyFlowLauncher is an API that allows you to quickly create plugins for Flow Laun
 Install via pip:
 
 ```py
-python -m pip install pyflowlauncher
+python -m pip install pyflowlauncher[all]
 ```
 
+ > ⚠️ The `[all]` is important if you intend to support Python versions older then `3.11`.
+
 ## Usage
 
 ### Basic plugin

{pyflowlauncher-0.6.2.dev0 → pyflowlauncher-0.7.1.dev0}/README.md

@@ -12,9 +12,11 @@ pyFlowLauncher is an API that allows you to quickly create plugins for Flow Laun
 Install via pip:
 
 ```py
-python -m pip install pyflowlauncher
+python -m pip install pyflowlauncher[all]
 ```
 
+ > ⚠️ The `[all]` is important if you intend to support Python versions older then `3.11`.
+
 ## Usage
 
 ### Basic plugin

{pyflowlauncher-0.6.2.dev0 → pyflowlauncher-0.7.1.dev0}/pyflowlauncher/__init__.py

@@ -1,12 +1,10 @@
 import importlib.metadata
 import logging
-import os
 
 from .plugin import Plugin
 from .result import JsonRPCAction, Result, send_results, ResultResponse
 from .method import Method
 
-log_level = os.environ.get("FLOW_LAUNCHER_API_LOG_LEVEL", "INFO")
 
 logger = logging.getLogger(__name__)
 
@@ -22,10 +20,3 @@ __all__ = [
     "JsonRPCAction",
     "Method",
 ]
-
-
-logging.basicConfig(
-    level=log_level,
-    format="%(asctime)s <%(name)s>[%(levelname)s]: %(message)s",
-    datefmt="%Y-%m-%d %H:%M:%S",
-)

pyflowlauncher-0.7.1.dev0/pyflowlauncher/event.py

@@ -0,0 +1,34 @@
+
+
+from typing import Any, Callable, Iterable, Type
+
+
+class EventHandler:
+
+    def __init__(self):
+        self._methods = {}
+        self._handlers = {}
+
+    def _get_callable_name(self, method: Callable[..., Any]):
+        return getattr(method, '__name__', method.__class__.__name__).lower()
+
+    def add_method(self, method: Callable[..., Any], *, name=None) -> str:
+        key = name or self._get_callable_name(method)
+        self._methods[key] = method
+        return key
+
+    def add_methods(self, methods: Iterable[Callable[..., Any]]):
+        for method in methods:
+            self.add_method(method)
+
+    def add_exception_handler(self, exception: Type[Exception], handler: Callable[..., Any]):
+        self._handlers[exception] = handler
+
+    def __call__(self, method: str, *args, **kwargs):
+        try:
+            return self._methods[method](*args, **kwargs)
+        except Exception as e:
+            handler = self._handlers.get(type(e), None)
+            if handler:
+                return handler(e)
+            raise e

{pyflowlauncher-0.6.2.dev0 → pyflowlauncher-0.7.1.dev0}/pyflowlauncher/plugin.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import sys
 from functools import wraps
-from typing import Any, Callable, Iterable, Union
+from typing import Any, Callable, Iterable, Optional, Type, Union
 from pathlib import Path
 import json
 
@@ -26,11 +26,9 @@ class Plugin:
         if methods:
             self.add_methods(methods)
 
-    def add_method(self, method: Method) -> None:
+    def add_method(self, method: Method) -> str:
         """Add a method to the event handler."""
-        name = getattr(method, '__name__', method.__class__.__name__).lower()
-        self._logger.debug(f"Adding method: '{name}'")
-        self._event_handler.add_method(method, name=name)
+        return self._event_handler.add_method(method)
 
     def add_methods(self, methods: Iterable[Method]) -> None:
         self._event_handler.add_methods(methods)
@@ -46,10 +44,22 @@ class Plugin:
         """Register a method to be called when the plugin is run."""
         return self.on_method(method)
 
-    def add_exception_handler(self, exception: Exception, handler: Callable[..., Any]) -> None:
+    def add_exception_handler(self, exception: Type[Exception], handler: Callable[..., Any]) -> None:
         """Add exception handler to be called when an exception is raised in a method."""
         self._event_handler.add_exception_handler(exception, handler)
 
+    def on_except(self, exception: Type[Exception]) -> Callable[..., Any]:
+        @wraps(exception)
+        def wrapper(handler: Callable[..., Any]) -> Callable[..., Any]:
+            self.add_exception_handler(exception, handler)
+            return handler
+        return wrapper
+
+    def action(self, method: Method, parameters: Optional[Iterable] = None) -> JsonRPCAction:
+        """Register a method and return a JsonRPCAction that calls it."""
+        method_name = self.add_method(method)
+        return {"method": method_name, "parameters": parameters or []}
+
     @property
     def settings(self) -> dict:
         if self._settings is None:
@@ -59,12 +69,11 @@ class Plugin:
 
     def run(self) -> None:
         request = self._client.recieve()
-        method = request.get('method')
+        method = request["method"]
         parameters = request.get('parameters', [])
         feedback = self._event_handler(method, *parameters)
-        # Inject settings if changed
-        if 'result' in feedback and self._settings is not None:
-            feedback['SettingsChange'] = self.settings
+        if not feedback:
+            return
         self._client.send(feedback)
 
     @property

{pyflowlauncher-0.6.2.dev0 → pyflowlauncher-0.7.1.dev0}/pyflowlauncher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflowlauncher
-Version: 0.6.2.dev0
+Version: 0.7.1.dev0
 Summary: Python library to help build Flow Launcher plugins.
 Author-email: William McAllister <dev.garulf@gmail.com>
 License: MIT
@@ -26,9 +26,11 @@ pyFlowLauncher is an API that allows you to quickly create plugins for Flow Laun
 Install via pip:
 
 ```py
-python -m pip install pyflowlauncher
+python -m pip install pyflowlauncher[all]
 ```
 
+ > ⚠️ The `[all]` is important if you intend to support Python versions older then `3.11`.
+
 ## Usage
 
 ### Basic plugin

{pyflowlauncher-0.6.2.dev0 → pyflowlauncher-0.7.1.dev0}/pyproject.toml

@@ -6,7 +6,7 @@ name = "pyflowlauncher"
 authors = [
     {name = "William McAllister", email = "dev.garulf@gmail.com"}
 ]
-version = '0.6.2-dev.0'
+version = '0.7.1-dev.0'
 description = "Python library to help build Flow Launcher plugins."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -30,7 +30,7 @@ packages = ["pyflowlauncher"]
 "pyflowlauncher" = ["py.typed"]
 
 [tool.bumpversion]
-current_version = "0.6.2-dev.0"
+current_version = "0.7.1-dev.0"
 parse = """(?x)
     (?P<major>[0-9]+)
     \\.(?P<minor>[0-9]+)

pyflowlauncher-0.6.2.dev0/pyflowlauncher/event.py

@@ -1,29 +0,0 @@
-
-
-from typing import Any, Callable
-
-
-class EventHandler:
-
-    def __init__(self):
-        self._methods = {}
-        self._handlers = {}
-
-    def add_method(self, method, *, name=None):
-        self._methods[name or method.__name__] = method
-
-    def add_methods(self, methods):
-        for method in methods:
-            self.add_method(method)
-
-    def add_exception_handler(self, exception: Exception, handler: Callable[..., Any]):
-        self._handlers[exception.__class__.__name__] = handler
-
-    def __call__(self, method, *args, **kwargs):
-        try:
-            return self._methods[method](*args, **kwargs)
-        except Exception as e:
-            handler = self._handlers.get(e.__class__.__name__, None)
-            if handler:
-                return handler(e)
-            raise e