From 042bb5e2c05f8e3cc5d53da92ccc44006b3955ef Mon Sep 17 00:00:00 2001 From: Paul Franklin Date: Sun, 5 Jun 2016 21:11:27 -0700 Subject: [PATCH] more report pylint improvements --- gramps/gen/plug/_options.py | 134 ++++++------ gramps/gen/plug/report/_options.py | 117 ++++++---- gramps/plugins/drawreport/statisticschart.py | 39 ++-- gramps/plugins/drawreport/timeline.py | 20 +- gramps/plugins/graph/gvhourglass.py | 42 ++-- gramps/plugins/textreport/custombooktext.py | 20 +- gramps/plugins/textreport/endoflinereport.py | 87 ++++---- gramps/plugins/textreport/familygroup.py | 186 ++++++++-------- gramps/plugins/textreport/kinshipreport.py | 73 +++---- .../textreport/numberofancestorsreport.py | 31 ++- gramps/plugins/textreport/placereport.py | 105 +++++---- gramps/plugins/textreport/recordsreport.py | 29 ++- gramps/plugins/textreport/simplebooktitle.py | 21 +- gramps/plugins/textreport/tagreport.py | 200 +++++++++--------- 14 files changed, 581 insertions(+), 523 deletions(-) diff --git a/gramps/gen/plug/_options.py b/gramps/gen/plug/_options.py index e609cf01a..b79f98b77 100644 --- a/gramps/gen/plug/_options.py +++ b/gramps/gen/plug/_options.py @@ -40,10 +40,10 @@ import sys # #------------------------------------------------------------------------- try: - from xml.sax import make_parser, handler,SAXParseException + from xml.sax import make_parser, handler, SAXParseException from xml.sax.saxutils import quoteattr except: - from _xmlplus.sax import make_parser, handler,SAXParseException + from _xmlplus.sax import make_parser, handler, SAXParseException from _xmlplus.sax.saxutils import quoteattr #------------------------------------------------------------------------- @@ -88,7 +88,7 @@ class OptionList: """ return self.options - def set_option(self, name,value): + def set_option(self, name, value): """ Set a particular option in the OptionList. @@ -118,7 +118,7 @@ class OptionList: :returns: value associated with the passed option :rtype: str """ - return self.options.get(name,None) + return self.options.get(name, None) #------------------------------------------------------------------------- # @@ -130,7 +130,7 @@ class OptionListCollection: Implements a collection of option lists. """ - def __init__(self,filename): + def __init__(self, filename): """ Create an OptionListCollection instance from the list defined in the specified file. @@ -167,7 +167,7 @@ class OptionListCollection: or None of no such option exists :rtype: str """ - return self.option_list_map.get(name,None) + return self.option_list_map.get(name, None) def get_module_names(self): """ @@ -189,13 +189,13 @@ class OptionListCollection: """ self.option_list_map[name] = option_list - def write_common(self,f): + def write_common(self, filename): """ Stub function for common options. Overridden by reports. """ pass - def write_module_common(self,f, option_list): + def write_module_common(self, filename, option_list): """ Stub function for common options. Overridden by reports. """ @@ -205,54 +205,55 @@ class OptionListCollection: """ Saves the current OptionListCollection to the associated file. """ - f = io.open(self.filename,"w", encoding="utf-8") - f.write("\n") - f.write('\n') + file = io.open(self.filename, "w", encoding="utf-8") + file.write("\n") + file.write('\n') - self.write_common(f) + self.write_common(file) for module_name in sorted(self.get_module_names()): # enable a diff option_list = self.get_option_list(module_name) module_docgen_opts = {} for docgen_name in self.docgen_names: module_docgen_opts[docgen_name] = [] - f.write('\n' % quoteattr(module_name)) + file.write('\n' % quoteattr(module_name)) options = option_list.get_options() for option_name in sorted(options.keys()): # enable a diff option_data = options[option_name] if isinstance(option_data, (list, tuple)): if option_data and option_data[0] in self.docgen_names: module_docgen_opts[option_data[0]].append( - (option_name, option_data[1])) + (option_name, option_data[1])) else: - f.write(' \n') + file.write(' \n' + % (list_index, + quoteattr(str(list_data)))) + file.write(' \n') else: - f.write(' \n') + file.write('\n') - f.write('\n') - f.close() + file.write('\n') + file.close() def parse(self): """ @@ -260,10 +261,10 @@ class OptionListCollection: """ try: if os.path.isfile(self.filename): - p = make_parser() - p.setContentHandler(OptionParser(self)) - p.parse(self.filename) - except (IOError,OSError,SAXParseException): + parser = make_parser() + parser.setContentHandler(OptionParser(self)) + parser.parse(self.filename) + except (IOError, OSError, SAXParseException): pass #------------------------------------------------------------------------- @@ -276,7 +277,7 @@ class OptionParser(handler.ContentHandler): SAX parsing class for the OptionListCollection XML file. """ - def __init__(self,collection): + def __init__(self, collection): """ Create a OptionParser class that populates the passed collection. @@ -288,18 +289,18 @@ class OptionParser(handler.ContentHandler): self.mname = None self.option_list = None self.oname = None - self.o = None + self.odict = None self.an_o = None self.list_class = OptionList - def startElement(self,tag,attrs): + def startElement(self, tag, attrs): """ Overridden class that handles the start of a XML element """ - if tag in ("report","module"): + if tag in ("report", "module"): self.mname = attrs['name'] self.option_list = self.list_class() - self.o = {} + self.odict = {} elif tag == "option": self.oname = attrs['name'] if 'length' in attrs: @@ -309,13 +310,13 @@ class OptionParser(handler.ContentHandler): elif tag == "listitem": self.an_o.append(attrs['value']) - def endElement(self,tag): + def endElement(self, tag): "Overridden class that handles the end of a XML element" if tag == "option": - self.o[self.oname] = self.an_o - elif tag in ("report","module"): - self.option_list.set_options(self.o) - self.collection.set_option_list(self.mname,self.option_list) + self.odict[self.oname] = self.an_o + elif tag in ("report", "module"): + self.option_list.set_options(self.odict) + self.collection.set_option_list(self.mname, self.option_list) #------------------------------------------------------------------------- # @@ -327,7 +328,7 @@ class OptionHandler: Implements handling of the options for the plugins. """ - def __init__(self,module_name, options_dict,person_id=None): + def __init__(self, module_name, options_dict, person_id=None): self.module_name = module_name self.default_options_dict = options_dict.copy() self.options_dict = options_dict @@ -336,7 +337,8 @@ class OptionHandler: self.init_subclass() self.option_list_collection = self.collection_class(self.filename) self.init_common() - self.saved_option_list = self.option_list_collection.get_option_list(module_name) + self.saved_option_list = self.option_list_collection.get_option_list( + module_name) self.person_id = person_id # Whatever was found should override the defaults @@ -383,14 +385,14 @@ class OptionHandler: docgen_names = self.option_list_collection.docgen_names for option_name in bad_opts: option_data = options[option_name] - if not ( isinstance(option_data, list) and - option_data and - option_data[0] in docgen_names ): + if not (isinstance(option_data, list) + and option_data + and option_data[0] in docgen_names): print(_("Option '%(opt_name)s' is present in %(file)s\n" - " but is not known to the module. Ignoring...") % - { 'opt_name' : option_name, - 'file' : self.option_list_collection.filename }, - file=sys.stderr ) + " but is not known to the module. Ignoring..." + % {'opt_name' : option_name, + 'file' : self.option_list_collection.filename}), + file=sys.stderr) options.pop(option_name) # Then we set common options from whatever was found @@ -412,7 +414,8 @@ class OptionHandler: if option_data == self.default_options_dict[option_name]: self.saved_option_list.remove_option(option_name) else: - self.saved_option_list.set_option(option_name,self.options_dict[option_name]) + self.saved_option_list.set_option( + option_name, self.options_dict[option_name]) # Handle common options self.save_common_options() @@ -426,7 +429,7 @@ class OptionHandler: def get_person_id(self): return self.person_id - def set_person_id(self,val): + def set_person_id(self, val): self.person_id = val #------------------------------------------------------------------------ @@ -443,7 +446,7 @@ class Options: classes should derive from it. """ - def __init__(self, name,person_id=None): + def __init__(self, name, person_id=None): """ Initialize the class, performing usual house-keeping tasks. Subclasses MUST call this in their __init__() method. @@ -478,7 +481,8 @@ class Options: Modifies all options to have the value they were last used as. Call this function after all options have been added. """ - self.handler = OptionHandler(self.name,self.options_dict,self.person_id) + self.handler = OptionHandler( + self.name, self.options_dict, self.person_id) def add_user_options(self): """ @@ -529,7 +533,7 @@ class MenuOptions: for name in self.menu.get_all_option_names(): option = self.menu.get_option_by_name(name) self.options_dict[name] = option.get_value() - self.options_help[name] = [ "", option.get_help() ] + self.options_help[name] = ["", option.get_help()] def make_default_style(self, default_style): """ @@ -553,7 +557,7 @@ class MenuOptions: """ self.menu.add_option(category, name, option) self.options_dict[name] = option.get_value() - self.options_help[name] = [ "", option.get_help() ] + self.options_help[name] = ["", option.get_help()] def add_user_options(self): """ diff --git a/gramps/gen/plug/report/_options.py b/gramps/gen/plug/report/_options.py index ba938d685..75bce5963 100644 --- a/gramps/gen/plug/report/_options.py +++ b/gramps/gen/plug/report/_options.py @@ -36,8 +36,8 @@ import os import copy from xml.sax.saxutils import escape -def escxml(d): - return escape(d, { '"' : '"' } ) +def escxml(word): + return escape(word, {'"' : '"'}) #------------------------------------------------------------------------- # @@ -445,56 +445,62 @@ class OptionListCollection(_options.OptionListCollection): """ return self.last_format_name - def write_common(self, f): - f.write('\n') + def write_common(self, file): + file.write('\n') if self.get_last_paper_metric() != self.default_paper_metric: - f.write(' \n' % self.get_last_paper_metric() ) + file.write(' \n' + % self.get_last_paper_metric()) if self.get_last_custom_paper_size() != self.default_custom_paper_size: size = self.get_last_custom_paper_size() - f.write(' \n' % (size[0], size[1]) ) + file.write(' \n' % (size[0], size[1])) if self.get_last_paper_name() != self.default_paper_name: - f.write(' \n' % escxml(self.get_last_paper_name()) ) + file.write(' \n' + % escxml(self.get_last_paper_name())) if self.get_last_css_filename() != self.default_css_filename: - f.write(' \n' % escxml(self.get_last_css_filename()) ) + file.write(' \n' + % escxml(self.get_last_css_filename())) if self.get_last_format_name() != self.default_format_name: - f.write(' \n' % escxml(self.get_last_format_name()) ) + file.write(' \n' + % escxml(self.get_last_format_name())) if self.get_last_orientation() != self.default_orientation: - f.write(' \n' % self.get_last_orientation() ) - f.write('\n') + file.write(' \n' + % self.get_last_orientation()) + file.write('\n') - def write_module_common(self, f, option_list): + def write_module_common(self, file, option_list): if option_list.get_format_name(): - f.write(' \n' % - escxml(option_list.get_format_name()) ) + file.write(' \n' + % escxml(option_list.get_format_name())) if option_list.get_format_name() == 'html': if option_list.get_css_filename(): - f.write(' \n' % - escxml(option_list.get_css_filename())) + file.write(' \n' + % escxml(option_list.get_css_filename())) else: # not HTML format, therefore it's paper if option_list.get_paper_name(): - f.write(' \n' % - escxml(option_list.get_paper_name()) ) + file.write(' \n' + % escxml(option_list.get_paper_name())) if option_list.get_orientation() is not None: # 0 is legal - f.write(' \n' % - option_list.get_orientation() ) + file.write(' \n' + % option_list.get_orientation()) if option_list.get_paper_metric() is not None: # 0 is legal - f.write(' \n' % - option_list.get_paper_metric() ) + file.write(' \n' + % option_list.get_paper_metric()) if option_list.get_custom_paper_size(): size = option_list.get_custom_paper_size() - f.write(' \n' % (size[0], size[1]) ) + file.write(' \n' + % (size[0], size[1])) if option_list.get_margins(): margins = option_list.get_margins() for pos in range(len(margins)): - f.write(' \n' % - (pos, margins[pos])) + file.write(' \n' + % (pos, margins[pos])) if option_list.get_style_name(): - f.write('