diff mbox series

[3/7] qapi: Eliminate accidental global frontend state

Message ID 20191001191514.11208-4-armbru@redhat.com
State New
Headers show
Series qapi: Cleanups and test speedup | expand

Commit Message

Markus Armbruster Oct. 1, 2019, 7:15 p.m. UTC
The frontend can't be run more than once due to its global state.
A future commit will want to do that.

The only global frontend state remaining is accidental:
QAPISchemaParser.__init__()'s parameter previously_included=[].
Python evaluates the default once, at definition time.  Any
modifications to it are visible in subsequent calls.  Well-known
Python trap.  Change the default to None and replace it by the real
default in the function body.  Use the opportunity to convert
previously_included to a set.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi/common.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Eric Blake Oct. 1, 2019, 8:03 p.m. UTC | #1
On 10/1/19 2:15 PM, Markus Armbruster wrote:
> The frontend can't be run more than once due to its global state.
> A future commit will want to do that.
> 
> The only global frontend state remaining is accidental:
> QAPISchemaParser.__init__()'s parameter previously_included=[].
> Python evaluates the default once, at definition time.  Any
> modifications to it are visible in subsequent calls.  Well-known
> Python trap.  Change the default to None and replace it by the real
> default in the function body.  Use the opportunity to convert
> previously_included to a set.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   scripts/qapi/common.py | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
> 

Reviewed-by: Eric Blake <eblake@redhat.com>
diff mbox series

Patch

diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index 5abab44302..9d5c05f6a1 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -391,8 +391,9 @@  class QAPIDoc(object):
 
 class QAPISchemaParser(object):
 
-    def __init__(self, fname, previously_included=[], incl_info=None):
-        previously_included.append(os.path.abspath(fname))
+    def __init__(self, fname, previously_included=None, incl_info=None):
+        previously_included = previously_included or set()
+        previously_included.add(os.path.abspath(fname))
 
         try:
             if sys.version_info[0] >= 3: