Initial support for generating .pyi files

Signed-off-by: Matthew Ballance <[email protected]>

Author: mballance

src/astbuilder/pyext_accessor_gen.py

@@ -1,4 +1,5 @@
 from astbuilder.pyext_type_name_gen import PyExtTypeNameGen
+from astbuilder.pyext_type_name_gen_pyi import PyExtTypeNameGenPyi
 from astbuilder.type_pointer import PointerKind
 from astbuilder.type_scalar import TypeKind
 from astbuilder.visitor import Visitor
@@ -22,13 +23,14 @@ class PyExtAccessorGen(Visitor):
     #
     #
 
-    def __init__(self, name, clsname, decl_pxd, pxd, pyx):
+    def __init__(self, name, clsname, decl_pxd, pxd, pyx, pyi):
         super().__init__()
         self.name = name
         self.clsname = clsname
         self.pxd = pxd
         self.decl_pxd = decl_pxd
         self.pyx = pyx
+        self.pyi = pyi
         self.field = None
         self.decl_pxd_ptr_tgen = PyExtTypeNameGen(
                 ns=self.name,
@@ -44,6 +46,7 @@ def __init__(self, name, clsname, decl_pxd, pxd, pyx):
                 is_pytype=False,
                 is_ref=True,
                 is_const=True)
+        self.pyi_tgen = PyExtTypeNameGenPyi(ns=self.name)
         self.list_accessor_gen = PyExtListAccessorGen(
             name, clsname, decl_pxd, pxd, pyx)
 
@@ -59,6 +62,8 @@ def visitTypeList(self, t):
             t, 
             is_pydecl=False,
             is_pytype=False) + " get" + name + "();")
+        self.pyi.println("def get%s(self) -> %s: ..." % (name, self.pyi_tgen.gen(t)))
+        self.pyi.println()
 
 
     def visitTypeMap(self, t):
@@ -93,6 +98,9 @@ def visitTypePointer(self, t):
         else:
             raise Exception("Accessor generation not supported for " + str(self.pt))
 
+        self.pyi.println("def get%s(self) -> %s: ..." % (name, tname))
+        self.pyi.println()
+
     def visitAstClass(self, c):
         self.gen_class_accessors(c)
 
@@ -178,6 +186,11 @@ def gen_enum_accessors(self, t):
         # Generate a non-const accessor
         self.decl_pxd.println("void set" + name + "(" +
             self.decl_pxd_ptr_tgen.gen(t) + " v)")
+        
+        self.pyi.println("def set%s(self, v : %s): ..." % (
+            name, 
+            self.pyi_tgen.gen(t)))
+        self.pyi.println()
 
         print("<-- gen_enum_accessors %s" % self.field.name)
 
@@ -261,6 +274,9 @@ def gen_string_accessors(self, t):
                          (self.name, self.clsname, name))
         self.pyx.dec_indent()
 
+        self.pyi.println("def get%s(self) -> str: ..." % name)
+        self.pyi.println()
+
         # Generate a setter
         self.decl_pxd.println("void set%s(%s v)" % (
             name,
@@ -278,6 +294,9 @@ def gen_string_accessors(self, t):
                 self.name, self.clsname, name))
         self.pyx.dec_indent()
 
+        self.pyi.println("def set%s(self, v : str): ..." % name)
+        self.pyi.println()
+
     def const_ref_ret(self, t, is_pydecl=False, is_pytype=False):
         return PyExtTypeNameGen(ns=self.name,compressed=True,is_pydecl=is_pydecl,
                                 is_pytype=is_pytype, is_ret=True,is_const=True).gen(t)

src/astbuilder/pyext_gen_params.py

