feat(python): keep formatting and indentation of the multiline SQL queries

Part of #26

Author: php-coder

examples/python/routes.py

@@ -51,7 +51,14 @@ def get_v1_collections_collection_id_categories_count(collectionId, conn = Depen
     try:
         with conn:
             with conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) as cur:
-                cur.execute("SELECT COUNT(DISTINCT s.category_id) AS counter FROM collections_series cs JOIN series s ON s.id = cs.series_id WHERE cs.collection_id = %(collectionId)s", { "collectionId": collectionId })
+                cur.execute(
+                    """
+                    SELECT COUNT(DISTINCT s.category_id) AS counter
+                      FROM collections_series cs
+                      JOIN series s
+                        ON s.id = cs.series_id
+                     WHERE cs.collection_id = %(collectionId)s
+                    """, { "collectionId": collectionId })
                 result = cur.fetchone()
                 if result is None:
                     raise HTTPException(status_code=404)
@@ -64,7 +71,15 @@ def get_list_v1_categories(limit, conn = Depends(db_connection)):
     try:
         with conn:
             with conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) as cur:
-                cur.execute("SELECT id , name , name_ru , slug FROM categories LIMIT %(limit)s", { "limit": limit })
+                cur.execute(
+                    """
+                    SELECT id
+                         , name
+                         , name_ru
+                         , slug
+                     FROM categories
+                    LIMIT %(limit)s
+                    """, { "limit": limit })
                 return cur.fetchall()
     finally:
         conn.close()
@@ -78,7 +93,15 @@ def get_v1_categories_category_id(categoryId, conn = Depends(db_connection)):
     try:
         with conn:
             with conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) as cur:
-                cur.execute("SELECT id , name , name_ru , slug FROM categories WHERE id = %(categoryId)s", { "categoryId": categoryId })
+                cur.execute(
+                    """
+                    SELECT id
+                         , name
+                         , name_ru
+                         , slug
+                      FROM categories
+                     WHERE id = %(categoryId)s
+                    """, { "categoryId": categoryId })
                 result = cur.fetchone()
                 if result is None:
                     raise HTTPException(status_code=404)

src/cli.js

@@ -243,6 +243,7 @@ const createEndpoints = async (destDir, lang, config) => {
             },
 
             "placeholdersMap": placeholdersMap,
+            "removeComments": removeComments,
         }
     );
 

src/templates/routes.py.ejs

@@ -32,6 +32,19 @@ function convertToFastApiPath(path) {
     return path.replace(/:([_a-zA-Z]+)/g, '{$1}')
 }
 
+// Differs from formatQuery() as it doesn't flatten query (preserve original formatting)
+// and also use """ for multiline strings
+function formatQueryForPython(query, indentLevel) {
+    const sql = removePlaceholders(removeComments(query))
+    const isMultilineSql = sql.indexOf('\n') >= 0
+    if (isMultilineSql) {
+        const indent = ' '.repeat(indentLevel)
+        const indentedSql = sql.replace(/\n/g, '\n' + indent)
+        return `\n${indent}"""\n${indent}${indentedSql}\n${indent}"""`;
+    }
+    return `"${sql}"`
+}
+
 
 endpoints.forEach(function(endpoint) {
     const path = convertToFastApiPath(endpoint.path)
@@ -58,7 +71,7 @@ endpoints.forEach(function(endpoint) {
         const queries = []
         queriesWithNames.forEach(queryWithName => {
             for (const [name, query] of Object.entries(queryWithName)) {
-                const sql = convertToPsycopgNamedArguments(formatQuery(query))
+                const sql = convertToPsycopgNamedArguments(formatQueryForPython(query, 20))
                 const params = extractParamsFromQuery(query);
                 const formattedParams = params.length > 0
                     // [ "p.categoryId" ] => [ '"categoryId": categoryId' ]
@@ -81,7 +94,7 @@ def <%- pythonMethodName %>(<%- methodArgs.join(', ') %>):
 <%                  queries.forEach(queryInfo => {
                         for (const [name, query] of Object.entries(queryInfo)) {
 -%>
-                cur.execute("<%- query.sql %>"<%- query.formattedParams %>)
+                cur.execute(<%- query.sql %><%- query.formattedParams %>)
                 result['<%- name %>'] = cur.fetchone()[0]
 <%                      }
                     })
@@ -92,7 +105,7 @@ def <%- pythonMethodName %>(<%- methodArgs.join(', ') %>):
                     const query = queries[0].result
 -%>
             with conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) as cur:
-                cur.execute("<%- query.sql %>"<%- query.formattedParams %>)
+                cur.execute(<%- query.sql %><%- query.formattedParams %>)
                 result = cur.fetchone()
                 if result is None:
                     raise HTTPException(status_code=404)
@@ -102,7 +115,7 @@ def <%- pythonMethodName %>(<%- methodArgs.join(', ') %>):
                 const query = queries[0].result
 -%>
             with conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) as cur:
-                cur.execute("<%- query.sql %>"<%- query.formattedParams %>)
+                cur.execute(<%- query.sql %><%- query.formattedParams %>)
                 return cur.fetchall()
 <%
             }