view src/bridge/bridge_constructor/constructors/embedded/constructor.py @ 2169:f472179305a1

tools(templates): workflow improvments: - template theme can be specified in parenthesis: (some_theme)path/to/template.html. Withtout parenthesis, "default" is used - static content are supposed to be in [theme]/static, error pages in [theme]/error/[err_code].html - default page are used in some case (2 for now): if error page with specified code doesn't exists, a base page is used, and if a page doesn't exist for a theme, the same one for default theme is looked for - CSS files are automatically found for HTML pages - CSS files can be split, the'll be added in the template according to the page requested. - theme CSS file is looked for, and if not found the default theme equivalent is looked for. - each element of a path can be associated to a CSS file, and styles.css is always there. For instance if blog/articles.html is requested, the following CSS can be included: "styles.css", "blog.css", "blog_article.css". They all must be in /static - if the automatic finding of CSS files is not wanted, css_files arguments can be used instead, with full relative path (i.e. including theme) - CSS files can be merged and included inline with css_inline argument - root_path can be specified, it will be used as a prefix for static files - requested theme (which may differ from actual theme, e.g. if the template is not found and default one is used instead) is available in template with "theme" variable - added getThemeAndRoot method to retrieve theme and theme root path from template
author Goffi <goffi@goffi.org>
date Sun, 05 Mar 2017 23:41:10 +0100
parents 442423faf220
children 8b37a62336c3
line wrap: on
line source

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

# SàT: a XMPP client
# 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/>.

from sat.bridge.bridge_constructor import base_constructor
# from textwraps import dedent


class EmbeddedConstructor(base_constructor.Constructor):
    NAME = "embedded"
    CORE_TEMPLATE = "embedded_template.py"
    CORE_DEST = "embedded.py"
    CORE_FORMATS = {
        'methods': """\
    def {name}(self, {args}{args_comma}callback=None, errback=None):
{ret_routine}
""",
        'signals': """\
    def {name}(self, {args}):
        try:
            cb = self._signals_cbs["{category}"]["{name}"]
        except KeyError:
            log.warning(u"ignoring signal {name}: no callback registered")
        else:
            cb({args_result})
"""
        }
    FRONTEND_TEMPLATE = "embedded_frontend_template.py"
    FRONTEND_DEST = CORE_DEST
    FRONTEND_FORMATS = {}

    def core_completion_method(self, completion, function, default, arg_doc, async_):
        completion.update({
            'debug': "" if not self.args.debug else 'log.debug ("%s")\n%s' % (completion['name'], 8 * ' '),
            'args_result': self.getArguments(function['sig_in'], name=arg_doc),
            'args_comma': ', ' if function['sig_in'] else '',
            })

        if async_:
            completion["cb_or_lambda"] = "callback" if function['sig_out'] else "lambda dummy: callback()"
            completion["ret_routine"] = """\
        d = self._methods_cbs["{name}"]({args_result})
        if callback is not None:
            d.addCallback({cb_or_lambda})
        if errback is None:
            d.addErrback(lambda failure_: log.error(failure_))
        else:
            d.addErrback(errback)
        return d
        """.format(**completion)
        else:
            completion['ret_or_nothing'] = 'ret' if function['sig_out'] else ''
            completion["ret_routine"] = """\
        try:
            ret = self._methods_cbs["{name}"]({args_result})
        except Exception as e:
            if errback is not None:
                errback(e)
            else:
                raise e
        else:
            if callback is None:
                return ret
            else:
                callback({ret_or_nothing})""".format(**completion)

    def core_completion_signal(self, completion, function, default, arg_doc, async_):
        completion.update({
            'args_result': self.getArguments(function['sig_in'], name=arg_doc),
            })