doc: make script docgen.py compliant with PEP8, replace %-formatting with .format()

1 files changed, 328 insertions, 211 deletions

diff --git a/doc/docgen.py b/doc/docgen.py
index d9d26a028..d68816c7e 100644
--- a/doc/docgen.py
+++ b/doc/docgen.py
@@ -18,7 +18,8 @@
 
 #
 # Documentation generator for WeeChat: build include files with commands,
-# options, infos, infolists, hdata and completions for WeeChat core and plugins.
+# options, infos, infolists, hdata and completions for WeeChat core and
+# plugins.
 #
 # Instructions to build config files yourself in WeeChat directories (replace
 # all paths with your path to WeeChat):
@@ -32,11 +33,11 @@
 # Files should be in ~/src/weechat/doc/xx/autogen/ (where xx is language).
 #
 
-SCRIPT_NAME    = 'docgen'
-SCRIPT_AUTHOR  = 'Sébastien Helleu <flashcode@flashtux.org>'
+SCRIPT_NAME = 'docgen'
+SCRIPT_AUTHOR = 'Sébastien Helleu <flashcode@flashtux.org>'
 SCRIPT_VERSION = '0.1'
 SCRIPT_LICENSE = 'GPL3'
-SCRIPT_DESC    = 'Documentation generator for WeeChat'
+SCRIPT_DESC = 'Documentation generator for WeeChat'
 
 SCRIPT_COMMAND = 'docgen'
 
@@ -50,11 +51,14 @@ except ImportError:
     import_ok = False
 
 try:
-    import os, gettext, re, hashlib
+    import gettext
+    import hashlib
+    import os
+    import re
     from collections import defaultdict
     from operator import itemgetter
 except ImportError as message:
-    print('Missing package(s) for %s: %s' % (SCRIPT_NAME, message))
+    print('Missing package(s) for {0}: {1}'.format(SCRIPT_NAME, message))
     import_ok = False
 
 # default path where doc files will be written (should be doc/ in sources
@@ -78,52 +82,61 @@ locale_list = ('en_US', 'fr_FR', 'it_IT', 'de_DE', 'ja_JP')
 # if plugin is listed without "c", that means plugin has only one command
 # /name (where "name" is name of plugin)
 # Note: we consider core is a plugin called "weechat"
-plugin_list = { 'sec'      : 'o',
-                'weechat'  : 'co',
-                'alias'    : '',
-                'aspell'   : 'o',
-                'charset'  : 'co',
-                'fifo'     : 'co',
-                'irc'      : 'co',
-                'logger'   : 'co',
-                'relay'    : 'co',
-                'rmodifier': 'co',
-                'script'   : 'co',
-                'perl'     : '',
-                'python'   : '',
-                'ruby'     : '',
-                'lua'      : '',
-                'tcl'      : '',
-                'guile'    : '',
-                'xfer'     : 'co' }
+plugin_list = {
+    'sec': 'o',
+    'weechat': 'co',
+    'alias': '',
+    'aspell': 'o',
+    'charset': 'co',
+    'fifo': 'co',
+    'irc': 'co',
+    'logger': 'co',
+    'relay': 'co',
+    'rmodifier': 'co',
+    'script': 'co',
+    'perl': '',
+    'python': '',
+    'ruby': '',
+    'lua': '',
+    'tcl': '',
+    'guile': '',
+    'xfer': 'co',
+}
 
 # options to ignore
-ignore_options = ( 'aspell\.dict\..*',
-                   'aspell\.option\..*',
-                   'charset\.decode\..*',
-                   'charset\.encode\..*',
-                   'irc\.msgbuffer\..*',
-                   'irc\.ctcp\..*',
-                   'irc\.ignore\..*',
-                   'irc\.server\..*',
-                   'jabber\.server\..*',
-                   'logger\.level\..*',
-                   'logger\.mask\..*',
-                   'relay\.port\..*',
-                   'rmodifier\.modifier\..*',
-                   'weechat\.palette\..*',
-                   'weechat\.proxy\..*',
-                   'weechat\.bar\..*',
-                   'weechat\.debug\..*',
-                   'weechat\.notify\..*' )
+ignore_options = (
+    'aspell\.dict\..*',
+    'aspell\.option\..*',
+    'charset\.decode\..*',
+    'charset\.encode\..*',
+    'irc\.msgbuffer\..*',
+    'irc\.ctcp\..*',
+    'irc\.ignore\..*',
+    'irc\.server\..*',
+    'jabber\.server\..*',
+    'logger\.level\..*',
+    'logger\.mask\..*',
+    'relay\.port\..*',
+    'rmodifier\.modifier\..*',
+    'weechat\.palette\..*',
+    'weechat\.proxy\..*',
+    'weechat\.bar\..*',
+    'weechat\.debug\..*',
+    'weechat\.notify\..*',
+)
 
 # completions to ignore
