Re: [PATCH v3 09/17] qapi: use './builtin' as the built-in module name

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> Use './builtin' as the built-in module name instead of
> None. Clarify the typing that this is now always a string.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  scripts/qapi/gen.py                      | 18 +++++++++---------
>  scripts/qapi/schema.py                   | 14 +++++++-------
>  tests/qapi-schema/comments.out           |  2 +-
>  tests/qapi-schema/doc-good.out           |  2 +-
>  tests/qapi-schema/empty.out              |  2 +-
>  tests/qapi-schema/event-case.out         |  2 +-
>  tests/qapi-schema/include-repetition.out |  2 +-
>  tests/qapi-schema/include-simple.out     |  2 +-
>  tests/qapi-schema/indented-expr.out      |  2 +-
>  tests/qapi-schema/qapi-schema-test.out   |  2 +-
>  10 files changed, 24 insertions(+), 24 deletions(-)
>
> diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py
> index 18b72dd06c8..55acd7e080d 100644
> --- a/scripts/qapi/gen.py
> +++ b/scripts/qapi/gen.py
> @@ -246,16 +246,16 @@ def __init__(self,
>          self._pydoc = pydoc
>          self._genc: Optional[QAPIGenC] = None
>          self._genh: Optional[QAPIGenH] = None
> -        self._module: Dict[Optional[str], Tuple[QAPIGenC, QAPIGenH]] = {}
> +        self._module: Dict[str, Tuple[QAPIGenC, QAPIGenH]] = {}
>          self._main_module: Optional[str] = None
>  
>      @staticmethod
> -    def _module_dirname(name: Optional[str]) -> str:
> +    def _module_dirname(name: str) -> str:
>          if QAPISchemaModule.is_user_module(name):
>              return os.path.dirname(name)
>          return ''
>  
> -    def _module_basename(self, what: str, name: Optional[str]) -> str:
> +    def _module_basename(self, what: str, name: str) -> str:
>          ret = '' if QAPISchemaModule.is_builtin_module(name) else self._prefix
>          if QAPISchemaModule.is_user_module(name):
>              basename = os.path.basename(name)
> @@ -263,15 +263,15 @@ def _module_basename(self, what: str, name: Optional[str]) -> str:
>              if name != self._main_module:
>                  ret += '-' + os.path.splitext(basename)[0]
>          else:
> -            name = name[2:] if name else 'builtin'
> -            ret += re.sub(r'-', '-' + name + '-', what)
> +            assert QAPISchemaModule.is_system_module(name)
> +            ret += re.sub(r'-', '-' + name[2:] + '-', what)
>          return ret
>  
> -    def _module_filename(self, what: str, name: Optional[str]) -> str:
> +    def _module_filename(self, what: str, name: str) -> str:
>          return os.path.join(self._module_dirname(name),
>                              self._module_basename(what, name))
>  
> -    def _add_module(self, name: Optional[str], blurb: str) -> None:
> +    def _add_module(self, name: str, blurb: str) -> None:
>          basename = self._module_filename(self._what, name)
>          genc = QAPIGenC(basename + '.c', blurb, self._pydoc)
>          genh = QAPIGenH(basename + '.h', blurb, self._pydoc)
> @@ -284,7 +284,7 @@ def _add_user_module(self, name: str, blurb: str) -> None:
>              self._main_module = name
>          self._add_module(name, blurb)
>  
> -    def _add_system_module(self, name: Optional[str], blurb: str) -> None:
> +    def _add_system_module(self, name: str, blurb: str) -> None:
>          assert QAPISchemaModule.is_system_module(name)
>          self._add_module(name, blurb)
>  
> @@ -305,7 +305,7 @@ def _begin_user_module(self, name: str) -> None:
>      def visit_module(self, module: QAPISchemaModule) -> None:
>          if module.system_module:
>              if self._builtin_blurb:
> -                self._add_system_module(None, self._builtin_blurb)
> +                self._add_system_module(module.name, self._builtin_blurb)
>                  self._begin_builtin_module()
>              else:
>                  # The built-in module has not been created.  No code may
> diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
> index 44a9232c881..c519c18a5ec 100644
> --- a/scripts/qapi/schema.py
> +++ b/scripts/qapi/schema.py
> @@ -68,7 +68,8 @@ def check_doc(self):
>  
>      def _set_module(self, schema, info):
>          assert self._checked
> -        self._module = schema.module_by_fname(info and info.fname)
> +        fname = info.fname if info else './builtin'
> +        self._module = schema.module_by_fname(fname)
>          self._module.add_entity(self)
>  
>      def set_module(self, schema):
> @@ -142,11 +143,11 @@ def __init__(self, name):
>          self._entity_list = []
>  
>      @classmethod
> -    def is_system_module(cls, name: Optional[str]) -> bool:
> -        return name is None or name.startswith('./')
> +    def is_system_module(cls, name: str) -> bool:
> +        return name.startswith('./')
>  
>      @classmethod
> -    def is_user_module(cls, name: Optional[str]) -> bool:
> +    def is_user_module(cls, name: str) -> bool:
>          return not cls.is_system_module(name)
>  
>      @classmethod
> @@ -849,7 +850,7 @@ def __init__(self, fname):
>          self._entity_dict = {}
>          self._module_dict = OrderedDict()
>          self._schema_dir = os.path.dirname(fname)
> -        self._make_module(None)  # built-ins
> +        self._make_module('./builtin')  # built-ins

The comment it now redundant.

>          self._make_module(fname)
>          self._predefining = True
>          self._def_predefineds()
> @@ -894,7 +895,7 @@ def resolve_type(self, name, info, what):
>                  info, "%s uses unknown type '%s'" % (what, name))
>          return typ
>  
> -    def _module_name(self, fname):
> +    def _module_name(self, fname: str) -> str:
>          if QAPISchemaModule.is_system_module(fname):
>              return fname
>          return os.path.relpath(fname, self._schema_dir)
> @@ -907,7 +908,6 @@ def _make_module(self, fname):
>  
>      def module_by_fname(self, fname):
>          name = self._module_name(fname)
> -        assert name in self._module_dict
>          return self._module_dict[name]
>  
>      def _def_include(self, expr, info, doc):
[...]