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
|
#-----------------------------------------------------------------------------------------------------------------------
# scripts/btUtils.py is part of Brewtarget, and is copyright the following authors 2022-2024:
# • Matt Young <mfsy@yahoo.com>
#
# Brewtarget is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# Brewtarget is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# <http://www.gnu.org/licenses/>.
#-----------------------------------------------------------------------------------------------------------------------
#-----------------------------------------------------------------------------------------------------------------------
# This file contains various util functions used in our other Python build scripts
#-----------------------------------------------------------------------------------------------------------------------
#-----------------------------------------------------------------------------------------------------------------------
# Python built-in modules we use
#-----------------------------------------------------------------------------------------------------------------------
import logging
import os
import pathlib
import subprocess
#-----------------------------------------------------------------------------------------------------------------------
# Helper function to return the 'base' directory (ie the one above the directory in which this file lives).
#-----------------------------------------------------------------------------------------------------------------------
def getBaseDir():
dir_thisScript = pathlib.Path(__file__).parent.resolve()
dir_base = dir_thisScript.parent.resolve()
return dir_base
#-----------------------------------------------------------------------------------------------------------------------
# Helper function to return a logger that logs to stderr
#
# param logLevel - Initial level to log at
#-----------------------------------------------------------------------------------------------------------------------
def getLogger(logLevel = logging.INFO):
logging.basicConfig(format='%(message)s')
# Per https://docs.python.org/3/library/logging.html __name__ is the module’s name in the Python package namespace.
# This is fine for us. I don't think we care too much what the logger's name is.
log = logging.getLogger(__name__)
log.setLevel(logLevel)
# Include the log level in the message
handler = logging.StreamHandler()
handler.setFormatter(
# You can add timestamps etc to logs, but that's overkill for this script. Source file location of log message is
# however pretty useful for debugging.
logging.Formatter('{levelname:s}: {message} [{filename:s}:{lineno:d}]', style='{')
)
log.addHandler(handler)
# If we don't do this, everything gets printed twice
log.propagate = False
return log
#-----------------------------------------------------------------------------------------------------------------------
# Helper function for checking result of running external commands
#
# Given a CompletedProcess object returned from subprocess.run(), this checks the return code and, if it is non-zero
# stops this script with an error message and the same return code. Otherwise the CompletedProcess object is returned
# to the caller (to make it easier to chain things together).
#-----------------------------------------------------------------------------------------------------------------------
def abortOnRunFail(runResult: subprocess.CompletedProcess):
if (runResult.returncode != 0):
# Per https://docs.python.org/3/library/logging.html, "Multiple calls to logging.getLogger() with the same name
# [parameter] will always return a reference to the same Logger object." So we are safe to set log in this way.
log = logging.getLogger(__name__)
# According to https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess,
# CompletedProcess.args (the arguments used to launch the process) "may be a list or a string", but its not clear
# when it would be one or the other.
if (isinstance(runResult.args, str)):
log.critical('Error running ' + runResult.args)
else:
commandName = os.path.basename(runResult.args[0])
log.critical('Error running ' + commandName + ' (' + ' '.join(str(ii) for ii in runResult.args) + ')')
if runResult.stderr:
log.critical('stderr: ' + runResult.stderr.decode('UTF-8'))
exit(runResult.returncode)
return runResult
|