-ignore_completions_items = ( 'docgen.*',
-                             'jabber.*',
-                             'weeget.*' )
+ignore_completions_items = (
+    'docgen.*',
+    'jabber.*',
+    'weeget.*',
+)
+
 
 def get_commands():
-    """Get list of commands in a dict with 3 indexes: plugin, command, xxx."""
+    """
+    Get list of commands in a dict with 3 indexes: plugin, command, xxx.
+    """
     global plugin_list
     commands = defaultdict(lambda: defaultdict(defaultdict))
     infolist = weechat.infolist_get('hook', '', 'command')
@@ -132,15 +145,22 @@ def get_commands():
         if plugin in plugin_list:
             command = weechat.infolist_string(infolist, 'command')
             if command == plugin or 'c' in plugin_list[plugin]:
-                for key in ('description', 'args', 'args_description', 'completion'):
-                    commands[plugin][command][key] = weechat.infolist_string(infolist, key)
+                for key in ('description', 'args', 'args_description',
+                            'completion'):
+                    commands[plugin][command][key] = \
+                        weechat.infolist_string(infolist, key)
     weechat.infolist_free(infolist)
     return commands
 
+
 def get_options():
-    """Get list of config options in a dict with 4 indexes: config, section, option, xxx."""
+    """
+    Get list of config options in a dict with 4 indexes: config,
+    section, option, xxx.
+    """
     global plugin_list, ignore_options
-    options = defaultdict(lambda: defaultdict(lambda: defaultdict(defaultdict)))
+    options = \
+        defaultdict(lambda: defaultdict(lambda: defaultdict(defaultdict)))
     infolist = weechat.infolist_get('option', '', '')
     while weechat.infolist_next(infolist):
         full_name = weechat.infolist_string(infolist, 'full_name')
@@ -149,57 +169,80 @@ def get_options():
             if config in plugin_list and 'o' in plugin_list[config]:
                 section = weechat.infolist_string(infolist, 'section_name')
                 option = weechat.infolist_string(infolist, 'option_name')
-                for key in ('type', 'string_values', 'default_value', 'description'):
-                    options[config][section][option][key] = weechat.infolist_string(infolist, key)
+                for key in ('type', 'string_values', 'default_value',
+                            'description'):
+                    options[config][section][option][key] = \
+                        weechat.infolist_string(infolist, key)
                 for key in ('min', 'max', 'null_value_allowed'):
-                    options[config][section][option][key] = weechat.infolist_integer(infolist, key)
+                    options[config][section][option][key] = \
+                        weechat.infolist_integer(infolist, key)
     weechat.infolist_free(infolist)
     return options
 
+
 def get_infos():
-    """Get list of infos hooked by plugins in a dict with 3 indexes: plugin, name, xxx."""
+    """
+    Get list of infos hooked by plugins in a dict with 3 indexes:
+    plugin, name, xxx.
+    """
     infos = defaultdict(lambda: defaultdict(defaultdict))
     infolist = weechat.infolist_get('hook', '', 'info')
     while weechat.infolist_next(infolist):
         info_name = weechat.infolist_string(infolist, 'info_name')
         plugin = weechat.infolist_string(infolist, 'plugin_name') or 'weechat'
         for key in ('description', 'args_description'):
-            infos[plugin][info_name][key] = weechat.infolist_string(infolist, key)
+            infos[plugin][info_name][key] = \
+                weechat.infolist_string(infolist, key)
     weechat.infolist_free(infolist)
     return infos
 
+
 def get_infos_hashtable():
-    """Get list of infos (hashtable) hooked by plugins in a dict with 3 indexes: plugin, name, xxx."""
+    """
+    Get list of infos (hashtable) hooked by plugins in a dict with 3
+    indexes: plugin, name, xxx.
+    """
     infos_hashtable = defaultdict(lambda: defaultdict(defaultdict))
     infolist = weechat.infolist_get('hook', '', 'info_hashtable')
     while weechat.infolist_next(infolist):
         info_name = weechat.infolist_string(infolist, 'info_name')
         plugin = weechat.infolist_string(infolist, 'plugin_name') or 'weechat'
         for key in ('description', 'args_description', 'output_description'):
-            infos_hashtable[plugin][info_name][key] = weechat.infolist_string(infolist, key)
+            infos_hashtable[plugin][info_name][key] = \
+                weechat.infolist_string(infolist, key)
     weechat.infolist_free(infolist)
     return infos_hashtable
 
+
 def get_infolists():
-    """Get list of infolists hooked by plugins in a dict with 3 indexes: plugin, name, xxx."""
+    """
+    Get list of infolists hooked by plugins in a dict with 3 indexes:
+    plugin, name, xxx.
+    """
     infolists = defaultdict(lambda: defaultdict(defaultdict))
     infolist = weechat.infolist_get('hook', '', 'infolist')
     while weechat.infolist_next(infolist):
         infolist_name = weechat.infolist_string(infolist, 'infolist_name')
         plugin = weechat.infolist_string(infolist, 'plugin_name') or 'weechat'
         for key in ('description', 'pointer_description', 'args_description'):
