Pretty format comments in identifier lists (fixes issue59).

andialbrecht · andialbrecht · commit e4bccf45a6e8 · 2012-04-19T22:02:08.000+02:00
diff --git a/CHANGES b/CHANGES
@@ -10,6 +10,7 @@ Bug Fixes
  * Fix statement splitting when parsing recursive statements (issue57,
    thanks to piranna).
  * Fix for negative numbers (issue56, thanks to kevinjqiu).
+ * Pretty format comments in identifier lists (issue59).
  * Several minor bug fixes and improvements.
 
 
diff --git a/sqlparse/engine/grouping.py b/sqlparse/engine/grouping.py
@@ -197,6 +197,7 @@ def group_identifier_list(tlist):
                    lambda t: t.ttype == T.Number.Integer,
                    lambda t: t.ttype == T.String.Single,
                    lambda t: isinstance(t, sql.Comparison),
+                   lambda t: isinstance(t, sql.Comment),
                    ]
     tcomma = tlist.token_next_match(idx, T.Punctuation, ',')
     start = None
@@ -314,18 +315,19 @@ def group_functions(tlist):
 
 
 def group(tlist):
-    for func in [group_parenthesis,
-                 group_functions,
-                 group_comments,
-                 group_where,
-                 group_case,
-                 group_identifier,
-                 group_typecasts,
-                 group_as,
-                 group_aliased,
-                 group_assignment,
-                 group_comparison,
-                 group_identifier_list,
-                 group_if,
-                 group_for]:
+    for func in [
+            group_comments,
+            group_parenthesis,
+            group_functions,
+            group_where,
+            group_case,
+            group_identifier,
+            group_typecasts,
+            group_as,
+            group_aliased,
+            group_assignment,
+            group_comparison,
+            group_identifier_list,
+            group_if,
+            group_for]:
         func(tlist)
diff --git a/sqlparse/filters.py b/sqlparse/filters.py
@@ -332,6 +332,9 @@ def _process_identifierlist(self, tlist):
             self.offset += num_offset
             for token in identifiers[1:]:
                 tlist.insert_before(token, self.nl())
+            for token in tlist.tokens:
+                if isinstance(token, sql.Comment):
+                    tlist.insert_after(token, self.nl())
             self.offset -= num_offset
         self._process_default(tlist)
 
diff --git a/sqlparse/sql.py b/sqlparse/sql.py
@@ -322,6 +322,14 @@ def insert_before(self, where, token):
         """Inserts *token* before *where*."""
         self.tokens.insert(self.token_index(where), token)
 
+    def insert_after(self, where, token):
+        """Inserts *token* after *where*."""
+        next_token = self.token_next(where)
+        if next_token is None:
+            self.tokens.append(token)
+        else:
+            self.tokens.insert(self.token_index(next_token), token)
+
     def has_alias(self):
         """Returns ``True`` if an alias is present."""
         return self.get_alias() is not None
