setup.py 10.5 KB
Newer Older
1
#! /usr/bin/env python
temporal's avatar
temporal committed
2 3
#
# See README for usage instructions.
4
import glob
5 6
import os
import subprocess
7
import sys
8
import platform
temporal's avatar
temporal committed
9 10 11

# We must use setuptools, not distutils, because we need to use the
# namespace_packages option for the "google" package.
12
from setuptools import setup, Extension, find_packages
13

14
from distutils.command.clean import clean as _clean
15 16 17 18

if sys.version_info[0] == 3:
  # Python 3
  from distutils.command.build_py import build_py_2to3 as _build_py
19
else:
20 21
  # Python 2
  from distutils.command.build_py import build_py as _build_py
temporal's avatar
temporal committed
22 23 24
from distutils.spawn import find_executable

# Find the Protocol Compiler.
25 26 27
if 'PROTOC' in os.environ and os.path.exists(os.environ['PROTOC']):
  protoc = os.environ['PROTOC']
elif os.path.exists("../src/protoc"):
temporal's avatar
temporal committed
28
  protoc = "../src/protoc"
29 30
elif os.path.exists("../src/protoc.exe"):
  protoc = "../src/protoc.exe"
31 32 33 34
elif os.path.exists("../vsprojects/Debug/protoc.exe"):
  protoc = "../vsprojects/Debug/protoc.exe"
elif os.path.exists("../vsprojects/Release/protoc.exe"):
  protoc = "../vsprojects/Release/protoc.exe"
temporal's avatar
temporal committed
35 36 37
else:
  protoc = find_executable("protoc")

38

39 40 41
def GetVersion():
  """Gets the version from google/protobuf/__init__.py

42 43
  Do not import google.protobuf.__init__ directly, because an installed
  protobuf library may be loaded instead."""
44 45

  with open(os.path.join('google', 'protobuf', '__init__.py')) as version_file:
Behzad Tabibian's avatar
Behzad Tabibian committed
46
    exec(version_file.read(), globals())
47
    global __version__
48 49 50
    return __version__


51
def generate_proto(source, require = True):
temporal's avatar
temporal committed
52 53 54 55
  """Invokes the Protocol Compiler to generate a _pb2.py from the given
  .proto file.  Does nothing if the output already exists and is newer than
  the input."""

56 57 58
  if not require and not os.path.exists(source):
    return

temporal's avatar
temporal committed
59 60 61 62 63
  output = source.replace(".proto", "_pb2.py").replace("../src/", "")

  if (not os.path.exists(output) or
      (os.path.exists(source) and
       os.path.getmtime(source) > os.path.getmtime(output))):
64
    print("Generating %s..." % output)
temporal's avatar
temporal committed
65

66 67 68 69
    if not os.path.exists(source):
      sys.stderr.write("Can't find required file: %s\n" % source)
      sys.exit(-1)

70
    if protoc is None:
temporal's avatar
temporal committed
71 72 73 74 75
      sys.stderr.write(
          "protoc is not installed nor found in ../src.  Please compile it "
          "or install the binary package.\n")
      sys.exit(-1)

76 77
    protoc_command = [ protoc, "-I../src", "-I.", "--python_out=.", source ]
    if subprocess.call(protoc_command) != 0:
temporal's avatar
temporal committed
78 79
      sys.exit(-1)

80
def GenerateUnittestProtos():
81
  generate_proto("../src/google/protobuf/any_test.proto", False)
82
  generate_proto("../src/google/protobuf/map_proto2_unittest.proto", False)
83
  generate_proto("../src/google/protobuf/map_unittest.proto", False)
84
  generate_proto("../src/google/protobuf/test_messages_proto3.proto", False)
85
  generate_proto("../src/google/protobuf/test_messages_proto2.proto", False)
86 87 88
  generate_proto("../src/google/protobuf/unittest_arena.proto", False)
  generate_proto("../src/google/protobuf/unittest_no_arena.proto", False)
  generate_proto("../src/google/protobuf/unittest_no_arena_import.proto", False)
89 90 91 92 93
  generate_proto("../src/google/protobuf/unittest.proto", False)
  generate_proto("../src/google/protobuf/unittest_custom_options.proto", False)
  generate_proto("../src/google/protobuf/unittest_import.proto", False)
  generate_proto("../src/google/protobuf/unittest_import_public.proto", False)
  generate_proto("../src/google/protobuf/unittest_mset.proto", False)