-            infolists[plugin][infolist_name][key] = weechat.infolist_string(infolist, key)
+            infolists[plugin][infolist_name][key] = \
+                weechat.infolist_string(infolist, key)
     weechat.infolist_free(infolist)
     return infolists
 
+
 def get_hdata():
-    """Get list of hdata hooked by plugins in a dict with 3 indexes: plugin, name, xxx."""
+    """
+    Get list of hdata hooked by plugins in a dict with 3 indexes:
+    plugin, name, xxx.
+    """
     hdata = defaultdict(lambda: defaultdict(defaultdict))
     infolist = weechat.infolist_get('hook', '', 'hdata')
     while weechat.infolist_next(infolist):
         hdata_name = weechat.infolist_string(infolist, 'hdata_name')
         plugin = weechat.infolist_string(infolist, 'plugin_name') or 'weechat'
-        hdata[plugin][hdata_name]['description'] = weechat.infolist_string(infolist, 'description')
+        hdata[plugin][hdata_name]['description'] = \
+            weechat.infolist_string(infolist, 'description')
         variables = ''
         variables_update = ''
         lists = ''
@@ -211,25 +254,36 @@ def get_hdata():
                 for item in string.split(','):
                     key = item.split(':')[0]
                     var_offset = weechat.hdata_get_var_offset(ptr_hdata, key)
-                    var_array_size = weechat.hdata_get_var_array_size_string(ptr_hdata, '', key)
+                    var_array_size = \
+                        weechat.hdata_get_var_array_size_string(ptr_hdata, '',
+                                                                key)
                     if var_array_size:
-                        var_array_size = ', array_size: "%s"' % var_array_size
+                        var_array_size = \
+                            ', array_size: "{0}"'.format(var_array_size)
                     var_hdata = weechat.hdata_get_var_hdata(ptr_hdata, key)
                     if var_hdata:
-                        var_hdata = ', hdata: "%s"' % var_hdata
-                    type_string = weechat.hdata_get_var_type_string(ptr_hdata, key)
+                        var_hdata = ', hdata: "{0}"'.format(var_hdata)
+                    type_string = weechat.hdata_get_var_type_string(ptr_hdata,
+                                                                    key)
+                    d = {'__update_allowed': key}
                     hdata2.append({'offset': var_offset,
-                                   'text': '\'%s\' (%s)' % (key, type_string),
-                                   'textlong': '\'%s\' (%s%s%s)' % (key, type_string, var_array_size, var_hdata),
-                                   'update': weechat.hdata_update(ptr_hdata, '', { '__update_allowed': key })})
+                                   'text': '\'{0}\' ({1})'.format(key,
+                                                                  type_string),
+                                   'textlong': '\'{0}\' ({1}{2}{3})'
+                                   ''.format(key, type_string, var_array_size,
+                                             var_hdata),
+                                   'update': weechat.hdata_update(ptr_hdata,
+                                                                  '', d)})
                 hdata2 = sorted(hdata2, key=itemgetter('offset'))
                 for item in hdata2:
-                    variables += '*** %s\n' % item['textlong']
+                    variables += '*** {0}\n'.format(item['textlong'])
                     if item['update']:
-                        variables_update += '*** %s\n' % item['text']
-                if weechat.hdata_update(ptr_hdata, '', { '__create_allowed' : '' }):
+                        variables_update += '*** {0}\n'.format(item['text'])
+                if weechat.hdata_update(ptr_hdata, '',
+                                        {'__create_allowed': ''}):
                     variables_update += '*** \'__create\'\n'
-                if weechat.hdata_update(ptr_hdata, '', { '__delete_allowed' : '' }):
+                if weechat.hdata_update(ptr_hdata, '',
+                                        {'__delete_allowed': ''}):
                     variables_update += '*** \'__delete\'\n'
             hdata[plugin][hdata_name]['vars'] = variables
             hdata[plugin][hdata_name]['vars_update'] = variables_update
@@ -237,36 +291,51 @@ def get_hdata():
             string = weechat.hdata_get_string(ptr_hdata, 'list_keys')
             if string:
                 for item in sorted(string.split(',')):
-                    lists += '*** \'%s\'\n' % item
+                    lists += '*** \'{0}\'\n'.format(item)
             hdata[plugin][hdata_name]['lists'] = lists
     weechat.infolist_free(infolist)
     return hdata
 
+
 def get_completions():
