modified comments and corrected typo

This commit is contained in:
Jenny Tam 2017-08-14 08:54:21 -07:00
parent 282b88d926
commit bdad16e904
2 changed files with 31 additions and 16 deletions

View file

@ -31,11 +31,7 @@ class BuildDriver(object):
"""Build sqlsrv and/or pdo_sqlsrv drivers with PHP source with the following properties:
Attributes:
phpver # PHP version, e.g. 7.1.*, 7.2.* etc.
driver # all, sqlsrv, or pdo_sqlsrv
arch # x64 or x86
thread # nts or ts
debug # whether debug is enabled
util # BuildUtil object whose constructor takes phpver, driver, arch, thread, debug
repo # GitHub repository
branch # GitHub repository branch
download_source # download source from GitHub or not
@ -65,10 +61,14 @@ class BuildDriver(object):
print('Debug enabled: ', self.util.debug_enabled)
def clean_or_remove(self, root_dir, work_dir):
"""Check if php source directory already exists. If so, prompt user whether to rebuild, clean, or superclean, meaning to remove the entire php source directory."""
"""Check if php source directory already exists.
If so, prompt user whether to rebuild, clean, or superclean,
meaning to remove the entire php source directory.
"""
phpsrc = self.util.phpsrc_root(root_dir)
if os.path.exists( phpsrc ):
print(phpsrc + " exists.")
print(phpsrc + " exists.")
print("Choose rebuild(r) if using the same configuration. Choose clean(c) otherwise. If unsure, choose superclean(s).")
choice = validate_input("Want to rebuild (r), clean (c) or superclean (s)? ", "r/c/s")
self.make_clean = False
if choice == 'r':
@ -86,7 +86,11 @@ class BuildDriver(object):
os.chdir(work_dir)
def build_extensions(self, dest, logfile):
"""This takes care of getting the drivers' source files, building the drivers. If running locally, *dest* should be the root drive. Otherwise, *dest* should be None. In this case, remote_path must be defined such that the binaries will be copied to the designated destinations."""
"""This takes care of getting the drivers' source files, building the drivers.
If running locally, *dest* should be the root drive. Otherwise, *dest* should be None.
In this case, remote_path must be defined such that the binaries will be copied
to the designated destinations.
"""
work_dir = os.path.dirname(os.path.realpath(__file__))
if self.download_source:

View file

@ -189,7 +189,9 @@ class BuildUtil(object):
@staticmethod
def download_msphpsql_source(repo, branch, dest_folder = 'Source', clean_up = True):
"""Download to *dest_folder* the msphpsql archive of the specified GitHub *repo* and *branch*."""
"""Download to *dest_folder* the msphpsql archive of the specified
GitHub *repo* and *branch*. The downloaded files will be removed by default.
"""
try:
work_dir = os.path.dirname(os.path.realpath(__file__))
@ -207,8 +209,8 @@ class BuildUtil(object):
with urllib.request.urlopen(url) as response, open(file, 'wb') as out_file:
shutil.copyfileobj(response, out_file)
except:
print ("Resort to skip ssl verifcation...")
# need to skip ssl verifcation on some agents
print ("Resort to skip ssl verification...")
# need to skip ssl verification on some agents
# see https://www.python.org/dev/peps/pep-0476/
with urllib.request.urlopen(url, context=ssl._create_unverified_context()) as response, open(file, 'wb') as out_file:
shutil.copyfileobj(response, out_file)
@ -234,7 +236,9 @@ class BuildUtil(object):
raise
def update_driver_source(self, source_dir, driver):
"""Update the *driver* source in *source_path* with the latest version, file descriptions, etc."""
"""Update the *driver* source in *source_path* with the
latest version, file descriptions, etc.
"""
driver_dir = os.path.join(source_dir, driver)
# Update Template.rc
@ -327,7 +331,10 @@ class BuildUtil(object):
print('Cannot create ', filename)
def build_drivers(self, make_clean = False, dest = None, log_file = None):
"""Build sqlsrv/pdo_sqlsrv extensions for PHP, assuming the Source folder exists in the working directory, and this folder will be removed when the build is complete."""
"""Build sqlsrv/pdo_sqlsrv extensions for PHP, assuming the Source folder
exists in the working directory, and this folder will be removed when the build
is complete.
"""
work_dir = os.path.dirname(os.path.realpath(__file__))
# First, update the driver source file contents
@ -376,7 +383,7 @@ class BuildUtil(object):
os.system(starter_script + ' -t ' + batch_file)
# Now we can safely remove the Source folder, because its contents have
# already been modified when building the extensions
# already been modified prior to building the extensions
shutil.rmtree(os.path.join(phpSDK, 'Source'), ignore_errors=True)
# Next, rename the newly compiled PHP extensions
@ -393,7 +400,9 @@ class BuildUtil(object):
os.rename(os.path.join(path, driver_old_name), os.path.join(path, driver_new_name))
def rename_binaries(self, sdk_dir):
"""Rename the sqlsrv and/or pdo_sqlsrv binaries based on PHP version and thread, including pdb files."""
"""Rename the sqlsrv and/or pdo_sqlsrv binaries based on
PHP version and thread, including pdb files.
"""
# Derive the path to where the extensions are located
ext_dir = self.build_abs_path(sdk_dir)
@ -414,7 +423,9 @@ class BuildUtil(object):
shutil.copy2(os.path.join(from_dir, binary), dest_dir)
def copy_binaries(self, sdk_dir, copy_to_ext):
"""Copy the sqlsrv and/or pdo_sqlsrv binaries, including pdb files, to the right place."""
"""Copy the sqlsrv and/or pdo_sqlsrv binaries,
including pdb files, to the right place.
"""
build_dir = self.build_abs_path(sdk_dir)
print('Copying the binaries from', build_dir)
if copy_to_ext: