Removed spurious warnings when assigning results name to originalText…

…For expression (Issue #110)

CHANGES

@@ -2,6 +2,13 @@
 Change Log
 ==========
 
+Version 3.0.5 -
+---------------
+- Fixed bug when `warn_ungrouped_named_tokens_in_collection` warning was raised
+  when assigning a results name to an `original_text_for` expression.
+  (Issue #110, would raise warning in packaging.)
+
+
 Version 3.0.4 -
 ---------------
 - Fixed bug in which `Dict` classes did not correctly return tokens as nested

pyparsing/__init__.py

@@ -105,7 +105,7 @@
     ),
     "",
 )[__version_info__.release_level == "final"]
-__version_time__ = "30 October 2021 16:35 UTC"
+__version_time__ = "31 October 2021 11:23 UTC"
 version_info.__str__ = lambda *args: "pyparsing {} - {}".format(
     __version__, __version_time__
 )

pyparsing/core.py

@@ -3660,7 +3660,7 @@ def copy(self):
     def _setResultsName(self, name, listAllMatches=False):
         if __diag__.warn_ungrouped_named_tokens_in_collection:
             for e in self.exprs:
-                if isinstance(e, ParserElement) and e.resultsName:
+                if isinstance(e, ParserElement) and e.resultsName and not e.resultsName.startswith("_NOWARN"):
                     warnings.warn(
                         "{}: setting results name {!r} on {} expression "
                         "collides with {!r} on contained expression".format(
@@ -4701,7 +4701,7 @@ def parseImpl(self, instring, loc, doActions=True):
     def _setResultsName(self, name, listAllMatches=False):
         if __diag__.warn_ungrouped_named_tokens_in_collection:
             for e in [self.expr] + self.expr.recurse():
-                if isinstance(e, ParserElement) and e.resultsName:
+                if isinstance(e, ParserElement) and e.resultsName and not e.resultsName.startswith("_NOWARN"):
                     warnings.warn(
                         "{}: setting results name {!r} on {} expression "
                         "collides with {!r} on contained expression".format(

pyparsing/helpers.py

@@ -387,13 +387,14 @@ def original_text_for(
     locMarker = Empty().set_parse_action(lambda s, loc, t: loc)
     endlocMarker = locMarker.copy()
     endlocMarker.callPreparse = False
-    matchExpr = locMarker("_original_start") + expr + endlocMarker("_original_end")
+    # prefix these transient names with _NOWARN to suppress ungrouped name warnings
+    matchExpr = locMarker("_NOWARN_original_start") + expr + endlocMarker("_NOWARN_original_end")
     if asString:
-        extractText = lambda s, l, t: s[t._original_start : t._original_end]
+        extractText = lambda s, l, t: s[t._NOWARN_original_start : t._NOWARN_original_end]
     else:
 
         def extractText(s, l, t):
-            t[:] = [s[t.pop("_original_start") : t.pop("_original_end")]]
+            t[:] = [s[t.pop("_NOWARN_original_start") : t.pop("_NOWARN_original_end")]]
 
     matchExpr.set_parse_action(extractText)
     matchExpr.ignoreExprs = expr.ignoreExprs

tests/test_unit.py

@@ -7552,6 +7552,22 @@ def testWarnUngroupedNamedTokens(self):
             ):
                 path = coord[...].setResultsName("path")
 
+    def testDontWarnUngroupedNamedTokensIfUngroupedNamesStartWithNOWARN(self):
+        """
+        - warn_ungrouped_named_tokens_in_collection - flag to enable warnings when a results
+          name is defined on a containing expression with ungrouped subexpressions that also
+          have results names (default=True)
+        """
+        with ppt.reset_pyparsing_context():
+            pp.enable_diag(pp.Diagnostics.warn_ungrouped_named_tokens_in_collection)
+
+            with self.assertDoesNotWarn(
+                msg="raised {} warning inner names start with '_NOWARN'".format(
+                    pp.Diagnostics.warn_ungrouped_named_tokens_in_collection
+                )
+            ):
+                pp.originalTextFor(pp.Word("ABC")[...])("words")
+
     def testWarnNameSetOnEmptyForward(self):
         """
         - warn_name_set_on_empty_Forward - flag to enable warnings when a Forward is defined