From 4fb5268acd926c254acc59dfa4c8fb6369a09211 Mon Sep 17 00:00:00 2001
From: Griatch <griatch@gmail.com>
Date: Thu, 13 Oct 2022 20:05:42 +0200
Subject: [PATCH] Fix of FuncParser nested any-output. Resolve #2908, #2902

---
 evennia/prototypes/tests.py            | 61 +++++++++++++++++++-------
 evennia/utils/funcparser.py            |  1 -
 evennia/utils/tests/test_funcparser.py |  9 ++--
 3 files changed, 52 insertions(+), 19 deletions(-)

diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py
index d9d9ffd818..7321142691 100644
--- a/evennia/prototypes/tests.py
+++ b/evennia/prototypes/tests.py
@@ -3,19 +3,20 @@ Unit tests for the prototypes and spawner
 
 """
 
-from random import randint, sample
-import mock
 import uuid
+from random import randint, sample
 from time import time
+
+import mock
 from anything import Something
 from django.test.utils import override_settings
+from evennia.prototypes import menus as olc_menus
+from evennia.prototypes import protfuncs as protofuncs
+from evennia.prototypes import prototypes as protlib
+from evennia.prototypes import spawner
+from evennia.prototypes.prototypes import _PROTOTYPE_TAG_META_CATEGORY
 from evennia.utils.test_resources import BaseEvenniaTest
 from evennia.utils.tests.test_evmenu import TestEvMenu
-from evennia.prototypes import spawner, prototypes as protlib
-from evennia.prototypes import menus as olc_menus
-from evennia.prototypes import protfuncs as protofuncs, spawner
-
-from evennia.prototypes.prototypes import _PROTOTYPE_TAG_META_CATEGORY
 
 _PROTPARENTS = {
     "NOBODY": {},
@@ -43,6 +44,11 @@ _PROTPARENTS = {
         "key": "goblin archwizard",
         "prototype_parent": ("GOBLIN_WIZARD", "ARCHWIZARD"),
     },
+    "ISSUE2908": {
+        "typeclass": "evennia.objects.objects.DefaultObject",
+        "key": "testobject_isse2909",
+        "location": "$choice($objlist(",
+    },
 }
 
 
@@ -163,10 +169,12 @@ class TestUtils(BaseEvenniaTest):
                 "key": "Obj",
                 "home": Something,
                 "location": Something,
-                "locks": "call:true();control:perm(Developer);delete:perm(Admin);"
-                "drop:holds();"
-                "edit:perm(Admin);examine:perm(Builder);get:all();"
-                "puppet:pperm(Developer);tell:perm(Admin);view:all()",
+                "locks": (
+                    "call:true();control:perm(Developer);delete:perm(Admin);"
+                    "drop:holds();"
+                    "edit:perm(Admin);examine:perm(Builder);get:all();"
+                    "puppet:pperm(Developer);tell:perm(Admin);view:all()"
+                ),
                 "prototype_desc": "Built from Obj",
                 "prototype_key": Something,
                 "prototype_locks": "spawn:all();edit:all()",
@@ -183,10 +191,12 @@ class TestUtils(BaseEvenniaTest):
                 "home": Something,
                 "key": "Obj",
                 "location": Something,
-                "locks": "call:true();control:perm(Developer);delete:perm(Admin);"
-                "drop:holds();"
-                "edit:perm(Admin);examine:perm(Builder);get:all();"
-                "puppet:pperm(Developer);tell:perm(Admin);view:all()",
+                "locks": (
+                    "call:true();control:perm(Developer);delete:perm(Admin);"
+                    "drop:holds();"
+                    "edit:perm(Admin);examine:perm(Builder);get:all();"
+                    "puppet:pperm(Developer);tell:perm(Admin);view:all()"
+                ),
                 "new": "new_val",
                 "permissions": ["Builder"],
                 "prototype_desc": "New version of prototype",
@@ -962,3 +972,24 @@ class TestPartialTagAttributes(BaseEvenniaTest):
     def test_partial_spawn(self):
         obj = spawner.spawn(self.prot)
         self.assertEqual(obj[0].key, self.prot["key"])
+
+
+class TestIssue2908(BaseEvenniaTest):
+    """
+    Test spawning a prototype with a nested protfunc, as per issue #2908.
+
+    """
+
+    def test_spawn_with_protfunc(self):
+
+        self.room1.tags.add("beach", category="zone")
+
+        prot = {
+            "prototype_key": "rock",
+            "typeclass": "evennia.objects.objects.DefaultObject",
+            "key": "a rock",
+            "location": "$choice($objlist(beach,category=zone,type=tag))",
+        }
+
+        obj = spawner.spawn(prot, caller=self.char1)
+        self.assertEqual(obj[0].location, self.room1)
diff --git a/evennia/utils/funcparser.py b/evennia/utils/funcparser.py
index b67fa2e530..6ed1b333ba 100644
--- a/evennia/utils/funcparser.py
+++ b/evennia/utils/funcparser.py
@@ -354,7 +354,6 @@ class FuncParser:
 
                 if curr_func:
                     # we are starting a nested funcdef
-                    # return_str = True
                     if len(callstack) > _MAX_NESTING:
                         # stack full - ignore this function
                         if raise_errors:
diff --git a/evennia/utils/tests/test_funcparser.py b/evennia/utils/tests/test_funcparser.py
index 53832e2ea2..c0c458ed70 100644
--- a/evennia/utils/tests/test_funcparser.py
+++ b/evennia/utils/tests/test_funcparser.py
@@ -788,9 +788,12 @@ class TestCallableSearch(test_resources.BaseEvenniaTest):
 
         # get random result from the possible matches
         string = "$choice($objlist(beach,category=zone,type=tag))"
-        from evennia import set_trace
-
-        set_trace()
+        ret = parser.parse_to_any(string, caller=self.char1, raise_errors=True)
+
+        self.assertIn(ret, [self.obj1, self.obj2])
+
+        # test wrapping in $obj(), should just pass object through
+        string = "$obj($choice($objlist(beach,category=zone,type=tag)))"
         ret = parser.parse_to_any(string, caller=self.char1, raise_errors=True)
 
         self.assertIn(ret, [self.obj1, self.obj2])