pybind_wrap.py

Go to the documentation of this file.

#!/usr/bin/env python3
"""
Helper script to wrap C++ to Python with Pybind.
This script is installed via CMake to the user's binary directory
and invoked during the wrapping by CMake.
"""
 
# pylint: disable=import-error
 
import argparse
 
from gtwrap.pybind_wrapper import PybindWrapper
 
 
def main():
    """Main runner."""
    arg_parser = argparse.ArgumentParser(
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    arg_parser.add_argument("--src",
                            type=str,
                            required=True,
                            help="Input interface .i/.h file(s)")
    arg_parser.add_argument(
        "--module_name",
        type=str,
        required=True,
        help="Name of the Python module to be generated and "
        "used in the Python `import` statement.",
    )
    arg_parser.add_argument(
        "--out",
        type=str,
        required=True,
        help="Name of the output pybind .cc file(s)",
    )
    arg_parser.add_argument(
        "--use-boost-serialization",
        action="store_true",
        help="Allow boost based serialization methods",
    )
    arg_parser.add_argument(
        "--top_module_namespaces",
        type=str,
        default="",
        help="C++ namespace for the top module, e.g. `ns1::ns2::ns3`. "
        "Only the content within this namespace and its sub-namespaces "
        "will be wrapped. The content of this namespace will be available at "
        "the top module level, and its sub-namespaces' in the submodules.\n"
        "For example, `import <module_name>` gives you access to a Python "
        "`<module_name>.Class` of the corresponding C++ `ns1::ns2::ns3::Class`"
        "and `from <module_name> import ns4` gives you access to a Python "
        "`ns4.Class` of the C++ `ns1::ns2::ns3::ns4::Class`. ",
    )
    arg_parser.add_argument(
        "--ignore",
        nargs='*',
        type=str,
        help="A space-separated list of classes to ignore. "
        "Class names must include their full namespaces.",
    )
    arg_parser.add_argument("--template",
                            type=str,
                            help="The module template file (e.g. module.tpl).")
    arg_parser.add_argument("--is_submodule",
                            default=False,
                            action="store_true")
    arg_parser.add_argument("--xml_source",
                            type=str,
                            default="",
                            help="The path to the Doxygen-generated XML documentation")
    args = arg_parser.parse_args()
 
    top_module_namespaces = args.top_module_namespaces.split("::")
    if top_module_namespaces[0]:
        top_module_namespaces = [''] + top_module_namespaces
 
    with open(args.template, "r", encoding="UTF-8") as f:
        template_content = f.read()
 
    wrapper = PybindWrapper(
        module_name=args.module_name,
        use_boost_serialization=args.use_boost_serialization,
        top_module_namespaces=top_module_namespaces,
        ignore_classes=args.ignore,
        module_template=template_content,
        xml_source=args.xml_source,
    )
 
    if args.is_submodule:
        wrapper.wrap_submodule(args.src)
 
    else:
        # Wrap the code and get back the cpp/cc code.
        sources = args.src.split(';')
        wrapper.wrap(sources, args.out)
 
 
if __name__ == "__main__":
    main()