murgatroid99 | 3466c4b | 2016-01-12 10:26:04 -0800 | [diff] [blame] | 1 | # Copyright 2015-2016, Google Inc. |
Nathaniel Manista | b68f3d1 | 2015-01-23 21:32:47 +0000 | [diff] [blame] | 2 | # 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 Manista | b8b0adf | 2015-01-29 00:30:51 +0000 | [diff] [blame] | 30 | """A setup module for the GRPC Python package.""" |
Nathaniel Manista | b68f3d1 | 2015-01-23 21:32:47 +0000 | [diff] [blame] | 31 | |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 32 | import os |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 33 | import os.path |
Masood Malekghassemi | 6d2ef17 | 2016-01-04 15:33:17 -0800 | [diff] [blame] | 34 | import shutil |
Alexander Staubo | 8eac91e | 2015-04-06 12:06:22 -0400 | [diff] [blame] | 35 | import sys |
Nathaniel Manista | b68f3d1 | 2015-01-23 21:32:47 +0000 | [diff] [blame] | 36 | |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 37 | from distutils import core as _core |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 38 | from distutils import extension as _extension |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 39 | import setuptools |
Masood Malekghassemi | b7e7b3f | 2015-12-17 00:16:49 -0800 | [diff] [blame] | 40 | from setuptools.command import egg_info |
| 41 | |
| 42 | # Redirect the manifest template from MANIFEST.in to PYTHON-MANIFEST.in. |
| 43 | egg_info.manifest_maker.template = 'PYTHON-MANIFEST.in' |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 44 | |
Masood Malekghassemi | e540b57 | 2016-01-14 15:00:34 -0800 | [diff] [blame] | 45 | PYTHON_STEM = './src/python/grpcio' |
| 46 | CORE_INCLUDE = ('./include', '.',) |
Masood Malekghassemi | 387e116 | 2016-01-05 10:16:12 -0800 | [diff] [blame] | 47 | BORINGSSL_INCLUDE = ('./third_party/boringssl/include',) |
Masood Malekghassemi | 0cc2792 | 2016-01-22 16:32:41 -0800 | [diff] [blame] | 48 | ZLIB_INCLUDE = ('./third_party/zlib',) |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 49 | |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 50 | # Ensure we're in the proper directory whether or not we're being used by pip. |
| 51 | os.chdir(os.path.dirname(os.path.abspath(__file__))) |
Masood Malekghassemi | 58a1dc2 | 2016-01-21 14:23:55 -0800 | [diff] [blame] | 52 | sys.path.insert(0, os.path.abspath(PYTHON_STEM)) |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 53 | |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 54 | # Break import-style to ensure we can actually find our in-repo dependencies. |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 55 | import commands |
Masood Malekghassemi | f747409 | 2016-02-12 12:04:53 -0800 | [diff] [blame] | 56 | import precompiled |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 57 | import grpc_core_dependencies |
Craig Tiller | f008f06 | 2016-02-08 12:48:03 -0800 | [diff] [blame] | 58 | import grpc_version |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 59 | |
Masood Malekghassemi | df97aec | 2016-01-11 16:19:14 -0800 | [diff] [blame] | 60 | LICENSE = '3-clause BSD' |
| 61 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 62 | # 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. |
| 65 | BUILD_WITH_CYTHON = os.environ.get('GRPC_PYTHON_BUILD_WITH_CYTHON', False) |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 66 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 67 | # Environment variable to determine whether or not to enable coverage analysis |
| 68 | # in Cython modules. |
| 69 | ENABLE_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. |
| 74 | INSTALL_TESTS = os.environ.get('GRPC_PYTHON_INSTALL_TESTS', False) |
| 75 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 76 | CYTHON_EXTENSION_PACKAGE_NAMES = () |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 77 | |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 78 | CYTHON_EXTENSION_MODULE_NAMES = ('grpc._cython.cygrpc',) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 79 | |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 80 | CYTHON_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 | |
| 85 | CORE_C_FILES = () |
| 86 | if not "win32" in sys.platform: |
Masood Malekghassemi | 10509a2 | 2016-02-03 13:32:22 -0800 | [diff] [blame] | 87 | CORE_C_FILES += tuple(grpc_core_dependencies.CORE_SOURCE_FILES) |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 88 | |
Masood Malekghassemi | 387e116 | 2016-01-05 10:16:12 -0800 | [diff] [blame] | 89 | EXTENSION_INCLUDE_DIRECTORIES = ( |
Masood Malekghassemi | 0cc2792 | 2016-01-22 16:32:41 -0800 | [diff] [blame] | 90 | (PYTHON_STEM,) + CORE_INCLUDE + BORINGSSL_INCLUDE + ZLIB_INCLUDE) |
Nathaniel Manista | a4ead5d | 2015-01-31 01:33:27 +0000 | [diff] [blame] | 91 | |
Masood Malekghassemi | 10509a2 | 2016-02-03 13:32:22 -0800 | [diff] [blame] | 92 | EXTENSION_LIBRARIES = () |
Masood Malekghassemi | c9c53ee | 2016-02-03 10:30:23 -0800 | [diff] [blame] | 93 | if "linux" in sys.platform: |
Craig Tiller | 4bef7ce | 2016-02-02 08:38:43 -0800 | [diff] [blame] | 94 | EXTENSION_LIBRARIES += ('rt',) |
Masood Malekghassemi | 10509a2 | 2016-02-03 13:32:22 -0800 | [diff] [blame] | 95 | if not "win32" in sys.platform: |
| 96 | EXTENSION_LIBRARIES += ('m',) |
Nathaniel Manista | a4ead5d | 2015-01-31 01:33:27 +0000 | [diff] [blame] | 97 | |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 98 | DEFINE_MACROS = (('OPENSSL_NO_ASM', 1), ('_WIN32_WINNT', 0x600)) |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 99 | |
Craig Tiller | 00572a9 | 2016-02-02 08:45:46 -0800 | [diff] [blame] | 100 | CFLAGS = () |
| 101 | LDFLAGS = () |
Craig Tiller | 4bef7ce | 2016-02-02 08:38:43 -0800 | [diff] [blame] | 102 | if "linux" in sys.platform: |
| 103 | LDFLAGS += ('-Wl,-wrap,memcpy',) |
| 104 | if "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 Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 109 | def cython_extensions(package_names, module_names, extra_sources, include_dirs, |
| 110 | libraries, define_macros, build_with_cython=False): |
Masood Malekghassemi | 387e116 | 2016-01-05 10:16:12 -0800 | [diff] [blame] | 111 | if ENABLE_CYTHON_TRACING: |
| 112 | define_macros = define_macros + [('CYTHON_TRACE_NOGIL', 1)] |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 113 | file_extension = 'pyx' if build_with_cython else 'c' |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 114 | module_files = [os.path.join(PYTHON_STEM, |
| 115 | name.replace('.', '/') + '.' + file_extension) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 116 | for name in module_names] |
| 117 | extensions = [ |
| 118 | _extension.Extension( |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 119 | name=module_name, |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 120 | sources=[module_file] + extra_sources, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 121 | include_dirs=include_dirs, libraries=libraries, |
Masood Malekghassemi | 387e116 | 2016-01-05 10:16:12 -0800 | [diff] [blame] | 122 | define_macros=define_macros, |
Craig Tiller | a7f3e05 | 2016-02-05 15:02:39 -0800 | [diff] [blame] | 123 | extra_compile_args=list(CFLAGS), |
| 124 | extra_link_args=list(LDFLAGS), |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 125 | ) for (module_name, module_file) in zip(module_names, module_files) |
| 126 | ] |
| 127 | if build_with_cython: |
| 128 | import Cython.Build |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 129 | return Cython.Build.cythonize( |
| 130 | extensions, |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 131 | include_path=include_dirs, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 132 | compiler_directives={'linetrace': bool(ENABLE_CYTHON_TRACING)}) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 133 | else: |
| 134 | return extensions |
| 135 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 136 | CYTHON_EXTENSION_MODULES = cython_extensions( |
| 137 | list(CYTHON_EXTENSION_PACKAGE_NAMES), list(CYTHON_EXTENSION_MODULE_NAMES), |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 138 | list(CYTHON_HELPER_C_FILES) + list(CORE_C_FILES), |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 139 | list(EXTENSION_INCLUDE_DIRECTORIES), list(EXTENSION_LIBRARIES), |
Masood Malekghassemi | 1d17781 | 2016-01-12 09:21:57 -0800 | [diff] [blame] | 140 | list(DEFINE_MACROS), bool(BUILD_WITH_CYTHON)) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 141 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 142 | PACKAGE_DIRECTORIES = { |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 143 | '': PYTHON_STEM, |
Nathaniel Manista | b8b0adf | 2015-01-29 00:30:51 +0000 | [diff] [blame] | 144 | } |
| 145 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 146 | INSTALL_REQUIRES = ( |
Masood Malekghassemi | 154b0ee | 2016-01-25 16:45:29 -0800 | [diff] [blame] | 147 | 'six>=1.10', |
Nathaniel Manista | a188022 | 2015-09-10 22:16:04 +0000 | [diff] [blame] | 148 | 'enum34>=1.0.4', |
| 149 | 'futures>=2.2.0', |
Masood Malekghassemi | ad32ff4 | 2016-01-21 15:15:38 -0800 | [diff] [blame] | 150 | # 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 Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 153 | ) |
| 154 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 155 | SETUP_REQUIRES = ( |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 156 | 'sphinx>=1.3', |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 157 | ) + INSTALL_REQUIRES |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 158 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 159 | COMMAND_CLASS = { |
Masood Malekghassemi | 791cc31 | 2015-07-27 14:22:33 -0700 | [diff] [blame] | 160 | 'doc': commands.SphinxDocumentation, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 161 | 'build_proto_modules': commands.BuildProtoModules, |
Masood Malekghassemi | 5c14763 | 2015-07-31 14:08:19 -0700 | [diff] [blame] | 162 | 'build_project_metadata': commands.BuildProjectMetadata, |
| 163 | 'build_py': commands.BuildPy, |
Masood Malekghassemi | 1d17781 | 2016-01-12 09:21:57 -0800 | [diff] [blame] | 164 | 'build_ext': commands.BuildExt, |
Masood Malekghassemi | f747409 | 2016-02-12 12:04:53 -0800 | [diff] [blame] | 165 | 'build_tagged_ext': precompiled.BuildTaggedExt, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 166 | 'gather': commands.Gather, |
| 167 | 'run_interop': commands.RunInterop, |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 168 | } |
| 169 | |
Masood Malekghassemi | 6d2ef17 | 2016-01-04 15:33:17 -0800 | [diff] [blame] | 170 | # Ensure that package data is copied over before any commands have been run: |
| 171 | credentials_dir = os.path.join(PYTHON_STEM, 'grpc/_adapter/credentials') |
| 172 | try: |
| 173 | os.mkdir(credentials_dir) |
| 174 | except OSError: |
| 175 | pass |
| 176 | shutil.copyfile('etc/roots.pem', os.path.join(credentials_dir, 'roots.pem')) |
| 177 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 178 | TEST_PACKAGE_DATA = { |
| 179 | 'tests.interop': [ |
| 180 | 'credentials/ca.pem', |
| 181 | 'credentials/server1.key', |
| 182 | 'credentials/server1.pem', |
| 183 | ], |
| 184 | 'tests.protoc_plugin': [ |
| 185 | 'protoc_plugin_test.proto', |
| 186 | ], |
| 187 | 'tests.unit': [ |
| 188 | 'credentials/ca.pem', |
| 189 | 'credentials/server1.key', |
| 190 | 'credentials/server1.pem', |
| 191 | ], |
| 192 | } |
| 193 | |
| 194 | TESTS_REQUIRE = ( |
| 195 | 'oauth2client>=1.4.7', |
Nathaniel Manista | 27f6243 | 2016-01-04 19:12:29 +0000 | [diff] [blame] | 196 | 'protobuf>=3.0.0a3', |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 197 | 'coverage>=4.0', |
| 198 | ) + INSTALL_REQUIRES |
| 199 | |
| 200 | TEST_SUITE = 'tests' |
| 201 | TEST_LOADER = 'tests:Loader' |
| 202 | TEST_RUNNER = 'tests:Runner' |
| 203 | |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 204 | PACKAGE_DATA = { |
| 205 | 'grpc._adapter': [ |
| 206 | 'credentials/roots.pem' |
| 207 | ], |
Masood Malekghassemi | f747409 | 2016-02-12 12:04:53 -0800 | [diff] [blame] | 208 | # Binaries that may or may not be present in the final installation, but are |
| 209 | # mentioned here for completeness. |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 210 | 'grpc._cython': [ |
Masood Malekghassemi | df1e07e | 2016-02-02 14:17:14 -0800 | [diff] [blame] | 211 | '_windows/grpc_c.32.python', |
| 212 | '_windows/grpc_c.64.python', |
| 213 | ], |
| 214 | } |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 215 | if INSTALL_TESTS: |
| 216 | PACKAGE_DATA = dict(PACKAGE_DATA, **TEST_PACKAGE_DATA) |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 217 | PACKAGES = setuptools.find_packages(PYTHON_STEM) |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 218 | else: |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame] | 219 | PACKAGES = setuptools.find_packages( |
| 220 | PYTHON_STEM, exclude=['tests', 'tests.*']) |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 221 | |
Masood Malekghassemi | f747409 | 2016-02-12 12:04:53 -0800 | [diff] [blame] | 222 | setup_arguments = { |
| 223 | 'name': 'grpcio', |
| 224 | 'version': grpc_version.VERSION, |
| 225 | 'license': LICENSE, |
| 226 | 'ext_modules': CYTHON_EXTENSION_MODULES, |
| 227 | 'packages': list(PACKAGES), |
| 228 | 'package_dir': PACKAGE_DIRECTORIES, |
| 229 | 'package_data': PACKAGE_DATA, |
| 230 | 'install_requires': INSTALL_REQUIRES, |
| 231 | 'setup_requires': SETUP_REQUIRES, |
| 232 | 'cmdclass': COMMAND_CLASS, |
| 233 | 'tests_require': TESTS_REQUIRE, |
Masood Malekghassemi | 603b076 | 2016-02-12 15:19:22 -0800 | [diff] [blame] | 234 | 'test_suite': TEST_SUITE, |
Masood Malekghassemi | f747409 | 2016-02-12 12:04:53 -0800 | [diff] [blame] | 235 | 'test_loader': TEST_LOADER, |
| 236 | 'test_runner': TEST_RUNNER, |
| 237 | } |
| 238 | |
| 239 | precompiled.update_setup_arguments(setup_arguments) |
| 240 | |
| 241 | setuptools.setup(**setup_arguments) |