summaryrefslogtreecommitdiff
path: root/setup.py
blob: 500be62a98a840f4ceae014964bad8db8df5c5b5 (plain)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
import os
import platform
import sys

from setuptools import __version__
from setuptools import Distribution as _Distribution
from setuptools import setup

if not int(__version__.partition(".")[0]) >= 47:
    raise RuntimeError(f"Setuptools >= 47 required. Found {__version__}")

# attempt to use pep-632 imports for setuptools symbols; however,
# since these symbols were only added to setuptools as of 59.0.1,
# fall back to the distutils symbols otherwise
try:
    from setuptools.errors import CCompilerError
    from setuptools.errors import DistutilsExecError
    from setuptools.errors import DistutilsPlatformError
except ImportError:
    from distutils.errors import CCompilerError
    from distutils.errors import DistutilsExecError
    from distutils.errors import DistutilsPlatformError

try:
    from Cython.Distutils.old_build_ext import old_build_ext
    from Cython.Distutils.extension import Extension

    CYTHON = True
except ImportError:
    CYTHON = False

cmdclass = {}

cpython = platform.python_implementation() == "CPython"

ext_errors = (CCompilerError, DistutilsExecError, DistutilsPlatformError)
extra_compile_args = []
if sys.platform == "win32":
    # Work around issue https://github.com/pypa/setuptools/issues/1902
    ext_errors += (IOError, TypeError)

cython_files = [
    "collections.pyx",
    "immutabledict.pyx",
    "processors.pyx",
    "resultproxy.pyx",
    "util.pyx",
]
cython_directives = {"language_level": "3"}

if CYTHON:

    def get_ext_modules():
        module_prefix = "sqlalchemy.cyextension."
        source_prefix = "lib/sqlalchemy/cyextension/"

        ext_modules = []
        for file in cython_files:
            name, _ = os.path.splitext(file)
            ext_modules.append(
                Extension(
                    module_prefix + name,
                    sources=[source_prefix + file],
                    extra_compile_args=extra_compile_args,
                    cython_directives=cython_directives,
                )
            )
        return ext_modules

    class BuildFailed(Exception):
        pass

    class ve_build_ext(old_build_ext):
        # This class allows Cython building to fail.

        def run(self):
            try:
                super().run()
            except DistutilsPlatformError:
                raise BuildFailed()

        def build_extension(self, ext):
            try:
                super().build_extension(ext)
            except ext_errors as e:
                raise BuildFailed() from e
            except ValueError as e:
                # this can happen on Windows 64 bit, see Python issue 7511
                if "'path'" in str(e):
                    raise BuildFailed() from e
                raise

    cmdclass["build_ext"] = ve_build_ext
    ext_modules = get_ext_modules()
else:
    ext_modules = []


class Distribution(_Distribution):
    def has_ext_modules(self):
        # We want to always claim that we have ext_modules. This will be fine
        # if we don't actually have them (such as on PyPy) because nothing
        # will get built, however we don't want to provide an overally broad
        # Wheel package when building a wheel without C support. This will
        # ensure that Wheel knows to treat us as if the build output is
        # platform specific.
        return True


def status_msgs(*msgs):
    print("*" * 75)
    for msg in msgs:
        print(msg)
    print("*" * 75)


def run_setup(with_cext):
    kwargs = {}
    if with_cext:
        kwargs["ext_modules"] = ext_modules
    else:
        if os.environ.get("REQUIRE_SQLALCHEMY_CEXT"):
            raise AssertionError(
                "Can't build on this platform with REQUIRE_SQLALCHEMY_CEXT"
                " set. Cython is required to build compiled extensions"
            )

        kwargs["ext_modules"] = []

    setup(cmdclass=cmdclass, distclass=Distribution, **kwargs)


if not cpython:
    run_setup(False)
    status_msgs(
        "WARNING: Cython extensions are not supported on "
        "this Python platform, speedups are not enabled.",
        "Plain-Python build succeeded.",
    )
elif not CYTHON:
    run_setup(False)
    status_msgs(
        "WARNING: Cython is required to build the compiled "
        "extensions, speedups are not enabled.",
        "Plain-Python build succeeded.",
    )
elif os.environ.get("DISABLE_SQLALCHEMY_CEXT"):
    run_setup(False)
    status_msgs(
        "DISABLE_SQLALCHEMY_CEXT is set; "
        "not attempting to build Cython extensions.",
        "Plain-Python build succeeded.",
    )
else:
    try:
        run_setup(True)
    except BuildFailed as exc:

        if os.environ.get("REQUIRE_SQLALCHEMY_CEXT"):
            status_msgs(
                "NOTE: Cython extension build is required because "
                "REQUIRE_SQLALCHEMY_CEXT is set, and the build has failed; "
                "will not degrade to non-C extensions"
            )
            raise

        status_msgs(
            exc.cause,
            "WARNING: The Cython extension could not be compiled, "
            "speedups are not enabled.",
            "Failure information, if any, is above.",
            "Retrying the build without the C extension now.",
        )

        run_setup(False)

        status_msgs(
            "WARNING: The Cython extension could not be compiled, "
            "speedups are not enabled.",
            "Plain-Python build succeeded.",
        )