API reference

This section contains the API reference and usage information for PyCTest.

PyCTest Modules:

PyCTest is an extension that directly hooks into the CMake/CTest libraries. Instead of generating CMake/CTest files, it use the library itself. Since the CMake version is directly controlled as a git submodule, there are no external compatibility issues.

version_info List of version fields
build_info Build information
version Version string
cmake_executable Path to CMake executable
ctest_executable Path to CTest executable
cpack_executable Path to CPack executable

Prints the PyCTest banner at first import

Set PYCTEST_VERBOSE=<INT> or PYCTEST_BANNER=<BOOL or INT> to control banner settings. Default is ON.

pyctest.version_info = (0, 0, 12)

List of version fields

pyctest.build_info = {'build_type': 'MinSizeRel', 'compiler': '/home/conda/feedstock_root/build_artifacts/pyctest_1546027739524/_build_env/bin/x86_64-conda_cos6-linux-gnu-c++', 'compiler_id': 'GNU', 'compiler_version': '7.3.0', 'date': 'Fri Dec 28 20:09:42 2018 UTC', 'library_architecture': 'x86_64', 'system_name': 'Linux', 'system_version': '4.4.0-96-generic'}

Build information

pyctest.version = '0.0.12'

Version string

pyctest.cmake_executable = '/home/docs/checkouts/readthedocs.org/user_builds/pyctest/conda/latest/lib/python3.7/site-packages/pyctest/bin/cmake'

Path to CMake executable

pyctest.ctest_executable = '/home/docs/checkouts/readthedocs.org/user_builds/pyctest/conda/latest/lib/python3.7/site-packages/pyctest/bin/ctest'

Path to CTest executable

pyctest.cpack_executable = '/home/docs/checkouts/readthedocs.org/user_builds/pyctest/conda/latest/lib/python3.7/site-packages/pyctest/bin/cpack'

Path to CPack executable