# Copyright (c) 2017 CEF Python, see the Authors file.
# All rights reserved. Licensed under BSD 3-clause license.
# Project website: https://github.com/cztomczak/cefpython
"""
Build the cefpython module, install package and run example.
Before running you must first put cefpython ready CEF binaries and
libraries in the cefpython/build/ directory (create if doesn't exist).
You have two options for obtaining these binaries and libraries.
Option 1: Download upstream CEF binaries and libraries from cefpython
GitHub Releases page. These binaries are tagged eg. "v55-upstream".
Extract the archive so that for example you have such a directory:
cefpython/build/cef55_3.2883.1553.g80bd606_win32/ .
Option 2: Use the automate.py tool. With this tool you can build CEF
from sources or use ready binaries from Spotify Automated Builds.
Usage:
build.py VERSION [--rebuild-cpp] [--unittests] [--fast] [--clean] [--kivy]
[--hello-world] [--enable-profiling]
[--enable-line-tracing]
Options:
VERSION Version number eg. 50.0
--unittests Run only unit tests. Do not run examples while
building cefpython modules. Examples require
interaction such as closing window before proceeding.
--fast Fast mode
--clean Clean C++ projects build files on Linux/Mac
--kivy Run only Kivy example
--hello-world Run only Hello World example
--enable-profiling Enable cProfile profiling
--enable-line-tracing Enable cProfile line tracing
"""
# --rebuild-cpp Force rebuild of .vcproj C++ projects (DISABLED)
# NOTE: When passing string command to subprocess functions you must
# always use shell=True, otherwise on Linux error is thrown:
# "No such file or directory". Always pass string commands to
# subprocess functions with shell=True. If you pass a list of
# arguments instead, then on Linux a "Segmentation fault" error
# message is not shown. When passing a list of args to subprocess
# function then you can't pass shell=True on Linux. If you pass
# then it will execute args[0] and ignore others args.
# NOTE 2: When calling os.system() returned value may be 256 when eg.
# when running unit tests fail. If you pass 256 to sys.exit
# an undefined result will occur. In my case on Linux it caused
# that other script that called it sys.exit(256) was interpreted
# for the script execute successfully. So never pass to sys.exit
# a value returned from os.system. Check the value and call
# sys.exit(1).
# How to debug on Linux (OLD unsupported).
# 1. Install "python-dbg" package
# 2. Install "python-wxgtk2.8-dbg" package
# 3. Run "python compile.py debug"
# 4. In cygdb type "cy run"
# 5. To display debug backtrace type "cy bt"
# 6. More commands: http://docs.cython.org/src/userguide/debugging.html
from common import *
import copy
import sys
import os
import glob
import shutil
import subprocess
import re
# raw_input() was renamed to input() in Python 3
try:
# noinspection PyUnresolvedReferences
# noinspection PyShadowingBuiltins
input = raw_input
except NameError:
pass
# Command line args variables
SYS_ARGV_ORIGINAL = None
VERSION = ""
UNITTESTS = False
DEBUG_FLAG = False
FAST_FLAG = False
CLEAN_FLAG = False
KIVY_FLAG = False
HELLO_WORLD_FLAG = False
REBUILD_CPP = False
ENABLE_PROFILING = False
ENABLE_LINE_TRACING = False
# First run
FIRST_RUN = False
def main():
command_line_args()
print("[build.py] Python version: {ver} {arch}"
.format(ver=platform.python_version(), arch=ARCH_STR))
print("[build.py] Python executable: %s" % sys.executable)
print("[build.py] PYVERSION = %s" % PYVERSION)
print("[build.py] OS_POSTFIX2 = %s" % OS_POSTFIX2)
check_cython_version()
check_directories()
setup_environ()
if os.path.exists(CEFPYTHON_API_HFILE):
fix_cefpython_api_header_file()
if WINDOWS:
compile_cpp_projects_with_setuptools()
elif MAC or LINUX:
compile_cpp_projects_unix()
else:
print("[build.py] INFO: Looks like first run, as"
" cefpython_py{pyver}.h is missing. Skip building"
" C++ projects."
.format(pyver=PYVERSION))
global FIRST_RUN
FIRST_RUN = True
clear_cache()
copy_and_fix_pyx_files()
build_cefpython_module()
fix_cefpython_api_header_file()
install_and_run()
def command_line_args():
global DEBUG_FLAG, FAST_FLAG, CLEAN_FLAG, KIVY_FLAG, HELLO_WORLD_FLAG, \
REBUILD_CPP, VERSION, UNITTESTS
VERSION = get_version_from_command_line_args(__file__)
# Other scripts called by this script expect that version number
# is available in sys.argv, so don't remove it like it's done
# for all other args starting with "--".
if not VERSION:
print(__doc__)
sys.exit(1)
print("[build.py] Parse command line arguments")
global SYS_ARGV_ORIGINAL
SYS_ARGV_ORIGINAL = copy.copy(sys.argv)
if "--unittests" in sys.argv:
UNITTESTS = True
print("[build.py] Running examples disabled (--unittests)")
sys.argv.remove("--unittests")
if "--debug" in sys.argv:
DEBUG_FLAG = True
print("[build.py] DEBUG mode On")
sys.argv.remove("--debug")
if "--fast" in sys.argv:
# Fast mode doesn't delete C++ .o .a files.
# Fast mode also disables optimization flags in setup/setup.py .
FAST_FLAG = True
print("[build.py] FAST mode On")
sys.argv.remove("--fast")
if "--clean" in sys.argv:
CLEAN_FLAG = True
sys.argv.remove("--clean")
if "--kivy" in sys.argv:
KIVY_FLAG = True
print("[build.py] KIVY example")
sys.argv.remove("--kivy")
if "--hello-world" in sys.argv:
HELLO_WORLD_FLAG = True
print("[build.py] HELLO WORLD example")
sys.argv.remove("--hello-world")
# Rebuild c++ projects
if "--rebuild-cpp" in sys.argv:
REBUILD_CPP = True
print("[build.py] REBUILD_CPP mode enabled")
sys.argv.remove("--rebuild-cpp")
global ENABLE_PROFILING
if "--enable-profiling" in sys.argv:
print("[build.py] cProfile profiling enabled")
ENABLE_PROFILING = True
sys.argv.remove("--enable-profiling")
global ENABLE_LINE_TRACING
if "--enable-line-tracing" in sys.argv:
print("[build.py] cProfile line tracing enabled")
ENABLE_LINE_TRACING = True
sys.argv.remove("--enable-line-tracing")
for arg in sys.argv:
if arg.startswith("--"):
print("ERROR: invalid arg {0}".format(arg))
sys.exit(1)
if len(sys.argv) > lib\\cefpython3'
shutil.rmtree(adir, ignore_errors=True)
else:
# On Linux sudo might be required to delete directory, as this
# might be a setup installer directory with package installed
# using sudo and in such case files were created with sudo.
command = "rm -rf {dir}".format(dir=adir)
command = sudo_command(command, python=sys.executable)
os.system(command)
if __name__ == "__main__":
main()