-    """Get list of completions hooked by plugins in a dict with 3 indexes: plugin, item, xxx."""
+    """
+    Get list of completions hooked by plugins in a dict with 3 indexes:
+    plugin, item, xxx.
+    """
     global ignore_completions_items
     completions = defaultdict(lambda: defaultdict(defaultdict))
     infolist = weechat.infolist_get('hook', '', 'completion')
     while weechat.infolist_next(infolist):
         completion_item = weechat.infolist_string(infolist, 'completion_item')
         if not re.search('|'.join(ignore_completions_items), completion_item):
-            plugin = weechat.infolist_string(infolist, 'plugin_name') or 'weechat'
-            completions[plugin][completion_item]['description'] = weechat.infolist_string(infolist, 'description')
+            plugin = weechat.infolist_string(infolist, 'plugin_name') or \
+                'weechat'
+            completions[plugin][completion_item]['description'] = \
+                weechat.infolist_string(infolist, 'description')
     weechat.infolist_free(infolist)
     return completions
 
+
 def get_url_options():
-    """Get list of completions hooked by plugins in a dict with 3 indexes: plugin, item, xxx."""
+    """
+    Get list of completions hooked by plugins in a dict with 3 indexes:
+    plugin, item, xxx.
+    """
     url_options = []
     infolist = weechat.infolist_get('url_options', '', '')
     while weechat.infolist_next(infolist):
-        url_options.append({ 'name': weechat.infolist_string(infolist, 'name').lower(),
-                             'option': weechat.infolist_integer(infolist, 'option'),
-                             'type': weechat.infolist_string(infolist, 'type'),
-                             'constants': weechat.infolist_string(infolist, 'constants').lower().replace(',', ', ') })
+        url_options.append(
+            {
+                'name': weechat.infolist_string(infolist, 'name').lower(),
+                'option': weechat.infolist_integer(infolist, 'option'),
+                'type': weechat.infolist_string(infolist, 'type'),
+                'constants': weechat.infolist_string(infolist, 'constants')
+                .lower().replace(',', ', ')
+            })
     weechat.infolist_free(infolist)
     return url_options
 
+
 def update_file(oldfile, newfile, num_files, num_files_updated, obj):
     """Update a doc file."""
     try:
@@ -291,6 +360,7 @@ def update_file(oldfile, newfile, num_files, num_files_updated, obj):
     num_files['total2'] += 1
     num_files[obj] += 1
 
+
 def docgen_cmd_cb(data, buffer, args):
     """Callback for /docgen command."""
     global locale_list
@@ -310,7 +380,7 @@ def docgen_cmd_cb(data, buffer, args):
     # get path and replace ~ by home if needed
     path = weechat.config_get_plugin('path')
     if path.startswith('~'):
-        path = '%s%s' % (os.environ['HOME'], path[1:])
+        path = os.environ['HOME'] + path[1:]
 
     # write to doc files, by locale
     num_files = defaultdict(int)
@@ -324,54 +394,60 @@ def docgen_cmd_cb(data, buffer, args):
             if key != 'total2':
                 num_files[key] = 0
                 num_files_updated[key] = 0
-        t = gettext.translation('weechat', weechat.info_get('weechat_localedir', ''),
-                                languages=['%s.UTF-8' % locale], fallback=True)
+        t = gettext.translation('weechat',
+                                weechat.info_get('weechat_localedir', ''),
+                                languages=[locale + '.UTF-8'], fallback=True)
         t.install()
-        directory = '%s/%s/autogen' % (path, locale[0:2])
+        directory = path + '/' + locale[0:2] + '/autogen'
         if not os.path.isdir(directory):
-            weechat.prnt('', '%sdocgen error: directory "%s" does not exist' % (weechat.prefix('error'),
-                                                                                directory))
+            weechat.prnt('',
+                         '{0}docgen error: directory "{1}" does not exist'
+                         ''.format(weechat.prefix('error'), directory))
             continue
+
         # write commands
         for plugin in commands:
-            filename = '%s/user/%s_commands.txt' % (directory, plugin)
-            tmpfilename = '%s.tmp' % filename
+            filename = directory + '/user/' + plugin + '_commands.txt'
+            tmpfilename = filename + '.tmp'
             f = open(tmpfilename, 'w')
             for command in sorted(commands[plugin]):
-                args = translate(commands[plugin][command]['args'])
+                _cmd = commands[plugin][command]
+                args = translate(_cmd['args'])
                 args_formats = args.split(' || ')
-                description = translate(commands[plugin][command]['description'])
-                args_description = translate(commands[plugin][command]['args_description'])
-                f.write('[[command_%s_%s]]\n' % (plugin, command))
-                f.write('[command]*`%s`* %s::\n\n' % (command, description))
+                desc = translate(_cmd['description'])
+                args_desc = translate(_cmd['args_description'])
+                f.write('[[command_{0}_{1}]]\n'.format(plugin, command))
+                f.write('[command]*`{0}`* {1}::\n\n'.format(command, desc))
                 f.write('----------------------------------------\n')