@@ -4,6 +4,7 @@
 @author: mballance
 '''
 from astbuilder.pyext_type_name_gen import PyExtTypeNameGen
+from astbuilder.pyext_type_name_gen_pyi import PyExtTypeNameGenPyi
 from astbuilder.type_userdef import TypeUserDef
 from astbuilder.type_pointer import TypePointer
 from astbuilder.ast_enum import AstEnum
@@ -60,6 +61,36 @@ def gen_ctor_params(cls,
 
         return ret    
 
+    @classmethod
+    def gen_ctor_params_pyi(cls, 
+        ns, 
+        c, 
+        out): 
+        """Returns True if this level (or a previous level) added content"""
+        ret = False
+            
+        if c.super is not None:
+            # Recurse first
+            ret |= cls.gen_ctor_params_pyi(ns, c.super.target, out)
+        else:
+            out.write("self")
+
+        ret = True
+
+        out.inc_indent()
+        params = list(filter(lambda d : d.is_ctor, c.data))
+        for i,p in enumerate(params):
+            if i == 0:
+                out.write(",\n")
+            out.write(out.ind)
+            out.write(p.name + " : ")
+            out.write(PyExtTypeNameGenPyi(ns=ns).gen(p.t))
+            out.write((",\n" if i+1 < len(params) else ""))
+            ret = True
+        out.dec_indent()            
+
+        return ret
+    
     @classmethod
     def gen_ctor_pvals(cls, name, c, out):
         ret = False

src/astbuilder/pyext_gen_pyx.py

@@ -63,6 +63,8 @@ def gen(self, ast):
             self.pyx.println("cimport %s_decl" % self.name)
 
         self.pyx.println("from enum import IntEnum")
+        self.pyi.println("from enum import IntEnum, auto")
+        self.pyi.println("from typing import Dict, List, Tuple")
 
         for e in ast.enums:
             if self.namespace is not None:
@@ -77,6 +79,9 @@ def gen(self, ast):
 
             self.pyx.println("class %s(IntEnum):" % e.name)
             self.pyx.inc_indent()
+            
+            self.pyi.println("class %s(IntEnum):" % e.name)
+            self.pyi.inc_indent()
 
             for i,v in enumerate(e.values):
                 if self.namespace is not None:
@@ -87,10 +92,13 @@ def gen(self, ast):
                         e.name, v[0], e.name + "::" + v[0]))
                 self.pyx.println("%s = %s_decl.%s.%s_%s" % (
                     v[0], self.name, e.name, e.name, v[0]))
+                self.pyi.println("%s = auto()" % v[0])
+            self.pyi.println()
 
             self.decl_pxd.dec_indent()                
             self.decl_pxd.dec_indent()                
             self.pyx.dec_indent()
+            self.pyi.dec_indent()
 
         for e in ast.structs:
             if self.namespace is not None:
@@ -124,6 +132,9 @@ def gen(self, ast):
 
             self.pyx.println("class %s(IntEnum):" % e.name)
             self.pyx.inc_indent()
+
+            self.pyi.println("class %s(IntEnum):" % e.name)
+            self.pyi.inc_indent()
 
             for i,v in enumerate(e.values):
                 if self.namespace is not None:
@@ -134,10 +145,13 @@ def gen(self, ast):
                         e.name, v, e.name + "::" + v))
                 self.pyx.println("%s = %s_decl.%s.%s_%s" % (
                     v, self.name, e.name, e.name, v))
+                self.pyi.println("%s = auto()" % v)
+            self.pyi.println()
 
             self.decl_pxd.dec_indent()                
             self.decl_pxd.dec_indent()                
             self.pyx.dec_indent()
+            self.pyi.dec_indent()
 
         self.gen_factory_decl()
         self.gen_factory()
@@ -211,8 +225,10 @@ def gen_factory(self):
         self.pyx.println("cdef Factory _inst = None")
         self.pxd.println("cdef class Factory(object):")
         self.pyx.println("cdef class Factory(object):")
+        self.pyi.println("class Factory(object):")
         self.pxd.inc_indent()
         self.pyx.inc_indent()
+        self.pyi.inc_indent()
         self.pxd.println("cdef %s_decl.IFactory *_hndl" % (self.name,))
 
         for c in self.ast.classes:
@@ -221,6 +237,9 @@ def gen_factory(self):
             PyExtGenParams.gen_ctor_params(
                 self.name, c, self.pxd, is_pydecl=True, is_pytype=True, ins_self=True)
             self.pxd.write(")\n")
+            self.pyi.write("%sdef mk%s(" % (self.pyi.ind, name))
+            PyExtGenParams.gen_ctor_params_pyi(self.name, c, self.pyi)
+            self.pyi.write(") -> '%s': ...\n" % c.name)
 
             self.pyx.print("cpdef %s mk%s(" % (c.name, name))
             self.pyx.inc_indent(2) 
@@ -287,9 +306,14 @@ def gen_factory(self):
 
         self.pyx.println("return _inst")
         self.pyx.dec_indent()
+
+        self.pyi.println("@staticmethod")
+        self.pyi.println("def inst() -> 'Factory': ...")
+        self.pyi.println()
 
         self.pxd.dec_indent()
         self.pyx.dec_indent()
+        self.pyi.dec_indent()
 
     def visitAstClass(self, c : AstClass):
 
@@ -317,20 +341,27 @@ def visitAstClass(self, c : AstClass):
                 c.name, PyExtTypeNameGen(ns=self.name,is_pytype=True).gen(c.super)))
             self.pxd.println("cdef class %s(%s):" % (
                 c.name, PyExtTypeNameGen(self.name, is_pytype=True).gen(c.super)))
+            self.pyi.println("class %s(%s):" % (
+                c.name, PyExtTypeNameGen(self.name, is_pytype=True).gen(c.super)))
         else:
             self.pyx.println("cdef class %s(object):" % c.name)
             self.pxd.println("cdef class %s(object):" % c.name)
+            self.pyi.println("class %s(object):" % c.name)
 
 
         self.pyx.inc_indent()
         self.pxd.inc_indent()
+        self.pyi.inc_indent()
+
+        self.pyi.println("pass")
 
         if c.super is None:
             self.pxd.println("cdef %s_decl.I%s    *_hndl" % (self.name, c.name))
             self.pxd.println("cdef bool           _owned")
 
         self.pyx.println()
         self.pxd.println()
+        self.pyi.println()
 
         if c.super is None:
             self.pyx.println("def __dealloc__(self):")
@@ -406,7 +437,7 @@ def visitAstClass(self, c : AstClass):
 #         self.pyx.println()
 
         for d in c.data:
-            PyExtAccessorGen(self.name, c.name, self.decl_pxd, self.pxd, self.pyx).gen(d)
+            PyExtAccessorGen(self.name, c.name, self.decl_pxd, self.pxd, self.pyx, self.pyi).gen(d)
 
         if len(c.data) == 0:
             self.decl_pxd.println("pass")
@@ -421,6 +452,7 @@ def visitAstClass(self, c : AstClass):
         self.decl_pxd.dec_indent()        
         self.pyx.dec_indent()        
         self.pxd.dec_indent()
+        self.pyi.dec_indent()
 
         self.decl_pxd.println()
         self.pyx.println()

src/astbuilder/pyext_type_name_gen_pyi.py

@@ -0,0 +1,90 @@
+
+from astbuilder.type_pointer import PointerKind
+from astbuilder.type_scalar import TypeScalar, TypeKind
+
+from .type_pointer import TypePointer
+from .visitor import Visitor
+from astbuilder.ast_enum import AstEnum
+from astbuilder.ast_flags import AstFlags
+from astbuilder.ast_struct import AstStruct
+
+
+class PyExtTypeNameGenPyi(Visitor):
+    
+    def __init__(self, ns, is_ret=False):
+        self.out = ""
+        self.ns = ns
+        self.is_ret = is_ret
+        self.depth = 0
+        
+    def gen(self, t):
+        self.out = ""
+        t.accept(self)
+        return self.out
+
+    def visitAstEnum(self, e : AstEnum):
+#        print("is_pydecl=%s is_pytype=%s" % (self.is_pydecl, self.is_pytype))
+        self.out += e.name
+    
+    def visitAstFlags(self, f : AstFlags):
+        self.out += f.name
+    
+    def visitTypeList(self, t):
+        if self.depth == 0:
+            self.depth += 1
+            
+            self.out += "List["
+            self.out += PyExtTypeNameGenPyi(ns=self.ns).gen(t.t)
+            self.out += "]"
+        
+            self.depth -= 1
+        else:
+            self.out += PyExtTypeNameGenPyi(ns=self.ns).gen(t)
+
+    def visitTypeMap(self, t):
+        if self.depth == 0:
+            self.depth += 1
+            
+            self.out += "Dict["
+            self.out += PyExtTypeNameGenPyi(ns=self.ns).gen(t.kt)
+            self.out += ","
+            self.out += PyExtTypeNameGenPyi(ns=self.ns).gen(t.vt)
+            self.out += "]"
+        
+            self.depth -= 1
+        else:
+            self.out += PyExtTypeNameGenPyi(ns=self.ns).gen(t)
+        
+    def visitTypePointer(self, t : TypePointer):
+        if self.depth == 0:
+            self.depth += 1
+            Visitor.visitTypePointer(self, t)
+            self.depth -= 1
+        else:
+            self.out += PyExtTypeNameGenPyi(ns=self.ns).gen(t)
+
+    def visitTypeScalar(self, t : TypeScalar):
+        vmap = {
+            TypeKind.String : "str",
+            TypeKind.Bool : "bool",
+            TypeKind.Int8: "int",
+            TypeKind.Uint8: "int",
+            TypeKind.Int16: "int",
+            TypeKind.Uint16: "int",
+            TypeKind.Int32: "int",
+            TypeKind.Uint32: "int",
+            TypeKind.Int64: "int",
+            TypeKind.Uint64: "int",
+            }
+        self.out += vmap[t.t]
+    
+    def visitAstStruct(self, s : AstStruct):
+        self.out += s.name
+
+    def visitTypeUserDef(self, t):
+        if isinstance(t.target, (AstEnum,AstFlags)):
+            t.target.accept(self)
+        elif isinstance(t.target, (AstStruct,)):
+            self.out += "%s" % t.name
+        else:
+            self.out += "%s" % t.name