Nathaniel Manista | b68f3d1 | 2015-01-23 21:32:47 +0000 | [diff] [blame] | 1 | # Copyright 2015, Google Inc. |
| 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 |
Alexander Staubo | 8eac91e | 2015-04-06 12:06:22 -0400 | [diff] [blame] | 34 | import sys |
Nathaniel Manista | b68f3d1 | 2015-01-23 21:32:47 +0000 | [diff] [blame] | 35 | |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 36 | from distutils import core as _core |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 37 | from distutils import extension as _extension |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 38 | import setuptools |
| 39 | |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 40 | PYTHON_STEM = './src/python/grpcio/' |
| 41 | CORE_INCLUDE = ('./include', './',) |
| 42 | |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 43 | # Ensure we're in the proper directory whether or not we're being used by pip. |
| 44 | os.chdir(os.path.dirname(os.path.abspath(__file__))) |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 45 | sys.path.insert(0, PYTHON_STEM) |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 46 | |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 47 | # 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] | 48 | import commands |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 49 | import grpc_core_dependencies |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 50 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 51 | # Environment variable to determine whether or not the Cython extension should |
| 52 | # *use* Cython or use the generated C files. Note that this requires the C files |
| 53 | # to have been generated by building first *with* Cython support. |
| 54 | BUILD_WITH_CYTHON = os.environ.get('GRPC_PYTHON_BUILD_WITH_CYTHON', False) |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 55 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 56 | # Environment variable to determine whether or not to enable coverage analysis |
| 57 | # in Cython modules. |
| 58 | ENABLE_CYTHON_TRACING = os.environ.get( |
| 59 | 'GRPC_PYTHON_ENABLE_CYTHON_TRACING', False) |
| 60 | |
| 61 | # Environment variable to determine whether or not to include the test files in |
| 62 | # the installation. |
| 63 | INSTALL_TESTS = os.environ.get('GRPC_PYTHON_INSTALL_TESTS', False) |
| 64 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 65 | CYTHON_EXTENSION_PACKAGE_NAMES = () |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 66 | |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 67 | CYTHON_EXTENSION_MODULE_NAMES = ('grpc._cython.cygrpc',) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 68 | |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 69 | EXTENSION_INCLUDE_DIRECTORIES = (PYTHON_STEM,) + CORE_INCLUDE |
Nathaniel Manista | a4ead5d | 2015-01-31 01:33:27 +0000 | [diff] [blame] | 70 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 71 | EXTENSION_LIBRARIES = ( |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 72 | 'ssl', |
| 73 | 'crypto', |
Nathaniel Manista | a4ead5d | 2015-01-31 01:33:27 +0000 | [diff] [blame] | 74 | ) |
Alexander Staubo | 8eac91e | 2015-04-06 12:06:22 -0400 | [diff] [blame] | 75 | if not "darwin" in sys.platform: |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 76 | EXTENSION_LIBRARIES += ('rt',) |
Nathaniel Manista | a4ead5d | 2015-01-31 01:33:27 +0000 | [diff] [blame] | 77 | |
Masood Malekghassemi | 743c10c | 2015-06-16 18:05:27 -0700 | [diff] [blame] | 78 | |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 79 | def cython_extensions(package_names, module_names, include_dirs, libraries, |
| 80 | build_with_cython=False): |
| 81 | file_extension = 'pyx' if build_with_cython else 'c' |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 82 | module_files = [os.path.join(PYTHON_STEM, |
| 83 | name.replace('.', '/') + '.' + file_extension) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 84 | for name in module_names] |
| 85 | extensions = [ |
| 86 | _extension.Extension( |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 87 | name=module_name, |
| 88 | sources=[module_file] + grpc_core_dependencies.CORE_SOURCE_FILES, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 89 | include_dirs=include_dirs, libraries=libraries, |
| 90 | define_macros=[('CYTHON_TRACE_NOGIL', 1)] if ENABLE_CYTHON_TRACING else [] |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 91 | ) for (module_name, module_file) in zip(module_names, module_files) |
| 92 | ] |
| 93 | if build_with_cython: |
| 94 | import Cython.Build |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 95 | return Cython.Build.cythonize( |
| 96 | extensions, |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 97 | include_path=include_dirs, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 98 | compiler_directives={'linetrace': bool(ENABLE_CYTHON_TRACING)}) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 99 | else: |
| 100 | return extensions |
| 101 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 102 | CYTHON_EXTENSION_MODULES = cython_extensions( |
| 103 | list(CYTHON_EXTENSION_PACKAGE_NAMES), list(CYTHON_EXTENSION_MODULE_NAMES), |
| 104 | list(EXTENSION_INCLUDE_DIRECTORIES), list(EXTENSION_LIBRARIES), |
| 105 | bool(BUILD_WITH_CYTHON)) |
Masood Malekghassemi | 5a65bcd | 2015-09-25 11:27:10 -0700 | [diff] [blame] | 106 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 107 | PACKAGE_DIRECTORIES = { |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 108 | '': PYTHON_STEM, |
Nathaniel Manista | b8b0adf | 2015-01-29 00:30:51 +0000 | [diff] [blame] | 109 | } |
| 110 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 111 | INSTALL_REQUIRES = ( |
Nathaniel Manista | a188022 | 2015-09-10 22:16:04 +0000 | [diff] [blame] | 112 | 'enum34>=1.0.4', |
| 113 | 'futures>=2.2.0', |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 114 | ) |
| 115 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 116 | SETUP_REQUIRES = ( |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 117 | 'sphinx>=1.3', |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 118 | ) + INSTALL_REQUIRES |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 119 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 120 | COMMAND_CLASS = { |
Masood Malekghassemi | 791cc31 | 2015-07-27 14:22:33 -0700 | [diff] [blame] | 121 | 'doc': commands.SphinxDocumentation, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 122 | 'build_proto_modules': commands.BuildProtoModules, |
Masood Malekghassemi | 5c14763 | 2015-07-31 14:08:19 -0700 | [diff] [blame] | 123 | 'build_project_metadata': commands.BuildProjectMetadata, |
| 124 | 'build_py': commands.BuildPy, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 125 | 'gather': commands.Gather, |
| 126 | 'run_interop': commands.RunInterop, |
Masood Malekghassemi | d65632a | 2015-07-27 14:30:09 -0700 | [diff] [blame] | 127 | } |
| 128 | |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 129 | TEST_PACKAGE_DATA = { |
| 130 | 'tests.interop': [ |
| 131 | 'credentials/ca.pem', |
| 132 | 'credentials/server1.key', |
| 133 | 'credentials/server1.pem', |
| 134 | ], |
| 135 | 'tests.protoc_plugin': [ |
| 136 | 'protoc_plugin_test.proto', |
| 137 | ], |
| 138 | 'tests.unit': [ |
| 139 | 'credentials/ca.pem', |
| 140 | 'credentials/server1.key', |
| 141 | 'credentials/server1.pem', |
| 142 | ], |
| 143 | } |
| 144 | |
| 145 | TESTS_REQUIRE = ( |
| 146 | 'oauth2client>=1.4.7', |
Nathaniel Manista | 27f6243 | 2016-01-04 19:12:29 +0000 | [diff] [blame] | 147 | 'protobuf>=3.0.0a3', |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 148 | 'coverage>=4.0', |
| 149 | ) + INSTALL_REQUIRES |
| 150 | |
| 151 | TEST_SUITE = 'tests' |
| 152 | TEST_LOADER = 'tests:Loader' |
| 153 | TEST_RUNNER = 'tests:Runner' |
| 154 | |
| 155 | PACKAGE_DATA = {} |
| 156 | if INSTALL_TESTS: |
| 157 | PACKAGE_DATA = dict(PACKAGE_DATA, **TEST_PACKAGE_DATA) |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 158 | PACKAGES = setuptools.find_packages(PYTHON_STEM) |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 159 | else: |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 160 | PACKAGES = setuptools.find_packages( |
| 161 | PYTHON_STEM, exclude=['tests', 'tests.*']) |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 162 | |
Masood Malekghassemi | 451887b | 2015-03-30 17:44:19 -0700 | [diff] [blame] | 163 | setuptools.setup( |
| 164 | name='grpcio', |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 165 | version='0.12.0b1', |
Masood Malekghassemi | f21dc7e | 2015-11-20 19:28:41 -0800 | [diff] [blame] | 166 | ext_modules=CYTHON_EXTENSION_MODULES, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 167 | packages=list(PACKAGES), |
| 168 | package_dir=PACKAGE_DIRECTORIES, |
Masood Malekghassemi | 116982e | 2015-12-11 15:53:38 -0800 | [diff] [blame^] | 169 | package_data=PACKAGE_DATA, |
Masood Malekghassemi | 7566c9a | 2015-10-21 20:29:23 -0700 | [diff] [blame] | 170 | install_requires=INSTALL_REQUIRES, |
| 171 | setup_requires=SETUP_REQUIRES, |
| 172 | cmdclass=COMMAND_CLASS, |
| 173 | tests_require=TESTS_REQUIRE, |
| 174 | test_suite=TEST_SUITE, |
| 175 | test_loader=TEST_LOADER, |
| 176 | test_runner=TEST_RUNNER, |
Masood Malekghassemi | 451887b | 2015-03-30 17:44:19 -0700 | [diff] [blame] | 177 | ) |