src/tools/docwriter/check.py

#
#  check.py
#
#    Check if all external modules are present.
#
#  Copyright 2018 by
#  Nikhil Ramakrishnan.
#
#  This file is part of the FreeType project, and may only be used,
#  modified, and distributed under the terms of the FreeType project
#  license, LICENSE.TXT.  By continuing to use, modify, or distribute
#  this file you indicate that you have read the license and
#  understand and accept it fully.

"""Utility to check if all required modules are available.

The list of required modules can be modified in this file.

Usage:
    import check
    status = check.check()
"""

import logging

log = logging.getLogger( __name__ )

#
# Required imports
# Note that this is not the package name, but the module name as would be
# used in an import statement.
#
import_list = ["mistune", "yaml"]

def check():
    """Check if all required modules are present.

    Returns 0 on success, non-zero on error.
    """
    flag = 0
    for package in import_list:
        try:
            exec( "import " + package )
        except Exception:
            log.error( "Missing module: %s", package )
            flag = True
    if flag:
        return 1
    return 0

# eof