Files @ 81fdf2f62ef2
Branch filter:

Location: kallithea/scripts/generate-ini.py - annotation

Thomas De Schampheleire
validators: remove unneeded M/StateObj classes

The M class is actually a wrapper around formencode.api.Validator.message,
inserting a translator into the 'state' object. Setting a translator into
the state object is indeed what is mentioned in the formencode docs.

But, if you work this way, the custom state should be set both for custom
validators, as well as for validators that are simple wrappers around
formencode's default validators (for example wrappers that just set a custom
message string). And the latter is what Kallithea is currently _not_ doing.

Also, when using formencode.api.Validator.message correctly, you should not
use the translator function _ on your validator strings manually.

Remove the inconsistency in Kallithea validators as follows:
- remove M and StateObj classes
- replace the usage of M by direct calls to self.message (which is now no
longer in charge of translating but simply of mapping a keyword onto the
right message)
- translation will be done by explicit _ calls at Kallithea side, so that
formencode directly receives translated strings.
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
9358211ee144
9358211ee144
9358211ee144
9358211ee144
9358211ee144
f973b866fffc
06d5c043e989
b1fc5a98952c
06d5c043e989
b1fc5a98952c
06d5c043e989
b1fc5a98952c
b1fc5a98952c
b1fc5a98952c
b1fc5a98952c
b1fc5a98952c
b1fc5a98952c
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
06d5c043e989
#!/usr/bin/env python2
"""
Based on kallithea/bin/template.ini.mako, generate
  kallithea/config/deployment.ini_tmpl
  development.ini
  kallithea/tests/test.ini
"""

import re

makofile = 'kallithea/bin/template.ini.mako'

# the mako conditionals used in all other ini files and templates
selected_mako_conditionals = set([
    "database_engine == 'sqlite'",
    "http_server == 'waitress'",
    "error_aggregation_service == 'errormator'",
    "error_aggregation_service == 'sentry'",
])

# the mako variables used in all other ini files and templates
mako_variable_values = {
    'host': '127.0.0.1',
    'port': '5000',
    'here': '%(here)s',
    'uuid()': '${app_instance_uuid}',
}

# files to be generated from the mako template
ini_files = [
    ('kallithea/config/deployment.ini_tmpl',
        '''
        Kallithea - Example config

        The %(here)s variable will be replaced with the parent directory of this file
        ''',
        {}, # exactly the same settings as template.ini.mako
    ),
    ('kallithea/tests/test.ini',
        '''
        Kallithea - config for tests:
        initial_repo_scan = true
        sqlalchemy and kallithea_test.sqlite
        custom logging

        The %(here)s variable will be replaced with the parent directory of this file
        ''',
        {
            '[server:main]': {
                'port': '4999',
            },
            '[app:main]': {
                'initial_repo_scan': 'true',
                'app_instance_uuid': 'test',
                'show_revision_number': 'true',
                'beaker.cache.sql_cache_short.expire': '1',
                'beaker.session.secret': '{74e0cd75-b339-478b-b129-07dd221def1f}',
                'cache_dir': '%(here)s/../../data/test/cache',
                'index_dir': '%(here)s/../../data/test/index',
                'archive_cache_dir': '%(here)s/../../data/test/tarballcache',
                'beaker.cache.data_dir': '%(here)s/../../data/test/cache/data',
                'beaker.cache.lock_dir': '%(here)s/../../data/test/cache/lock',
                'sqlalchemy.url': 'sqlite:///%(here)s/kallithea_test.sqlite',
            },
            '[handler_console]': {
                'level': 'DEBUG',
                'formatter': 'color_formatter',
            },
            # The 'handler_console_sql' block is very similar to the one in
            # development.ini, but without the explicit 'level=DEBUG' setting:
            # it causes duplicate sqlalchemy debug logs, one through
            # handler_console_sql and another through another path.
            '[handler_console_sql]': {
                'formatter': 'color_formatter_sql',
            },
        },
    ),
    ('development.ini',
        '''
        Kallithea - Development config:
        listening on *:5000
        sqlite and kallithea.db
        initial_repo_scan = true
        set debug = true
        verbose and colorful logging

        The %(here)s variable will be replaced with the parent directory of this file
        ''',
        {
            '[server:main]': {
                'host': '0.0.0.0',
            },
            '[app:main]': {
                'initial_repo_scan': 'true',
                'set debug': 'true',
                'app_instance_uuid': 'development-not-secret',
                'beaker.session.secret': 'development-not-secret',
            },
            '[handler_console]': {
                'level': 'DEBUG',
                'formatter': 'color_formatter',
            },
            '[handler_console_sql]': {
                'level': 'DEBUG',
                'formatter': 'color_formatter_sql',
            },
        },
    ),
]


