From e8e48fa82bdce3f0c1da0693148867befa221de7 Mon Sep 17 00:00:00 2001
From: TakeshiMusgrave <tkm45@cornell.edu>
Date: Thu, 7 Apr 2022 12:14:12 -0400
Subject: Converted lint-python-mutable-default-parameters.sh to python

Change permission

Change argument so that it's compatiable with python 3.6

Change comment to docstring

Remove .split, .append, .extend calls. Remove 'output' variable assignment
---
 .../lint/lint-python-mutable-default-parameters.py | 72 ++++++++++++++++++++++
 .../lint/lint-python-mutable-default-parameters.sh | 52 ----------------
 2 files changed, 72 insertions(+), 52 deletions(-)
 create mode 100755 test/lint/lint-python-mutable-default-parameters.py
 delete mode 100755 test/lint/lint-python-mutable-default-parameters.sh

(limited to 'test/lint')

diff --git a/test/lint/lint-python-mutable-default-parameters.py b/test/lint/lint-python-mutable-default-parameters.py
new file mode 100755
index 0000000000..7991e3630b
--- /dev/null
+++ b/test/lint/lint-python-mutable-default-parameters.py
@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) 2019 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+"""
+Detect when a mutable list or dict is used as a default parameter value in a Python function.
+"""
+
+import subprocess
+import sys
+
+
+def main():
+    command = [
+        "git",
+        "grep",
+        "-E",
+        r"^\s*def [a-zA-Z0-9_]+\(.*=\s*(\[|\{)",
+        "--",
+        "*.py",
+    ]
+    output = subprocess.run(command, stdout=subprocess.PIPE, universal_newlines=True)
+    if len(output.stdout) > 0:
+        error_msg = (
+            "A mutable list or dict seems to be used as default parameter value:\n\n"
+            f"{output.stdout}\n"
+            f"{example()}"
+        )
+        print(error_msg)
+        sys.exit(1)
+    else:
+        sys.exit(0)
+
+
+def example():
+    return """This is how mutable list and dict default parameter values behave:
+
+>>> def f(i, j=[], k={}):
+...     j.append(i)
+...     k[i] = True
+...     return j, k
+...
+>>> f(1)
+([1], {1: True})
+>>> f(1)
+([1, 1], {1: True})
+>>> f(2)
+([1, 1, 2], {1: True, 2: True})
+
+The intended behaviour was likely:
+
+>>> def f(i, j=None, k=None):
+...     if j is None:
+...         j = []
+...     if k is None:
+...         k = {}
+...     j.append(i)
+...     k[i] = True
+...     return j, k
+...
+>>> f(1)
+([1], {1: True})
+>>> f(1)
+([1], {1: True})
+>>> f(2)
+([2], {2: True})"""
+
+
+if __name__ == "__main__":
+    main()
diff --git a/test/lint/lint-python-mutable-default-parameters.sh b/test/lint/lint-python-mutable-default-parameters.sh
deleted file mode 100755
index 1f9f035d30..0000000000
--- a/test/lint/lint-python-mutable-default-parameters.sh
+++ /dev/null
@@ -1,52 +0,0 @@
-#!/usr/bin/env bash
-#
-# Copyright (c) 2019 The Bitcoin Core developers
-# Distributed under the MIT software license, see the accompanying
-# file COPYING or http://www.opensource.org/licenses/mit-license.php.
-#
-# Detect when a mutable list or dict is used as a default parameter value in a Python function.
-
-export LC_ALL=C
-EXIT_CODE=0
-OUTPUT=$(git grep -E '^\s*def [a-zA-Z0-9_]+\(.*=\s*(\[|\{)' -- "*.py")
-if [[ ${OUTPUT} != "" ]]; then
-    echo "A mutable list or dict seems to be used as default parameter value:"
-    echo
-    echo "${OUTPUT}"
-    echo
-    cat << EXAMPLE
-This is how mutable list and dict default parameter values behave:
-
->>> def f(i, j=[], k={}):
-...     j.append(i)
-...     k[i] = True
-...     return j, k
-...
->>> f(1)
-([1], {1: True})
->>> f(1)
-([1, 1], {1: True})
->>> f(2)
-([1, 1, 2], {1: True, 2: True})
-
-The intended behaviour was likely:
-
->>> def f(i, j=None, k=None):
-...     if j is None:
-...         j = []
-...     if k is None:
-...         k = {}
-...     j.append(i)
-...     k[i] = True
-...     return j, k
-...
->>> f(1)
-([1], {1: True})
->>> f(1)
-([1], {1: True})
->>> f(2)
-([2], {2: True})
-EXAMPLE
-    EXIT_CODE=1
-fi
-exit ${EXIT_CODE}
-- 
cgit v1.2.3