Source

class Source(*args, **kwargs)

The GSource struct is an opaque data type representing an event source.

Methods

class Source
finalize()
get_current_time()

This function ignores source and is otherwise the same as get_current_time().

Deprecated since version 2.28: use get_time() instead

set_callback(fn, user_data=None)

Sets the callback function for a source. The callback for a source is called from the source’s dispatch function.

The exact type of func depends on the type of source; ie. you should not count on func being called with data as its first parameter. Cast func with SOURCE_FUNC() to avoid warnings about incompatible function types.

See [memory management of sources][mainloop-memory-management] for details on how to handle memory management of data.

Typically, you won’t use this function. Instead use functions specific to the type of source you are using, such as idle_add() or timeout_add().

It is safe to call this function multiple times on a source which has already been attached to a context. The changes will take effect for the next time the source is dispatched after this call returns.

Note that destroy() for a currently attached source has the effect of also unsetting the callback.

Parameters:
  • fn

  • user_data

Fields

class Source
can_recurse
priority