blob: e1abe7fd8ff28148be5e59162f946e79a44db43c [file] [log] [blame]
murgatroid993466c4b2016-01-12 10:26:04 -08001# Copyright 2015-2016, 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
Masood Malekghassemie540b572016-01-14 15:00:34 -080045PYTHON_STEM = './src/python/grpcio'
46CORE_INCLUDE = ('./include', '.',)
Masood Malekghassemi387e1162016-01-05 10:16:12 -080047BORINGSSL_INCLUDE = ('./third_party/boringssl/include',)
Masood Malekghassemi0cc27922016-01-22 16:32:41 -080048ZLIB_INCLUDE = ('./third_party/zlib',)
Masood Malekghassemi116982e2015-12-11 15:53:38 -080049
Masood Malekghassemid65632a2015-07-27 14:30:09 -070050# Ensure we're in the proper directory whether or not we're being used by pip.
51os.chdir(os.path.dirname(os.path.abspath(__file__)))
Masood Malekghassemi58a1dc22016-01-21 14:23:55 -080052sys.path.insert(0, os.path.abspath(PYTHON_STEM))
Masood Malekghassemid65632a2015-07-27 14:30:09 -070053
Masood Malekghassemi116982e2015-12-11 15:53:38 -080054# Break import-style to ensure we can actually find our in-repo dependencies.
Masood Malekghassemid65632a2015-07-27 14:30:09 -070055import commands
Masood Malekghassemif7474092016-02-12 12:04:53 -080056import precompiled
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',)
106 DEFINE_MACROS += (('PyMODINIT_FUNC', '__attribute__((visibility ("default"))) void'),)
107
108
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800109def cython_extensions(package_names, module_names, extra_sources, include_dirs,
110 libraries, define_macros, build_with_cython=False):
Masood Malekghassemi387e1162016-01-05 10:16:12 -0800111 if ENABLE_CYTHON_TRACING:
112 define_macros = define_macros + [('CYTHON_TRACE_NOGIL', 1)]
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700113 file_extension = 'pyx' if build_with_cython else 'c'
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800114 module_files = [os.path.join(PYTHON_STEM,
115 name.replace('.', '/') + '.' + file_extension)
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700116 for name in module_names]
117 extensions = [
118 _extension.Extension(
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800119 name=module_name,
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800120 sources=[module_file] + extra_sources,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700121 include_dirs=include_dirs, libraries=libraries,
Masood Malekghassemi387e1162016-01-05 10:16:12 -0800122 define_macros=define_macros,
Craig Tillera7f3e052016-02-05 15:02:39 -0800123 extra_compile_args=list(CFLAGS),
124 extra_link_args=list(LDFLAGS),
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700125 ) for (module_name, module_file) in zip(module_names, module_files)
126 ]
127 if build_with_cython:
128 import Cython.Build
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700129 return Cython.Build.cythonize(
130 extensions,
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800131 include_path=include_dirs,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700132 compiler_directives={'linetrace': bool(ENABLE_CYTHON_TRACING)})
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700133 else:
134 return extensions
135
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700136CYTHON_EXTENSION_MODULES = cython_extensions(
137 list(CYTHON_EXTENSION_PACKAGE_NAMES), list(CYTHON_EXTENSION_MODULE_NAMES),
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800138 list(CYTHON_HELPER_C_FILES) + list(CORE_C_FILES),
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700139 list(EXTENSION_INCLUDE_DIRECTORIES), list(EXTENSION_LIBRARIES),
Masood Malekghassemi1d177812016-01-12 09:21:57 -0800140 list(DEFINE_MACROS), bool(BUILD_WITH_CYTHON))
Masood Malekghassemi5a65bcd2015-09-25 11:27:10 -0700141
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700142PACKAGE_DIRECTORIES = {
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800143 '': PYTHON_STEM,
Nathaniel Manistab8b0adf2015-01-29 00:30:51 +0000144}
145
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700146INSTALL_REQUIRES = (
Masood Malekghassemi154b0ee2016-01-25 16:45:29 -0800147 'six>=1.10',
Nathaniel Manistaa1880222015-09-10 22:16:04 +0000148 'enum34>=1.0.4',
149 'futures>=2.2.0',
Masood Malekghassemiad32ff42016-01-21 15:15:38 -0800150 # TODO(atash): eventually split the grpcio package into a metapackage
151 # depending on protobuf and the runtime component (independent of protobuf)
152 'protobuf>=3.0.0a3',
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700153)
154
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700155SETUP_REQUIRES = (
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700156 'sphinx>=1.3',
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700157) + INSTALL_REQUIRES
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700158
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700159COMMAND_CLASS = {
Masood Malekghassemi791cc312015-07-27 14:22:33 -0700160 'doc': commands.SphinxDocumentation,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700161 'build_proto_modules': commands.BuildProtoModules,
Masood Malekghassemi5c147632015-07-31 14:08:19 -0700162 'build_project_metadata': commands.BuildProjectMetadata,
163 'build_py': commands.BuildPy,
Masood Malekghassemi1d177812016-01-12 09:21:57 -0800164 'build_ext': commands.BuildExt,
Masood Malekghassemif7474092016-02-12 12:04:53 -0800165 'build_tagged_ext': precompiled.BuildTaggedExt,
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700166 'gather': commands.Gather,
167 'run_interop': commands.RunInterop,
Jan Tattermusche6cc9c72016-03-07 12:36:38 -0800168 'test_lite': commands.TestLite
Masood Malekghassemid65632a2015-07-27 14:30:09 -0700169}
170
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800171# Ensure that package data is copied over before any commands have been run:
Nathaniel Manistafa6cad72016-02-05 21:26:54 +0000172credentials_dir = os.path.join(PYTHON_STEM, 'grpc/_cython/_credentials')
Masood Malekghassemi6d2ef172016-01-04 15:33:17 -0800173try:
174 os.mkdir(credentials_dir)
175except OSError:
176 pass
177shutil.copyfile('etc/roots.pem', os.path.join(credentials_dir, 'roots.pem'))
178
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700179TEST_PACKAGE_DATA = {
180 'tests.interop': [
181 'credentials/ca.pem',
182 'credentials/server1.key',
183 'credentials/server1.pem',
184 ],
185 'tests.protoc_plugin': [
186 'protoc_plugin_test.proto',
187 ],
188 'tests.unit': [
189 'credentials/ca.pem',
190 'credentials/server1.key',
191 'credentials/server1.pem',
192 ],
193}
194
195TESTS_REQUIRE = (
196 'oauth2client>=1.4.7',
Nathaniel Manista27f62432016-01-04 19:12:29 +0000197 'protobuf>=3.0.0a3',
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700198 'coverage>=4.0',
199) + INSTALL_REQUIRES
200
201TEST_SUITE = 'tests'
202TEST_LOADER = 'tests:Loader'
203TEST_RUNNER = 'tests:Runner'
204
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800205PACKAGE_DATA = {
Masood Malekghassemif7474092016-02-12 12:04:53 -0800206 # Binaries that may or may not be present in the final installation, but are
207 # mentioned here for completeness.
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800208 'grpc._cython': [
Nathaniel Manistafa6cad72016-02-05 21:26:54 +0000209 '_credentials/roots.pem',
Masood Malekghassemidf1e07e2016-02-02 14:17:14 -0800210 '_windows/grpc_c.32.python',
211 '_windows/grpc_c.64.python',
212 ],
213}
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700214if INSTALL_TESTS:
215 PACKAGE_DATA = dict(PACKAGE_DATA, **TEST_PACKAGE_DATA)
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800216 PACKAGES = setuptools.find_packages(PYTHON_STEM)
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700217else:
Masood Malekghassemi116982e2015-12-11 15:53:38 -0800218 PACKAGES = setuptools.find_packages(
219 PYTHON_STEM, exclude=['tests', 'tests.*'])
Masood Malekghassemi7566c9a2015-10-21 20:29:23 -0700220
Masood Malekghassemif7474092016-02-12 12:04:53 -0800221setup_arguments = {
222 'name': 'grpcio',
223 'version': grpc_version.VERSION,
224 'license': LICENSE,
225 'ext_modules': CYTHON_EXTENSION_MODULES,
226 'packages': list(PACKAGES),
227 'package_dir': PACKAGE_DIRECTORIES,
228 'package_data': PACKAGE_DATA,
229 'install_requires': INSTALL_REQUIRES,
230 'setup_requires': SETUP_REQUIRES,
231 'cmdclass': COMMAND_CLASS,
232 'tests_require': TESTS_REQUIRE,
Masood Malekghassemi603b0762016-02-12 15:19:22 -0800233 'test_suite': TEST_SUITE,
Masood Malekghassemif7474092016-02-12 12:04:53 -0800234 'test_loader': TEST_LOADER,
235 'test_runner': TEST_RUNNER,
236}
237
238precompiled.update_setup_arguments(setup_arguments)
239
240setuptools.setup(**setup_arguments)