-                prefix = '/%s  ' % command
+                prefix = '/' + command + '  '
                 if args_formats != ['']:
                     for fmt in args_formats:
-                        f.write('%s%s\n' % (prefix, fmt))
+                        f.write(prefix + fmt + '\n')
                         prefix = ' ' * len(prefix)
-                if args_description:
+                if args_desc:
                     f.write('\n')
-                    for line in args_description.split('\n'):
-                        f.write('%s\n' % line)
+                    for line in args_desc.split('\n'):
+                        f.write(line + '\n')
                 f.write('----------------------------------------\n\n')
             f.close()
-            update_file(filename, tmpfilename, num_files, num_files_updated, 'commands')
+            update_file(filename, tmpfilename, num_files, num_files_updated,
+                        'commands')
 
         # write config options
         for config in options:
-            filename = '%s/user/%s_options.txt' % (directory, config)
-            tmpfilename = '%s.tmp' % filename
+            filename = directory + '/user/' + config + '_options.txt'
+            tmpfilename = filename + '.tmp'
             f = open(tmpfilename, 'w')
             for section in sorted(options[config]):
                 for option in sorted(options[config][section]):
-                    opt_type = options[config][section][option]['type']
-                    string_values = options[config][section][option]['string_values']
-                    default_value = options[config][section][option]['default_value']
-                    opt_min = options[config][section][option]['min']
-                    opt_max = options[config][section][option]['max']
-                    null_value_allowed = options[config][section][option]['null_value_allowed']
-                    description = translate(options[config][section][option]['description'])
+                    _opt = options[config][section][option]
+                    opt_type = _opt['type']
+                    string_values = _opt['string_values']
+                    default_value = _opt['default_value']
+                    opt_min = _opt['min']
+                    opt_max = _opt['max']
+                    null_value_allowed = _opt['null_value_allowed']
+                    desc = translate(_opt['description'])
                     type_nls = translate(opt_type)
                     values = ''
                     if opt_type == 'boolean':
@@ -380,194 +456,235 @@ def docgen_cmd_cb(data, buffer, args):
                         if string_values:
                             values = string_values.replace('|', ', ')
                         else:
-                            values = '%d .. %d' % (opt_min, opt_max)
+                            values = '{0} .. {1}'.format(opt_min, opt_max)
                     elif opt_type == 'string':
                         if opt_max <= 0:
                             values = _('any string')
                         elif opt_max == 1:
                             values = _('any char')
                         elif opt_max > 1:
-                            values = '%s (%s: %d)' % (_('any string'),
-                                                      _('max chars'),
-                                                      opt_max)
+                            values = '{0} ({1}: {2})'.format(_('any string'),
+                                                             _('max chars'),
+                                                             opt_max)
                         else:
                             values = _('any string')
-                        default_value = '"%s"' % default_value.replace('"', '\\"')
+                        default_value = '"{0}"'.format(
+                            default_value.replace('"', '\\"'))
                     elif opt_type == 'color':
                         values = _('a WeeChat color name (default, black, '
-                                   '(dark)gray, white, (light)red, (light)green, '
-                                   'brown, yellow, (light)blue, (light)magenta, '
-                                   '(light)cyan), a terminal color number or '
-                                   'an alias; attributes are allowed before '
-                                   'color (for text color only, not '
-                                   'background): \"*\" for bold, \"!\" for '
-                                   'reverse, \"/\" for italic, \"_\" for underline')
-                    f.write('* [[option_%s.%s.%s]] *%s.%s.%s*\n' % (config, section, option, config, section, option))
-                    f.write('** %s: `%s`\n' % (_('description'), description))
-                    f.write('** %s: %s\n' % (_('type'), type_nls))
-                    f.write('** %s: %s (%s: `%s`)\n' % (_('values'), values,
-                                                        _('default value'), default_value))
+                                   '(dark)gray, white, (light)red, '
+                                   '(light)green, brown, yellow, (light)blue, '
+                                   '(light)magenta, (light)cyan), a terminal '
+                                   'color number or an alias; attributes are '
+                                   'allowed before color (for text color '
+                                   'only, not background): \"*\" for bold, '
+                                   '\"!\" for reverse, \"/\" for italic, '
+                                   '\"_\" for underline')
+                    f.write('* [[option_{0}.{1}.{2}]] *{3}.{4}.{5}*\n'
+                            ''.format(config, section, option, config, section,
+                                      option))
+                    f.write('** {0}: `{1}`\n'.format(_('description'), desc))
+                    f.write('** {0}: {1}\n'.format(_('type'), type_nls))
+                    f.write('** {0}: {1} ({2}: `{3}`)\n'
+                            ''.format(_('values'), values, _('default value'),
+                                      default_value))
                     if null_value_allowed:
