Source code for qubes.dochelpers

# The Qubes OS Project,
# Copyright (C) 2010-2015  Joanna Rutkowska <>
# Copyright (C) 2014-2015  Wojtek Porczyk <>
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, see <>.

"""Documentation helpers.

This module contains classes and functions which help to maintain documentation,
particularly our custom Sphinx extension.

import argparse
import io
import json
import os
import re
import urllib.error
import urllib.request

import docutils
import docutils.nodes
import docutils.parsers.rst
import docutils.parsers.rst.roles
import docutils.statemachine
import sphinx
import sphinx.errors
import sphinx.locale
import sphinx.util.docfields
from sphinx.util import logging



    log = logging.getLogger(__name__)
except AttributeError:
    log = None

class GithubTicket:
    # pylint: disable=too-few-public-methods
    def __init__(self, data):
        self.number = data['number']
        self.summary = data['title']
        self.uri = data['html_url']

[docs]def fetch_ticket_info(app, number): """Fetch info about particular trac ticket given :param app: Sphinx app object :param str number: number of the ticket, without # :rtype: mapping :raises: urllib.error.HTTPError """ with urllib.request.urlopen(urllib.request.Request( app.config.ticket_base_uri.format(number=number), headers={ 'Accept': 'application/vnd.github.v3+json', 'User-agent': __name__})) as response: return GithubTicket(json.load(response))
[docs]def ticket(name, rawtext, text, lineno, inliner, options=None, content=None): """Link to qubes ticket :param str name: The role name used in the document :param str rawtext: The entire markup snippet, with role :param str text: The text marked with the role :param int lineno: The line number where rawtext appears in the input :param docutils.parsers.rst.states.Inliner inliner: The inliner instance \ that called this function :param options: Directive options for customisation :param content: The directive content for customisation """ # pylint: disable=unused-argument if options is None: options = {} ticketno = text.lstrip('#') if not ticketno.isdigit(): msg = inliner.reporter.error( 'Invalid ticket identificator: {!r}'.format(text), line=lineno) prb = inliner.problematic(rawtext, rawtext, msg) return [prb], [msg] try: info = fetch_ticket_info(, ticketno) except urllib.error.HTTPError as e: msg = inliner.reporter.error( 'Error while fetching ticket info: {!s}'.format(e), line=lineno) prb = inliner.problematic(rawtext, rawtext, msg) return [prb], [msg] docutils.parsers.rst.roles.set_classes(options) node = docutils.nodes.reference( rawtext, '#{} ({})'.format(info.number, info.summary), refuri=info.uri, **options) return [node], []
[docs]class versioncheck(docutils.nodes.warning): # pylint: disable=invalid-name pass
def visit(self, node): self.visit_admonition(node, 'version') def depart(self, node): self.depart_admonition(node) sphinx.locale.admonitionlabels['version'] = 'Version mismatch'
[docs]class VersionCheck(docutils.parsers.rst.Directive): """Directive versioncheck Check if current version (from ````) equals version specified as argument. If not, generate warning.""" has_content = True required_arguments = 1 optional_arguments = 0 final_argument_whitespace = True option_spec = {} def run(self): current = version = self.arguments[0] if current == version: return [] text = ' '.join("""This manual page was written for version **{}**, but current version at the time when this page was generated is **{}**. This may or may not mean that page is outdated or has inconsistencies.""".format(version, current).split()) node = versioncheck(text) node['classes'] = ['admonition', 'warning'] self.state.nested_parse(docutils.statemachine.StringList([text]), self.content_offset, node) return [node]
def make_rst_section(heading, char): return '{}\n{}\n\n'.format(heading, char[0] * len(heading)) def prepare_manpage(command): parser = stream = io.StringIO() stream.write('.. program:: {}\n\n'.format(command)) stream.write(make_rst_section( ':program:`{}` -- {}'.format(command, parser.description), '=')) stream.write(""".. warning:: This page was autogenerated from command-line parser. It shouldn't be 1:1 conversion, because it would add little value. Please revise it and add more descriptive help, which normally won't fit in standard ``--help`` option. After rewrite, please remove this admonition.\n\n""") stream.write(make_rst_section('Synopsis', '-')) usage = ' '.join(parser.format_usage().strip().split()) if usage.startswith('usage: '): usage = usage[len('usage: '):] # replace METAVARS with *METAVARS* usage = re.sub(r'\b([A-Z]{2,})\b', r'*\1*', usage) stream.write(':command:`{}` {}\n\n'.format(command, usage)) stream.write(make_rst_section('Options', '-')) for action in parser._actions: # pylint: disable=protected-access stream.write('.. option:: ') if action.metavar: stream.write(', '.join('{}{}{}'.format( option, '=' if option.startswith('--') else ' ', action.metavar) for option in sorted(action.option_strings))) else: stream.write(', '.join(sorted(action.option_strings))) stream.write('\n\n {}\n\n'.format( stream.write(make_rst_section('Authors', '-')) stream.write("""\ | Joanna Rutkowska <joanna at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Marek Marczykowski <marmarek at invisiblethingslab dot com> | Wojtek Porczyk <woju at invisiblethingslab dot com> .. vim: ts=3 sw=3 et tw=80 """) return stream.getvalue()
[docs]class OptionsCheckVisitor(docutils.nodes.SparseNodeVisitor): """ Checks if the visited option nodes and the specified args are in sync. """ def __init__(self, command, args, document): assert isinstance(args, set) docutils.nodes.SparseNodeVisitor.__init__(self, document) self.command = command self.args = args
[docs] def visit_desc(self, node): """ Skips all but 'option' elements """ if not node.get('desctype', None) == 'option': raise docutils.nodes.SkipChildren
[docs] def visit_desc_name(self, node): """ Checks if the option is defined `self.args` """ if not isinstance(node[0], docutils.nodes.Text): raise sphinx.errors.SphinxError('first child should be Text') arg = str(node[0]) try: self.args.remove(arg) except KeyError: raise sphinx.errors.SphinxError( 'No such argument for {!r}: {!r}'.format(self.command, arg))
[docs] def check_undocumented_arguments(self, ignored_options=None): """ Call this to check if any undocumented arguments are left. While the documentation talks about a 'SparseNodeVisitor.depart_document()' function, this function does not exists. (For details see implementation of :py:meth:`NodeVisitor.dispatch_departure()`) So we need to manually call this. """ if ignored_options is None: ignored_options = set() left_over_args = self.args - ignored_options if left_over_args: raise sphinx.errors.SphinxError( 'Undocumented arguments for command {!r}: {!r}'.format( self.command, ', '.join(sorted(left_over_args))))
[docs]class CommandCheckVisitor(docutils.nodes.SparseNodeVisitor): """ Checks if the visited sub command section nodes and the specified sub command args are in sync. """ def __init__(self, command, sub_commands, document): docutils.nodes.SparseNodeVisitor.__init__(self, document) self.command = command self.sub_commands = sub_commands
[docs] def visit_section(self, node): """ Checks if the visited sub-command section nodes exists and it options are in sync. Uses :py:class:`OptionsCheckVisitor` for checking sub-commands options """ title = str(node[0][0]) if title.upper() == SUBCOMMANDS_TITLE: return sub_cmd = self.command + ' ' + title try: args = self.sub_commands[title] options_visitor = OptionsCheckVisitor(sub_cmd, args, self.document) node.walkabout(options_visitor) options_visitor.check_undocumented_arguments( {'--help', '--quiet', '--verbose', '-h', '-q', '-v'}) del self.sub_commands[title] except KeyError: raise sphinx.errors.SphinxError( 'No such sub-command {!r}'.format(sub_cmd))
[docs] def visit_Text(self, node): """ If the visited text node starts with 'alias: ', all the provided comma separted alias in this node, are removed from `self.sub_commands` """ # pylint: disable=invalid-name text = str(node).strip() if text.startswith('aliases:'): aliases = {a.strip() for a in text.split('aliases:')[1].split(',')} for alias in aliases: assert alias in self.sub_commands del self.sub_commands[alias]
[docs] def check_undocumented_sub_commands(self): """ Call this to check if any undocumented sub_commands are left. While the documentation talks about a 'SparseNodeVisitor.depart_document()' function, this function does not exists. (For details see implementation of :py:meth:`NodeVisitor.dispatch_departure()`) So we need to manually call this. """ if self.sub_commands: raise sphinx.errors.SphinxError( 'Undocumented commands for {!r}: {!r}'.format( self.command, ', '.join(sorted(self.sub_commands.keys()))))
[docs]class ManpageCheckVisitor(docutils.nodes.SparseNodeVisitor): """ Checks if the sub-commands and options specified in the 'COMMAND' and 'OPTIONS' (case insensitve) sections in sync the command parser. """ def __init__(self, app, command, document): docutils.nodes.SparseNodeVisitor.__init__(self, document) try: parser = except ImportError: msg = 'cannot import module for command' if log: log.warning(msg) else: # Handle legacy app.warn(msg) self.parser = None return except AttributeError: raise sphinx.errors.SphinxError('cannot find parser in module') self.command = command self.parser = parser self.options = set() self.sub_commands = {} = app # pylint: disable=protected-access for action in parser._actions: if == argparse.SUPPRESS: continue if issubclass(action.__class__, for cmd, cmd_parser in action._name_parser_map.items(): self.sub_commands[cmd] = set() for sub_action in cmd_parser._actions: if != argparse.SUPPRESS: self.sub_commands[cmd].update( sub_action.option_strings) else: self.options.update(action.option_strings)
[docs] def visit_section(self, node): """ If section title is OPTIONS or COMMANDS dispatch the apropriate `NodeVisitor`. """ if self.parser is None: return section_title = str(node[0][0]).upper() if section_title == OPTIONS_TITLE: options_visitor = OptionsCheckVisitor(self.command, self.options, self.document) node.walkabout(options_visitor) options_visitor.check_undocumented_arguments() elif section_title == SUBCOMMANDS_TITLE: sub_cmd_visitor = CommandCheckVisitor( self.command, self.sub_commands, self.document) node.walkabout(sub_cmd_visitor) sub_cmd_visitor.check_undocumented_sub_commands()
[docs]def check_man_args(app, doctree, docname): """ Checks the manpage for undocumented or obsolete sub-commands and options. """ dirname, command = os.path.split(docname) if os.path.basename(dirname) != 'manpages': return msg = 'Checking arguments for {!r}'.format(command) if log: else: # Handle legacy doctree.walk(ManpageCheckVisitor(app, command, doctree))
# # this is lifted from sphinx' own # event_sig_re = re.compile(r'([a-zA-Z-:<>]+)\s*\((.*)\)') def parse_event(env, sig, signode): # pylint: disable=unused-argument m = event_sig_re.match(sig) if not m: signode += sphinx.addnodes.desc_name(sig, sig) return sig name, args = m.groups() signode += sphinx.addnodes.desc_name(name, name) plist = sphinx.addnodes.desc_parameterlist() for arg in args.split(','): arg = arg.strip() plist += sphinx.addnodes.desc_parameter(arg, arg) signode += plist return name # # end of codelifting # def break_to_pdb(app, *_dummy): if not app.config.break_to_pdb: return # pylint: disable=forgotten-debug-statement import pdb pdb.set_trace() def setup(app): app.add_role('ticket', ticket) app.add_config_value( 'ticket_base_uri', '{number}', 'env') app.add_config_value('break_to_pdb', False, 'env') app.add_node(versioncheck, html=(visit, depart), man=(visit, depart)) app.add_directive('versioncheck', VersionCheck) fdesc = sphinx.util.docfields.GroupedField('parameter', label='Parameters', names=['param'], can_collapse=True) app.add_object_type('event', 'event', 'pair: %s; event', parse_event, doc_field_types=[fdesc]) app.connect('doctree-resolved', break_to_pdb) app.connect('doctree-resolved', check_man_args) # vim: ts=4 sw=4 et