Ticket #2721: commentable_block_tags.patch

django/template/__init__.py

@@ -66 +66 @@
 TOKEN_TEXT = 0
 TOKEN_VAR = 1
 TOKEN_BLOCK = 2
+TOKEN_COMMENT = 3
 
 # template syntax constants
+COMMENT_IDENTIFIER = '#'
 FILTER_SEPARATOR = '|'
 FILTER_ARGUMENT_SEPARATOR = ':'
 VARIABLE_ATTRIBUTE_SEPARATOR = '.'
@@ -163 +165 @@
 
 class Token(object):
     def __init__(self, token_type, contents):
-        "The token_type must be TOKEN_TEXT, TOKEN_VAR or TOKEN_BLOCK"
+        "The token_type must be TOKEN_TEXT, TOKEN_VAR, TOKEN_BLOCK, or TOKEN_COMMENT"
         self.token_type, self.contents = token_type, contents
 
     def __str__(self):
         return '<%s token: "%s...">' % \
-            ({TOKEN_TEXT: 'Text', TOKEN_VAR: 'Var', TOKEN_BLOCK: 'Block'}[self.token_type],
+            ({TOKEN_TEXT: 'Text', TOKEN_VAR: 'Var', TOKEN_BLOCK: 'Block', TOKEN_COMMENT: 'Comment'}[self.token_type],
             self.contents[:20].replace('\n', ''))
 
     def split_contents(self):
@@ -190 +192 @@
         if token_string.startswith(VARIABLE_TAG_START):
             token = Token(TOKEN_VAR, token_string[len(VARIABLE_TAG_START):-len(VARIABLE_TAG_END)].strip())
         elif token_string.startswith(BLOCK_TAG_START):
-            token = Token(TOKEN_BLOCK, token_string[len(BLOCK_TAG_START):-len(BLOCK_TAG_END)].strip())
+            token_string = token_string[len(BLOCK_TAG_START):-len(BLOCK_TAG_END)].strip()
+            if token_string.startswith(COMMENT_IDENTIFIER):
+                token = Token(TOKEN_COMMENT, token_string)
+            else:
+                token = Token(TOKEN_BLOCK, token_string)
         else:
             token = Token(TOKEN_TEXT, token_string)
         return token

tests/regressiontests/templates/tests.py

@@ -170 +170 @@
             # Escaped backslash using known escape char
             'basic-syntax35': (r'{{ var|default_if_none:"foo\now" }}', {"var": None}, r'foo\now'),
 
+            ### COMMENTED BLOCK TAGS ####################################################
+            'commented-block-tag01': ("{% #invalidtag %}commented invalid tag", {}, "commented invalid tag"),
+            'commented-block-tag02': ("commented valid tag{% # if %}", {}, "commented valid tag"),
+            'commented-block-tag03': ("{% comment %}hide{% #endcomment %}still hide{% endcomment %}show", {}, "show"),
+
             ### COMMENT TAG ###########################################################
             'comment-tag01': ("{% comment %}this is hidden{% endcomment %}hello", {}, "hello"),
             'comment-tag02': ("{% comment %}this is hidden{% endcomment %}hello{% comment %}foo{% endcomment %}", {}, "hello"),