-                        f.write('** %s\n' % _('undefined value allowed (null)'))
+                        f.write('** {0}\n'
+                                ''.format(_('undefined value allowed (null)')))
                     f.write('\n')
             f.close()
-            update_file(filename, tmpfilename, num_files, num_files_updated, 'options')
+            update_file(filename, tmpfilename, num_files, num_files_updated,
+                        'options')
 
         # write infos hooked
-        filename = '%s/plugin_api/infos.txt' % directory
-        tmpfilename = '%s.tmp' % filename
+        filename = directory + '/plugin_api/infos.txt'
+        tmpfilename = filename + '.tmp'
         f = open(tmpfilename, 'w')
         f.write('[width="100%",cols="^1,^2,6,6",options="header"]\n')
         f.write('|========================================\n')
-        f.write('| %s | %s | %s | %s\n\n' % (_('Plugin'), _('Name'), _('Description'), _('Arguments')))
+        f.write('| {0} | {1} | {2} | {3}\n\n'
+                ''.format(_('Plugin'), _('Name'), _('Description'),
+                          _('Arguments')))
         for plugin in sorted(infos):
             for info in sorted(infos[plugin]):
-                description = translate(infos[plugin][info]['description'])
-                args_description = translate(infos[plugin][info]['args_description']) or '-'
-                f.write('| %s | %s | %s | %s\n\n' % (escape(plugin),
-                                                     escape(info),
-                                                     escape(description),
-                                                     escape(args_description)))
+                _inf = infos[plugin][info]
+                desc = translate(_inf['description'])
+                args_desc = translate(_inf['args_description'] or '-')
+                f.write('| {0} | {1} | {2} | {3}\n\n'
+                        ''.format(escape(plugin), escape(info),
+                                  escape(desc), escape(args_desc)))
         f.write('|========================================\n')
         f.close()
-        update_file(filename, tmpfilename, num_files, num_files_updated, 'infos')
+        update_file(filename, tmpfilename, num_files, num_files_updated,
+                    'infos')
 
         # write infos (hashtable) hooked
-        filename = '%s/plugin_api/infos_hashtable.txt' % directory
-        tmpfilename = '%s.tmp' % filename
+        filename = directory + '/plugin_api/infos_hashtable.txt'
+        tmpfilename = filename + '.tmp'
         f = open(tmpfilename, 'w')
         f.write('[width="100%",cols="^1,^2,6,6,6",options="header"]\n')
         f.write('|========================================\n')
-        f.write('| %s | %s | %s | %s | %s\n\n' % (_('Plugin'), _('Name'), _('Description'),
-                                                  _('Hashtable (input)'), _('Hashtable (output)')))
+        f.write('| {0} | {1} | {2} | {3} | {4}\n\n'
+                ''.format(_('Plugin'), _('Name'), _('Description'),
+                          _('Hashtable (input)'), _('Hashtable (output)')))
         for plugin in sorted(infos_hashtable):
             for info in sorted(infos_hashtable[plugin]):
-                description = translate(infos_hashtable[plugin][info]['description'])
-                args_description = translate(infos_hashtable[plugin][info]['args_description'])
-                output_description = translate(infos_hashtable[plugin][info]['output_description']) or '-'
-                f.write('| %s | %s | %s | %s | %s\n\n' % (escape(plugin),
-                                                          escape(info),
-                                                          escape(description),
-                                                          escape(args_description),
-                                                          escape(output_description)))
+                _inh = infos_hashtable[plugin][info]
+                desc = translate(_inh['description'])
+                args_desc = translate(_inh['args_description'])
+                output_desc = translate(_inh['output_description']) or '-'
+                f.write('| {0} | {1} | {2} | {3} | {4}\n\n'
+                        ''.format(escape(plugin), escape(info),
+                                  escape(desc), escape(args_desc),
+                                  escape(output_desc)))
         f.write('|========================================\n')
         f.close()
-        update_file(filename, tmpfilename, num_files, num_files_updated, 'infos_hashtable')
+        update_file(filename, tmpfilename, num_files, num_files_updated,
+                    'infos_hashtable')
 
         # write infolists hooked
-        filename = '%s/plugin_api/infolists.txt' % directory
-        tmpfilename = '%s.tmp' % filename
+        filename = directory + '/plugin_api/infolists.txt'
+        tmpfilename = filename + '.tmp'
         f = open(tmpfilename, 'w')
         f.write('[width="100%",cols="^1,^2,5,5,5",options="header"]\n')
         f.write('|========================================\n')
-        f.write('| %s | %s | %s | %s | %s\n\n' % (_('Plugin'), _('Name'), _('Description'),
-                                                  _('Pointer'), _('Arguments')))
+        f.write('| {0} | {1} | {2} | {3} | {4}\n\n'
+                ''.format(_('Plugin'), _('Name'), _('Description'),
+                          _('Pointer'), _('Arguments')))
         for plugin in sorted(infolists):
             for infolist in sorted(infolists[plugin]):
