Improving documentation for Signals in Python

Jhanarato · February 7, 2025, 9:02am

This page contains the only API documentation I can find for the GObject.Signal decorator:

https://pygobject.gnome.org/guide/api/signals.html#gi.repository.GObject.Signal

I’ve been writing some learning tests, and perhaps they could be used to improve it:

tests/test_learn_signals.py

master

import pytest

from gi.repository import Gio, GObject, Gtk


class NoargSignaller(GObject.Object):
    @GObject.Signal
    def noarg_signal(self) -> None:
        pass

def test_noarg_signal():
    called = False

    def handler(instance: NoargSignaller):
        assert isinstance(instance, NoargSignaller)
        nonlocal called
        called = True

    signaller = NoargSignaller()
    signaller.connect("noarg-signal", handler)

This file has been truncated. show original

I’m still very new to GTK in general, but I’m happy to help.

Cheers,

J.R.

Sid · February 12, 2025, 5:54pm

The source file resides in https://gitlab.gnome.org/GNOME/pygobject/-/blob/main/docs/guide/api/signals.rst.

Please get in touch with the pygobject devs before starting.