setup.py revision 3412
290N/A# The contents of this file are subject to the terms of the 290N/A# Common Development and Distribution License (the "License"). 290N/A# You may not use this file except in compliance with the License. 290N/A# See the License for the specific language governing permissions 290N/A# and limitations under the License. 290N/A# When distributing Covered Code, include this CDDL HEADER in each 290N/A# If applicable, add the following below this CDDL HEADER, with the 290N/A# fields enclosed by brackets "[]" replaced with your own identifying 290N/A# information: Portions Copyright [yyyy] [name of copyright owner] 3026N/A# Copyright (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved. 2828N/A# the version of pylint that we must have in order to run the pylint checks. 534N/A# Unbuffer stdout and stderr. This helps to ensure that subprocess output 534N/A# is properly interleaved with output from this program. 534N/A# Can't have unbuffered text I/O in Python 3. This doesn't quite matter. 290N/A# Extract Python minor version. 395N/A# A list of source, destination tuples of modules which should be hardlinked 395N/A# together if the os supports it and otherwise copied. 395N/A 'svc-pkg-repositories-setup'],
395N/A 'svc-pkg-sysrepo-cache'],
2867N/A # install same set of files in "en/" in "__LOCALE__/ as well" 2535N/A # for localizable file package (regarding themes, install 2828N/A# The apache-based depot includes an shtml file we add to the resource dir 2828N/A 'ar ca cs de es fr he hu id it ja ko nl pl pt_BR ru sk sv zh_CN zh_HK zh_TW'.
split()
2339N/A# Runs lint on the extension module source code 2364N/A # Make string shell-friendly 395N/A """Compare the installed version against the version 395N/A we require to build with, returning False if the version 290N/A is too old. It's tempting to use pkg.version.Version 290N/A here, but since that's a build artifact, we'll do it 290N/A # if the lists are of different lengths, we just 290N/A # compare with the precision we have. 290N/A # if we somehow get non-numeric version 290N/A # components, we ignore them. 2674N/A # it's fine to default to the required version - the build will 290N/A # break if the installed version is incompatible and $PYLINT_VER 395N/A "$PKG_SKIP_PYLINT was set")
591N/A "installed version {0} is older than version {1}".
format(
2639N/A # Insert tests directory onto sys.path so any custom checkers 691N/A # assumes pylint is accessible on the sys.path 2674N/A # Unfortunately, pylint seems pretty fragile and will crash if 2339N/A # we try to run it over all the current pkg source. Hence for 2339N/A # now we only run it over a subset of the source. As source 2339N/A # files are made pylint clean they should be added to the 591N/A # In Python 3 porting mode, all checkers will be 2639N/A # disabled and only messages emitted by the porting 2639N/A # checker will be displayed. Therefore we need to run 3026N/A # We check all Python files in the gate. 2339N/A# Runs lint on the extension module source code 506N/A # Make string shell-friendly 290N/A [
'-D_FILE_OFFSET_BITS=64'] + \
1674N/A [
'-D_FILE_OFFSET_BITS=64'] + \
506N/A [
'-D_FILE_OFFSET_BITS=64'] + \
430N/A [
'-D_FILE_OFFSET_BITS=64'] + \
2561N/A [
'-D_FILE_OFFSET_BITS=64'] + \
2535N/A# Runs both C and Python lint 2535N/A # Make string shell-friendly 2535N/A # PRIVATE_BUILD set in the environment tells us to put the build 2535N/A # directory into the .pyc files, rather than the final 2688N/A # This is used when installing scripts, below, but it isn't a 2826N/A # standard distutils variable. 2688N/A """At the end of the install function, we need to rename some 2688N/A files because distutils provides no way to rename files as they 2688N/A are placed in their install locations. 2535N/A # XXX Uncomment it when we need to deliver python 3.4 version 2535N/A # Don't install the scripts for python 3.4. 2597N/A """Remove the target files prior to the standard install_lib procedure 2597N/A if the build_py module has determined that they've actually changed. 2597N/A This may be needed when a module's timestamp goes backwards in time, if 2597N/A a working-directory change is reverted, or an older changeset is checked 2688N/A """Enhance the standard install_data subcommand to take not only a list 2688N/A of filenames, but a list of source and destination filename tuples, for 2688N/A the cases where a filename needs to be renamed between the two 2688N/A # use temp environment modified with the given dict 2688N/A # just use environment of this (parent) process as is 2688N/A # just use stderr of this (parent) process 2535N/A """A clone of distutils.file_util._copy_file_contents() that strips the 2535N/A CDDL text. For Python files, we replace the CDDL text with an equal 2535N/A number of empty comment lines so that line numbers match between the 2535N/A source and destination files.""" 2535N/A # Match the lines between and including the CDDL header signposts, as 2535N/A # well as empty comment lines before and after, if they exist. 2826N/A # Look for shebang line to replace with arch-specific Python executable. 2826N/A # replace the CDDL expression 2826N/A # with the same number of empty 2826N/A # comment lines as the cddl_re 2535N/A# Make file_util use our version of _copy_file_contents 2688N/A """Check if scope of localization looks up-to-date or possibly not, 2688N/A actual source files (e.g. .py) detected. 2688N/A print(
"New file(s) with translatable strings detected:",
2688N/APlease evaluate whether any of the above file(s) needs localization. 2535N/A """Generate pkg.pot by extracting localizable strings from source 2535N/A """Checks for common i18n messaging bugs in the source.""" 2535N/A # A list of the i18n errors we check for in the code 2535N/A # This checks that messages with multiple parameters are always 2535N/A # written using "{name}" format, rather than just "{0}" 2535N/A "format string with unnamed arguments cannot be properly localized" 2242N/AThe following i18n errors were detected and should be corrected: 2508N/A """create XML help for localization, where French part of legalnotice 2508N/A # indicates currently in French part of legalnotice 2508N/A # reached end of legalnotice 2508N/A """Input is English XML file. Output is pkg_help.pot, message 2508N/A source for next translation update. 2508N/A """Input is English XML file and <lang>.po file (which contains 2508N/A translations). Output is translated XML file. 2677N/A (
"file=",
"f",
"source file to copy"),
2677N/A (
"dest=",
"d",
"destination directory"),
2677N/A (
"mode=",
"m",
"file mode"),
2508N/A print(
"ERROR: unable to obtain mercurial version",
2508N/A """ Run python's compiler over the file, and discard the results. 2508N/A Arrange to generate an exception if the file does not compile. 2508N/A This is needed because distutil's own use of pycompile (in the 2508N/A distutils.utils module) is broken, and doesn't stop on error. """ 2535N/A # Assume it's a tuple of (filename, lineno, col, code) 422N/A# On Solaris, ld inserts the full argument to the -o option into the symbol 422N/A# table. This means that the resulting object will be different depending on 422N/A# the path at which the workspace lives, and not just on the interesting content 422N/A# In order to work around that bug (7076871), we create a new compiler class 422N/A# that looks at the argument indicating the output file, chdirs to its 422N/A# directory, and runs the real link with the output file set to just the base 422N/A# Unfortunately, distutils isn't too customizable in this regard, so we have to 422N/A# twiddle with a couple of the names in the distutils.ccompiler namespace: we 383N/A# have to add a new entry to the compiler_class dict, and we have to override 422N/A# the new_compiler() function to point to our own. Luckily, our copy of 383N/A# new_compiler() gets to be very simple, since we always know what we want to 2508N/A 'unixccompiler',
'MyUnixCCompiler',
2508N/A 'standard Unix-style compiler with a link stage modified for Solaris' 2508N/A # store our 64-bit extensions elsewhere 2535N/A # Gather the timestamps of the .py files in the gate, so we can 2535N/A # force the mtimes of the built and delivered copies to be 2535N/A # consistent across builds, causing their corresponding .pyc 2535N/A # files to be unchanged unless the .py file content changed. 2688N/A print(
"ERROR: unable to gather .py timestamps",
290N/A # Before building extensions, we need to generate .c files 290N/A # for the C extension modules by running the CFFI build 290N/A # make scripts executable 1099N/A # override the build_module method to do VERSION substitution on 1101N/A # Grab the previously-built version out of the build 1715N/A # If the versions haven't changed, there's no need to 448N/A print(
"doing version substitution: ", v)
1101N/A # Will raise a DistutilsError on failure. 2499N/A # If the timestamp on the source file (coming from mercurial if 2499N/A # unchanged, or from the filesystem if changed) doesn't match 1101N/A # the filesystem timestamp on the destination, then force the 290N/A # copy to make sure the right data is in place. 290N/A # Force a copy of the file if the source timestamp is different 430N/A # from that of the destination, not just if it's newer. This 395N/A # allows timestamps in the working directory to regress (for 290N/A # instance, following the reversion of a change). 290N/A # If we copied the file, then we need to go and readjust the 1637N/A # timestamp on the file to match what we have in our database. 1637N/A # Save the filename aside for our version of install_lib. 613N/A """Convert a manpage output path to the directory where its source lives.""" 2639N/A """Convert XML manpages to ROFF for delivery. 2698N/A The input should be a list of the output file paths. The corresponding 2698N/A inputs will be generated from this. We do it in this way so that we can 2639N/A share the paths with the install code. 2639N/A All paths should have a common manpath root. In particular, pages 2639N/A belonging to different localizations should be run through this function 2508N/A # Get the output dir by removing the filename and the manX 2535N/A # As a subclass of distutils.cmd.Command, these methods are required to 395N/A # Anything that gets created here should get deleted in 395N/A # clean_func.run() below. 395N/A # generate pkg.pot for next translation 2046N/A """Remove a file without caring whether it exists.""" 395N/A # These files generated by the CFFI build scripts are useless 395N/A # at this point, therefore clean them up. 290N/A print(
"deleting temporary files generated by CFFI")
395N/A # list of options stored in initialize_options below. The first entry 395N/A # in each tuple must be the exact name of a member variable. 395N/A (
"archivedir=",
'a',
"archive failed tests <dir>"),
395N/A (
"baselinefile=",
'b',
"baseline file <file>"),
395N/A (
"coverage",
"c",
"collect code coverage data"),
691N/A (
"genbaseline",
'g',
"generate test baseline"),
691N/A (
"only=",
"o",
"only <regex>"),
691N/A (
"parseable",
'p',
"parseable output"),
691N/A (
"port=",
"z",
"lowest port to start a depot on"),
691N/A (
"timing",
"t",
"timing file <file>"),
691N/A (
"verbosemode",
'v',
"run tests in verbose mode"),
691N/A (
"stoponerr",
'x',
"stop when a baseline mismatch occurs"),
691N/A (
"debugoutput",
'd',
"emit debugging output"),
2339N/A (
"showonexpectedfail",
'f',
2339N/A "show all failure info, even for expected fails"),
2339N/A (
"startattest=",
's',
"start at indicated test"),
2339N/A (
"jobs=",
'j',
"number of parallel processes to use"),
2339N/A (
"quiet",
"q",
"use the dots as the output format"),
2339N/A (
"livesystem",
'l',
"run tests on live system"),
# Reconstruct the cmdline and send that to run.py # This class wraps the distutils Extension class, allowing us to set # build_64 in the object constructor instead of being forced to add it # after the object has been created. # 'name' and the item in 'sources' must be a string literal # These are set to real values based on the platform, down below if osname in (
"sunos",
"linux",
"darwin"):
# all builds of IPS should have manpages # Solaris-specific extensions are added here # install localizable .xml and its .pot file to put into localizable file package # install English .pot file to put into localizable file package # install English manpage sources to put into localizable file package # Unix platforms which the elf extension has been ported to # are specified here, so they are built automatically # Solaris has built-in md library and Solaris-specific arch extension # All others use OpenSSL and cross-platform arch module 'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',