94
  generate_proto("../src/google/protobuf/unittest_mset_wire_format.proto", False)
95 96
  generate_proto("../src/google/protobuf/unittest_no_generic_services.proto", False)
  generate_proto("../src/google/protobuf/unittest_proto3_arena.proto", False)
97
  generate_proto("../src/google/protobuf/util/json_format_proto3.proto", False)
98
  generate_proto("google/protobuf/internal/any_test.proto", False)
99 100 101 102
  generate_proto("google/protobuf/internal/descriptor_pool_test1.proto", False)
  generate_proto("google/protobuf/internal/descriptor_pool_test2.proto", False)
  generate_proto("google/protobuf/internal/factory_test1.proto", False)
  generate_proto("google/protobuf/internal/factory_test2.proto", False)
103
  generate_proto("google/protobuf/internal/file_options_test.proto", False)
104 105 106
  generate_proto("google/protobuf/internal/import_test_package/inner.proto", False)
  generate_proto("google/protobuf/internal/import_test_package/outer.proto", False)
  generate_proto("google/protobuf/internal/missing_enum_values.proto", False)
107
  generate_proto("google/protobuf/internal/message_set_extensions.proto", False)
108 109 110
  generate_proto("google/protobuf/internal/more_extensions.proto", False)
  generate_proto("google/protobuf/internal/more_extensions_dynamic.proto", False)
  generate_proto("google/protobuf/internal/more_messages.proto", False)
111
  generate_proto("google/protobuf/internal/no_package.proto", False)
112
  generate_proto("google/protobuf/internal/packed_field_test.proto", False)
113 114
  generate_proto("google/protobuf/internal/test_bad_identifiers.proto", False)
  generate_proto("google/protobuf/pyext/python.proto", False)
115

116

117 118 119
class clean(_clean):
  def run(self):
    # Delete generated files in the code tree.
temporal's avatar
temporal committed
120 121 122
    for (dirpath, dirnames, filenames) in os.walk("."):
      for filename in filenames:
        filepath = os.path.join(dirpath, filename)
123
        if filepath.endswith("_pb2.py") or filepath.endswith(".pyc") or \
124
          filepath.endswith(".so") or filepath.endswith(".o"):
temporal's avatar
temporal committed
125
          os.remove(filepath)
126 127 128 129 130
    # _clean is an old-style class, so super() doesn't work.
    _clean.run(self)

class build_py(_build_py):
  def run(self):
temporal's avatar
temporal committed
131 132
    # Generate necessary .proto file if it doesn't exist.
    generate_proto("../src/google/protobuf/descriptor.proto")
133
    generate_proto("../src/google/protobuf/compiler/plugin.proto")
134
    generate_proto("../src/google/protobuf/any.proto")
135 136 137
    generate_proto("../src/google/protobuf/api.proto")
    generate_proto("../src/google/protobuf/duration.proto")
    generate_proto("../src/google/protobuf/empty.proto")
138
    generate_proto("../src/google/protobuf/field_mask.proto")
139 140 141 142 143
    generate_proto("../src/google/protobuf/source_context.proto")
    generate_proto("../src/google/protobuf/struct.proto")
    generate_proto("../src/google/protobuf/timestamp.proto")
    generate_proto("../src/google/protobuf/type.proto")
    generate_proto("../src/google/protobuf/wrappers.proto")
144 145
    GenerateUnittestProtos()

146 147
    # _build_py is an old-style class, so super() doesn't work.
    _build_py.run(self)
148

149 150 151
class test_conformance(_build_py):
  target = 'test_python'
  def run(self):
152 153 154
    # Python 2.6 dodges these extra failures.
    os.environ["CONFORMANCE_PYTHON_EXTRA_FAILURES"] = (
        "--failure_list failure_list_python-post26.txt")
155 156
    cmd = 'cd ../conformance && make %s' % (test_conformance.target)
    status = subprocess.check_call(cmd, shell=True)
157

158

159 160 161 162 163 164 165
def get_option_from_sys_argv(option_str):
  if option_str in sys.argv:
    sys.argv.remove(option_str)
    return True
  return False


166
if __name__ == '__main__':
167
  ext_module_list = []
168
  warnings_as_errors = '--warnings_as_errors'
