module __init__

Short summary

module pyquickhelper

Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers…

source on GitHub

Functions

function

truncated documentation

_setup_hook

if this function is added to the module, the help automation and unit tests call it first before anything goes on …

check

Checks the library is working. It raises an exception if it does not.

get_fLOG

return a logging function

get_insetup_functions

Returns function used when a module includes C++ parts.

load_ipython_extension

to allow the call %load_ext pyquickhelper

Documentation

Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers…

source on GitHub

pyquickhelper._setup_hook(add_print=False, unit_test=False)[source][source]

if this function is added to the module, the help automation and unit tests call it first before anything goes on as an initialization step. It should be run in a separate process.

Parameters
  • add_print – print Success: _setup_hook

  • unit_test – used only for unit testing purpose

source on GitHub

pyquickhelper.check()[source][source]

Checks the library is working. It raises an exception if it does not.

Returns

boolean

source on GitHub

pyquickhelper.get_fLOG(log=True)[source][source]

return a logging function

Parameters

log – True, return fLOG, otherwise noLOG()

Returns

function

source on GitHub

pyquickhelper.get_insetup_functions()[source][source]

Returns function used when a module includes C++ parts.

Returns

tuple of functions

source on GitHub

pyquickhelper.load_ipython_extension(ip)[source][source]

to allow the call %load_ext pyquickhelper

Parameters

ip – from get_ipython()

source on GitHub