view frontends/src/jp/cmd_debug.py @ 2109:85f3e12e984d

core (memory/cache): file caching handling, first draft: instead of having file caching handled individually by plugins, a generic module has been added in memory. - Cache can be global or associated to a profile. In the later case, client.cache can be used. - Cache are managed with unique ids (which can be any unique unicode, hash uuid, or something else). - To know if a file is in cache, getFilePath is used: if the file is in cache, its absolute path is returned, else None is returned. - To cache a file, cacheData is used with at list the source of cache (most of time plugin import name), and unique id. The method return file opened in binary writing mode (so cacheData can - and should - be used with "with" statement). - 2 files will be created: a metadata file (named after the unique id), and the actual file. - each file has a end of life time, after it, the cache is invalidated and the file must be requested again.
author Goffi <goffi@goffi.org>
date Thu, 05 Jan 2017 20:23:38 +0100
parents 741db5abf077
children 8b37a62336c3
line wrap: on
line source

#!/usr/bin/env python2
# -*- coding: utf-8 -*-

# jp: a SàT command line tool
# Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


import base
from sat.core.i18n import _
from sat_frontends.jp.constants import Const as C
import json

__commands__ = ["Debug"]


class BridgeCommon(object):

    def evalArgs(self):
        if self.args.arg:
            try:
                return eval(u'[{}]'.format(u",".join(self.args.arg)))
            except SyntaxError as e:
                self.disp(u"Can't evaluate arguments: {mess}\n{text}\n{offset}^".format(
                    mess=e,
                    text=e.text.decode('utf-8'),
                    offset=u" "*(e.offset-1)
                    ), error=True)
                self.host.quit(C.EXIT_BAD_ARG)
        else:
            return []


class Method(base.CommandBase, BridgeCommon):

    def __init__(self, host):
        base.CommandBase.__init__(self, host, 'method', help=_(u'call a bridge method'))
        BridgeCommon.__init__(self)
        self.need_loop=True

    def add_parser_options(self):
        self.parser.add_argument("method", type=str, help=_(u"name of the method to execute"))
        self.parser.add_argument("arg", type=base.unicode_decoder, nargs="*", help=_(u"argument of the method"))

    def method_cb(self, ret=None):
        if ret is not None:
            self.disp(unicode(ret))
        self.host.quit()

    def method_eb(self, failure):
        self.disp(_(u"Error while executing {}: {}".format(self.args.method, failure)), error=True)
        self.host.quit(C.EXIT_ERROR)

    def start(self):
        method = getattr(self.host.bridge, self.args.method)
        args = self.evalArgs()
        try:
            method(*args, profile=self.profile, callback=self.method_cb, errback=self.method_eb)
        except TypeError:
            # maybe the method doesn't need a profile ?
            try:
                method(*args, callback=self.method_cb, errback=self.method_eb)
            except TypeError:
                self.method_eb(_(u"bad arguments"))


class Signal(base.CommandBase, BridgeCommon):

    def __init__(self, host):
        base.CommandBase.__init__(self, host, 'signal', help=_(u'send a fake signal from backend'))
        BridgeCommon.__init__(self)

    def add_parser_options(self):
        self.parser.add_argument("signal", type=str, help=_(u"name of the signal to send"))
        self.parser.add_argument("arg", type=base.unicode_decoder, nargs="*", help=_(u"argument of the signal"))

    def start(self):
        args = self.evalArgs()
        json_args = json.dumps(args)
        # XXX: we use self.args.profile and not self.profile
        #      because we want the raw profile_key (so plugin handle C.PROF_KEY_NONE)
        self.host.bridge.debugFakeSignal(self.args.signal, json_args, self.args.profile)


class Bridge(base.CommandBase):
    subcommands = (Method, Signal)

    def __init__(self, host):
        super(Bridge, self).__init__(host, 'bridge', use_profile=False, help=_('bridge s(t)imulation'))


class Debug(base.CommandBase):
    subcommands = (Bridge,)

    def __init__(self, host):
        super(Debug, self).__init__(host, 'debug', use_profile=False, help=_('debugging tools'))