Improve detection of call signature and kwargs.

vpetrovykh · vpetrovykh · commit 72ccccbf68bb · 2020-05-01T07:53:27.000-04:00
Correctly identify calls of the form "foo[123](bar=2)" to highlight the contents of the parentheses as call arguments. Issue: #197
diff --git a/grammars/MagicPython.cson b/grammars/MagicPython.cson
@@ -343,6 +343,9 @@ repository:
       {
         include: "#list"
       }
+      {
+        include: "#odd-function-call"
+      }
       {
         include: "#round-braces"
       }
@@ -513,6 +516,28 @@ repository:
         include: "#expression"
       }
     ]
+  "odd-function-call":
+    comment: '''
+      A bit obscured function call where there may have been an
+      arbitrary number of other operations to get the function.
+      E.g. "arr[idx](args)"
+      
+    '''
+    begin: '''
+      (?x)
+        (?<= \\] | \\) ) \\s*
+        (?=\\()
+      
+    '''
+    end: "(\\))"
+    endCaptures:
+      "1":
+        name: "punctuation.definition.arguments.end.python"
+    patterns: [
+      {
+        include: "#function-arguments"
+      }
+    ]
   "round-braces":
     begin: "\\("
     end: "\\)"
@@ -1627,6 +1652,7 @@ repository:
     ]
   "function-call":
     name: "meta.function-call.python"