-                description = translate(infolists[plugin][infolist]['description'])
-                pointer_description = translate(infolists[plugin][infolist]['pointer_description']) or '-'
-                args_description = translate(infolists[plugin][infolist]['args_description']) or '-'
-                f.write('| %s | %s | %s | %s | %s\n\n' % (escape(plugin),
-                                                          escape(infolist),
-                                                          escape(description),
-                                                          escape(pointer_description),
-                                                          escape(args_description)))
+                _inl = infolists[plugin][infolist]
+                desc = translate(_inl['description'])
+                pointer_desc = translate(_inl['pointer_description']) or '-'
+                args_desc = translate(_inl['args_description']) or '-'
+                f.write('| {0} | {1} | {2} | {3} | {4}\n\n'
+                        ''.format(escape(plugin), escape(infolist),
+                                  escape(desc), escape(pointer_desc),
+                                  escape(args_desc)))
         f.write('|========================================\n')
         f.close()
-        update_file(filename, tmpfilename, num_files, num_files_updated, 'infolists')
+        update_file(filename, tmpfilename, num_files, num_files_updated,
+                    'infolists')
 
         # write hdata hooked
-        filename = '%s/plugin_api/hdata.txt' % directory
-        tmpfilename = '%s.tmp' % filename
+        filename = directory + '/plugin_api/hdata.txt'
+        tmpfilename = filename + '.tmp'
         f = open(tmpfilename, 'w')
         for plugin in sorted(hdata):
             for hdata_name in sorted(hdata[plugin]):
-                description = translate(hdata[plugin][hdata_name]['description'])
-                variables = hdata[plugin][hdata_name]['vars']
-                variables_update = hdata[plugin][hdata_name]['vars_update']
-                lists = hdata[plugin][hdata_name]['lists']
-                f.write('* \'%s\': %s\n' % (escape(hdata_name),
-                                            escape(description)))
-                f.write('** %s: %s\n' % (_('plugin'), escape(plugin)))
-                f.write('** %s:\n%s' % (_('variables'), escape(variables)))
+                _hda = hdata[plugin][hdata_name]
+                desc = translate(_hda['description'])
+                variables = _hda['vars']
+                variables_update = _hda['vars_update']
+                lists = _hda['lists']
+                f.write('* \'{0}\': {1}\n'.format(escape(hdata_name),
+                                                  escape(desc)))
+                f.write('** {0}: {1}\n'.format(_('plugin'), escape(plugin)))
+                f.write('** {0}:\n{1}'.format(_('variables'),
+                                              escape(variables)))
                 if variables_update:
-                    f.write('** %s:\n%s' % (_('update allowed'), escape(variables_update)))
+                    f.write('** {0}:\n{1}'.format(_('update allowed'),
+                                                  escape(variables_update)))
                 if lists:
-                    f.write('** %s:\n%s' % (_('lists'), escape(lists)))
+                    f.write('** {0}:\n{1}'.format(_('lists'), escape(lists)))
         f.close()
-        update_file(filename, tmpfilename, num_files, num_files_updated, 'hdata')
+        update_file(filename, tmpfilename, num_files, num_files_updated,
+                    'hdata')
 
         # write completions hooked
-        filename = '%s/plugin_api/completions.txt' % directory
-        tmpfilename = '%s.tmp' % filename
+        filename = directory + '/plugin_api/completions.txt'
+        tmpfilename = filename + '.tmp'
         f = open(tmpfilename, 'w')
         f.write('[width="65%",cols="^1,^2,8",options="header"]\n')
         f.write('|========================================\n')
-        f.write('| %s | %s | %s\n\n' % (_('Plugin'), _('Name'), _('Description')))
+        f.write('| {0} | {1} | {2}\n\n'
+                ''.format(_('Plugin'), _('Name'), _('Description')))
         for plugin in sorted(completions):
             for completion_item in sorted(completions[plugin]):
-                description = translate(completions[plugin][completion_item]['description'])
-                f.write('| %s | %s | %s\n\n' % (escape(plugin),
-                                                escape(completion_item),
-                                                escape(description)))
+                _cmp = completions[plugin][completion_item]
+                desc = translate(_cmp['description'])
+                f.write('| {0} | {1} | {2}\n\n'
+                        ''.format(escape(plugin), escape(completion_item),
+                                  escape(desc)))
         f.write('|========================================\n')
         f.close()
-        update_file(filename, tmpfilename, num_files, num_files_updated, 'completions')
+        update_file(filename, tmpfilename, num_files, num_files_updated,
+                    'completions')
 
         # write url options
-        filename = '%s/plugin_api/url_options.txt' % directory
-        tmpfilename = '%s.tmp' % filename
+        filename = directory + '/plugin_api/url_options.txt'
+        tmpfilename = filename + '.tmp'
         f = open(tmpfilename, 'w')
         f.write('[width="100%",cols="2,^1,7",options="header"]\n')
         f.write('|========================================\n')
