From bc30bd7bd20026e3f874df2d981d5835848c744a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Sun, 1 Mar 2020 12:41:41 +0100 Subject: [PATCH] Fix flake8 errors and warnings We add the flake8 configuration used so we ensure everyone uses the same. issue9082 review286821003 --- .flake8 | 2 + doc/conf.py | 129 ++++++++++++++-------------- relatorio/reporting.py | 2 + relatorio/templates/base.py | 1 + relatorio/templates/opendocument.py | 12 ++- relatorio/tests/__init__.py | 1 + relatorio/tests/test_odt.py | 18 ++-- 7 files changed, 92 insertions(+), 73 deletions(-) create mode 100644 .flake8 diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..bb03d08 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +ignore=E123,E124,E126,E128,W503 diff --git a/doc/conf.py b/doc/conf.py index c873073..c4ed6f3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -3,7 +3,8 @@ # relatorio documentation build configuration file, created by # sphinx-quickstart on Wed Jun 24 12:26:14 2015. # -# This file is execfile()d with the current directory set to its containing dir. +# This file is execfile()d with the current directory set to its containing +# dir. # # Note that not all possible configuration values are present in this # autogenerated file. @@ -11,20 +12,13 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os - -# 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('.')) - -# -- General configuration ----------------------------------------------------- +# -- 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. +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.todo'] # Add any paths that contain templates here, relative to this directory. @@ -34,7 +28,7 @@ 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' @@ -54,40 +48,41 @@ # 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'] -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# The reST default role (used for this markup: `text`) to use for all +# documents. +# 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' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] -# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. @@ -96,26 +91,26 @@ # 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 # " v documentation". -#html_title = None +# html_title = None # 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. -#html_logo = None +# html_logo = None # 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, @@ -124,91 +119,92 @@ # 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 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 = 'relatoriodoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# (source start file, target name, title, author, documentclass +# [howto/manual]). latex_documents = [ - ('index', 'relatorio.tex', u'relatorio Documentation', - u'Nicolas Évrard, CGaëtan de Menten, Cédric Krier', 'manual'), + ('index', 'relatorio.tex', u'relatorio Documentation', + u'Nicolas Évrard, CGaëtan de Menten, Cédric Krier', '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 # 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 -------------------------------------------- +# -- Options for manual page output ------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). @@ -218,25 +214,26 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False -# -- Options for Texinfo output ------------------------------------------------ +# -- Options for Texinfo output ----------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'relatorio', u'relatorio Documentation', - u'Nicolas Évrard, CGaëtan de Menten, Cédric Krier', 'relatorio', 'One line description of project.', - 'Miscellaneous'), + ('index', 'relatorio', u'relatorio Documentation', + u'Nicolas Évrard, CGaëtan de Menten, Cédric Krier', 'relatorio', + 'a templating library', + 'Templating'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' diff --git a/relatorio/reporting.py b/relatorio/reporting.py index 63c9eb9..139a2f9 100644 --- a/relatorio/reporting.py +++ b/relatorio/reporting.py @@ -87,6 +87,7 @@ def add_factory(cls, abbr_mimetype, template_factory, id_function=None): if id_function is not None: cls.mime_func.append(id_function) + default_loader = MIMETemplateLoader(auto_reload=True) @@ -102,6 +103,7 @@ def __call__(self, **kwargs): data = kwargs.copy() return data + default_factory = DefaultFactory() diff --git a/relatorio/templates/base.py b/relatorio/templates/base.py index 8249f5e..ce8cd09 100644 --- a/relatorio/templates/base.py +++ b/relatorio/templates/base.py @@ -42,5 +42,6 @@ def __or__(self, function): "Support for the bitwise operator" return RelatorioStream(self.events | function, self.serializer) + MIMETemplateLoader.add_factory('text', NewTextTemplate) MIMETemplateLoader.add_factory('markup', MarkupTemplate) diff --git a/relatorio/templates/opendocument.py b/relatorio/templates/opendocument.py index 857137c..2ccbc67 100644 --- a/relatorio/templates/opendocument.py +++ b/relatorio/templates/opendocument.py @@ -57,6 +57,15 @@ except ImportError: ChartTemplate = type(None) +try: + basestring +except NameError: + basestring = str +try: + long +except NameError: + long = int + __metaclass__ = type warnings.filterwarnings('always', module='relatorio.templates.opendocument') @@ -538,7 +547,8 @@ def has_style(node): grand_parent = parent.getparent() # Guess type only if it is the only value in the cell # and its parent has no style - if ((grand_parent is None + if (( + grand_parent is None or grand_parent.tag != table_cell_tag) or len(grand_parent) != 1 or len(parent) != 1 diff --git a/relatorio/tests/__init__.py b/relatorio/tests/__init__.py index 72d44a5..1a76b6e 100644 --- a/relatorio/tests/__init__.py +++ b/relatorio/tests/__init__.py @@ -42,6 +42,7 @@ def main(): runner = unittest.TextTestRunner() runner.run(suite) + if __name__ == '__main__': sys.path.insert(0, os.path.dirname(os.path.dirname( os.path.dirname(os.path.abspath(__file__))))) diff --git a/relatorio/tests/test_odt.py b/relatorio/tests/test_odt.py index 22c7839..6423ce7 100644 --- a/relatorio/tests/test_odt.py +++ b/relatorio/tests/test_odt.py @@ -34,6 +34,11 @@ GENSHI_URI, RELATORIO_URI, fod2od, remove_node_keeping_tail, \ escape_xml_invalid_chars +try: + unicode +except NameError: + unicode = str + OO_TABLE_NS = "urn:oasis:names:tc:opendocument:xmlns:table:1.0" @@ -121,11 +126,12 @@ def test_directives_in_cell(self): cell = root_interpolated[0] self.assertRegex( cell.get('{http://genshi.edgewall.org/}attrs'), - '__relatorio_guess_type\(__relatorio_store_cache\([0-9]*, foo\)\)') + r'__relatorio_guess_type\(__relatorio_store_cache\([0-9]*, foo\)\)' + ) child = cell[0][0] self.assertRegex( child.get('{http://genshi.edgewall.org/}replace'), - '__relatorio_get_cache\([0-9]*\)') + r'__relatorio_get_cache\([0-9]*\)') def test_directives_in_cell_with_children(self): "Testing directive inside cell with children" @@ -292,7 +298,7 @@ def test_column_looping(self): -''' +''' # noqa: E501 interpolated = self.oot.insert_directives(xml) root = lxml.etree.parse(interpolated).getroot() child2 = root[1] @@ -336,7 +342,7 @@ def test_statement_missmatch_text_warning(self): "Test warning for missing statement text" xml = b''' content:bar - ''' + ''' # noqa: E501 with self.assertWarnsRegex( UserWarning, @@ -352,7 +358,7 @@ def test_statement_text_warning_closing(self): xml = b''' with foo='test' - ''' + ''' # noqa: E501 with self.assertWarnsRegex( UserWarning, @@ -368,7 +374,7 @@ def test_text_outside_p(self): zzz /if aaa - ''' + ''' # noqa: E501 interpolated = self.oot.insert_directives(xml) root_interpolated = lxml.etree.parse(interpolated).getroot() child = root_interpolated[0]