+    comment: "Regular function call of the type \"name(args)\""
     begin: '''
       (?x)
         \\b(?=
diff --git a/grammars/MagicPython.tmLanguage b/grammars/MagicPython.tmLanguage
@@ -521,6 +521,10 @@ it's probably control flow like:
             <key>include</key>
             <string>#list</string>
           </dict>
+          <dict>
+            <key>include</key>
+            <string>#odd-function-call</string>
+          </dict>
           <dict>
             <key>include</key>
             <string>#round-braces</string>
@@ -779,6 +783,36 @@ it's probably control flow like:
           </dict>
         </array>
       </dict>
+      <key>odd-function-call</key>
+      <dict>
+        <key>comment</key>
+        <string>A bit obscured function call where there may have been an
+arbitrary number of other operations to get the function.
+E.g. "arr[idx](args)"
+</string>
+        <key>begin</key>
+        <string>(?x)
+  (?&lt;= \] | \) ) \s*
+  (?=\()
+</string>
+        <key>end</key>
+        <string>(\))</string>
+        <key>endCaptures</key>
+        <dict>
+          <key>1</key>
+          <dict>
+            <key>name</key>
+            <string>punctuation.definition.arguments.end.python</string>
+          </dict>
+        </dict>
+        <key>patterns</key>
+        <array>
+          <dict>
+            <key>include</key>
+            <string>#function-arguments</string>
+          </dict>
+        </array>
+      </dict>
       <key>round-braces</key>
       <dict>
         <key>begin</key>
@@ -2554,6 +2588,8 @@ it's probably control flow like:
       <dict>
         <key>name</key>
         <string>meta.function-call.python</string>
+        <key>comment</key>
+        <string>Regular function call of the type "name(args)"</string>
         <key>begin</key>
         <string>(?x)
   \b(?=
diff --git a/grammars/src/MagicPython.syntax.yaml b/grammars/src/MagicPython.syntax.yaml
@@ -404,6 +404,7 @@ repository:
       - include: '#curly-braces'
       - include: '#item-access'
       - include: '#list'
+      - include: '#odd-function-call'
       - include: '#round-braces'
       - include: '#function-call'
       - include: '#builtin-functions'
@@ -505,6 +506,21 @@ repository:
     patterns:
       - include: '#expression'
 
+  odd-function-call:
+    comment: |
+      A bit obscured function call where there may have been an
+      arbitrary number of other operations to get the function.
+      E.g. "arr[idx](args)"
+    begin: |
+      (?x)
+        (?<= \] | \) ) \s*
+        (?=\()
+    end: (\))
+    endCaptures:
+      '1': {name: punctuation.definition.arguments.end.python}
+    patterns:
+      - include: '#function-arguments'
+
   round-braces:
     begin: \(
     end: \)
@@ -1230,6 +1246,7 @@ repository:
 
   function-call:
     name: meta.function-call.python
+    comment: Regular function call of the type "name(args)"
     begin: |
       (?x)
         \b(?=
diff --git a/test/atom-spec/python-spec.js b/test/atom-spec/python-spec.js
@@ -651,6 +651,77 @@ describe("Grammar Tests", function() {
       expect(tokens[3][3].scopes).toEqual(["source.python","meta.function-call.python","punctuation.definition.arguments.end.python"]);
     });
 
+  it("test/calls/call11.py", 
+    function() {
+      tokens = grammar.tokenizeLines("id = Field[uuid.UUID] (\n    uuid.UUID,\n    inheritable=False,\n    simpledelta=False,\n    allow_ddl_set=True,\n)")
+      expect(tokens[0][0].value).toBe("id");
+      expect(tokens[0][0].scopes).toEqual(["source.python","support.function.builtin.python"]);
+      expect(tokens[0][1].value).toBe(" ");
+      expect(tokens[0][1].scopes).toEqual(["source.python"]);
+      expect(tokens[0][2].value).toBe("=");
+      expect(tokens[0][2].scopes).toEqual(["source.python","keyword.operator.assignment.python"]);
+      expect(tokens[0][3].value).toBe(" ");
+      expect(tokens[0][3].scopes).toEqual(["source.python"]);
+      expect(tokens[0][4].value).toBe("Field");
+      expect(tokens[0][4].scopes).toEqual(["source.python","meta.item-access.python","meta.indexed-name.python"]);
+      expect(tokens[0][5].value).toBe("[");
+      expect(tokens[0][5].scopes).toEqual(["source.python","meta.item-access.python","punctuation.definition.arguments.begin.python"]);
+      expect(tokens[0][6].value).toBe("uuid");
+      expect(tokens[0][6].scopes).toEqual(["source.python","meta.item-access.python","meta.item-access.arguments.python"]);
+      expect(tokens[0][7].value).toBe(".");
+      expect(tokens[0][7].scopes).toEqual(["source.python","meta.item-access.python","meta.item-access.arguments.python","meta.member.access.python","punctuation.separator.period.python"]);
+      expect(tokens[0][8].value).toBe("UUID");
+      expect(tokens[0][8].scopes).toEqual(["source.python","meta.item-access.python","meta.item-access.arguments.python","meta.member.access.python","constant.other.caps.python"]);
+      expect(tokens[0][9].value).toBe("]");
+      expect(tokens[0][9].scopes).toEqual(["source.python","meta.item-access.python","punctuation.definition.arguments.end.python"]);
+      expect(tokens[0][10].value).toBe(" ");
+      expect(tokens[0][10].scopes).toEqual(["source.python"]);
+      expect(tokens[0][11].value).toBe("(");
+      expect(tokens[0][11].scopes).toEqual(["source.python","punctuation.definition.arguments.begin.python"]);
+      expect(tokens[1][0].value).toBe("    ");
+      expect(tokens[1][0].scopes).toEqual(["source.python","meta.function-call.arguments.python"]);
+      expect(tokens[1][1].value).toBe("uuid");
+      expect(tokens[1][1].scopes).toEqual(["source.python","meta.function-call.arguments.python"]);
+      expect(tokens[1][2].value).toBe(".");
+      expect(tokens[1][2].scopes).toEqual(["source.python","meta.function-call.arguments.python","meta.member.access.python","punctuation.separator.period.python"]);
+      expect(tokens[1][3].value).toBe("UUID");
+      expect(tokens[1][3].scopes).toEqual(["source.python","meta.function-call.arguments.python","meta.member.access.python","constant.other.caps.python"]);
+      expect(tokens[1][4].value).toBe(",");
+      expect(tokens[1][4].scopes).toEqual(["source.python","meta.function-call.arguments.python","punctuation.separator.arguments.python"]);
+      expect(tokens[2][0].value).toBe("    ");
+      expect(tokens[2][0].scopes).toEqual(["source.python","meta.function-call.arguments.python"]);
+      expect(tokens[2][1].value).toBe("inheritable");
+      expect(tokens[2][1].scopes).toEqual(["source.python","meta.function-call.arguments.python","variable.parameter.function-call.python"]);
+      expect(tokens[2][2].value).toBe("=");
+      expect(tokens[2][2].scopes).toEqual(["source.python","meta.function-call.arguments.python","keyword.operator.assignment.python"]);
+      expect(tokens[2][3].value).toBe("False");
+      expect(tokens[2][3].scopes).toEqual(["source.python","meta.function-call.arguments.python","constant.language.python"]);
+      expect(tokens[2][4].value).toBe(",");
+      expect(tokens[2][4].scopes).toEqual(["source.python","meta.function-call.arguments.python","punctuation.separator.arguments.python"]);
+      expect(tokens[3][0].value).toBe("    ");
+      expect(tokens[3][0].scopes).toEqual(["source.python","meta.function-call.arguments.python"]);
+      expect(tokens[3][1].value).toBe("simpledelta");
+      expect(tokens[3][1].scopes).toEqual(["source.python","meta.function-call.arguments.python","variable.parameter.function-call.python"]);
+      expect(tokens[3][2].value).toBe("=");
+      expect(tokens[3][2].scopes).toEqual(["source.python","meta.function-call.arguments.python","keyword.operator.assignment.python"]);
+      expect(tokens[3][3].value).toBe("False");
+      expect(tokens[3][3].scopes).toEqual(["source.python","meta.function-call.arguments.python","constant.language.python"]);
+      expect(tokens[3][4].value).toBe(",");
+      expect(tokens[3][4].scopes).toEqual(["source.python","meta.function-call.arguments.python","punctuation.separator.arguments.python"]);
+      expect(tokens[4][0].value).toBe("    ");
+      expect(tokens[4][0].scopes).toEqual(["source.python","meta.function-call.arguments.python"]);
+      expect(tokens[4][1].value).toBe("allow_ddl_set");
+      expect(tokens[4][1].scopes).toEqual(["source.python","meta.function-call.arguments.python","variable.parameter.function-call.python"]);
+      expect(tokens[4][2].value).toBe("=");
+      expect(tokens[4][2].scopes).toEqual(["source.python","meta.function-call.arguments.python","keyword.operator.assignment.python"]);
+      expect(tokens[4][3].value).toBe("True");
+      expect(tokens[4][3].scopes).toEqual(["source.python","meta.function-call.arguments.python","constant.language.python"]);
+      expect(tokens[4][4].value).toBe(",");
+      expect(tokens[4][4].scopes).toEqual(["source.python","meta.function-call.arguments.python","punctuation.separator.arguments.python"]);
+      expect(tokens[5][0].value).toBe(")");
+      expect(tokens[5][0].scopes).toEqual(["source.python","punctuation.definition.arguments.end.python"]);
+    });
+
   it("test/calls/call2.py", 
     function() {
       tokens = grammar.tokenizeLines("foo(from=1)")
diff --git a/test/calls/call11.py b/test/calls/call11.py
@@ -0,0 +1,44 @@
+id = Field[uuid.UUID] (
+    uuid.UUID,
+    inheritable=False,
+    simpledelta=False,
+    allow_ddl_set=True,
+)
+
+
+
+
+
+id            : source.python, support.function.builtin.python
+              : source.python
+=             : keyword.operator.assignment.python, source.python
+              : source.python
+Field         : meta.indexed-name.python, meta.item-access.python, source.python
+[             : meta.item-access.python, punctuation.definition.arguments.begin.python, source.python
+uuid          : meta.item-access.arguments.python, meta.item-access.python, source.python
+.             : meta.item-access.arguments.python, meta.item-access.python, meta.member.access.python, punctuation.separator.period.python, source.python
+UUID          : constant.other.caps.python, meta.item-access.arguments.python, meta.item-access.python, meta.member.access.python, source.python
+]             : meta.item-access.python, punctuation.definition.arguments.end.python, source.python
+              : source.python
+(             : punctuation.definition.arguments.begin.python, source.python
+              : meta.function-call.arguments.python, source.python
+uuid          : meta.function-call.arguments.python, source.python
+.             : meta.function-call.arguments.python, meta.member.access.python, punctuation.separator.period.python, source.python
+UUID          : constant.other.caps.python, meta.function-call.arguments.python, meta.member.access.python, source.python
+,             : meta.function-call.arguments.python, punctuation.separator.arguments.python, source.python
+              : meta.function-call.arguments.python, source.python
+inheritable   : meta.function-call.arguments.python, source.python, variable.parameter.function-call.python
+=             : keyword.operator.assignment.python, meta.function-call.arguments.python, source.python
+False         : constant.language.python, meta.function-call.arguments.python, source.python
+,             : meta.function-call.arguments.python, punctuation.separator.arguments.python, source.python
+              : meta.function-call.arguments.python, source.python
+simpledelta   : meta.function-call.arguments.python, source.python, variable.parameter.function-call.python
+=             : keyword.operator.assignment.python, meta.function-call.arguments.python, source.python
+False         : constant.language.python, meta.function-call.arguments.python, source.python
+,             : meta.function-call.arguments.python, punctuation.separator.arguments.python, source.python
+              : meta.function-call.arguments.python, source.python
+allow_ddl_set : meta.function-call.arguments.python, source.python, variable.parameter.function-call.python
+=             : keyword.operator.assignment.python, meta.function-call.arguments.python, source.python
+True          : constant.language.python, meta.function-call.arguments.python, source.python
+,             : meta.function-call.arguments.python, punctuation.separator.arguments.python, source.python
+)             : punctuation.definition.arguments.end.python, source.python