169 170 171 172 173 174 175 176 177 178 179
  if get_option_from_sys_argv('--cpp_implementation'):
    # Link libprotobuf.a and libprotobuf-lite.a statically with the
    # extension. Note that those libraries have to be compiled with
    # -fPIC for this to work.
    compile_static_ext = get_option_from_sys_argv('--compile_static_extension')
    libraries = ['protobuf']
    extra_objects = None
    if compile_static_ext:
      libraries = None
      extra_objects = ['../src/.libs/libprotobuf.a',
                       '../src/.libs/libprotobuf-lite.a']
180
    test_conformance.target = 'test_python_cpp'
181

Paul Yang's avatar
Paul Yang committed
182 183 184 185 186 187
    extra_compile_args = []

    if sys.platform != 'win32':
        extra_compile_args.append('-Wno-write-strings')
        extra_compile_args.append('-Wno-invalid-offsetof')
        extra_compile_args.append('-Wno-sign-compare')
Feng Xiao's avatar
Feng Xiao committed
188
        extra_compile_args.append('-Wno-unused-variable')
189
        extra_compile_args.append('-std=c++11')
Paul Yang's avatar
Paul Yang committed
190

Feng Xiao's avatar
Feng Xiao committed
191 192 193
    if sys.platform == 'darwin':
      extra_compile_args.append("-Wno-shorten-64-to-32");

Paul Yang's avatar
Paul Yang committed
194 195 196 197 198 199 200 201 202
    # https://github.com/Theano/Theano/issues/4926
    if sys.platform == 'win32':
      extra_compile_args.append('-D_hypot=hypot')

    # https://github.com/tpaviot/pythonocc-core/issues/48
    if sys.platform == 'win32' and  '64 bit' in sys.version:
      extra_compile_args.append('-DMS_WIN64')

    # MSVS default is dymanic
203
    if (sys.platform == 'win32'):
Paul Yang's avatar
Paul Yang committed
204 205
      extra_compile_args.append('/MT')

206
    if "clang" in os.popen('$CC --version 2> /dev/null').read():
207
      extra_compile_args.append('-Wno-shorten-64-to-32')
208 209 210 211 212

    if warnings_as_errors in sys.argv:
      extra_compile_args.append('-Werror')
      sys.argv.remove(warnings_as_errors)

213
    # C++ implementation extension
214
    ext_module_list.extend([
215 216
        Extension(
            "google.protobuf.pyext._message",
217
            glob.glob('google/protobuf/pyext/*.cc'),
218
            include_dirs=[".", "../src"],
219 220
            libraries=libraries,
            extra_objects=extra_objects,
221
            library_dirs=['../src/.libs'],
222
            extra_compile_args=extra_compile_args,
223 224 225 226
        ),
        Extension(
            "google.protobuf.internal._api_implementation",
            glob.glob('google/protobuf/internal/api_implementation.cc'),
Paul Yang's avatar
Paul Yang committed
227
            extra_compile_args=extra_compile_args + ['-DPYTHON_PROTO2_CPP_IMPL_V2'],
228 229
        ),
    ])
230
    os.environ['PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION'] = 'cpp'
231

Dan O'Reilly's avatar
Dan O'Reilly committed
232
  # Keep this list of dependencies in sync with tox.ini.
233
  install_requires = ['six>=1.9', 'setuptools']
Dan O'Reilly's avatar
Dan O'Reilly committed
234 235 236 237
  if sys.version_info <= (2,7):
    install_requires.append('ordereddict')
    install_requires.append('unittest2')

238 239 240 241
  setup(
      name='protobuf',
      version=GetVersion(),
      description='Protocol Buffers',
242
      download_url='https://github.com/google/protobuf/releases',
243 244 245 246
      long_description="Protocol Buffers are Google's data interchange format",
      url='https://developers.google.com/protocol-buffers/',
      maintainer='protobuf@googlegroups.com',
      maintainer_email='protobuf@googlegroups.com',
247
      license='3-Clause BSD License',
248
      classifiers=[
249 250 251 252 253 254 255
        "Programming Language :: Python",
        "Programming Language :: Python :: 2",
        "Programming Language :: Python :: 2.7",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.3",
        "Programming Language :: Python :: 3.4",
        ],
256
      namespace_packages=['google'],
257 258 259 260 261 262 263 264 265
      packages=find_packages(
          exclude=[
              'import_test_package',
          ],
      ),
      test_suite='google.protobuf.internal',
      cmdclass={
          'clean': clean,
          'build_py': build_py,
266
          'test_conformance': test_conformance,
267
      },
Dan O'Reilly's avatar
Dan O'Reilly committed
268
      install_requires=install_requires,
269 270
      ext_modules=ext_module_list,
  )