[WIP] stub generation (Reboot)

pgidocgen/docobj.py

@@ -338,6 +338,7 @@ def from_object(cls, repo, parent_fullname, sig):
             print("FIXME: signal: %s " % inst.fullname)
             signature_desc = "(FIXME pgi-docgen: arguments are missing here)"
 
+        inst.full_signature = fsig
         inst.signature_desc = signature_desc
         inst.info = DocInfo.from_object(repo, "signals", inst,
                                         current_type=parent_fullname)
@@ -653,6 +654,7 @@ def from_object(cls, repo, parent_fullname, field_info):
         name = field_info.name
         field = cls(parent_fullname, name)
 
+        field.py_type = field_info.py_type
         field.type_desc = py_type_to_class_ref(field_info.py_type)
         field.readable = field_info.readable
         field.writable = field_info.writeable
@@ -793,6 +795,7 @@ def render(docs):
                     signature = get_signature_string(obj)
 
         assert signature
+        instance.full_signature = func_sig
         instance.signature_desc = signature_desc
         instance.signature = signature
         instance.info.desc = desc
@@ -887,12 +890,13 @@ def from_object(cls, repo, obj):
 
 class Constant(BaseDocObject):
 
-    def __init__(self, parent_fullname, name, value):
+    def __init__(self, parent_fullname, name, value, py_type):
         self.fullname = parent_fullname + "." + name
         self.name = name
         self.info = None
 
         self.value = value
+        self.py_type = py_type
 
     @classmethod
     def from_object(cls, repo, parent_fullname, name, obj):
@@ -904,7 +908,7 @@ def from_object(cls, repo, parent_fullname, name, obj):
         else:
             value = repr(obj)
 
-        instance = Constant(parent_fullname, name, value)
+        instance = Constant(parent_fullname, name, value, type(obj))
         instance.info = DocInfo.from_object(repo, "all", instance)
         return instance
 

pgidocgen/main.py

@@ -9,7 +9,12 @@
 
 import argparse
 
-from . import create, build, stubs, create_debian, update
+from . import create, build, stubs, update
+
+try:
+    from . import create_debian
+except ImportError:
+    create_debian = None
 
 
 def main(argv):
@@ -19,7 +24,8 @@ def main(argv):
     create.add_parser(subparser)
     build.add_parser(subparser)
     stubs.add_parser(subparser)
-    create_debian.add_parser(subparser)
+    if create_debian:
+        create_debian.add_parser(subparser)
     update.add_parser(subparser)
 
     args = parser.parse_args(argv[1:])

pgidocgen/namespace.py

@@ -545,6 +545,20 @@ def is_available(mod, name):
     return types, type_structs, shadow_map, instance_params
 
 
+def _is_empty_text_node(child) -> bool:
+    return (
+        child.nodeType == child.TEXT_NODE and
+        not child.data.strip()
+    )
+
+
+def _is_source_position_node(child) -> bool:
+    return (
+        child.nodeType == child.ELEMENT_NODE and
+        child.tagName == 'source-position'
+    )
+
+
 def _parse_private(dom, namespace):
     private = set()
 
@@ -563,8 +577,15 @@ def is_empty(node):
         is_gtype_struct = bool(record.getAttribute("glib:is-gtype-struct-for"))
         is_private = record.getAttribute("name").endswith("Private")
         if is_private and not is_gtype_struct and is_empty(record):
-            name = namespace + "." + record.getAttribute("name")
-            private.add(name)
+
+            meaningful_children = [
+                c for c in record.childNodes
+                if not _is_empty_text_node(c) and not _is_source_position_node(c)
+            ]
+
+            if not meaningful_children:
+                name = namespace + "." + record.getAttribute("name")
+                private.add(name)
 
     return private
 

pgidocgen/stuboverrides.py

@@ -0,0 +1,80 @@
+
+PROPERTY_STUB = """# TODO: Constrain T if possible. Builtins + GTypes might be sufficient?
+T = typing.TypeVar('T')
+
+PropertyGetterFn = typing.Callable[[typing.Any], T]
+PropertySetterFn = typing.Callable[[typing.Any, T], None]
+
+
+class Property(typing.Generic[T]):
+
+    name: typing.Optional[str]
+    type: typing.Type[T]
+    default: typing.Optional[T]
+    nick: str
+    blurb: str
+    flags: ParamFlags
+    minimum: typing.Optional[T]
+    maximum: typing.Optional[T]
+
+    def __init__(
+        self,
+        getter: typing.Optional[PropertyGetterFn[T]] = None,
+        setter: typing.Optional[PropertySetterFn[T]] = None,
+        type: typing.Optional[typing.Type[T]] = None,
+        default: typing.Optional[T] = None,
+        nick: str = '',
+        blurb: str = '',
+        flags: ParamFlags = ParamFlags.READWRITE,
+        minimum: typing.Optional[T] = None,
+        maximum: typing.Optional[T] = None,
+    ) -> None:
+        ...
+
+    def __get__(self, instance: typing.Any, klass: typing.Type) -> T:
+        ...
+
+    def __set__(self, instance: typing.Any, value: T) -> None:
+        ...
+
+    def __call__(self, PropertyGetterFn) -> Property[T]:
+        ...
+
+    def getter(self: Property[T], fget: PropertyGetterFn) -> Property[T]:
+        ...
+
+    def setter(self: Property[T], fset: PropertySetterFn) -> Property[T]:
+        ...
+
+    # TODO: There's three Tuple variant structures that could be
+    # returned here, and they're all unpleasantly complicated.
+    def get_pspec_args(self) -> typing.Sequence[typing.Any]:
+        ...
+"""
+
+FLAGS_TYPEVAR = """FlagsT = typing.TypeVar('FlagsT')
+"""
+
+
+#: Map of namespace to additional manually-written stub classes that
+#: should be added to the top of the generated stub.
+NAMESPACE_OVERRIDES = {
+    'GLib': [
+        FLAGS_TYPEVAR,
+    ],
+    'GObject': [
+        PROPERTY_STUB,
+    ],
+}
+
+#: Map of class full name to attributes to be added to the class.
+OBJECT_OVERRIDES = {
+    'GLib.Flags': [
+        'def __or__(self: FlagsT, other: typing.Union[int, FlagsT]) -> FlagsT: ...',
+        'def __and__(self: FlagsT, other: typing.Union[int, FlagsT]) -> FlagsT: ...',
+        'def __xor__(self: FlagsT, other: typing.Union[int, FlagsT]) -> FlagsT: ...',
+    ],
+    'GObject.Object': [
+        'Property = Property',
+    ],
+}