def main():
    # make sure all mako lines starting with '#' (the '##' comments) are marked up as <text>
    print 'reading:', makofile
    mako_org = file(makofile).read()
    mako_no_text_markup = re.sub(r'</?%text>', '', mako_org)
    mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE)
    if mako_marked_up != mako_org:
        print 'writing:', makofile
        file(makofile, 'w').write(mako_marked_up)

    # select the right mako conditionals for the other less sophisticated formats
    def sub_conditionals(m):
        """given a %if...%endif match, replace with just the selected
        conditional sections enabled and the rest as comments
        """
        conditional_lines = m.group(1)
        def sub_conditional(m):
            """given a conditional and the corresponding lines, return them raw
            or commented out, based on whether conditional is selected
            """
            criteria, lines = m.groups()
            if criteria not in selected_mako_conditionals:
                lines = '\n'.join((l if not l or l.startswith('#') else '#' + l) for l in lines.split('\n'))
            return lines
        conditional_lines = re.sub(r'^%(?:el)?if (.*):\n((?:^[^%\n].*\n|\n)*)',
            sub_conditional, conditional_lines, flags=re.MULTILINE)
        return conditional_lines
    mako_no_conditionals = re.sub(r'^(%if .*\n(?:[^%\n].*\n|%elif .*\n|\n)*)%endif\n',
        sub_conditionals, mako_no_text_markup, flags=re.MULTILINE)

    # expand mako variables
    def pyrepl(m):
        return mako_variable_values.get(m.group(1), m.group(0))
    mako_no_variables = re.sub(r'\${([^}]*)}', pyrepl, mako_no_conditionals)

    # remove utf-8 coding header
    base_ini = re.sub(r'^## -\*- coding: utf-8 -\*-\n', '', mako_no_variables)

    # create ini files
    for fn, desc, settings in ini_files:
        print 'updating:', fn
        ini_lines = re.sub(
            '# Kallithea - config file generated with kallithea-config *#\n',
            ''.join('# %-77s#\n' % l.strip() for l in desc.strip().split('\n')),
            base_ini)
        def process_section(m):
            """process a ini section, replacing values as necessary"""
            sectionname, lines = m.groups()
            if sectionname in settings:
                section_settings = settings[sectionname]
                def process_line(m):
                    """process a section line and update value if necessary"""
                    setting, value = m.groups()
                    line = m.group(0)
                    if setting in section_settings:
                        line = '%s = %s' % (setting, section_settings[setting])
                        if '$' not in value:
                            line = '#%s = %s\n%s' % (setting, value, line)
                    return line.rstrip()
                lines = re.sub(r'^([^#\n].*) = ?(.*)', process_line, lines, flags=re.MULTILINE)
            return sectionname + '\n' + lines
        ini_lines = re.sub(r'^(\[.*\])\n((?:(?:[^[\n].*)?\n)*)', process_section, ini_lines, flags=re.MULTILINE)
        file(fn, 'w').write(ini_lines)

if __name__ == '__main__':
    main()