Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# -*- coding: utf-8 -*-
2"""
3@file
4@brief Module *manypi*.
5Many pieces of code to access and process various API
6mostly used for teaching purpose.
7"""
8import sys
11__version__ = "0.2.77"
12__author__ = "Xavier Dupré"
13__github__ = "https://github.com/sdpython/manydataapi"
14__url__ = "http://www.xavierdupre.fr/app/manydataapi/helpsphinx/index.html"
15__license__ = "MIT License"
18def _setup_hook(add_print=False, unit_test=False):
19 """
20 if this function is added to the module,
21 the help automation and unit tests call it first before
22 anything goes on as an initialization step.
23 It should be run in a separate process.
25 @param add_print print *Success: _setup_hook*
26 @param unit_test used only for unit testing purpose
27 """
28 # we can check many things, needed module
29 # any others things before unit tests are started
30 if add_print: # pragma: no cover
31 print("Success: _setup_hook")
34def check(log=False):
35 """
36 Checks the library is working.
37 It raises an exception.
39 @param log if True, display information, otherwise
40 @return 0 or exception
41 """
42 return True # pragma: no cover