quickstart-cpp/scripts/build_scripts/utils.py at main · ALFR849/quickstart-cpp · GitHub

History

94 lines (71 loc) · 2.88 KB

Raw

#!/usr/bin/env python

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

"""

Helper functions that are shared amongst prereqs and build scripts across various

platforms.

"""

import distutils.spawn

import platform

import shutil

import subprocess

import os

import urllib.request

def run_command(cmd, capture_output=False, cwd=None, check=False, as_root=False,

print_cmd=True):

"""Run a command.

Args:

cmd (list(str)): Command to run as a list object.

Eg: ['ls', '-l'].

capture_output (bool): Capture the output of this command.

Output can be accessed as <return_object>.stdout

cwd (str): Directory to execute the command from.

check (bool): Raises a CalledProcessError if True and the command errored out

as_root (bool): Run command as root user with admin priveleges (supported on mac and linux).

print_cmd (bool): Print the command we are running to stdout.

Raises:

(subprocess.CalledProcessError): If command errored out and `text=True`

Returns:

(`subprocess.CompletedProcess`): object containing information from

command execution

"""

if as_root and (is_mac_os() or is_linux_os()):

cmd.insert(0, 'sudo')

cmd_string = ' '.join(cmd)

if print_cmd:

print('Running cmd: {0}\n'.format(cmd_string))

# If capture_output is requested, we also set text=True to store the returned value of the

# command as a string instead of bytes object

return subprocess.run(cmd, capture_output=capture_output, cwd=cwd,

check=check, text=capture_output)

def is_command_installed(tool):

"""Check if a command is installed on the system."""

return distutils.spawn.find_executable(tool)

def delete_directory(dir_path):

"""Recursively delete a valid directory"""

if os.path.exists(dir_path):

shutil.rmtree(dir_path)

def download_file(url, file_path):

"""Download from url and save to specified file path."""

with urllib.request.urlopen(url) as response, open(file_path, 'wb') as out_file:

shutil.copyfileobj(response, out_file)

def unpack_files(archive_file_path, output_dir=None):

"""Unpack/extract an archive to specified output_directory"""

shutil.unpack_archive(archive_file_path, output_dir)

def is_windows_os():

return platform.system() == 'Windows'

def is_mac_os():

return platform.system() == 'Darwin'

def is_linux_os():

return platform.system() == 'Linux'

quickstart-cpp/scripts/build_scripts/utils.py at main · ALFR849/quickstart-cpp · GitHub

Expand file tree

Breadcrumbs

utils.py

Latest commit

History

Breadcrumbs

utils.py

File metadata and controls