Ignore comments at beginning of statement when calling Statement.get_type (fixes andialbrecht#186).

andialbrecht · andialbrecht · commit fb6b59dece40 · 2015-07-26T11:20:49.000+02:00
diff --git a/CHANGES b/CHANGES
@@ -7,6 +7,8 @@ Bug Fixes
 * sqlformat command line tool doesn't duplicat newlines anymore (issue191).
 * Don't mix up MySQL comments starting with hash and MSSQL
   temp tables (issue192).
+* Statement.get_type() now ignores comments at the beginning of
+  a statement (issue186).
 
 
 Release 0.1.15 (Apr 15, 2015)
diff --git a/sqlparse/sql.py b/sqlparse/sql.py
@@ -240,15 +240,20 @@ def get_sublists(self):
     def _groupable_tokens(self):
         return self.tokens
 
-    def token_first(self, ignore_whitespace=True):
+    def token_first(self, ignore_whitespace=True, ignore_comments=False):
         """Returns the first child token.
 
         If *ignore_whitespace* is ``True`` (the default), whitespace
         tokens are ignored.
+
+        if *ignore_comments* is ``True`` (default: ``False``), comments are
+        ignored too.
         """
         for token in self.tokens:
             if ignore_whitespace and token.is_whitespace():
                 continue
+            if ignore_comments and isinstance(token, Comment):
+                continue
             return token
 
     def token_next_by_instance(self, idx, clss):
@@ -468,8 +473,11 @@ def get_type(self):
         The returned value is a string holding an upper-cased reprint of
         the first DML or DDL keyword. If the first token in this group
         isn't a DML or DDL keyword "UNKNOWN" is returned.
+
+        Whitespaces and comments at the beginning of the statement
+        are ignored.
         """
-        first_token = self.token_first()
+        first_token = self.token_first(ignore_comments=True)
         if first_token is None:
             # An "empty" statement that either has not tokens at all
             # or only whitespace tokens.
diff --git a/tests/test_regressions.py b/tests/test_regressions.py
@@ -255,3 +255,9 @@ def test_issue193_splitting_function():
 SELECT * FROM a.b;"""
     splitted = sqlparse.split(sql)
     assert len(splitted) == 2
+
+
+def test_issue186_get_type():
+    sql = "-- comment\ninsert into foo"
+    p = sqlparse.parse(sql)[0]
+    assert p.get_type() == 'INSERT'
