Skip to contentSkip to conversation

userdiff: support Python async functions

PATCH In review Josh Holland 3 participants 3 messages Nov 19, 2019 – Nov 20, 2019

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 userdiff: support Python async functions

Python's async functions (declared with "async def" rather than "def") were not being displayed in hunk headers. This commit teaches git about the async function syntax, and adds tests for the Python userdiff regex.

---
This patch now includes tests for indented declarations, as well as the unindented versions which were present before. Apologies for the delay in preparing this patch.

 t/t4018/python-async-def          | 4 ++++
 t/t4018/python-class              | 4 ++++
 t/t4018/python-def                | 4 ++++
 t/t4018/python-indented-async-def | 7 +++++++
 t/t4018/python-indented-class     | 5 +++++
 t/t4018/python-indented-def       | 7 +++++++
 userdiff.c                        | 2 +-
 7 files changed, 32 insertions(+), 1 deletion(-)
 create mode 100644 t/t4018/python-async-def
 create mode 100644 t/t4018/python-class
 create mode 100644 t/t4018/python-def
 create mode 100644 t/t4018/python-indented-async-def
 create mode 100644 t/t4018/python-indented-class
 create mode 100644 t/t4018/python-indented-def
t/t4018/python-async-def new file +4 -0
new file mode 100644
index 000000000..87640e03d
@@ -0,0 +1,4 @@
+async def RIGHT(pi: int = 3.14):
+    while True:
+        break
+    return ChangeMe()
t/t4018/python-class new file +4 -0
new file mode 100644
index 000000000..ba9e74143
@@ -0,0 +1,4 @@
+class RIGHT(int, str):
+    # comment
+    # another comment
+    # ChangeMe
t/t4018/python-def new file +4 -0
new file mode 100644
index 000000000..e50b31b0a
@@ -0,0 +1,4 @@
+def RIGHT(pi: int = 3.14):
+    while True:
+        break
+    return ChangeMe()
t/t4018/python-indented-async-def new file +7 -0
new file mode 100644
index 000000000..f5d03258a
@@ -0,0 +1,7 @@
+class Foo:
+    async def RIGHT(self, x: int):
+        return [
+            1,
+            2,
+            ChangeMe,
+        ]
t/t4018/python-indented-class new file +5 -0
new file mode 100644
index 000000000..19b4f35c4
@@ -0,0 +1,5 @@
+if TYPE_CHECKING:
+    class RIGHT:
+        # comment
+        # another comment
+        # ChangeMe
t/t4018/python-indented-def new file +7 -0
new file mode 100644
index 000000000..208fbadd2
@@ -0,0 +1,7 @@
+class Foo:
+    def RIGHT(self, x: int):
+        return [
+            1,
+            2,
+            ChangeMe,
+        ]
userdiff.c +1 -1
index e187d356f..3fd324e61 100644
@@ -133,7 +133,7 @@ PATTERNS("php",
 	 "[a-zA-Z_][a-zA-Z0-9_]*"
 	 "|[-+0-9.e]+|0[xXbB]?[0-9a-fA-F]+"
 	 "|[-+*/<>%&^|=!.]=|--|\\+\\+|<<=?|>>=?|===|&&|\\|\\||::|->"),
-PATTERNS("python", "^[ \t]*((class|def)[ \t].*)$",
+PATTERNS("python", "^[ \t]*((class|(async[ \t]+)?def)[ \t].*)$",
 	 /* -- */
 	 "[a-zA-Z_][a-zA-Z0-9_]*"
 	 "|[-+0-9.e]+[jJlL]?|0[xX]?[0-9a-fA-F]+[lL]?"
Signature · 1 line
2.24.0
#1 lore raw
Quoted 2 lines · Josh Holland

This patch now includes tests for indented declarations, as well as the unindented versions which were present before.

Very much appreciated.

I wondered if something like

t/t4018/python-indented-async-def +3 -0
index f5d03258af..567c1dafcb 100644
@@ -1,3 +1,6 @@
+async def not_this_one(self):
+    return []
+
 class Foo:
     async def RIGHT(self, x: int):
         return [

would further help, but if a breakage makes us ignore a start of definition that is indented, we would hit "class Foo:" you added and notice such a breakage anyway, without additional definition before it. So I think what we see in this patch is good.

Thanks.

Quoted 17 lines

...

 t/t4018/python-indented-async-def | 7 +++++++

...

t/t4018/python-indented-async-def new file +7 -0
new file mode 100644
index 000000000..f5d03258a
@@ -0,0 +1,7 @@
+class Foo:
+    async def RIGHT(self, x: int):
+        return [
+            1,
+            2,
+            ChangeMe,
+        ]
...
Acked-by
#2 lore raw

Am 20.11.19 um 04:59 schrieb Junio C Hamano:

Quoted 21 lines
Quoted 2 lines · Josh Holland

This patch now includes tests for indented declarations, as well as the unindented versions which were present before.

Very much appreciated.

I wondered if something like

t/t4018/python-indented-async-def +3 -0
index f5d03258af..567c1dafcb 100644
@@ -1,3 +1,6 @@
+async def not_this_one(self):
+    return []
+
 class Foo:
     async def RIGHT(self, x: int):
         return [
Quoted 4 lines

would further help, but if a breakage makes us ignore a start of definition that is indented, we would hit "class Foo:" you added and notice such a breakage anyway, without additional definition before it. So I think what we see in this patch is good.

Good point raised and fine analysis!

This patch is

-- Hannes