blob: ab217433a3b0d37c89e5284ed0d7dd970869f87c [file] [log] [blame]
Craig Tiller6169d5f2016-03-31 07:46:18 -07001# Copyright 2015, Google Inc.
Nathaniel Manistab68f3d12015-01-23 21:32:47 +00002# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met:
7#
8# * Redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer.
10# * Redistributions in binary form must reproduce the above
11# copyright notice, this list of conditions and the following disclaimer
12# in the documentation and/or other materials provided with the
13# distribution.
14# * Neither the name of Google Inc. nor the names of its
15# contributors may be used to endorse or promote products derived from
16# this software without specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
Nathaniel Manistab8b0adf2015-01-29 00:30:51 +000030"""A setup module for the GRPC Python package."""
Ken Payson5998cd72016-08-10 15:39:43 -070031from distutils import cygwinccompiler
Masood Malekghassemiabdff3d2016-07-18 13:26:25 -070032from distutils import extension as _extension
Masood Malekghassemi398b06e2016-07-15 23:17:41 -070033from distutils import util
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070034import os
Masood Malekghassemid65632a2015-07-27 14:30:09 -070035import os.path
Masood Malekghassemiabdff3d2016-07-18 13:26:25 -070036import pkg_resources
Masood Malekghassemi586e3832016-06-03 19:29:12 -070037import platform
Masood Malekghassemi398b06e2016-07-15 23:17:41 -070038import re
Ken Paysonfe754b42016-06-23 12:32:07 -070039import shlex
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -080040import shutil
Alexander Staubo8eac91e2015-04-06 12:06:22 -040041import sys
Ken Payson1efb6012016-06-08 13:06:44 -070042import sysconfig
Nathaniel Manistab68f3d12015-01-23 21:32:47 +000043
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070044import setuptools
Masood Malekghassemib7e7b3f2015-12-17 00:16:49 -080045from setuptools.command import egg_info
46
47# Redirect the manifest template from MANIFEST.in to PYTHON-MANIFEST.in.
48egg_info.manifest_maker.template = 'PYTHON-MANIFEST.in'
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070049
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -050050PY3 = sys.version_info.major == 3
Masood Malekghassemi58a04942016-07-16 01:42:52 -070051PYTHON_STEM = os.path.join('src', 'python', 'grpcio')
52CORE_INCLUDE = ('include', '.',)
53BORINGSSL_INCLUDE = (os.path.join('third_party', 'boringssl', 'include'),)
54ZLIB_INCLUDE = (os.path.join('third_party', 'zlib'),)
Masood Malekghassemib928de82016-10-28 15:05:33 -070055README = os.path.join(PYTHON_STEM, 'README.rst')
Masood Malekghassemi116982e2015-12-11 15:53:38 -080056
Masood Malekghassemid65632a2015-07-27 14:30:09 -070057# Ensure we're in the proper directory whether or not we're being used by pip.
58os.chdir(os.path.dirname(os.path.abspath(__file__)))
Masood Malekghassemi58a1dc22016-01-21 14:23:55 -080059sys.path.insert(0, os.path.abspath(PYTHON_STEM))
Masood Malekghassemid65632a2015-07-27 14:30:09 -070060
Masood Malekghassemi116982e2015-12-11 15:53:38 -080061# Break import-style to ensure we can actually find our in-repo dependencies.
Ken Payson5998cd72016-08-10 15:39:43 -070062import _spawn_patch
Masood Malekghassemid65632a2015-07-27 14:30:09 -070063import commands
Masood Malekghassemi116982e2015-12-11 15:53:38 -080064import grpc_core_dependencies
Craig Tillerf008f062016-02-08 12:48:03 -080065import grpc_version
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070066
Ken Payson5998cd72016-08-10 15:39:43 -070067_spawn_patch.monkeypatch_spawn()
Masood Malekghassemi586e3832016-06-03 19:29:12 -070068
Masood Malekghassemidf97aec2016-01-11 16:19:14 -080069LICENSE = '3-clause BSD'
70
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070071# Environment variable to determine whether or not the Cython extension should
72# *use* Cython or use the generated C files. Note that this requires the C files
Masood Malekghassemif17f0f62016-07-08 12:07:49 -070073# to have been generated by building first *with* Cython support. Even if this
74# is set to false, if the script detects that the generated `.c` file isn't
75# present, then it will still attempt to use Cython.
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070076BUILD_WITH_CYTHON = os.environ.get('GRPC_PYTHON_BUILD_WITH_CYTHON', False)
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070077
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070078# Environment variable to determine whether or not to enable coverage analysis
79# in Cython modules.
80ENABLE_CYTHON_TRACING = os.environ.get(
81 'GRPC_PYTHON_ENABLE_CYTHON_TRACING', False)
82
Masood Malekghassemi2da46662016-10-25 15:57:48 -070083# Environment variable specifying whether or not there's interest in setting up
84# documentation building.
85ENABLE_DOCUMENTATION_BUILD = os.environ.get(
86 'GRPC_PYTHON_ENABLE_DOCUMENTATION_BUILD', False)
87
Masood Malekghassemi586e3832016-06-03 19:29:12 -070088# There are some situations (like on Windows) where CC, CFLAGS, and LDFLAGS are
89# entirely ignored/dropped/forgotten by distutils and its Cygwin/MinGW support.
90# We use these environment variables to thus get around that without locking
91# ourselves in w.r.t. the multitude of operating systems this ought to build on.
Masood Malekghassemid66be0b2016-07-07 11:24:39 -070092# We can also use these variables as a way to inject environment-specific
93# compiler/linker flags. We assume GCC-like compilers and/or MinGW as a
94# reasonable default.
95EXTRA_ENV_COMPILE_ARGS = os.environ.get('GRPC_PYTHON_CFLAGS', None)
96EXTRA_ENV_LINK_ARGS = os.environ.get('GRPC_PYTHON_LDFLAGS', None)
97if EXTRA_ENV_COMPILE_ARGS is None:
Ken Payson5998cd72016-08-10 15:39:43 -070098 EXTRA_ENV_COMPILE_ARGS = ''
99 if 'win32' in sys.platform and sys.version_info < (3, 5):
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700100 # We use define flags here and don't directly add to DEFINE_MACROS below to
101 # ensure that the expert user/builder has a way of turning it off (via the
102 # envvars) without adding yet more GRPC-specific envvars.
103 # See https://sourceforge.net/p/mingw-w64/bugs/363/
104 if '32' in platform.architecture()[0]:
105 EXTRA_ENV_COMPILE_ARGS += ' -D_ftime=_ftime32 -D_timeb=__timeb32 -D_ftime_s=_ftime32_s'
106 else:
107 EXTRA_ENV_COMPILE_ARGS += ' -D_ftime=_ftime64 -D_timeb=__timeb64'
108 elif "linux" in sys.platform or "darwin" in sys.platform:
Nicolas "Pixel" Noblee3e17d32016-08-20 01:45:32 +0200109 EXTRA_ENV_COMPILE_ARGS += ' -fvisibility=hidden -fno-wrapv'
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700110if EXTRA_ENV_LINK_ARGS is None:
Ken Payson5998cd72016-08-10 15:39:43 -0700111 EXTRA_ENV_LINK_ARGS = ''
112 if "linux" in sys.platform or "darwin" in sys.platform:
113 EXTRA_ENV_LINK_ARGS += ' -lpthread'
114 elif "win32" in sys.platform and sys.version_info < (3, 5):
115 msvcr = cygwinccompiler.get_msvcr()[0]
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700116 # TODO(atash) sift through the GCC specs to see if libstdc++ can have any
117 # influence on the linkage outcome on MinGW for non-C++ programs.
118 EXTRA_ENV_LINK_ARGS += (
119 ' -static-libgcc -static-libstdc++ -mcrtdll={msvcr} '
120 '-static'.format(msvcr=msvcr))
Nicolas "Pixel" Noblee3e17d32016-08-20 01:45:32 +0200121 if "linux" in sys.platform:
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700122 EXTRA_ENV_LINK_ARGS += ' -Wl,-wrap,memcpy'
Ken Payson5998cd72016-08-10 15:39:43 -0700123
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700124EXTRA_COMPILE_ARGS = shlex.split(EXTRA_ENV_COMPILE_ARGS)
125EXTRA_LINK_ARGS = shlex.split(EXTRA_ENV_LINK_ARGS)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700126
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700127CYTHON_EXTENSION_PACKAGE_NAMES = ()
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700128
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800129CYTHON_EXTENSION_MODULE_NAMES = ('grpc._cython.cygrpc',)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700130
Masood Malekghassemi3acddb22016-07-13 18:38:33 -0700131CYTHON_HELPER_C_FILES = ()
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800132
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700133CORE_C_FILES = tuple(grpc_core_dependencies.CORE_SOURCE_FILES)
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800134
Masood Malekghassemi387e1162016-01-05 10:16:12 -0800135EXTENSION_INCLUDE_DIRECTORIES = (
Masood Malekghassemi0cc27922016-01-22 16:32:41 -0800136 (PYTHON_STEM,) + CORE_INCLUDE + BORINGSSL_INCLUDE + ZLIB_INCLUDE)
Nathaniel Manistaa4ead5d2015-01-31 01:33:27 +0000137
Masood Malekghassemi10509a22016-02-03 13:32:22 -0800138EXTENSION_LIBRARIES = ()
Masood Malekghassemic9c53ee2016-02-03 10:30:23 -0800139if "linux" in sys.platform:
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800140 EXTENSION_LIBRARIES += ('rt',)
Masood Malekghassemi10509a22016-02-03 13:32:22 -0800141if not "win32" in sys.platform:
142 EXTENSION_LIBRARIES += ('m',)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700143if "win32" in sys.platform:
Ken Payson5998cd72016-08-10 15:39:43 -0700144 EXTENSION_LIBRARIES += ('advapi32', 'ws2_32',)
Nathaniel Manistaa4ead5d2015-01-31 01:33:27 +0000145
Masood Malekghassemi58a04942016-07-16 01:42:52 -0700146DEFINE_MACROS = (
147 ('OPENSSL_NO_ASM', 1), ('_WIN32_WINNT', 0x600),
148 ('GPR_BACKWARDS_COMPATIBILITY_MODE', 1),)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700149if "win32" in sys.platform:
Ken Payson5998cd72016-08-10 15:39:43 -0700150 DEFINE_MACROS += (('WIN32_LEAN_AND_MEAN', 1),)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700151 if '64bit' in platform.architecture()[0]:
152 DEFINE_MACROS += (('MS_WIN64', 1),)
Ken Payson5998cd72016-08-10 15:39:43 -0700153 elif sys.version_info >= (3, 5):
154 # For some reason, this is needed to get access to inet_pton/inet_ntop
155 # on msvc, but only for 32 bits
156 DEFINE_MACROS += (('NTDDI_VERSION', 0x06000000),)
Masood Malekghassemi743c10c2015-06-16 18:05:27 -0700157
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700158LDFLAGS = tuple(EXTRA_LINK_ARGS)
159CFLAGS = tuple(EXTRA_COMPILE_ARGS)
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800160if "linux" in sys.platform or "darwin" in sys.platform:
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -0500161 pymodinit_type = 'PyObject*' if PY3 else 'void'
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -0500162 pymodinit = '__attribute__((visibility ("default"))) {}'.format(pymodinit_type)
163 DEFINE_MACROS += (('PyMODINIT_FUNC', pymodinit),)
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800164
Ken Payson1efb6012016-06-08 13:06:44 -0700165# By default, Python3 distutils enforces compatibility of
166# c plugins (.so files) with the OSX version Python3 was built with.
167# For Python3.4, this is OSX 10.6, but we need Thread Local Support (__thread)
168if 'darwin' in sys.platform and PY3:
169 mac_target = sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET')
170 if mac_target and (pkg_resources.parse_version(mac_target) <
171 pkg_resources.parse_version('10.7.0')):
172 os.environ['MACOSX_DEPLOYMENT_TARGET'] = '10.7'
Masood Malekghassemi398b06e2016-07-15 23:17:41 -0700173 os.environ['_PYTHON_HOST_PLATFORM'] = re.sub(
174 r'macosx-[0-9]+\.[0-9]+-(.+)',
175 r'macosx-10.7-\1',
176 util.get_platform())
Ken Payson1efb6012016-06-08 13:06:44 -0700177
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700178def cython_extensions_and_necessity():
179 cython_module_files = [os.path.join(PYTHON_STEM,
180 name.replace('.', '/') + '.pyx')
181 for name in CYTHON_EXTENSION_MODULE_NAMES]
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700182 extensions = [
183 _extension.Extension(
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800184 name=module_name,
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700185 sources=[module_file] + list(CYTHON_HELPER_C_FILES) + list(CORE_C_FILES),
186 include_dirs=list(EXTENSION_INCLUDE_DIRECTORIES),
187 libraries=list(EXTENSION_LIBRARIES),
188 define_macros=list(DEFINE_MACROS),
Craig Tillera7f3e052016-02-05 15:02:39 -0800189 extra_compile_args=list(CFLAGS),
190 extra_link_args=list(LDFLAGS),
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700191 ) for (module_name, module_file) in zip(list(CYTHON_EXTENSION_MODULE_NAMES), cython_module_files)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700192 ]
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700193 need_cython = BUILD_WITH_CYTHON
194 if not BUILD_WITH_CYTHON:
195 need_cython = need_cython or not commands.check_and_update_cythonization(extensions)
196 return commands.try_cythonize(extensions, linetracing=ENABLE_CYTHON_TRACING, mandatory=BUILD_WITH_CYTHON), need_cython
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700197
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700198CYTHON_EXTENSION_MODULES, need_cython = cython_extensions_and_necessity()
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700199
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700200PACKAGE_DIRECTORIES = {
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800201 '': PYTHON_STEM,
Nathaniel Manistab8b0adf2015-01-29 00:30:51 +0000202}
203
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700204INSTALL_REQUIRES = (
Ken Payson2b7fae02016-06-28 17:20:37 -0700205 'six>=1.5.2',
Nathaniel Manistaa1880222015-09-10 22:16:04 +0000206 'enum34>=1.0.4',
Masood Malekghassemiad32ff42016-01-21 15:15:38 -0800207 # TODO(atash): eventually split the grpcio package into a metapackage
208 # depending on protobuf and the runtime component (independent of protobuf)
Ken Paysone5fd01a2016-08-02 12:06:21 -0700209 'protobuf>=3.0.0',
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700210)
211
aaronjhengb273c042016-08-29 12:02:48 +0800212if not PY3:
213 INSTALL_REQUIRES += ('futures>=2.2.0',)
214
Ken Payson2b7fae02016-06-28 17:20:37 -0700215SETUP_REQUIRES = INSTALL_REQUIRES + (
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700216 'sphinx>=1.3',
Ken Payson2b7fae02016-06-28 17:20:37 -0700217 'sphinx_rtd_theme>=0.1.8',
218 'six>=1.10',
Masood Malekghassemi2da46662016-10-25 15:57:48 -0700219 ) if ENABLE_DOCUMENTATION_BUILD else ()
220
Masood Malekghassemi5e43db82016-12-14 18:23:25 -0800221try:
222 import Cython
223except ImportError:
224 if BUILD_WITH_CYTHON:
225 sys.stderr.write(
226 "You requested a Cython build via GRPC_PYTHON_BUILD_WITH_CYTHON, "
227 "but do not have Cython installed. We won't stop you from using "
228 "other commands, but the extension files will fail to build.\n")
229 elif need_cython:
230 sys.stderr.write(
231 'We could not find Cython. Setup may take 10-20 minutes.\n')
232 SETUP_REQUIRES += ('cython>=0.23',)
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700233
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700234COMMAND_CLASS = {
Masood Malekghassemi791cc312015-07-27 14:22:33 -0700235 'doc': commands.SphinxDocumentation,
Masood Malekghassemi5c147632015-07-31 14:08:19 -0700236 'build_project_metadata': commands.BuildProjectMetadata,
237 'build_py': commands.BuildPy,
Masood Malekghassemi1d177812016-01-12 09:21:57 -0800238 'build_ext': commands.BuildExt,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700239 'gather': commands.Gather,
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700240}
241
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800242# Ensure that package data is copied over before any commands have been run:
Masood Malekghassemi58a04942016-07-16 01:42:52 -0700243credentials_dir = os.path.join(PYTHON_STEM, 'grpc', '_cython', '_credentials')
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800244try:
245 os.mkdir(credentials_dir)
246except OSError:
247 pass
Masood Malekghassemi58a04942016-07-16 01:42:52 -0700248shutil.copyfile(os.path.join('etc', 'roots.pem'),
249 os.path.join(credentials_dir, 'roots.pem'))
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800250
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800251PACKAGE_DATA = {
Masood Malekghassemif7474092016-02-12 12:04:53 -0800252 # Binaries that may or may not be present in the final installation, but are
253 # mentioned here for completeness.
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800254 'grpc._cython': [
Nathaniel Manistafa6cad72016-02-05 21:26:54 +0000255 '_credentials/roots.pem',
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800256 '_windows/grpc_c.32.python',
257 '_windows/grpc_c.64.python',
258 ],
259}
Masood Malekghassemi1ff429d2016-06-02 16:39:20 -0700260PACKAGES = setuptools.find_packages(PYTHON_STEM)
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700261
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700262setuptools.setup(
263 name='grpcio',
264 version=grpc_version.VERSION,
265 license=LICENSE,
Masood Malekghassemib928de82016-10-28 15:05:33 -0700266 long_description=open(README).read(),
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700267 ext_modules=CYTHON_EXTENSION_MODULES,
268 packages=list(PACKAGES),
269 package_dir=PACKAGE_DIRECTORIES,
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700270 package_data=PACKAGE_DATA,
271 install_requires=INSTALL_REQUIRES,
272 setup_requires=SETUP_REQUIRES,
273 cmdclass=COMMAND_CLASS,
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700274)