pg.wrap_module¶

Accessible via pg.wrap_module, pg.symbolic.wrap_module.

wrap_module(module, names=None, where=None, export_to=None, **kwargs)[source]¶

Wrap classes from a module.

For example, users can wrap all subclasses of xxx.Base under module xxx:

import xxx

pg.wrap_module(
  xxx, where=lambda c: isinstance(c, xxx.Base))

Parameters:

module – A container that contains classes to wrap.
names – An optional list of class names. If not provided, all classes under module will be considered candidates.
where – An optional filter function in signature (user_class) -> bool. Only the classes under module with True return value will be wrapped.
export_to – An optional module to export the wrapper classes.
**kwargs – Keyword arguments passed to wrap

Returns:

Wrapper classes.