blob: 0e2646d5d2fdf3f963186bedb3600fce3b216af3 [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."""
Nathaniel Manistab68f3d12015-01-23 21:32:47 +000031
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070032import os
Masood Malekghassemid65632a2015-07-27 14:30:09 -070033import os.path
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -080034import shutil
Alexander Staubo8eac91e2015-04-06 12:06:22 -040035import sys
Nathaniel Manistab68f3d12015-01-23 21:32:47 +000036
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070037from distutils import core as _core
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -070038from distutils import extension as _extension
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070039import setuptools
Masood Malekghassemib7e7b3f2015-12-17 00:16:49 -080040from setuptools.command import egg_info
41
42# Redirect the manifest template from MANIFEST.in to PYTHON-MANIFEST.in.
43egg_info.manifest_maker.template = 'PYTHON-MANIFEST.in'
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070044
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -050045PY3 = sys.version_info.major == 3
Masood Malekghassemie540b572016-01-14 15:00:34 -080046PYTHON_STEM = './src/python/grpcio'
47CORE_INCLUDE = ('./include', '.',)
Masood Malekghassemi387e1162016-01-05 10:16:12 -080048BORINGSSL_INCLUDE = ('./third_party/boringssl/include',)
Masood Malekghassemi0cc27922016-01-22 16:32:41 -080049ZLIB_INCLUDE = ('./third_party/zlib',)
Masood Malekghassemi116982e2015-12-11 15:53:38 -080050
Masood Malekghassemid65632a2015-07-27 14:30:09 -070051# Ensure we're in the proper directory whether or not we're being used by pip.
52os.chdir(os.path.dirname(os.path.abspath(__file__)))
Masood Malekghassemi58a1dc22016-01-21 14:23:55 -080053sys.path.insert(0, os.path.abspath(PYTHON_STEM))
Masood Malekghassemid65632a2015-07-27 14:30:09 -070054
Masood Malekghassemi116982e2015-12-11 15:53:38 -080055# Break import-style to ensure we can actually find our in-repo dependencies.
Masood Malekghassemid65632a2015-07-27 14:30:09 -070056import commands
Masood Malekghassemi116982e2015-12-11 15:53:38 -080057import grpc_core_dependencies
Craig Tillerf008f062016-02-08 12:48:03 -080058import grpc_version
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070059
Masood Malekghassemidf97aec2016-01-11 16:19:14 -080060LICENSE = '3-clause BSD'
61
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070062# Environment variable to determine whether or not the Cython extension should
63# *use* Cython or use the generated C files. Note that this requires the C files
64# to have been generated by building first *with* Cython support.
65BUILD_WITH_CYTHON = os.environ.get('GRPC_PYTHON_BUILD_WITH_CYTHON', False)
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070066
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070067# Environment variable to determine whether or not to enable coverage analysis
68# in Cython modules.
69ENABLE_CYTHON_TRACING = os.environ.get(
70 'GRPC_PYTHON_ENABLE_CYTHON_TRACING', False)
71
72# Environment variable to determine whether or not to include the test files in
73# the installation.
74INSTALL_TESTS = os.environ.get('GRPC_PYTHON_INSTALL_TESTS', False)
75
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -070076CYTHON_EXTENSION_PACKAGE_NAMES = ()
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -070077
Masood Malekghassemi116982e2015-12-11 15:53:38 -080078CYTHON_EXTENSION_MODULE_NAMES = ('grpc._cython.cygrpc',)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -070079
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -080080CYTHON_HELPER_C_FILES = (
81 os.path.join(PYTHON_STEM, 'grpc/_cython/loader.c'),
82 os.path.join(PYTHON_STEM, 'grpc/_cython/imports.generated.c'),
83)
84
85CORE_C_FILES = ()
86if not "win32" in sys.platform:
Masood Malekghassemi10509a22016-02-03 13:32:22 -080087 CORE_C_FILES += tuple(grpc_core_dependencies.CORE_SOURCE_FILES)
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -080088
Masood Malekghassemi387e1162016-01-05 10:16:12 -080089EXTENSION_INCLUDE_DIRECTORIES = (
Masood Malekghassemi0cc27922016-01-22 16:32:41 -080090 (PYTHON_STEM,) + CORE_INCLUDE + BORINGSSL_INCLUDE + ZLIB_INCLUDE)
Nathaniel Manistaa4ead5d2015-01-31 01:33:27 +000091
Masood Malekghassemi10509a22016-02-03 13:32:22 -080092EXTENSION_LIBRARIES = ()
Masood Malekghassemic9c53ee2016-02-03 10:30:23 -080093if "linux" in sys.platform:
Craig Tiller4bef7ce2016-02-02 08:38:43 -080094 EXTENSION_LIBRARIES += ('rt',)
Masood Malekghassemi10509a22016-02-03 13:32:22 -080095if not "win32" in sys.platform:
96 EXTENSION_LIBRARIES += ('m',)
Nathaniel Manistaa4ead5d2015-01-31 01:33:27 +000097
Craig Tiller71ea4a12016-02-04 15:06:41 -080098DEFINE_MACROS = (('OPENSSL_NO_ASM', 1), ('_WIN32_WINNT', 0x600), ('GPR_BACKWARDS_COMPATIBILITY_MODE', 1),)
Masood Malekghassemi743c10c2015-06-16 18:05:27 -070099
Craig Tiller00572a92016-02-02 08:45:46 -0800100LDFLAGS = ()
Craig Tillerf456b922016-02-12 12:19:12 -0800101CFLAGS = ()
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800102if "linux" in sys.platform:
103 LDFLAGS += ('-Wl,-wrap,memcpy',)
104if "linux" in sys.platform or "darwin" in sys.platform:
105 CFLAGS += ('-fvisibility=hidden',)
Leifur Halldor Asgeirsson38a3d7a2016-03-01 10:00:08 -0500106
107 pymodinit_type = 'PyObject*' if PY3 else 'void'
108
109 pymodinit = '__attribute__((visibility ("default"))) {}'.format(pymodinit_type)
110 DEFINE_MACROS += (('PyMODINIT_FUNC', pymodinit),)
Craig Tiller4bef7ce2016-02-02 08:38:43 -0800111
112
Leifur Halldor Asgeirsson554c7dd2016-02-18 17:24:05 -0500113def cython_extensions(module_names, extra_sources, include_dirs,
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800114 libraries, define_macros, build_with_cython=False):
Masood Malekghassemi68a94c82016-03-09 11:45:07 -0800115 # Set compiler directives linetrace argument only if we care about tracing;
116 # this is due to Cython having different behavior between linetrace being
117 # False and linetrace being unset. See issue #5689.
118 cython_compiler_directives = {}
Masood Malekghassemi387e1162016-01-05 10:16:12 -0800119 if ENABLE_CYTHON_TRACING:
120 define_macros = define_macros + [('CYTHON_TRACE_NOGIL', 1)]
Masood Malekghassemi68a94c82016-03-09 11:45:07 -0800121 cython_compiler_directives['linetrace'] = True
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700122 file_extension = 'pyx' if build_with_cython else 'c'
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800123 module_files = [os.path.join(PYTHON_STEM,
124 name.replace('.', '/') + '.' + file_extension)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700125 for name in module_names]
126 extensions = [
127 _extension.Extension(
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800128 name=module_name,
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800129 sources=[module_file] + extra_sources,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700130 include_dirs=include_dirs, libraries=libraries,
Masood Malekghassemi387e1162016-01-05 10:16:12 -0800131 define_macros=define_macros,
Craig Tillera7f3e052016-02-05 15:02:39 -0800132 extra_compile_args=list(CFLAGS),
133 extra_link_args=list(LDFLAGS),
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700134 ) for (module_name, module_file) in zip(module_names, module_files)
135 ]
136 if build_with_cython:
137 import Cython.Build
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700138 return Cython.Build.cythonize(
139 extensions,
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800140 include_path=include_dirs,
Masood Malekghassemi68a94c82016-03-09 11:45:07 -0800141 compiler_directives=cython_compiler_directives)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700142 else:
143 return extensions
144
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700145CYTHON_EXTENSION_MODULES = cython_extensions(
Leifur Halldor Asgeirsson554c7dd2016-02-18 17:24:05 -0500146 list(CYTHON_EXTENSION_MODULE_NAMES),
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800147 list(CYTHON_HELPER_C_FILES) + list(CORE_C_FILES),
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700148 list(EXTENSION_INCLUDE_DIRECTORIES), list(EXTENSION_LIBRARIES),
Masood Malekghassemi1d177812016-01-12 09:21:57 -0800149 list(DEFINE_MACROS), bool(BUILD_WITH_CYTHON))
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700150
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700151PACKAGE_DIRECTORIES = {
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800152 '': PYTHON_STEM,
Nathaniel Manistab8b0adf2015-01-29 00:30:51 +0000153}
154
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700155INSTALL_REQUIRES = (
Masood Malekghassemi154b0ee2016-01-25 16:45:29 -0800156 'six>=1.10',
Nathaniel Manistaa1880222015-09-10 22:16:04 +0000157 'enum34>=1.0.4',
158 'futures>=2.2.0',
Masood Malekghassemiad32ff42016-01-21 15:15:38 -0800159 # TODO(atash): eventually split the grpcio package into a metapackage
160 # depending on protobuf and the runtime component (independent of protobuf)
161 'protobuf>=3.0.0a3',
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700162)
163
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700164SETUP_REQUIRES = (
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700165 'sphinx>=1.3',
Masood Malekghassemi3ee1f9b2016-02-22 18:37:18 -0800166 'sphinx_rtd_theme>=0.1.8'
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700167) + INSTALL_REQUIRES
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700168
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700169COMMAND_CLASS = {
Masood Malekghassemi791cc312015-07-27 14:22:33 -0700170 'doc': commands.SphinxDocumentation,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700171 'build_proto_modules': commands.BuildProtoModules,
Masood Malekghassemi5c147632015-07-31 14:08:19 -0700172 'build_project_metadata': commands.BuildProjectMetadata,
173 'build_py': commands.BuildPy,
Masood Malekghassemi1d177812016-01-12 09:21:57 -0800174 'build_ext': commands.BuildExt,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700175 'gather': commands.Gather,
176 'run_interop': commands.RunInterop,
Jan Tattermusche6cc9c72016-03-07 12:36:38 -0800177 'test_lite': commands.TestLite
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700178}
179
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800180# Ensure that package data is copied over before any commands have been run:
Nathaniel Manistafa6cad72016-02-05 21:26:54 +0000181credentials_dir = os.path.join(PYTHON_STEM, 'grpc/_cython/_credentials')
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800182try:
183 os.mkdir(credentials_dir)
184except OSError:
185 pass
186shutil.copyfile('etc/roots.pem', os.path.join(credentials_dir, 'roots.pem'))
187
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700188TEST_PACKAGE_DATA = {
189 'tests.interop': [
190 'credentials/ca.pem',
191 'credentials/server1.key',
192 'credentials/server1.pem',
193 ],
194 'tests.protoc_plugin': [
195 'protoc_plugin_test.proto',
196 ],
197 'tests.unit': [
198 'credentials/ca.pem',
199 'credentials/server1.key',
200 'credentials/server1.pem',
201 ],
202}
203
204TESTS_REQUIRE = (
Ken Payson22a65e12016-06-07 19:06:05 -0700205 'oauth2client>=2.1.0',
Nathaniel Manista27f62432016-01-04 19:12:29 +0000206 'protobuf>=3.0.0a3',
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700207 'coverage>=4.0',
208) + INSTALL_REQUIRES
209
210TEST_SUITE = 'tests'
211TEST_LOADER = 'tests:Loader'
212TEST_RUNNER = 'tests:Runner'
213
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800214PACKAGE_DATA = {
Masood Malekghassemif7474092016-02-12 12:04:53 -0800215 # Binaries that may or may not be present in the final installation, but are
216 # mentioned here for completeness.
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800217 'grpc._cython': [
Nathaniel Manistafa6cad72016-02-05 21:26:54 +0000218 '_credentials/roots.pem',
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800219 '_windows/grpc_c.32.python',
220 '_windows/grpc_c.64.python',
221 ],
222}
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700223if INSTALL_TESTS:
224 PACKAGE_DATA = dict(PACKAGE_DATA, **TEST_PACKAGE_DATA)
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800225 PACKAGES = setuptools.find_packages(PYTHON_STEM)
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700226else:
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800227 PACKAGES = setuptools.find_packages(
228 PYTHON_STEM, exclude=['tests', 'tests.*'])
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700229
Masood Malekghassemiab5309c2016-05-05 18:39:01 -0700230setuptools.setup(
231 name='grpcio',
232 version=grpc_version.VERSION,
233 license=LICENSE,
234 ext_modules=CYTHON_EXTENSION_MODULES,
235 packages=list(PACKAGES),
236 package_dir=PACKAGE_DIRECTORIES,
237 # TODO(atash): Figure out why auditwheel doesn't like namespace packages.
238 #namespace_packages=['grpc'],
239 package_data=PACKAGE_DATA,
240 install_requires=INSTALL_REQUIRES,
241 setup_requires=SETUP_REQUIRES,
242 cmdclass=COMMAND_CLASS,
243 tests_require=TESTS_REQUIRE,
244 test_suite=TEST_SUITE,
245 test_loader=TEST_LOADER,
246 test_runner=TEST_RUNNER,
247)