eric: comparison Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleFixer.py

-:4dd53711d869
+:04a671fa4adb
 "E125", "E126", "E127", "E128", "E133", "E201",
 "E202", "E203", "E211", "E221", "E222", "E223",
 "E224", "E225", "E226", "E227", "E228", "E231",
 "E241", "E242", "E251", "E261", "E262", "E271",
 "E272", "E273", "E274", "E301", "E302", "E303",
-"E304", "E401", "E501", "E502", "E701", "E702",
+"E304", "E305", "E306", "E307", "E308", "E401",
-"E703", "E711", "E712",
+"E501", "E502", "E701", "E702", "E703", "E711",
+"E712",
 "N804", "N805", "N806",
 "W191", "W291", "W292", "W293", "W391", "W603",
 ]
 class CodeStyleFixer(object):
 """
 Class implementing a fixer for certain code style issues.
 """
 def __init__(self, filename, sourceLines, fixCodes, noFixCodes,
-maxLineLength, inPlace, eol, backup=False):
+maxLineLength, blankLines, inPlace, eol, backup=False):
 """
 Constructor
-@param filename name of the file to be fixed (string)
+@param filename name of the file to be fixed
+@type str
 @param sourceLines list of source lines including eol marker
-(list of string)
+@type list of str
 @param fixCodes list of codes to be fixed as a comma separated
-string (string)
+string
+@type str
 @param noFixCodes list of codes not to be fixed as a comma
-separated string (string)
+separated string
-@param maxLineLength maximum allowed line length (integer)
+@type str
-@param inPlace flag indicating to modify the file in place (boolean)
+@param maxLineLength maximum allowed line length
-@param eol end of line character(s) (string)
+@type int
+@param blanklines tuple containg the number of blank lines before
+a top level class or function and before a method or nested class
+or function
+@type tuple of (int, int)
+@param inPlace flag indicating to modify the file in place
+@type bool
+@param eol end of line character(s)
+@type str
 @param backup flag indicating to create a backup before fixing
-anything (boolean)
+anything
+@type bool
 """
 super(CodeStyleFixer, self).__init__()
 self.__filename = filename
 self.__origName = ""
 self.__source = sourceLines[:]  # save a copy
 self.__fixCodes = [c.strip() for c in fixCodes.split(",") if c.strip()]
 self.__noFixCodes = [
 c.strip() for c in noFixCodes.split(",") if c.strip()]
 self.__maxLineLength = maxLineLength
+self.__blankLines = {
+"toplevel": blankLines[0],
+"method": blankLines[1],
+}
 self.fixed = 0
 self.__reindenter = None
 self.__indentWord = self.__getIndentWord()
 "E262": self.__fixE261,
 "E271": self.__fixE221,
 "E272": self.__fixE221,
 "E273": self.__fixE221,
 "E274": self.__fixE221,
-"E301": self.__fixE301,
+"E301": self.__fixBlankLinesBefore,
-"E302": self.__fixE302,
+"E302": self.__fixBlankLinesBefore,
-"E303": self.__fixE303,
+"E303": self.__fixBlankLinesBefore,
 "E304": self.__fixE304,
+"E305": self.__fixBlankLinesBefore,
+"E306": self.__fixBlankLinesBefore,
+"E307": self.__fixBlankLinesBefore,
+"E308": self.__fixBlankLinesBefore,
 "E401": self.__fixE401,
 "E501": self.__fixE501,
 "E502": self.__fixE502,
 "E701": self.__fixE701,
 "E702": self.__fixE702,
 newText = left + ("  # " + right if right.strip() else right)
 self.__source[line] = newText
 # Whitespace around comment sign corrected.
 return (1, "FE261", 0)
-def __fixE301(self, code, line, pos, apply=False):
+def __fixBlankLinesBefore(self, code, line, pos, apply=False):
 """
-Private method to fix the need for one blank line.
+Private method to fix the need for blank lines before class, function
+and method definitions.
-Codes: E301
+Codes: E301, E302, E303, E305, E306, E307, E308
 @param code code of the issue (string)
 @param line line number of the issue (integer)
 @param pos position inside line (integer)
 @keyparam apply flag indicating, that the fix should be applied
 @return value indicating an applied/deferred fix (-1, 0, 1),
 a message for the fix (string) and an ID for a deferred
 fix (integer)
 """
 if apply:
-self.__source.insert(line - 1, self.__eol)
+if code in ["E301", "E306", "E307"]:
-# One blank line inserted.
+blankLinesBefore = self.__blankLines["method"]
-return (1, "FE301", 0)
+elif code == "E308":
-else:
+blankLinesBefore = 1
-fixId = self.__getID()
+else:
-self.__stack.append((fixId, code, line, pos))
+blankLinesBefore = self.__blankLines["toplevel"]
-return (-1, "", fixId)
-def __fixE302(self, code, line, pos, apply=False):
-"""
-Private method to fix the need for two blank lines.
-Codes: E302
-@param code code of the issue (string)
-@param line line number of the issue (integer)
-@param pos position inside line (integer)
-@keyparam apply flag indicating, that the fix should be applied
-(boolean)
-@return value indicating an applied/deferred fix (-1, 0, 1),
-a message for the fix (string) and an ID for a deferred
-fix (integer)
-"""
-if apply:
 # count blank lines
 index = line - 1
 blanks = 0
 while index:
 if self.__source[index - 1].strip() == "":
 blanks += 1
 index -= 1
 else:
 break
-delta = blanks - 2
+delta = blanks - blankLinesBefore
 line -= 1
 if delta < 0:
 # insert blank lines (one or two)
 while delta < 0:
 self.__source.insert(line, self.__eol)
 delta += 1
 # %n blank line(s) inserted.
-return (1, ("FE302+", 2 - blanks), 0)
+return (1, ("FE302+", blankLinesBefore - blanks), 0)
 elif delta > 0:
 # delete superfluous blank lines
 while delta > 0:
 del self.__source[line - 1]
 line -= 1
 delta -= 1
 # %n superfluous line(s) removed.
-return (1, ("FE302-", blanks - 2), 0)
+return (1, ("FE302-", blanks - blankLinesBefore), 0)
 else:
 return (0, "", 0)
-else:
-fixId = self.__getID()
-self.__stack.append((fixId, code, line, pos))
-return (-1, "", fixId)
-def __fixE303(self, code, line, pos, apply=False):
-"""
-Private method to fix superfluous blank lines.
-Codes: E303
-@param code code of the issue (string)
-@param line line number of the issue (integer)
-@param pos position inside line (integer)
-@keyparam apply flag indicating, that the fix should be applied
-(boolean)
-@return value indicating an applied/deferred fix (-1, 0, 1),
-a message for the fix (string) and an ID for a deferred
-fix (integer)
-"""
-if apply:
-index = line - 3
-while index:
-if self.__source[index].strip() == "":
-del self.__source[index]
-index -= 1
-else:
-break
-# Superfluous blank lines removed.
-return (1, "FE303", 0)
 else:
 fixId = self.__getID()
 self.__stack.append((fixId, code, line, pos))
 return (-1, "", fixId)

Mercurial Repositories > eric / file comparison

comparison: Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleFixer.py

Plugins/CheckerPlugins/CodeStyleChecker/CodeStyleFixer.py