File: cmdtalkplugin.py

package info (click to toggle)
recoll 1.43.12-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,952 kB
  • sloc: cpp: 104,785; python: 9,933; xml: 7,314; ansic: 6,447; sh: 1,252; perl: 166; makefile: 72
file content (70 lines) | stat: -rw-r--r-- 2,297 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Copyright (C) 2016-2022 J.F.Dockes
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the
# Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

# This implements a cmdtalk processor (class Processor) which expects a method name in each set of
# input parameters, under the key prcnmkey: "cmdtalk:proc". The client module creates a Dispatch
# object which it uses to record the methods to call. The message processor looks for the prcnmkey
# value and call the processing method accordingly. Example code:
#
#     dispatcher = cmdtalkplugin.Dispatch()
#     msgproc = cmdtalkplugin.Processor(dispatcher)
#
#     @dispatcher.record('trackuri')
#     def trackuri(a):
#       dosomething(a)
#     ....
#
#     msgproc.mainloop()

import sys
import cmdtalk

prcnmkey = "cmdtalk:proc"


class Dispatch:
    def __init__(self):
        self.map = {}

    def record(self, nm):
        def decorator(func):
            self.map[nm] = func
            return func

        return decorator

    def run(self, nm, params):
        func = self.map[nm]
        return func(params)


class Processor:
    def __init__(self, dispatcher, outfile=sys.stdout, infile=sys.stdin, exitfunc=None):
        self.em = cmdtalk.CmdTalk(outfile=outfile, infile=infile, exitfunc=exitfunc)
        self.dispatcher = dispatcher

    def log(self, s, doexit=0, exitvalue=1):
        self.em.log(s, doexit, exitvalue)

    def process(self, params):
        # self.em.log(f"pCmdTalkProcessor.process: [{params}]")
        if not prcnmkey in params:
            raise Exception(f"{prcnmkey} not in args")

        return self.dispatcher.run(params[prcnmkey], params)

    def mainloop(self):
        cmdtalk.main(self.em, self)