1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
#-----------------------------------------------------------------------------
# Copyright (c) 2005-2023, PyInstaller Development Team.
#
# Distributed under the terms of the GNU General Public License (version 2
# or later) with exception for distributing the bootloader.
#
# The full license is in the file COPYING.txt, distributed with this software.
#
# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)
#-----------------------------------------------------------------------------
import os
import pathlib
import shutil
import pytest
from PyInstaller.compat import is_win, is_darwin
# Bring all common fixtures into this file.
from PyInstaller.utils.conftest import * # noqa: F401, F403
# A fixture that compiles a test shared library from `data/load_dll_using_ctypes/ctypes_dylib.c` in a sub-directory
# of the tmp_dir, and returns path to the compiled shared library.
#
# NOTE: for this fixture to be session-scoped, we need to define it here (as opposed to `PyInstaller.utils.confest`).
# This is because its data directory needs to be resolved based on this module's location. (And even if we were to use
# test-scoped fixture and infer location from `request.path`, the fixture would be valid only for test files from this
# directory).
@pytest.fixture(scope="session")
def compiled_dylib(tmp_path_factory):
# Copy the source to temporary directory.
orig_source_dir = pathlib.Path(__file__).parent / 'data' / 'ctypes_dylib'
tmp_source_dir = tmp_path_factory.mktemp('compiled_ctypes_dylib')
shutil.copy2(orig_source_dir / 'ctypes_dylib.c', tmp_source_dir)
# Compile shared library using `distuils.ccompiler` module. The code is loosely based on implementation of the
# `distutils.command.build_ext` command module.
def _compile_dylib(source_dir):
# Until python 3.12, `distutils` was part of standard library. For newer python versions, `setuptools` provides
# its vendored copy. If neither are available, skip the test.
try:
import distutils.ccompiler
import distutils.sysconfig
except ImportError:
pytest.skip('distutils.ccompiler is not available')
# Set up compiler
compiler = distutils.ccompiler.new_compiler()
distutils.sysconfig.customize_compiler(compiler)
if hasattr(compiler, 'initialize'): # Applicable to MSVCCompiler on Windows.
compiler.initialize()
if is_win:
# With MinGW compiler, the `customize_compiler()` call ends up changing `compiler.shared_lib_extension` into
# ".pyd". Use ".dll" instead.
suffix = '.dll'
elif is_darwin:
# On macOS, `compiler.shared_lib_extension` is ".so", but ".dylib" is more appropriate.
suffix = '.dylib'
else:
suffix = compiler.shared_lib_extension
# Change the current working directory to the directory that contains source files. Ideally, we could pass the
# absolute path to sources to `compiler.compile()` and set its `output_dir` argument to the directory where
# object files should be generated. However, in this case, the object files are put under output directory
# *while retaining their original path component*. If `output_dir` is not specified, then the original absolute
# source file paths seem to be turned into relative ones (e.g, on Linux, the leading / is stripped away).
#
# NOTE: with python >= 3.11 we could use contextlib.chdir().
old_cwd = pathlib.Path.cwd()
os.chdir(source_dir)
try:
# Compile source .c file into object
sources = [
'ctypes_dylib.c',
]
objects = compiler.compile(sources)
# Link into shared library
output_filename = f'ctypes_dylib{suffix}'
compiler.link_shared_object(
objects,
output_filename,
target_lang='c',
export_symbols=['add_twelve'],
)
finally:
os.chdir(old_cwd) # Restore old working directory.
# Return path to compiled shared library
return source_dir / output_filename
try:
return _compile_dylib(tmp_source_dir)
except Exception as e:
pytest.skip(f"Could not compile test shared library: {e}")
|
