rewrite settings to reduce code duplication / unneccessary setting dumps

Author: cibere

main.py

@@ -25,5 +25,5 @@
 
 plugin = RtfmPlugin()
 plugin.logs = logs
-logs.update_debug(plugin.debug_mode)
+logs.update_debug(plugin.better_settings.debug_mode)
 plugin.run(setup_default_log_handler=False)

plugin/handlers/settings_handler.py

@@ -17,7 +17,7 @@ def __init__(self) -> None:
     def condition(self, query: Query):
         assert self.plugin
 
-        return (query.keyword or "*") == self.plugin.main_kw
+        return (query.keyword or "*") == self.plugin.better_settings.main_kw
 
     async def callback(self, query: Query):
         assert self.plugin

plugin/plugin.py

@@ -102,55 +102,7 @@ def libraries(self) -> dict[str, Library]:
 
     @property
     def keywords(self):
-        return [*list(self.libraries.keys()), self.main_kw]
-
-    @property
-    def main_kw(self) -> str:
-        return self.better_settings.main_kw
-
-    @main_kw.setter
-    def main_kw(self, value: str) -> None:
-        self.better_settings.main_kw = value
-        self.dump_settings()
-
-    @property
-    def static_port(self) -> int:
-        return self.better_settings.static_port
-
-    @static_port.setter
-    def static_port(self, value: int) -> None:
-        self.better_settings.static_port = value
-        self.dump_settings()
-
-    @property
-    def debug_mode(self) -> bool:
-        return self.better_settings.debug_mode
-
-    @debug_mode.setter
-    def debug_mode(self, value: bool) -> None:
-        log.debug("Debug Mode Set To: %r", value)
-        if value != self.better_settings.debug_mode:
-            self.logs.update_debug(value)
-            self.better_settings.debug_mode = value
-            self.dump_settings()
-
-    @property
-    def simple_view(self) -> bool:
-        return self.better_settings.simple_view
-
-    @simple_view.setter
-    def simple_view(self, value: bool) -> None:
-        self.better_settings.simple_view = value
-        self.dump_settings()
-
-    @property
-    def reset_query(self) -> bool:
-        return self.better_settings.reset_query
-
-    @reset_query.setter
-    def reset_query(self, value: bool) -> None:
-        self.better_settings.reset_query = value
-        self.dump_settings()
+        return [*list(self.libraries.keys()), self.better_settings.main_kw]
 
     async def build_rtfm_lookup_tables(self) -> None:
         log.debug("Starting to build cache...")
@@ -276,7 +228,7 @@ async def inner(
             *args: P.args, **kwargs: P.kwargs
         ) -> QueryResponse | ErrorResponse:
             resp = await original(*args, **kwargs)
-            if isinstance(resp, QueryResponse) and self.simple_view:
+            if isinstance(resp, QueryResponse) and self.better_settings.simple_view:
                 for res in resp.results:
                     res.sub = None
             return resp

plugin/results.py

@@ -107,7 +107,7 @@ async def callback(self) -> ExecuteResponse:
         else:
             await self.plugin.api.open_url(self.url)
 
-        if self.plugin.reset_query:
+        if self.plugin.better_settings.reset_query:
             await self.plugin.last_query.update(text="")
 
         return ExecuteResponse()

plugin/server/api.py

@@ -7,12 +7,12 @@
 import msgspec
 from aiohttp import web
 
+from ..settings import RtfmBetterSettings
 from .payloads.error import ErrorResponse
 from .payloads.get_library import GetLibraryPayload, GetLibraryResponse
 from .payloads.settings import (
     ExportSettingsResponse,
     ImportSettingsRequest,
-    PluginSettings,
 )
 
 if TYPE_CHECKING:
