blob: 388e629ec2a16c8dfb03bce801e693e4d16cca93 [file] [log] [blame]
Jan Tattermusch7897ae92017-06-07 22:57:36 +02001# Copyright 2015 gRPC authors.
Nathaniel Manistab68f3d12015-01-23 21:32:47 +00002#
Jan Tattermusch7897ae92017-06-07 22:57:36 +02003# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
Nathaniel Manistab68f3d12015-01-23 21:32:47 +00006#
Jan Tattermusch7897ae92017-06-07 22:57:36 +02007# http://www.apache.org/licenses/LICENSE-2.0
Nathaniel Manistab68f3d12015-01-23 21:32:47 +00008#
Jan Tattermusch7897ae92017-06-07 22:57:36 +02009# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
Nathaniel Manistab68f3d12015-01-23 21:32:47 +000014
Nathaniel Manistab8b0adf2015-01-29 00:30:51 +000015"""A setup module for the GRPC Python package."""
Ken Payson5998cd72016-08-10 15:39:43 -070016from distutils import cygwinccompiler
Masood Malekghassemiabdff3d2016-07-18 13:26:25 -070017from distutils import extension as _extension
Masood Malekghassemi398b06e2016-07-15 23:17:41 -070018from distutils import util
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070019import os
Masood Malekghassemid65632a2015-07-27 14:30:09 -070020import os.path
Masood Malekghassemiabdff3d2016-07-18 13:26:25 -070021import pkg_resources
Masood Malekghassemi586e3832016-06-03 19:29:12 -070022import platform
Masood Malekghassemi398b06e2016-07-15 23:17:41 -070023import re
Ken Paysonfe754b42016-06-23 12:32:07 -070024import shlex
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -080025import shutil
Alexander Staubo8eac91e2015-04-06 12:06:22 -040026import sys
Ken Payson1efb6012016-06-08 13:06:44 -070027import sysconfig
Nathaniel Manistab68f3d12015-01-23 21:32:47 +000028
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070029import setuptools
Masood Malekghassemib7e7b3f2015-12-17 00:16:49 -080030from setuptools.command import egg_info
31
32# Redirect the manifest template from MANIFEST.in to PYTHON-MANIFEST.in.
33egg_info.manifest_maker.template = 'PYTHON-MANIFEST.in'
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070034
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -050035PY3 = sys.version_info.major == 3
Masood Malekghassemi58a04942016-07-16 01:42:52 -070036PYTHON_STEM = os.path.join('src', 'python', 'grpcio')
37CORE_INCLUDE = ('include', '.',)
Thomas Bechtold30ce6932018-05-24 17:12:13 +020038SSL_INCLUDE = (os.path.join('third_party', 'boringssl', 'include'),)
Masood Malekghassemi58a04942016-07-16 01:42:52 -070039ZLIB_INCLUDE = (os.path.join('third_party', 'zlib'),)
David Garcia Quintas92ea0332018-06-04 13:49:15 -070040NANOPB_INCLUDE = (os.path.join('third_party', 'nanopb'),)
Yuchen Zengf64bf282016-08-11 21:21:32 -070041CARES_INCLUDE = (
Yuchen Zeng6694bb02017-01-23 17:09:51 -080042 os.path.join('third_party', 'cares'),
43 os.path.join('third_party', 'cares', 'cares'),)
Yuchen Zengf64bf282016-08-11 21:21:32 -070044if 'darwin' in sys.platform:
Yuchen Zeng6694bb02017-01-23 17:09:51 -080045 CARES_INCLUDE += (os.path.join('third_party', 'cares', 'config_darwin'),)
Mehrdad Afshari451c02b2017-10-12 10:28:14 -070046if 'freebsd' in sys.platform:
47 CARES_INCLUDE += (os.path.join('third_party', 'cares', 'config_freebsd'),)
48if 'linux' in sys.platform:
49 CARES_INCLUDE += (os.path.join('third_party', 'cares', 'config_linux'),)
Frank Groeneveldfbf81282017-10-12 08:27:14 +020050if 'openbsd' in sys.platform:
51 CARES_INCLUDE += (os.path.join('third_party', 'cares', 'config_openbsd'),)
Alex Polcyn77f64f72018-03-01 19:22:53 +000052ADDRESS_SORTING_INCLUDE = (os.path.join('third_party', 'address_sorting', 'include'),)
Masood Malekghassemib928de82016-10-28 15:05:33 -070053README = os.path.join(PYTHON_STEM, 'README.rst')
Masood Malekghassemi116982e2015-12-11 15:53:38 -080054
Masood Malekghassemid65632a2015-07-27 14:30:09 -070055# Ensure we're in the proper directory whether or not we're being used by pip.
56os.chdir(os.path.dirname(os.path.abspath(__file__)))
Masood Malekghassemi58a1dc22016-01-21 14:23:55 -080057sys.path.insert(0, os.path.abspath(PYTHON_STEM))
Masood Malekghassemid65632a2015-07-27 14:30:09 -070058
Masood Malekghassemi116982e2015-12-11 15:53:38 -080059# Break import-style to ensure we can actually find our in-repo dependencies.
Ken Payson5998cd72016-08-10 15:39:43 -070060import _spawn_patch
Masood Malekghassemid65632a2015-07-27 14:30:09 -070061import commands
Masood Malekghassemi116982e2015-12-11 15:53:38 -080062import grpc_core_dependencies
Craig Tillerf008f062016-02-08 12:48:03 -080063import grpc_version
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070064
Ken Payson5998cd72016-08-10 15:39:43 -070065_spawn_patch.monkeypatch_spawn()
Masood Malekghassemi586e3832016-06-03 19:29:12 -070066
Jan Tattermusch4d5c3102017-06-07 10:23:56 +020067LICENSE = 'Apache License 2.0'
Masood Malekghassemidf97aec2016-01-11 16:19:14 -080068
Ken Payson9c420442017-07-25 12:06:46 -070069CLASSIFIERS = [
70 'Development Status :: 5 - Production/Stable',
71 'Programming Language :: Python',
72 'Programming Language :: Python :: 2',
73 'Programming Language :: Python :: 2.7',
74 'Programming Language :: Python :: 3',
75 'Programming Language :: Python :: 3.4',
76 'Programming Language :: Python :: 3.5',
77 'Programming Language :: Python :: 3.6',
78 'License :: OSI Approved :: Apache Software License',
Ken Paysonf5f5ed02017-08-24 11:46:03 -070079]
Ken Payson9c420442017-07-25 12:06:46 -070080
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070081# Environment variable to determine whether or not the Cython extension should
82# *use* Cython or use the generated C files. Note that this requires the C files
Masood Malekghassemif17f0f62016-07-08 12:07:49 -070083# to have been generated by building first *with* Cython support. Even if this
84# is set to false, if the script detects that the generated `.c` file isn't
85# present, then it will still attempt to use Cython.
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070086BUILD_WITH_CYTHON = os.environ.get('GRPC_PYTHON_BUILD_WITH_CYTHON', False)
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070087
Thomas Bechtold30ce6932018-05-24 17:12:13 +020088# Export this variable to use the system installation of openssl. You need to
89# have the header files installed (in /usr/include/openssl) and during
90# runtime, the shared libary must be installed
91BUILD_WITH_SYSTEM_OPENSSL = os.environ.get('GRPC_PYTHON_BUILD_SYSTEM_OPENSSL',
92 False)
93
Thomas Bechtold3823d902018-05-25 06:52:23 +020094# Export this variable to use the system installation of zlib. You need to
95# have the header files installed (in /usr/include/) and during
96# runtime, the shared libary must be installed
97BUILD_WITH_SYSTEM_ZLIB = os.environ.get('GRPC_PYTHON_BUILD_SYSTEM_ZLIB',
98 False)
99
Thomas Bechtold78a6e042018-05-25 07:08:05 +0200100# Export this variable to use the system installation of cares. You need to
101# have the header files installed (in /usr/include/) and during
102# runtime, the shared libary must be installed
103BUILD_WITH_SYSTEM_CARES = os.environ.get('GRPC_PYTHON_BUILD_SYSTEM_CARES',
104 False)
105
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700106# Environment variable to determine whether or not to enable coverage analysis
107# in Cython modules.
108ENABLE_CYTHON_TRACING = os.environ.get(
109 'GRPC_PYTHON_ENABLE_CYTHON_TRACING', False)
110
Masood Malekghassemi2da46662016-10-25 15:57:48 -0700111# Environment variable specifying whether or not there's interest in setting up
112# documentation building.
113ENABLE_DOCUMENTATION_BUILD = os.environ.get(
114 'GRPC_PYTHON_ENABLE_DOCUMENTATION_BUILD', False)
115
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700116# There are some situations (like on Windows) where CC, CFLAGS, and LDFLAGS are
117# entirely ignored/dropped/forgotten by distutils and its Cygwin/MinGW support.
118# We use these environment variables to thus get around that without locking
119# ourselves in w.r.t. the multitude of operating systems this ought to build on.
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700120# We can also use these variables as a way to inject environment-specific
121# compiler/linker flags. We assume GCC-like compilers and/or MinGW as a
122# reasonable default.
123EXTRA_ENV_COMPILE_ARGS = os.environ.get('GRPC_PYTHON_CFLAGS', None)
124EXTRA_ENV_LINK_ARGS = os.environ.get('GRPC_PYTHON_LDFLAGS', None)
125if EXTRA_ENV_COMPILE_ARGS is None:
kpayson641bfff8e2018-03-13 22:05:48 -0700126 EXTRA_ENV_COMPILE_ARGS = ' -std=c++11'
Ken Payson5998cd72016-08-10 15:39:43 -0700127 if 'win32' in sys.platform and sys.version_info < (3, 5):
kpayson641bfff8e2018-03-13 22:05:48 -0700128 EXTRA_ENV_COMPILE_ARGS += ' -D_hypot=hypot'
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700129 # We use define flags here and don't directly add to DEFINE_MACROS below to
130 # ensure that the expert user/builder has a way of turning it off (via the
131 # envvars) without adding yet more GRPC-specific envvars.
132 # See https://sourceforge.net/p/mingw-w64/bugs/363/
133 if '32' in platform.architecture()[0]:
134 EXTRA_ENV_COMPILE_ARGS += ' -D_ftime=_ftime32 -D_timeb=__timeb32 -D_ftime_s=_ftime32_s'
135 else:
136 EXTRA_ENV_COMPILE_ARGS += ' -D_ftime=_ftime64 -D_timeb=__timeb64'
Ken Payson571c75a2017-04-13 16:39:37 -0700137 elif "linux" in sys.platform:
kpayson641bfff8e2018-03-13 22:05:48 -0700138 EXTRA_ENV_COMPILE_ARGS += ' -std=gnu99 -fvisibility=hidden -fno-wrapv -fno-exceptions'
Ken Payson571c75a2017-04-13 16:39:37 -0700139 elif "darwin" in sys.platform:
Ken Paysonf8d6fb72017-06-15 17:32:49 -0700140 EXTRA_ENV_COMPILE_ARGS += ' -fvisibility=hidden -fno-wrapv -fno-exceptions'
kpayson641bfff8e2018-03-13 22:05:48 -0700141EXTRA_ENV_COMPILE_ARGS += ' -DPB_FIELD_16BIT'
Ken Payson45a520f2017-01-24 09:40:21 -0800142
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700143if EXTRA_ENV_LINK_ARGS is None:
Ken Payson5998cd72016-08-10 15:39:43 -0700144 EXTRA_ENV_LINK_ARGS = ''
145 if "linux" in sys.platform or "darwin" in sys.platform:
146 EXTRA_ENV_LINK_ARGS += ' -lpthread'
147 elif "win32" in sys.platform and sys.version_info < (3, 5):
148 msvcr = cygwinccompiler.get_msvcr()[0]
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700149 # TODO(atash) sift through the GCC specs to see if libstdc++ can have any
150 # influence on the linkage outcome on MinGW for non-C++ programs.
151 EXTRA_ENV_LINK_ARGS += (
152 ' -static-libgcc -static-libstdc++ -mcrtdll={msvcr} '
153 '-static'.format(msvcr=msvcr))
Nicolas "Pixel" Noblee3e17d32016-08-20 01:45:32 +0200154 if "linux" in sys.platform:
Ken Paysonf8d6fb72017-06-15 17:32:49 -0700155 EXTRA_ENV_LINK_ARGS += ' -Wl,-wrap,memcpy -static-libgcc'
Ken Payson5998cd72016-08-10 15:39:43 -0700156
Masood Malekghassemid66be0b2016-07-07 11:24:39 -0700157EXTRA_COMPILE_ARGS = shlex.split(EXTRA_ENV_COMPILE_ARGS)
158EXTRA_LINK_ARGS = shlex.split(EXTRA_ENV_LINK_ARGS)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700159
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700160CYTHON_EXTENSION_PACKAGE_NAMES = ()
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700161
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800162CYTHON_EXTENSION_MODULE_NAMES = ('grpc._cython.cygrpc',)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700163
Masood Malekghassemi3acddb22016-07-13 18:38:33 -0700164CYTHON_HELPER_C_FILES = ()
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800165
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700166CORE_C_FILES = tuple(grpc_core_dependencies.CORE_SOURCE_FILES)
Jan Tattermuschdc57fbd2017-09-06 21:26:08 +0200167if "win32" in sys.platform:
Yuchen Zengb4d33e02017-04-20 16:41:25 -0700168 CORE_C_FILES = filter(lambda x: 'third_party/cares' not in x, CORE_C_FILES)
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800169
Thomas Bechtold30ce6932018-05-24 17:12:13 +0200170if BUILD_WITH_SYSTEM_OPENSSL:
171 CORE_C_FILES = filter(lambda x: 'third_party/boringssl' not in x, CORE_C_FILES)
172 CORE_C_FILES = filter(lambda x: 'src/boringssl' not in x, CORE_C_FILES)
173 SSL_INCLUDE = (os.path.join('/usr', 'include', 'openssl'),)
174
Thomas Bechtold3823d902018-05-25 06:52:23 +0200175if BUILD_WITH_SYSTEM_ZLIB:
176 CORE_C_FILES = filter(lambda x: 'third_party/zlib' not in x, CORE_C_FILES)
177 ZLIB_INCLUDE = (os.path.join('/usr', 'include'),)
178
Thomas Bechtold78a6e042018-05-25 07:08:05 +0200179if BUILD_WITH_SYSTEM_CARES:
180 CORE_C_FILES = filter(lambda x: 'third_party/cares' not in x, CORE_C_FILES)
181 CARES_INCLUDE = (os.path.join('/usr', 'include'),)
182
Masood Malekghassemi387e1162016-01-05 10:16:12 -0800183EXTENSION_INCLUDE_DIRECTORIES = (
Thomas Bechtold30ce6932018-05-24 17:12:13 +0200184 (PYTHON_STEM,) + CORE_INCLUDE + SSL_INCLUDE + ZLIB_INCLUDE +
David Garcia Quintas92ea0332018-06-04 13:49:15 -0700185 NANOPB_INCLUDE + CARES_INCLUDE + ADDRESS_SORTING_INCLUDE)
Nathaniel Manistaa4ead5d2015-01-31 01:33:27 +0000186
Masood Malekghassemi10509a22016-02-03 13:32:22 -0800187EXTENSION_LIBRARIES = ()
Masood Malekghassemic9c53ee2016-02-03 10:30:23 -0800188if "linux" in sys.platform:
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800189 EXTENSION_LIBRARIES += ('rt',)
Masood Malekghassemi10509a22016-02-03 13:32:22 -0800190if not "win32" in sys.platform:
191 EXTENSION_LIBRARIES += ('m',)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700192if "win32" in sys.platform:
Ken Payson5998cd72016-08-10 15:39:43 -0700193 EXTENSION_LIBRARIES += ('advapi32', 'ws2_32',)
Thomas Bechtold30ce6932018-05-24 17:12:13 +0200194if BUILD_WITH_SYSTEM_OPENSSL:
195 EXTENSION_LIBRARIES += ('ssl', 'crypto',)
Thomas Bechtold3823d902018-05-25 06:52:23 +0200196if BUILD_WITH_SYSTEM_ZLIB:
197 EXTENSION_LIBRARIES += ('z',)
Thomas Bechtold78a6e042018-05-25 07:08:05 +0200198if BUILD_WITH_SYSTEM_CARES:
199 EXTENSION_LIBRARIES += ('cares',)
Nathaniel Manistaa4ead5d2015-01-31 01:33:27 +0000200
Masood Malekghassemi58a04942016-07-16 01:42:52 -0700201DEFINE_MACROS = (
202 ('OPENSSL_NO_ASM', 1), ('_WIN32_WINNT', 0x600),
Yihua Zhang04fb58e2018-03-08 06:49:24 -0800203 ('GPR_BACKWARDS_COMPATIBILITY_MODE', 1))
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700204if "win32" in sys.platform:
Jan Tattermuschdc57fbd2017-09-06 21:26:08 +0200205 # TODO(zyc): Re-enble c-ares on x64 and x86 windows after fixing the
206 # ares_library_init compilation issue
207 DEFINE_MACROS += (('WIN32_LEAN_AND_MEAN', 1), ('CARES_STATICLIB', 1),
Matt Kwonge7a60bd2018-01-22 17:00:13 -0800208 ('GRPC_ARES', 0), ('NTDDI_VERSION', 0x06000000),
209 ('NOMINMAX', 1),)
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700210 if '64bit' in platform.architecture()[0]:
Jan Tattermuschdc57fbd2017-09-06 21:26:08 +0200211 DEFINE_MACROS += (('MS_WIN64', 1),)
Ken Payson5998cd72016-08-10 15:39:43 -0700212 elif sys.version_info >= (3, 5):
213 # For some reason, this is needed to get access to inet_pton/inet_ntop
214 # on msvc, but only for 32 bits
215 DEFINE_MACROS += (('NTDDI_VERSION', 0x06000000),)
Yuchen Zeng88d4e772016-08-16 22:34:02 -0700216else:
Ken Payson9714e032017-10-10 11:18:49 -0700217 DEFINE_MACROS += (('HAVE_CONFIG_H', 1), ('GRPC_ENABLE_FORK_SUPPORT', 1),)
Masood Malekghassemi743c10c2015-06-16 18:05:27 -0700218
Masood Malekghassemi586e3832016-06-03 19:29:12 -0700219LDFLAGS = tuple(EXTRA_LINK_ARGS)
220CFLAGS = tuple(EXTRA_COMPILE_ARGS)
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800221if "linux" in sys.platform or "darwin" in sys.platform:
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -0500222 pymodinit_type = 'PyObject*' if PY3 else 'void'
kpayson641bfff8e2018-03-13 22:05:48 -0700223 pymodinit = 'extern "C" __attribute__((visibility ("default"))) {}'.format(pymodinit_type)
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -0500224 DEFINE_MACROS += (('PyMODINIT_FUNC', pymodinit),)
Alexander Polcynd4a3bb82017-11-30 09:27:16 -0800225 DEFINE_MACROS += (('GRPC_POSIX_FORK_ALLOW_PTHREAD_ATFORK', 1),)
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800226
Ken Payson1efb6012016-06-08 13:06:44 -0700227# By default, Python3 distutils enforces compatibility of
228# c plugins (.so files) with the OSX version Python3 was built with.
229# For Python3.4, this is OSX 10.6, but we need Thread Local Support (__thread)
230if 'darwin' in sys.platform and PY3:
231 mac_target = sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET')
232 if mac_target and (pkg_resources.parse_version(mac_target) <
233 pkg_resources.parse_version('10.7.0')):
234 os.environ['MACOSX_DEPLOYMENT_TARGET'] = '10.7'
Masood Malekghassemi398b06e2016-07-15 23:17:41 -0700235 os.environ['_PYTHON_HOST_PLATFORM'] = re.sub(
236 r'macosx-[0-9]+\.[0-9]+-(.+)',
237 r'macosx-10.7-\1',
238 util.get_platform())
Ken Payson1efb6012016-06-08 13:06:44 -0700239
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700240def cython_extensions_and_necessity():
241 cython_module_files = [os.path.join(PYTHON_STEM,
242 name.replace('.', '/') + '.pyx')
243 for name in CYTHON_EXTENSION_MODULE_NAMES]
Ken Paysonae5ca1b2017-04-14 16:34:26 -0700244 config = os.environ.get('CONFIG', 'opt')
Ken Payson5b034e62017-04-14 16:25:51 -0700245 prefix = 'libs/' + config + '/'
Ken Payson571c75a2017-04-13 16:39:37 -0700246 if "darwin" in sys.platform:
Ken Payson5b034e62017-04-14 16:25:51 -0700247 extra_objects = [prefix + 'libares.a',
248 prefix + 'libboringssl.a',
249 prefix + 'libgpr.a',
250 prefix + 'libgrpc.a']
Ken Payson2d9c9d92017-04-13 17:07:32 -0700251 core_c_files = []
Ken Payson571c75a2017-04-13 16:39:37 -0700252 else:
Ken Payson2d9c9d92017-04-13 17:07:32 -0700253 core_c_files = list(CORE_C_FILES)
Ken Payson571c75a2017-04-13 16:39:37 -0700254 extra_objects = []
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700255 extensions = [
256 _extension.Extension(
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800257 name=module_name,
Ken Payson2d9c9d92017-04-13 17:07:32 -0700258 sources=[module_file] + list(CYTHON_HELPER_C_FILES) + core_c_files,
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700259 include_dirs=list(EXTENSION_INCLUDE_DIRECTORIES),
260 libraries=list(EXTENSION_LIBRARIES),
261 define_macros=list(DEFINE_MACROS),
Ken Payson571c75a2017-04-13 16:39:37 -0700262 extra_objects=extra_objects,
Craig Tillera7f3e052016-02-05 15:02:39 -0800263 extra_compile_args=list(CFLAGS),
264 extra_link_args=list(LDFLAGS),
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700265 ) for (module_name, module_file) in zip(list(CYTHON_EXTENSION_MODULE_NAMES), cython_module_files)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700266 ]
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700267 need_cython = BUILD_WITH_CYTHON
268 if not BUILD_WITH_CYTHON:
269 need_cython = need_cython or not commands.check_and_update_cythonization(extensions)
270 return commands.try_cythonize(extensions, linetracing=ENABLE_CYTHON_TRACING, mandatory=BUILD_WITH_CYTHON), need_cython
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700271
Masood Malekghassemifd9cc102016-07-21 14:20:43 -0700272CYTHON_EXTENSION_MODULES, need_cython = cython_extensions_and_necessity()
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700273
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700274PACKAGE_DIRECTORIES = {
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800275 '': PYTHON_STEM,
Nathaniel Manistab8b0adf2015-01-29 00:30:51 +0000276}
277
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700278INSTALL_REQUIRES = (
Ken Payson2b7fae02016-06-28 17:20:37 -0700279 'six>=1.5.2',
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700280)
281
Mehrdad Afshari0b739a22018-07-26 07:14:08 -0700282if not PY3:
283 INSTALL_REQUIRES += ('futures>=2.2.0', 'enum34>=1.0.4')
284
Ken Payson2b7fae02016-06-28 17:20:37 -0700285SETUP_REQUIRES = INSTALL_REQUIRES + (
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700286 'sphinx>=1.3',
Ken Payson2b7fae02016-06-28 17:20:37 -0700287 'sphinx_rtd_theme>=0.1.8',
288 'six>=1.10',
Masood Malekghassemi2da46662016-10-25 15:57:48 -0700289 ) if ENABLE_DOCUMENTATION_BUILD else ()
290
Masood Malekghassemi5e43db82016-12-14 18:23:25 -0800291try:
292 import Cython
293except ImportError:
294 if BUILD_WITH_CYTHON:
295 sys.stderr.write(
296 "You requested a Cython build via GRPC_PYTHON_BUILD_WITH_CYTHON, "
297 "but do not have Cython installed. We won't stop you from using "
298 "other commands, but the extension files will fail to build.\n")
299 elif need_cython:
300 sys.stderr.write(
301 'We could not find Cython. Setup may take 10-20 minutes.\n')
302 SETUP_REQUIRES += ('cython>=0.23',)
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700303
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700304COMMAND_CLASS = {
Masood Malekghassemi791cc312015-07-27 14:22:33 -0700305 'doc': commands.SphinxDocumentation,
Masood Malekghassemi5c147632015-07-31 14:08:19 -0700306 'build_project_metadata': commands.BuildProjectMetadata,
307 'build_py': commands.BuildPy,
Masood Malekghassemi1d177812016-01-12 09:21:57 -0800308 'build_ext': commands.BuildExt,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700309 'gather': commands.Gather,
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700310}
311
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800312# Ensure that package data is copied over before any commands have been run:
Masood Malekghassemi58a04942016-07-16 01:42:52 -0700313credentials_dir = os.path.join(PYTHON_STEM, 'grpc', '_cython', '_credentials')
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800314try:
315 os.mkdir(credentials_dir)
316except OSError:
317 pass
Masood Malekghassemi58a04942016-07-16 01:42:52 -0700318shutil.copyfile(os.path.join('etc', 'roots.pem'),
319 os.path.join(credentials_dir, 'roots.pem'))
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800320
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800321PACKAGE_DATA = {
Masood Malekghassemif7474092016-02-12 12:04:53 -0800322 # Binaries that may or may not be present in the final installation, but are
323 # mentioned here for completeness.
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800324 'grpc._cython': [
Nathaniel Manistafa6cad72016-02-05 21:26:54 +0000325 '_credentials/roots.pem',
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800326 '_windows/grpc_c.32.python',
327 '_windows/grpc_c.64.python',
328 ],
329}
Masood Malekghassemi1ff429d2016-06-02 16:39:20 -0700330PACKAGES = setuptools.find_packages(PYTHON_STEM)
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700331
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700332setuptools.setup(
333 name='grpcio',
334 version=grpc_version.VERSION,
Ken Payson78354302017-03-06 09:28:16 -0800335 description='HTTP/2-based RPC framework',
336 author='The gRPC Authors',
337 author_email='grpc-io@googlegroups.com',
Mehrdad Afsharibb3d95b2017-07-10 22:24:28 +0000338 url='https://grpc.io',
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700339 license=LICENSE,
Ken Payson9c420442017-07-25 12:06:46 -0700340 classifiers=CLASSIFIERS,
Masood Malekghassemib928de82016-10-28 15:05:33 -0700341 long_description=open(README).read(),
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700342 ext_modules=CYTHON_EXTENSION_MODULES,
343 packages=list(PACKAGES),
344 package_dir=PACKAGE_DIRECTORIES,
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700345 package_data=PACKAGE_DATA,
346 install_requires=INSTALL_REQUIRES,
347 setup_requires=SETUP_REQUIRES,
348 cmdclass=COMMAND_CLASS,
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700349)