Heim > Backend-Entwicklung > Python-Tutorial > Entwickeln Sie eine Ulauncher-Erweiterung mit einer Befehlsdatenbank

Entwickeln Sie eine Ulauncher-Erweiterung mit einer Befehlsdatenbank

Susan Sarandon
Freigeben: 2025-01-06 20:19:41
Original
735 Leute haben es durchsucht

Über das Wochenende habe ich über Reddit ein Projekt aufgenommen, bei dem es um ein Plugin für den Flow Launcher ging. Ich habe eine fzf- und rofi-Version für meine Ubuntu-Linux-Umgebung erstellt und dachte dann: Wie schwierig kann es sein, sie auf uLauncher zu portieren?

Develop a ulauncher extension with a command database

Hier dokumentiere ich, was ich getan habe.

1. Innerhalb ~/.local/share/ulauncher/extensions/

Erstellen Sie ein neues Verzeichnis. In meinem Fall habe ich ~/.local/share/ulauncher/extensions/com.github.ubuntupunk.ulauncher-vim

erstellt

2. Berühren Sie die folgenden Dateien:

├── images
│   └── icon.png
├── versions.json
├── manifest.json
└── main.py
Nach dem Login kopieren

3. Platzieren Sie in „versions.json“ das folgende Beispiel:

[
  {"required_api_version": "2", "commit": "master"}
]
Nach dem Login kopieren

4. In manifest.json

{
  "required_api_version": "2",
  "name": "Demo extension",
  "description": "Extension Description",
  "developer_name": "John Doe",
  "icon": "images/icon.png",
  "options": {
    "query_debounce": 0.1
  },
  "preferences": [
    {
      "id": "demo_kw",
      "type": "keyword",
      "name": "Demo",
      "description": "Demo extension",
      "default_value": "dm"
    }
  ]
}
Nach dem Login kopieren

5. In main.py

from ulauncher.api.client.Extension import Extension
from ulauncher.api.client.EventListener import EventListener
from ulauncher.api.shared.event import KeywordQueryEvent, ItemEnterEvent
from ulauncher.api.shared.item.ExtensionResultItem import ExtensionResultItem
from ulauncher.api.shared.action.RenderResultListAction import RenderResultListAction
from ulauncher.api.shared.action.HideWindowAction import HideWindowAction


class DemoExtension(Extension):

    def __init__(self):
        super().__init__()
        self.subscribe(KeywordQueryEvent, KeywordQueryEventListener())


class KeywordQueryEventListener(EventListener):

    def on_event(self, event, extension):
        items = []
        for i in range(5):
            items.append(ExtensionResultItem(icon='images/icon.png',
                                             name='Item %s' % i,
                                             description='Item description %s' % i,
                                             on_enter=HideWindowAction()))

        return RenderResultListAction(items)

if __name__ == '__main__':
    DemoExtension().run()
Nach dem Login kopieren

6. Bearbeiten Sie nun manifest.json

{
  "required_api_version": "2",
  "name": "Vim Prompter",
  "description": "Vim cheatsheet helper",
  "developer_name": "David Robert Lewis",
  "icon": "images/icon.png",
  "options": {
    "query_debounce": 0.1
  },
  "preferences": [
    {
      "id": "vm_kw",
      "type": "keyword",
      "name": "Vim",
      "description": "Search for Vim commands",
      "default_value": "vm"
    }
  ]
Nach dem Login kopieren

7. Fügen Sie die Funktion zum Laden von Befehlen zu main.py hinzu

class VmExtension(Extension):
    def load_vim_commands(self):
        """Load Vim commands from JSON file."""
        package_dir = os.path.dirname(os.path.abspath(__file__))
        full_path = os.path.join(package_dir, 'db', 'commands.json')   
        with open(full_path, 'r') as file:
            return json.load(file)

    def __init__(self):
        super().__init__()
        self.vim_commands = self.load_vim_commands()
        self.subscribe(KeywordQueryEvent, KeywordQueryEventListener())
Nach dem Login kopieren

8. Erstellen Sie einen Datenbankordner mit Folgendem:

commands.json

Beispielstruktur:

{
  "categories": {
    "navigation": {
      "name": "Navigation",
      "patterns": [
        "scroll",
        "jump",
        "goto",
        "position"
      ],
      "subcategories": {
        "cursor": {
          "name": "Cursor Movement",
          "patterns": [
            "move[s]? cursor",
            "^[hjkl]$",
            "^[HJKL]$",
            "^[wWeEbB]$"
          ]
        },
Nach dem Login kopieren

Sie können die gesamte commands.json hier sehen.

9. Ändern Sie den KeywordQueryEventListener, um die Suchfunktion zu implementieren.

class KeywordQueryEventListener(EventListener):
    def on_event(self, event, extension):
        query = event.get_argument() or ""
        items = []

        # If no query, show all commands (limited to first 8)
        commands_to_show = extension.vim_commands

        # If there's a query, filter commands
        if query:
            commands_to_show = [
                cmd for cmd in extension.vim_commands
                if query.lower() in cmd['command'].lower() or 
                   query.lower() in cmd['description'].lower()
            ]

        # Limit results to first 8 matches
        for cmd in commands_to_show[:8]:
            items.append(ExtensionResultItem(
                icon='images/icon.png',
                name=cmd['command'],
                description=f"{cmd['name']} - {cmd['description']}",
                on_enter=HideWindowAction()
            ))

        return RenderResultListAction(items)
Nach dem Login kopieren

10. Fügen Sie die URL-Öffnungsfunktion hinzu. Wir müssen den Webbrowser importieren und die Aktion on_enter ändern, um die Vim-Befehls-URL zu öffnen

from ulauncher.api.shared.action.OpenUrlAction import OpenUrlAction

class KeywordQueryEventListener(EventListener):
    def on_event(self, event, extension):
        query = event.get_argument() or ""
        items = []

        commands_to_show = extension.vim_commands

        if query:
            commands_to_show = [
                cmd for cmd in extension.vim_commands
                if query.lower() in cmd['command'].lower() or 
                   query.lower() in cmd['description'].lower()
            ]

        for cmd in commands_to_show[:8]:
            url = f"https://vim.rtorr.com/#:~:text={cmd['rtorr_description']}"
            items.append(ExtensionResultItem(
                icon='images/icon.png',
                name=cmd['command'],
                description=f"{cmd['name']} - {cmd['description']}",
                on_enter=OpenUrlAction(url)
            ))

        return RenderResultListAction(items)
Nach dem Login kopieren

11. Wesentliche Änderungen sind:

  • OpenUrlAction-Import hinzugefügt
  • HideWindowAction durch OpenUrlAction ersetzt
  • Die URL wurde mithilfe der rtorr_description des Befehls erstellt

12. Der vollständige Projektcode kann hier eingesehen werden:

ulauncher-vim repo

und die Ulauncher-Erweiterung hier

Referenzen

  1. https://dev.to/brpaz/an-introduction-to-ulauncher-extension-development-1m69
  2. https://ext.ulauncher.io/-/github-ubuntupunk-ulauncher-vim

Das obige ist der detaillierte Inhalt vonEntwickeln Sie eine Ulauncher-Erweiterung mit einer Befehlsdatenbank. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Quelle:dev.to
Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
Neueste Artikel des Autors
Beliebte Tutorials
Mehr>
Neueste Downloads
Mehr>
Web-Effekte
Quellcode der Website
Website-Materialien
Frontend-Vorlage