@0x/abi-gen: Update python wrappers generation to work with leading…

… underscores in identifiers.'
0xProject · Jun 2, 2020 · fc86835 · fc86835
1 parent 6ef4a54
commit fc86835
Show file tree

Hide file tree

Showing 8 changed files with 301 additions and 827 deletions.
diff --git a/packages/abi-gen/CHANGELOG.json b/packages/abi-gen/CHANGELOG.json
@@ -1,4 +1,13 @@
 [
+    {
+        "version": "5.3.0",
+        "changes": [
+            {
+                "note": "Allow identifiers with leading underscores in python wrappers",
+                "pr": 2591
+            }
+        ]
+    },
     {
         "version": "5.2.2",
         "changes": [

diff --git a/packages/abi-gen/src/index.ts b/packages/abi-gen/src/index.ts
@@ -146,7 +146,16 @@ if (args.language === 'TypeScript') {
 registerPartials();
 
 function makeLanguageSpecificName(methodName: string): string {
-    return args.language === 'Python' ? changeCase.snake(methodName) : methodName;
+    if (args.language === 'Python') {
+        let snakeCased = changeCase.snake(methodName);
+        // Move leading underscores to the end.
+        const m = /^(_*).+?(_*)$/.exec(methodName);
+        if (m) {
+            snakeCased = `${snakeCased}${m[1] || m[2]}`;
+        }
+        return snakeCased;
+    }
+    return methodName;
 }
 
 if (_.isEmpty(abiFileNames)) {

diff --git a/packages/abi-gen/src/python_handlebars_helpers.ts b/packages/abi-gen/src/python_handlebars_helpers.ts
@@ -153,10 +153,15 @@ export function registerPythonHelpers(): void {
         }
         return '';
     });
-    Handlebars.registerHelper(
-        'toPythonClassname',
-        (sourceName: string) => new Handlebars.SafeString(changeCase.pascal(sourceName)),
-    );
+    Handlebars.registerHelper('toPythonClassname', (sourceName: string) => {
+        let pascalCased = changeCase.pascal(sourceName);
+        // Retain trailing underscores.
+        const m = /^.+?(_*)$/.exec(sourceName);
+        if (m) {
+            pascalCased = `${pascalCased}${m[1]}`;
+        }
+        return new Handlebars.SafeString(pascalCased);
+    });
     Handlebars.registerHelper(
         'makeOutputsValue',
         /**

diff --git a/packages/abi-gen/src/utils.ts b/packages/abi-gen/src/utils.ts
@@ -331,13 +331,14 @@ export const utils = {
             'max',
             'round',
         ];
-        if (
-            pythonReservedWords.includes(snakeCased) ||
-            pythonBuiltins.includes(snakeCased) ||
-            /*changeCase strips leading underscores :(*/ input[0] === '_'
-        ) {
+        if (pythonReservedWords.includes(snakeCased) || pythonBuiltins.includes(snakeCased)) {
             snakeCased = `_${snakeCased}`;
         }
+        // Retain trailing underscores.
+        const m = /^.+?(_*)$/.exec(input);
+        if (m) {
+            snakeCased = `${snakeCased}${m[1]}`;
+        }
         return snakeCased;
     },
     /**

diff --git a/packages/abi-gen/templates/Python/partials/method_class.handlebars b/packages/abi-gen/templates/Python/partials/method_class.handlebars
@@ -1,5 +1,5 @@
 
-class {{toPythonClassname this.languageSpecificName}}Method(ContractMethod):
+class {{toPythonClassname this.languageSpecificName}}Method(ContractMethod): # pylint: disable=invalid-name
     """Various interfaces to the {{this.name}} method."""
 
     def __init__(self, web3_or_provider: Union[Web3, BaseProvider], contract_address: str, contract_function: ContractFunction{{#if inputs}}, validator: Validator=None{{/if}}):