PY-19705 Add an option for blanks between class header and its first method

On the whole, we don't touch these blank lines (as opposed to deleting
them previously) unless they exceed the limit specified in settings
(Keep maximum blank lines in declarations).
If someone wants to always put a blank line before the first method,
as in PY-1765, they can use this new option.

python/src/com/jetbrains/python/PyBundle.properties

@@ -1031,6 +1031,7 @@ formatter.before.hash = Before '#'
 formatter.after.hash = After '#'
 formatter.around.top.level.imports = After top-level imports:
 formatter.after.local.imports=After local imports:
+formatter.before.first.method=Before the first method:
 formatter.around.top.level.classes.and.function=Around top-level classes and functions:
 formatter.around.multiplicative.operators=Multiplicative operators (*, @, /, %)
 formatter.around.power.operator=Power operator (**)

python/src/com/jetbrains/python/formatter/PyBlock.java

@@ -737,7 +737,7 @@ public class PyBlock implements ASTBlock {
         if (myNode.getElementType() == PyElementTypes.CLASS_DECLARATION) {
           final PyStatement[] statements = ((PyStatementList)psi2).getStatements();
           if (statements.length > 0 && statements[0] instanceof PyFunction) {
-            return getBlankLinesForOption(settings.BLANK_LINES_AROUND_METHOD);
+            return getBlankLinesForOption(pySettings.BLANK_LINES_BEFORE_FIRST_METHOD);
           }
         }
         if (childType1 == PyTokenTypes.COLON && needLineBreakInStatement()) {
@@ -816,9 +816,9 @@ public class PyBlock implements ASTBlock {
   }
 
   @NotNull
-  private Spacing getBlankLinesForOption(int option) {
-    final int blankLines = option + 1;
-    return Spacing.createSpacing(0, 0, blankLines,
+  private Spacing getBlankLinesForOption(int minBlankLines) {
+    final int lineFeeds = minBlankLines + 1;
+    return Spacing.createSpacing(0, 0, lineFeeds,
                                  myContext.getSettings().KEEP_LINE_BREAKS,
                                  myContext.getSettings().KEEP_BLANK_LINES_IN_DECLARATIONS);
   }

python/src/com/jetbrains/python/formatter/PyCodeStyleSettings.java

@@ -63,6 +63,7 @@ public class PyCodeStyleSettings extends CustomCodeStyleSettings {
   public boolean SPACE_BEFORE_BACKSLASH = true;
 
   public int BLANK_LINES_AROUND_TOP_LEVEL_CLASSES_FUNCTIONS = 2;
+  public int BLANK_LINES_BEFORE_FIRST_METHOD = 0;
   // TODO make boolean (it needs special editor in BlankLinesPanel)
   public boolean BLANK_LINE_AT_FILE_END = true;
 

python/src/com/jetbrains/python/formatter/PyLanguageCodeStyleSettingsProvider.java

@@ -102,6 +102,8 @@ public class PyLanguageCodeStyleSettingsProvider extends LanguageCodeStyleSettin
                                 PyBundle.message("formatter.around.top.level.classes.and.function"), BLANK_LINES);
       consumer.showCustomOption(PyCodeStyleSettings.class, "BLANK_LINES_AFTER_LOCAL_IMPORTS",
                                 PyBundle.message("formatter.after.local.imports"), BLANK_LINES);
+      consumer.showCustomOption(PyCodeStyleSettings.class, "BLANK_LINES_BEFORE_FIRST_METHOD",
+                                PyBundle.message("formatter.before.first.method"), BLANK_LINES);
     }
     else if (settingsType == SettingsType.WRAPPING_AND_BRACES_SETTINGS) {
       consumer.showStandardOptions("RIGHT_MARGIN",

python/testData/create_tests/create_tst.expected.py

@@ -2,7 +2,6 @@ from unittest import TestCase
 
 
 class Spam(TestCase):
-
     def eggs(self):
         self.fail()
 

python/testData/formatter/alignmentOfClosingBraceInDictLiteralWhenNoHangingIndent_after.py

@@ -1,5 +1,4 @@
 class Checkpoints(webapp2.RequestHandler):
-
     def get(self):
         self.response.write(json.dumps({"meta": {"code": 400,
                                                  "errorType": "paramError",

python/testData/formatter/beforeTopLevelClass_after.py

@@ -2,6 +2,5 @@ from unittest import TestCase
 
 
 class MyTest(TestCase):
-
     def test_pass(self):
         self.assertEqual(1 + 1, 2)

python/testData/formatter/blankLineAroundClasses_after.py

@@ -1,5 +1,4 @@
 class Adjunct:
-
     def apply(self, right, arg):
         pass
 

python/testData/formatter/blankLineBetweenMethods_after.py

@@ -1,5 +1,4 @@
 class C:
-
     def foo(self):
         pass
 

python/testData/formatter/commentBetweenClasses_after.py

@@ -1,5 +1,4 @@
 class T1(object):
-
     def m1(self):
         pass
 
@@ -7,6 +6,5 @@ class T1(object):
 # comment about T2
 
 class T2(object):
-
     def m2(self):
         pass

python/testData/inspections/TransformClassicClass_after.py

@@ -1,5 +1,4 @@
 class A(object):
-
     def foo(self):
         pass
 

python/testData/quickFixes/PyAddMethodQuickFixTest/addMethodReplacePass_after.py

@@ -1,5 +1,4 @@
 class A:
-
     def y(self):
         pass
 

python/testData/refactoring/extractsuperclass/fieldsNpe.after.py

@@ -1,5 +1,4 @@
 class Ancestor(object):
-
     def __init__(self, a, b):
         self.a = a
         self.b = b

python/testData/refactoring/extractsuperclass/importMultiFile/dest_module.after.py

@@ -3,7 +3,6 @@ from shared_module import module_function as my_function, ModuleClass
 
 
 class NewParent(object):
-
     def do_useful_stuff(self):
         i = shared_module.MODULE_CONTANT
         my_function()

python/testData/refactoring/extractsuperclass/instanceNotDeclaredInInit.after.py

@@ -1,5 +1,4 @@
 class Parent(object):
-
     def __init__(self):
         self.eggs = 12
 

python/testData/refactoring/extractsuperclass/moveAndMakeAbstractImportExistsPy3/dest_module.after.py

@@ -7,7 +7,6 @@ abstractmethod()
 
 
 class NewParent(metaclass=ABCMeta):
-
     @classmethod
     @abstractmethod
     def foo_method(cls):

python/testData/refactoring/extractsuperclass/multifile/target.append.py

@@ -3,6 +3,5 @@ A = 1
 
 
 class Suppa:
-
     def foo(self):
         print "bar"

python/testData/refactoring/extractsuperclass/multifile/target.new.py

@@ -1,4 +1,3 @@
 class Suppa:
-
     def foo(self):
         print "bar"

python/testData/refactoring/extractsuperclass/py3ParentHasObject.after.py

@@ -1,5 +1,4 @@
 class Parent(object):
-
     def spam(self):
         pass
 

python/testData/refactoring/extractsuperclass/simple.after.py

@@ -1,5 +1,4 @@
 class Suppa:
-
     def foo(self):
         print "bar"
 

python/testData/refactoring/extractsuperclass/withSuper.after.py

@@ -1,5 +1,4 @@
 class Suppa(object):
-
     def foo(self):
         print "bar"
 

python/testSrc/com/jetbrains/python/PyFormatterTest.java

@@ -837,6 +837,7 @@ public class PyFormatterTest extends PyTestCase {
 
   // PY-19705
   public void testBlankLinesAroundFirstMethod() {
+    getPythonCodeStyleSettings().BLANK_LINES_BEFORE_FIRST_METHOD = 1;
     doTest();
   }