black

docs/conf.py

@@ -17,97 +17,97 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Diazo'
-copyright = '2011, Plone Foundation'
+project = "Diazo"
+copyright = "2011, Plone Foundation"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.0b1'
+version = "1.0b1"
 # The full version, including alpha/beta/rc tags.
-release = '1.0b1'
+release = "1.0b1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'haiku'
+html_theme = "haiku"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 html_title = "Diazo"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -116,102 +116,98 @@
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Diazodoc'
+htmlhelp_basename = "Diazodoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'Diazo.tex', 'Diazo Documentation',
-   'Plone Foundation', 'manual'),
+    ("index", "Diazo.tex", "Diazo Documentation", "Plone Foundation", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'diazo', 'Diazo Documentation',
-     ['Plone Foundation'], 1)
-]
+man_pages = [("index", "diazo", "Diazo Documentation", ["Plone Foundation"], 1)]

src/diazo/compiler.py

@@ -23,23 +23,23 @@
 import pkg_resources
 
 
-logger = logging.getLogger('diazo')
+logger = logging.getLogger("diazo")
 usage = __doc__
 
 
 def set_parser(stylesheet, parser, compiler_parser=None):
-    file_obj = pkg_resources.resource_filename('diazo', 'dummy.html')
+    file_obj = pkg_resources.resource_filename("diazo", "dummy.html")
     with open(file_obj) as file_handler:
         dummy_doc = etree.parse(
             file_handler,
             parser=parser,
         )
-    name = 'file:///__diazo__'
+    name = "file:///__diazo__"
     resolver = CustomResolver({name: stylesheet})
     if compiler_parser is None:
         compiler_parser = etree.XMLParser()
     compiler_parser.resolvers.add(resolver)
-    identity = pkg_xsl('identity.xsl', compiler_parser)
+    identity = pkg_xsl("identity.xsl", compiler_parser)
     output_doc = identity(dummy_doc, docurl=f"'{name}'")
     compiler_parser.resolvers.remove(resolver)
     return output_doc
@@ -48,23 +48,23 @@ def set_parser(stylesheet, parser, compiler_parser=None):
 def build_xsl_params_document(xsl_params):
     if xsl_params is None:
         xsl_params = {}
-    if 'path' not in xsl_params:
-        xsl_params['path'] = ''
+    if "path" not in xsl_params:
+        xsl_params["path"] = ""
     known_params = etree.XML(
         '<xsl:stylesheet version="1.0" '
         'xmlns:xsl="http://www.w3.org/1999/XSL/Transform" />',
     )
     for param_name, param_value in xsl_params.items():
         param_element = etree.SubElement(
             known_params,
-            '{http://www.w3.org/1999/XSL/Transform}param',
+            "{http://www.w3.org/1999/XSL/Transform}param",
         )
-        param_element.attrib['name'] = param_name
+        param_element.attrib["name"] = param_name
         if isinstance(param_value, str):
             param_element.text = param_value
         else:
-            param_element.attrib['select'] = str(quote_param(param_value))
-        param_element.tail = '\n'
+            param_element.attrib["select"] = str(quote_param(param_value))
+        param_element.tail = "\n"
 
     return known_params
 
@@ -124,7 +124,7 @@ def compile_theme(
       names. Values are default values.
     """
     if access_control is not None:
-        read_network = access_control.options['read_network']
+        read_network = access_control.options["read_network"]
     rules_doc = process_rules(
         rules=rules,
         theme=theme,
@@ -145,23 +145,25 @@ def compile_theme(
     known_params = build_xsl_params_document(xsl_params)
 
     # Create a pseudo resolver for this
-    known_params_url = 'file:///__diazo_known_params__'
-    emit_stylesheet_resolver = CustomResolver({
-        known_params_url: etree.tostring(known_params),
-    })
+    known_params_url = "file:///__diazo_known_params__"
+    emit_stylesheet_resolver = CustomResolver(
+        {
+            known_params_url: etree.tostring(known_params),
+        }
+    )
     emit_stylesheet_parser = etree.XMLParser()
     emit_stylesheet_parser.resolvers.add(emit_stylesheet_resolver)
 
     # Set up parameters
     params = {}
     if indent is not None:
-        params['indent'] = indent and "'yes'" or "'no'"
-    params['known_params_url'] = quote_param(known_params_url)
-    params['runtrace'] = '1' if runtrace else '0'
+        params["indent"] = indent and "'yes'" or "'no'"
+    params["known_params_url"] = quote_param(known_params_url)
+    params["runtrace"] = "1" if runtrace else "0"
 
     # Run the final stage compiler
     emit_stylesheet = pkg_xsl(
-        'emit-stylesheet.xsl',
+        "emit-stylesheet.xsl",
         parser=emit_stylesheet_parser,
     )
     compiled_doc = emit_stylesheet(rules_doc, **params)
@@ -175,20 +177,19 @@ def compile_theme(
 
 
 def main():
-    """Called from console script
-    """
+    """Called from console script"""
     parser = _createOptionParser(usage=usage)
     (options, args) = parser.parse_args()
 
     if options.rules is None:
         if len(args) == 2 and options.theme is None:
             options.rules, options.theme = args
         elif len(args) == 1:
-            options.rules, = args
+            (options.rules,) = args
         else:
-            parser.error('Wrong number of arguments.')
+            parser.error("Wrong number of arguments.")
     elif args:
-        parser.error('Wrong number of arguments.')
+        parser.error("Wrong number of arguments.")
 
     if options.trace:
         logger.setLevel(logging.DEBUG)
@@ -209,13 +210,13 @@ def main():
     )
     root = output_xslt.getroot()
     if not root.tail:
-        root.tail = '\n'
+        root.tail = "\n"
     output_xslt.write(
         options.output,
-        encoding='utf-8',
+        encoding="utf-8",
         pretty_print=options.pretty_print,
     )
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()