/
setup.py
393 lines (350 loc) · 14.4 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
"""Distutils script for cx_Oracle.
Windows platforms:
python setup.py build --compiler=mingw32 install
Unix platforms
python setup.py build install
"""
import distutils.command
try:
import distutils.command.bdist_msi
except ImportError:
distutils.command.bdist_msi = None
try:
import distutils.command.bdist_wininst
except ImportError:
distutils.command.bdist_wininst = None
import distutils.command.bdist_rpm
import distutils.command.build
import distutils.core
import distutils.dist
import distutils.util
import os
import re
import struct
import sys
import glob
from distutils.errors import DistutilsSetupError
# if setuptools is detected, use it to add support for eggs
try:
from setuptools import setup, Extension
except:
from distutils.core import setup
from distutils.extension import Extension
# define build constants
BUILD_VERSION = "5.3"
# define the list of files to be included as documentation for Windows
dataFiles = None
if sys.platform in ("win32", "cygwin"):
baseName = "cx_Oracle-doc"
dataFiles = [ (baseName,
[ "BUILD.txt", "LICENSE.txt", "README.txt"]) ]
for dir in ("samples", "test"):
files = []
fullDirName = "%s/%s" % (baseName, dir)
for name in os.listdir(dir):
if name.startswith("."):
continue
if os.path.isdir(os.path.join(dir, name)):
continue
fullName = "%s/%s" % (dir, name)
files.append(fullName)
dataFiles.append((fullDirName, files))
# define the list of files to be included as documentation for bdist_rpm
docFiles = "README.txt LICENSE.txt BUILD.txt samples test"
# method for checking a potential Oracle home
def CheckOracleHome(directoryToCheck):
global oracleHome, oracleVersion, oracleLibDir
import os
import struct
import sys
if sys.platform in ("win32", "cygwin"):
subDirs = ["bin"]
filesToCheck = [
("12c", "oraocci12.dll"),
("11g", "oraocci11.dll"),
("10g", "oraocci10.dll")
]
elif sys.platform == "darwin":
subDirs = ["lib"]
filesToCheck = [
("12c", "libclntsh.dylib.12.1"),
("11g", "libclntsh.dylib.11.1"),
("10g", "libclntsh.dylib.10.1")
]
else:
if struct.calcsize("P") == 4:
subDirs = ["lib", "lib32"]
else:
subDirs = ["lib", "lib64"]
filesToCheck = [
("12c", "libclntsh.so.12.1"),
("11g", "libclntsh.so.11.1"),
("10g", "libclntsh.so.10.1")
]
for version, baseFileName in filesToCheck:
fileName = os.path.join(directoryToCheck, baseFileName)
if os.path.exists(fileName):
if os.path.basename(directoryToCheck).lower() == "bin":
oracleHome = os.path.dirname(directoryToCheck)
else:
oracleHome = directoryToCheck
oracleLibDir = directoryToCheck
oracleVersion = version
return True
for subDir in subDirs:
fileName = os.path.join(directoryToCheck, subDir, baseFileName)
if os.path.exists(fileName):
oracleHome = directoryToCheck
oracleLibDir = os.path.join(directoryToCheck, subDir)
oracleVersion = version
return True
dirName = os.path.dirname(directoryToCheck)
fileName = os.path.join(dirName, subDir, baseFileName)
if os.path.exists(fileName):
oracleHome = dirName
oracleLibDir = os.path.join(dirName, subDir)
oracleVersion = version
return True
oracleHome = oracleVersion = oracleLibDir = None
return False
# Look for the highest version Instant Client "basic" or "basiclite" RPM
# Newer Instant Client dirs have the form:
# /usr/lib/oracle/12.1/client[64]/lib
# Older Instant Client dirs have the form:
# /usr/lib/oracle/10.2.0.5/client[64]/lib
def FindInstantClientRPMLib():
version = os.environ.get("IC_VERSION")
if version is not None:
versions = [version]
else:
versions = []
for path in glob.glob(os.path.join(rpmBaseLibDir, "[0-9.]*")):
versions.append(os.path.basename(path))
versions.sort(key = lambda x: [int(s) for s in x.split(".")])
versions.reverse()
for version in versions:
path = os.path.join(rpmBaseLibDir, version, rpmClientDir, "lib")
if os.path.exists(path) and CheckOracleHome(path):
return path
# If the lib dir appears to be an Instant Client RPM dir, then look only
# for matching SDK headers
def FindInstantClientRPMInclude(libDir):
version = os.path.basename(os.path.dirname(os.path.dirname(libDir)))
includeDir = os.path.join("/usr/include/oracle", version, rpmClientDir)
if os.path.isfile(os.path.join(includeDir, "oci.h")):
return [includeDir]
raise DistutilsSetupError("cannot locate Oracle Instant Client " \
"SDK RPM header files")
# define Linux Instant Client RPM path components
# Assume 64 bit builds if the platform is 64 bit
rpmBaseLibDir = "/usr/lib/oracle"
if struct.calcsize("P") == 4:
rpmClientDir = "client"
else:
rpmClientDir = "client64"
instantClientRPMLib = None
# try to determine the Oracle home
userOracleHome = os.environ.get("ORACLE_HOME")
if userOracleHome is not None:
if not CheckOracleHome(userOracleHome):
messageFormat = "Oracle home (%s) does not refer to an " \
"10g, 11g or 12c installation."
raise DistutilsSetupError(messageFormat % userOracleHome)
else:
for path in os.environ["PATH"].split(os.pathsep):
if CheckOracleHome(path):
break
if oracleHome is None and sys.platform.startswith("linux"):
instantClientRPMLib = FindInstantClientRPMLib()
if oracleHome is None:
raise DistutilsSetupError("cannot locate an Oracle software " \
"installation")
# define some variables
if sys.platform == "win32":
libDirs = [os.path.join(oracleHome, "bin"), oracleHome,
os.path.join(oracleHome, "oci", "lib", "msvc"),
os.path.join(oracleHome, "sdk", "lib", "msvc")]
possibleIncludeDirs = ["oci/include", "rdbms/demo", "sdk/include"]
includeDirs = []
for dir in possibleIncludeDirs:
path = os.path.normpath(os.path.join(oracleHome, dir))
if os.path.isdir(path):
includeDirs.append(path)
if not includeDirs:
message = "cannot locate Oracle include files in %s" % oracleHome
raise DistutilsSetupError(message)
libs = ["oci"]
elif sys.platform == "cygwin":
includeDirs = ["/usr/include", "rdbms/demo", "rdbms/public", \
"network/public", "oci/include"]
libDirs = ["bin", "lib"]
for i in range(len(includeDirs)):
includeDirs[i] = os.path.join(oracleHome, includeDirs[i])
for i in range(len(libDirs)):
libDirs[i] = os.path.join(oracleHome, libDirs[i])
libs = ["oci"]
else:
libDirs = [oracleLibDir]
libs = ["clntsh"]
if instantClientRPMLib is not None:
includeDirs = FindInstantClientRPMInclude(instantClientRPMLib)
else:
possibleIncludeDirs = ["rdbms/demo", "rdbms/public", "network/public",
"sdk/include"]
if sys.platform == "darwin":
possibleIncludeDirs.append("plsql/public")
includeDirs = []
for dir in possibleIncludeDirs:
path = os.path.join(oracleHome, dir)
if os.path.isdir(path):
includeDirs.append(path)
if not includeDirs:
path = os.path.join(oracleLibDir, "include")
if os.path.isdir(path):
includeDirs.append(path)
if not includeDirs:
path = re.sub("lib(64)?", "include", oracleHome)
if os.path.isdir(path):
includeDirs.append(path)
if not includeDirs:
raise DistutilsSetupError("cannot locate Oracle include files")
# NOTE: on HP-UX Itanium with Oracle 10g you need to add the library "ttsh10"
# to the list of libraries along with "clntsh"; since I am unable to test, I'll
# leave this as a comment until someone can verify when this is required
# without making other cases where sys.platform == "hp-ux11" stop working
# setup extra link and compile args
extraCompileArgs = ["-DBUILD_VERSION=%s" % BUILD_VERSION]
extraLinkArgs = []
if sys.platform == "aix4":
extraCompileArgs.append("-qcpluscmt")
elif sys.platform == "aix5":
extraCompileArgs.append("-DAIX5")
elif sys.platform == "cygwin":
extraLinkArgs.append("-Wl,--enable-runtime-pseudo-reloc")
elif sys.platform == "darwin":
extraLinkArgs.append("-shared-libgcc")
# force the inclusion of an RPATH linker directive if desired; this will
# eliminate the need for setting LD_LIBRARY_PATH but it also means that this
# location will be the only location searched for the Oracle client library
if "FORCE_RPATH" in os.environ or instantClientRPMLib:
extraLinkArgs.append("-Wl,-rpath,%s" % oracleLibDir)
# tweak distribution full name to include the Oracle version
class Distribution(distutils.dist.Distribution):
def get_fullname_with_oracle_version(self):
name = self.metadata.get_fullname()
return "%s-%s" % (name, oracleVersion)
# tweak the RPM build command to include the Python and Oracle version
class bdist_rpm(distutils.command.bdist_rpm.bdist_rpm):
def run(self):
distutils.command.bdist_rpm.bdist_rpm.run(self)
specFile = os.path.join(self.rpm_base, "SPECS",
"%s.spec" % self.distribution.get_name())
queryFormat = "%{name}-%{version}-%{release}.%{arch}.rpm"
command = "rpm -q --qf '%s' --specfile %s" % (queryFormat, specFile)
origFileName = os.popen(command).read()
parts = origFileName.split("-")
parts.insert(2, oracleVersion)
parts.insert(3, "py%s%s" % sys.version_info[:2])
newFileName = "-".join(parts)
self.move_file(os.path.join("dist", origFileName),
os.path.join("dist", newFileName))
# tweak the build directories to include the Oracle version
class build(distutils.command.build.build):
def finalize_options(self):
import distutils.util
import os
import sys
platSpecifier = ".%s-%s-%s" % \
(distutils.util.get_platform(), sys.version[0:3],
oracleVersion)
if self.build_platlib is None:
self.build_platlib = os.path.join(self.build_base,
"lib%s" % platSpecifier)
if self.build_temp is None:
self.build_temp = os.path.join(self.build_base,
"temp%s" % platSpecifier)
distutils.command.build.build.finalize_options(self)
class test(distutils.core.Command):
description = "run the test suite for the extension"
user_options = []
def finalize_options(self):
pass
def initialize_options(self):
pass
def run(self):
self.run_command("build")
buildCommand = self.distribution.get_command_obj("build")
sys.path.insert(0, os.path.abspath("test"))
sys.path.insert(0, os.path.abspath(buildCommand.build_lib))
fileName = os.path.join("test", "test.py")
exec(open(fileName).read())
commandClasses = dict(build = build, bdist_rpm = bdist_rpm, test = test)
# tweak the Windows installer names to include the Oracle version
if distutils.command.bdist_msi is not None:
class bdist_msi(distutils.command.bdist_msi.bdist_msi):
def run(self):
origMethod = self.distribution.get_fullname
self.distribution.get_fullname = \
self.distribution.get_fullname_with_oracle_version
distutils.command.bdist_msi.bdist_msi.run(self)
self.distribution.get_fullname = origMethod
commandClasses["bdist_msi"] = bdist_msi
if distutils.command.bdist_wininst is not None:
class bdist_wininst(distutils.command.bdist_wininst.bdist_wininst):
def run(self):
origMethod = self.distribution.get_fullname
self.distribution.get_fullname = \
self.distribution.get_fullname_with_oracle_version
distutils.command.bdist_wininst.bdist_wininst.run(self)
self.distribution.get_fullname = origMethod
commandClasses["bdist_wininst"] = bdist_wininst
# define classifiers for the package index
classifiers = [
"Development Status :: 6 - Mature",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: C",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 3",
"Topic :: Database"
]
# setup the extension
extension = Extension(
name = "cx_Oracle",
include_dirs = includeDirs,
libraries = libs,
library_dirs = libDirs,
extra_compile_args = extraCompileArgs,
extra_link_args = extraLinkArgs,
sources = ["src/cx_Oracle.c"],
depends = ["src/AQ.c", "src/Buffer.c", "src/Connection.c",
"src/Cursor.c", "src/CursorVar.c", "src/DateTimeVar.c",
"src/Environment.c", "src/Error.c", "src/ExternalLobVar.c",
"src/IntervalVar.c", "src/LobVar.c", "src/LongVar.c",
"src/NumberVar.c", "src/Object.c", "src/ObjectType.c",
"src/ObjectVar.c", "src/SessionPool.c", "src/StringVar.c",
"src/Subscription.c", "src/TimestampVar.c", "src/Transforms.c",
"src/Variable.c"])
# perform the setup
setup(
name = "cx_Oracle",
version = BUILD_VERSION,
distclass = Distribution,
description = "Python interface to Oracle",
data_files = dataFiles,
cmdclass = commandClasses,
options = dict(bdist_rpm = dict(doc_files = docFiles)),
long_description = \
"Python interface to Oracle Database conforming to the Python DB "
"API 2.0 specification.\n"
"See http://www.python.org/topics/database/DatabaseAPI-2.0.html.",
author = "Anthony Tuininga",
author_email = "anthony.tuininga@gmail.com",
url = "https://oracle.github.io/python-cx_Oracle",
ext_modules = [extension],
keywords = "Oracle",
license = "BSD License",
classifiers = classifiers)