@@ -37,7 +37,7 @@ def build_api(
     async def save_settings(request: web.Request):
         try:
             form_data = decoder.decode(await request.content.read())
-            payload = PluginSettings.parse_form_data(form_data)
+            payload = RtfmBetterSettings.parse_form_data(form_data)
         except msgspec.DecodeError:
             return web.Response(
                 body=ErrorResponse("Invalid Data Received").encode(), status=400
@@ -64,17 +64,18 @@ async def get_library(request: web.Request):
         response = GetLibraryResponse(lib.to_partial())
         return web.Response(body=response.encode(), headers=no_cache_headers)
 
-    @routes.get("/api/export_settings")
+    @routes.get("/api/settings/export")
     async def export_settings(request: web.Request):
-        obj = PluginSettings.from_plugin(plugin)
-        response = ExportSettingsResponse(base64.b64encode(obj.encode()).decode())
+        response = ExportSettingsResponse(
+            base64.b64encode(plugin.better_settings.encode()).decode()
+        )
         return web.Response(body=response.encode(), headers=no_cache_headers)
 
-    @routes.post("/api/import_settings")
+    @routes.post("/api/settings/import")
     async def import_settings(request: web.Request):
         try:
             data = ImportSettingsRequest.decode(await request.read())
-            settings = PluginSettings.decode(base64.b64decode(data.data))
+            settings = RtfmBetterSettings.decode(base64.b64decode(data.data))
         except msgspec.DecodeError as e:
             log.exception("Error while import settings", exc_info=e)
             return web.Response(

plugin/server/core.py

@@ -36,17 +36,7 @@ def build_app(
     @routes.get("/")
     @aiohttp_jinja2.template("index.html")
     async def index(request: web.Request):
-        data = {
-            "libs": plugin.libraries.values(),
-            "main_kw": plugin.main_kw,
-            "port": plugin.static_port,
-            "rtfm_version": plugin.metadata.version,
-            "debug_mode": plugin.debug_mode,
-            "simple_view": plugin.simple_view,
-            "reset_query": plugin.reset_query,
-        }
-        log.debug("Sending data: %r", data)
-        return data
+        return {"plugin": plugin}
 
     @routes.get("/style.css")
     async def style(request: web.Request):
@@ -121,13 +111,14 @@ async def run_app(
     *,
     run_forever: bool = True,
 ) -> None:
+    static_port = plugin.better_settings.static_port
     app = build_app(plugin)
-    port = await start_runner(app, "localhost", plugin.static_port)
+    port = await start_runner(app, "localhost", static_port)
 
-    if plugin.static_port != 0 and port != plugin.static_port:
+    if static_port != 0 and port != static_port:
         await plugin.api.show_notification(
             "rtfm",
-            f"Your chosen static port ({plugin.static_port}) was already in use so webserver started on port {port}",
+            f"Your chosen static port ({static_port}) was already in use so webserver started on port {port}",
         )
 
     plugin.webserver_port = port

plugin/server/index.html

@@ -16,41 +16,41 @@
         <p>The rtfm plugin allows you to easily and quickly query manuals and docs.</p>
         {% call actions() %}
             <a class="button" target="_blank" href="https://github.com/cibere/Flow.Launcher.Plugin.rtfm">Open Github Page</a>
-            <a class="button" target="_blank" href="https://rtfm.cibere.dev/{{ rtfm_version }}">Open Documentation</a>
+            <a class="button" target="_blank" href="https://rtfm.cibere.dev/{{ plugin.metadata.version }}">Open Documentation</a>
         {% endcall %}
     {% endcall %}
 
     <form id="main-form" action="/api/settings" method="POST">
         {% call card("Plugin Settings") %}
             <div class="two-columns">
                 {% call input(label="Webserver Port", id="webserver-port-input", description="This is the port that this settings page will be hosted on. If set to 0, the plugin will let your system choose an unused port on startup.") %}
-                    <input type="number" id="webserver-port-input" name="plugin.port" min="0" max="65535" step="1" value="{{ port }}">
+                    <input type="number" id="webserver-port-input" name="plugin.port" min="0" max="65535" step="1" value="{{ plugin.static_port }}">
                 {% endcall %}
                 {% call input(label="Main Keyword", id="main-keyword-input", description="This is the keyword that lets you access the settings page, reload the cache, and open up the plugin's log file.") %}
-                    <input type="text" id="main-keyword-input" name="plugin.keyword" value="{{ main_kw }}">
+                    <input type="text" id="main-keyword-input" name="plugin.keyword" value="{{ plugin.main_kw }}">
                 {% endcall %}
                 {% call checkbox(label="Debug Mode", id="main-debug-mode-input", description="If checked, the plugin will include debug logs in the plugin's log file.") %}
                     <input
                         id="main-debug-mode-input"
                         type="checkbox"
-                        name="plugin.debug"
-                        {% if debug_mode %}checked{% endif %}
+                        name="plugin.debug_mode"
+                        {% if plugin.debug_mode %}checked{% endif %}
                     >
                 {% endcall %}
                 {% call checkbox(label="Simple View", id="main-simple-view-input", description="If checked, the plugin will remove subtitles from the results it returns") %}
                     <input
                         id="main-simple-view-input"
                         type="checkbox"
-                        name="plugin.simple"
-                        {% if simple_view %}checked{% endif %}
+                        name="plugin.simple_view"
+                        {% if plugin.simple_view %}checked{% endif %}
                     >
                 {% endcall %}
                 {% call checkbox(label="Reset Query", id="main-reset-query-input", description="If checked, the plugin will reset the query to just the keyword when opening a result") %}
                     <input
                         id="main-reset-query-input"
                         type="checkbox"
                         name="plugin.reset_query"
-                        {% if reset_query %}checked{% endif %}
+                        {% if plugin.reset_query %}checked{% endif %}
                     >
                 {% endcall %}
             </div>
@@ -74,7 +74,7 @@
             {% endcall %}
         </div>
 
-        {% for lib in libs %}
+        {% for lib in plugin.libraries.values() %}
             {{ doc(location=lib.loc, index=loop.index, type=lib.typename, name=lib.name, cache_results=lib.cache_results, is_api=lib.is_api) }}
         {% endfor %}
     </form>

plugin/server/payloads/settings.py

@@ -1,80 +1,9 @@
 from __future__ import annotations
 
-import asyncio
-from collections import defaultdict
-from typing import TYPE_CHECKING, Any, Literal
+from typing import Literal
 
-from ...libraries.library import PartialLibrary
 from .base import Payload
 
-if TYPE_CHECKING:
-    from ...plugin import RtfmPlugin
-
-
-class PluginSettings(Payload):
-    port: int
-    keyword: str
-    libraries: list[PartialLibrary]
-    debug: bool = False
-    simple: bool = False
-    reset_query: bool = False
-
-    @classmethod
-    def parse_form_data(cls, data: dict[str, str]) -> PluginSettings:
-        kwargs: dict[str, Any] = {}
-        raw_docs: dict[int, dict[str, Any]] = defaultdict(lambda: {})
-
-        for key, value in data.items():
-            parts = key.split(".")
-            match parts[0]:
-                case "plugin":
-                    match parts[1]:
-                        case "port":
-                            kwargs["port"] = int(value)
-                        case "keyword":
-                            kwargs["keyword"] = value or "*"
-                        case "debug":
-                            kwargs["debug"] = True
-                        case "simple":
-                            kwargs["simple"] = True
-                        case "reset_query":
-                            kwargs["reset_query"] = True
-                case "doc":
-                    idx = int(parts[1])
-                    match parts[2]:
-                        case "cache_results":
-                            value = True
-                        case "keyword":
-                            parts[2] = "name"
-                            if not value:
-                                value = "*"
-
-                    raw_docs[idx][parts[2]] = value
-
-        kwargs["libraries"] = [PartialLibrary(**opts) for opts in raw_docs.values()]
-        return cls(**kwargs)
-
-    async def save(self, plugin: RtfmPlugin) -> None:
-        plugin.static_port = self.port
-        plugin.main_kw = self.keyword
-        plugin.debug_mode = self.debug
-        plugin.simple_view = self.simple
-        plugin.reset_query = self.reset_query
-
-        await plugin.update_libraries(self.libraries)
-        asyncio.create_task(plugin.build_rtfm_lookup_tables())
-
-    @classmethod
-    def from_plugin(cls, plugin: RtfmPlugin) -> PluginSettings:
-        return cls(
-            port=plugin.static_port,
-            keyword=plugin.main_kw,
-            debug=plugin.debug_mode,
-            simple=plugin.simple_view,
-            reset_query=plugin.reset_query,
-            libraries=[lib.to_partial() for lib in plugin.libraries.values()],
-        )
-
 
 class ExportSettingsResponse(Payload):
     data: str

plugin/server/script.js

@@ -189,7 +189,7 @@ elements.importBtn.addEventListener("click", () => {
         reader.addEventListener("load", async () => {
             const data = reader.result;
             try {
-                let response = await fetch("/api/import_settings", {
+                let response = await fetch("/api/settings/import", {
                     body: JSON.stringify({data}),
                     method: "POST",
                 });
@@ -205,7 +205,7 @@ elements.importBtn.addEventListener("click", () => {
 
 elements.exportBtn.addEventListener("click", async () => {
     try {
-        const data = await fetch("/api/export_settings").then(res => res.json());
+        const data = await fetch("/api/settings/export").then(res => res.json());
         if (!data.success) {
             alert("Failed to export settings!");
             return;