-        f.write('| %s | %s | %s\n\n' % (_('Option'), _('Type'), _('Constants') + ' ^(1)^'))
+        f.write('| {0} | {1} | {2}\n\n'
+                ''.format(_('Option'), _('Type'), _('Constants') + ' ^(1)^'))
         for option in url_options:
             constants = option['constants']
             if constants:
                 constants = ' ' + constants
-            f.write('| %s | %s |%s\n\n' % (escape(option['name']),
-                                            escape(option['type']),
-                                            escape(constants)))
+            f.write('| {0} | {1} |{2}\n\n'
+                    ''.format(escape(option['name']), escape(option['type']),
+                              escape(constants)))
         f.write('|========================================\n')
         f.close()
-        update_file(filename, tmpfilename, num_files, num_files_updated, 'url_options')
+        update_file(filename, tmpfilename, num_files, num_files_updated,
+                    'url_options')
 
         # write counters
         weechat.prnt('',
-                     'docgen: %s: %3d files   (%2d cmd, %2d opt, %2d infos, '
-                     '%2d infos_hash, %2d infolists, %2d hdata, %2d complt)'
-                     % (locale, num_files['total1'],
-                        num_files['commands'], num_files['options'],
-                        num_files['infos'], num_files['infos_hashtable'],
-                        num_files['infolists'], num_files['hdata'],
-                        num_files['completions']))
+                     'docgen: {0}: {1:3d} files   '
+                     '({2:2d} cmd, {3:2d} opt, {4:2d} infos, '
+                     '{5:2d} infos_hash, {6:2d} infolists, {7:2d} hdata, '
+                     '{8:2d} complt)'
+                     ''.format(locale,
+                               num_files['total1'],
+                               num_files['commands'],
+                               num_files['options'],
+                               num_files['infos'],
+                               num_files['infos_hashtable'],
+                               num_files['infolists'],
+                               num_files['hdata'],
+                               num_files['completions']))
         weechat.prnt('',
-                     '               %3d updated (%2d cmd, %2d opt, %2d infos, '
-                     '%2d infos_hash, %2d infolists, %2d hdata, %2d complt)'
-                     % (num_files_updated['total1'], num_files_updated['commands'],
-                        num_files_updated['options'], num_files_updated['infos'],
-                        num_files_updated['infos_hashtable'], num_files_updated['infolists'],
-                        num_files_updated['hdata'], num_files_updated['completions']))
+                     '               '
+                     '{0:3d} updated ({1:2d} cmd, {2:2d} opt, {3:2d} infos, '
+                     '{4:2d} infos_hash, {5:2d} infolists, {6:2d} hdata, '
+                     '{7:2d} complt)'
+                     ''.format(num_files_updated['total1'],
+                               num_files_updated['commands'],
+                               num_files_updated['options'],
+                               num_files_updated['infos'],
+                               num_files_updated['infos_hashtable'],
+                               num_files_updated['infolists'],
+                               num_files_updated['hdata'],
+                               num_files_updated['completions']))
     weechat.prnt('',
-                 'docgen: total: %d files, %d updated' % (num_files['total2'], num_files_updated['total2']))
+                 'docgen: total: {0} files, {1} updated'
+                 ''.format(num_files['total2'], num_files_updated['total2']))
     return weechat.WEECHAT_RC_OK
 
+
 def docgen_completion_cb(data, completion_item, buffer, completion):
     """Callback for completion."""
     global locale_list
     for locale in locale_list:
-        weechat.hook_completion_list_add(completion, locale, 0, weechat.WEECHAT_LIST_POS_SORT)
+        weechat.hook_completion_list_add(completion, locale, 0,
+                                         weechat.WEECHAT_LIST_POS_SORT)
     return weechat.WEECHAT_RC_OK
 
+
 if __name__ == '__main__' and import_ok:
-    if weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION, SCRIPT_LICENSE,
-                        SCRIPT_DESC, '', ''):
+    if weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION,
+                        SCRIPT_LICENSE, SCRIPT_DESC, '', ''):
         weechat.hook_command(SCRIPT_COMMAND,
                              'Documentation generator.',
                              '[locales]',
-                             'locales: list of locales to build (by default build all locales)',
+                             'locales: list of locales to build (by default '
+                             'build all locales)',
                              '%(docgen_locales)|%*',
                              'docgen_cmd_cb', '')
-        weechat.hook_completion('docgen_locales', 'locales for docgen', 'docgen_completion_cb', '')
+        weechat.hook_completion('docgen_locales', 'locales for docgen',
+                                'docgen_completion_cb', '')
         if not weechat.config_is_set_plugin('path'):
             weechat.config_set_plugin('path', DEFAULT_PATH)