mirror of
https://github.com/u-boot/u-boot.git
synced 2025-05-08 19:11:53 +00:00
test/py: use " for docstrings
Python's coding style docs indicate to use " not ' for docstrings. test/py has other violations of the coding style docs, since the docs specify a stranger style than I would expect, but nobody has complained about those yet:-) Signed-off-by: Stephen Warren <swarren@nvidia.com> Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Stephen Warren
Simon Glass
parent
56382a81f3
commit
e8debf394f
19 changed files with 245 additions and 245 deletions
|
|
@ -14,12 +14,12 @@ import subprocess
|
|||
mod_dir = os.path.dirname(os.path.abspath(__file__))
|
||||
|
||||
class LogfileStream(object):
|
||||
'''A file-like object used to write a single logical stream of data into
|
||||
"""A file-like object used to write a single logical stream of data into
|
||||
a multiplexed log file. Objects of this type should be created by factory
|
||||
functions in the Logfile class rather than directly.'''
|
||||
functions in the Logfile class rather than directly."""
|
||||
|
||||
def __init__(self, logfile, name, chained_file):
|
||||
'''Initialize a new object.
|
||||
"""Initialize a new object.
|
||||
|
||||
Args:
|
||||
logfile: The Logfile object to log to.
|
||||
|
|
@ -29,26 +29,26 @@ class LogfileStream(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.logfile = logfile
|
||||
self.name = name
|
||||
self.chained_file = chained_file
|
||||
|
||||
def close(self):
|
||||
'''Dummy function so that this class is "file-like".
|
||||
"""Dummy function so that this class is "file-like".
|
||||
|
||||
Args:
|
||||
None.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
pass
|
||||
|
||||
def write(self, data, implicit=False):
|
||||
'''Write data to the log stream.
|
||||
"""Write data to the log stream.
|
||||
|
||||
Args:
|
||||
data: The data to write tot he file.
|
||||
|
|
@ -60,33 +60,33 @@ class LogfileStream(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.logfile.write(self, data, implicit)
|
||||
if self.chained_file:
|
||||
self.chained_file.write(data)
|
||||
|
||||
def flush(self):
|
||||
'''Flush the log stream, to ensure correct log interleaving.
|
||||
"""Flush the log stream, to ensure correct log interleaving.
|
||||
|
||||
Args:
|
||||
None.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.logfile.flush()
|
||||
if self.chained_file:
|
||||
self.chained_file.flush()
|
||||
|
||||
class RunAndLog(object):
|
||||
'''A utility object used to execute sub-processes and log their output to
|
||||
"""A utility object used to execute sub-processes and log their output to
|
||||
a multiplexed log file. Objects of this type should be created by factory
|
||||
functions in the Logfile class rather than directly.'''
|
||||
functions in the Logfile class rather than directly."""
|
||||
|
||||
def __init__(self, logfile, name, chained_file):
|
||||
'''Initialize a new object.
|
||||
"""Initialize a new object.
|
||||
|
||||
Args:
|
||||
logfile: The Logfile object to log to.
|
||||
|
|
@ -96,18 +96,18 @@ class RunAndLog(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.logfile = logfile
|
||||
self.name = name
|
||||
self.chained_file = chained_file
|
||||
|
||||
def close(self):
|
||||
'''Clean up any resources managed by this object.'''
|
||||
"""Clean up any resources managed by this object."""
|
||||
pass
|
||||
|
||||
def run(self, cmd, cwd=None, ignore_errors=False):
|
||||
'''Run a command as a sub-process, and log the results.
|
||||
"""Run a command as a sub-process, and log the results.
|
||||
|
||||
Args:
|
||||
cmd: The command to execute.
|
||||
|
|
@ -120,7 +120,7 @@ class RunAndLog(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
msg = "+" + " ".join(cmd) + "\n"
|
||||
if self.chained_file:
|
||||
|
|
@ -163,13 +163,13 @@ class RunAndLog(object):
|
|||
raise exception
|
||||
|
||||
class SectionCtxMgr(object):
|
||||
'''A context manager for Python's "with" statement, which allows a certain
|
||||
"""A context manager for Python's "with" statement, which allows a certain
|
||||
portion of test code to be logged to a separate section of the log file.
|
||||
Objects of this type should be created by factory functions in the Logfile
|
||||
class rather than directly.'''
|
||||
class rather than directly."""
|
||||
|
||||
def __init__(self, log, marker):
|
||||
'''Initialize a new object.
|
||||
"""Initialize a new object.
|
||||
|
||||
Args:
|
||||
log: The Logfile object to log to.
|
||||
|
|
@ -177,7 +177,7 @@ class SectionCtxMgr(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.log = log
|
||||
self.marker = marker
|
||||
|
|
@ -189,18 +189,18 @@ class SectionCtxMgr(object):
|
|||
self.log.end_section(self.marker)
|
||||
|
||||
class Logfile(object):
|
||||
'''Generates an HTML-formatted log file containing multiple streams of
|
||||
data, each represented in a well-delineated/-structured fashion.'''
|
||||
"""Generates an HTML-formatted log file containing multiple streams of
|
||||
data, each represented in a well-delineated/-structured fashion."""
|
||||
|
||||
def __init__(self, fn):
|
||||
'''Initialize a new object.
|
||||
"""Initialize a new object.
|
||||
|
||||
Args:
|
||||
fn: The filename to write to.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.f = open(fn, "wt")
|
||||
self.last_stream = None
|
||||
|
|
@ -217,7 +217,7 @@ class Logfile(object):
|
|||
""")
|
||||
|
||||
def close(self):
|
||||
'''Close the log file.
|
||||
"""Close the log file.
|
||||
|
||||
After calling this function, no more data may be written to the log.
|
||||
|
||||
|
|
@ -226,7 +226,7 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.f.write("""\
|
||||
</tt>
|
||||
|
|
@ -241,7 +241,7 @@ class Logfile(object):
|
|||
"".join(chr(c) for c in range(127, 256)))
|
||||
|
||||
def _escape(self, data):
|
||||
'''Render data format suitable for inclusion in an HTML document.
|
||||
"""Render data format suitable for inclusion in an HTML document.
|
||||
|
||||
This includes HTML-escaping certain characters, and translating
|
||||
control characters to a hexadecimal representation.
|
||||
|
|
@ -251,7 +251,7 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
An escaped version of the data.
|
||||
'''
|
||||
"""
|
||||
|
||||
data = data.replace(chr(13), "")
|
||||
data = "".join((c in self._nonprint) and ("%%%02x" % ord(c)) or
|
||||
|
|
@ -260,14 +260,14 @@ class Logfile(object):
|
|||
return data
|
||||
|
||||
def _terminate_stream(self):
|
||||
'''Write HTML to the log file to terminate the current stream's data.
|
||||
"""Write HTML to the log file to terminate the current stream's data.
|
||||
|
||||
Args:
|
||||
None.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.cur_evt += 1
|
||||
if not self.last_stream:
|
||||
|
|
@ -280,7 +280,7 @@ class Logfile(object):
|
|||
self.last_stream = None
|
||||
|
||||
def _note(self, note_type, msg):
|
||||
'''Write a note or one-off message to the log file.
|
||||
"""Write a note or one-off message to the log file.
|
||||
|
||||
Args:
|
||||
note_type: The type of note. This must be a value supported by the
|
||||
|
|
@ -289,7 +289,7 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._terminate_stream()
|
||||
self.f.write("<div class=\"" + note_type + "\">\n<pre>")
|
||||
|
|
@ -297,14 +297,14 @@ class Logfile(object):
|
|||
self.f.write("\n</pre></div>\n")
|
||||
|
||||
def start_section(self, marker):
|
||||
'''Begin a new nested section in the log file.
|
||||
"""Begin a new nested section in the log file.
|
||||
|
||||
Args:
|
||||
marker: The name of the section that is starting.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._terminate_stream()
|
||||
self.blocks.append(marker)
|
||||
|
|
@ -314,7 +314,7 @@ class Logfile(object):
|
|||
"\">Section: " + blk_path + "</div>\n")
|
||||
|
||||
def end_section(self, marker):
|
||||
'''Terminate the current nested section in the log file.
|
||||
"""Terminate the current nested section in the log file.
|
||||
|
||||
This function validates proper nesting of start_section() and
|
||||
end_section() calls. If a mismatch is found, an exception is raised.
|
||||
|
|
@ -324,7 +324,7 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
if (not self.blocks) or (marker != self.blocks[-1]):
|
||||
raise Exception("Block nesting mismatch: \"%s\" \"%s\"" %
|
||||
|
|
@ -337,7 +337,7 @@ class Logfile(object):
|
|||
self.blocks.pop()
|
||||
|
||||
def section(self, marker):
|
||||
'''Create a temporary section in the log file.
|
||||
"""Create a temporary section in the log file.
|
||||
|
||||
This function creates a context manager for Python's "with" statement,
|
||||
which allows a certain portion of test code to be logged to a separate
|
||||
|
|
@ -352,96 +352,96 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
A context manager object.
|
||||
'''
|
||||
"""
|
||||
|
||||
return SectionCtxMgr(self, marker)
|
||||
|
||||
def error(self, msg):
|
||||
'''Write an error note to the log file.
|
||||
"""Write an error note to the log file.
|
||||
|
||||
Args:
|
||||
msg: A message describing the error.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("error", msg)
|
||||
|
||||
def warning(self, msg):
|
||||
'''Write an warning note to the log file.
|
||||
"""Write an warning note to the log file.
|
||||
|
||||
Args:
|
||||
msg: A message describing the warning.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("warning", msg)
|
||||
|
||||
def info(self, msg):
|
||||
'''Write an informational note to the log file.
|
||||
"""Write an informational note to the log file.
|
||||
|
||||
Args:
|
||||
msg: An informational message.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("info", msg)
|
||||
|
||||
def action(self, msg):
|
||||
'''Write an action note to the log file.
|
||||
"""Write an action note to the log file.
|
||||
|
||||
Args:
|
||||
msg: A message describing the action that is being logged.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("action", msg)
|
||||
|
||||
def status_pass(self, msg):
|
||||
'''Write a note to the log file describing test(s) which passed.
|
||||
"""Write a note to the log file describing test(s) which passed.
|
||||
|
||||
Args:
|
||||
msg: A message describing passed test(s).
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("status-pass", msg)
|
||||
|
||||
def status_skipped(self, msg):
|
||||
'''Write a note to the log file describing skipped test(s).
|
||||
"""Write a note to the log file describing skipped test(s).
|
||||
|
||||
Args:
|
||||
msg: A message describing passed test(s).
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("status-skipped", msg)
|
||||
|
||||
def status_fail(self, msg):
|
||||
'''Write a note to the log file describing failed test(s).
|
||||
"""Write a note to the log file describing failed test(s).
|
||||
|
||||
Args:
|
||||
msg: A message describing passed test(s).
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self._note("status-fail", msg)
|
||||
|
||||
def get_stream(self, name, chained_file=None):
|
||||
'''Create an object to log a single stream's data into the log file.
|
||||
"""Create an object to log a single stream's data into the log file.
|
||||
|
||||
This creates a "file-like" object that can be written to in order to
|
||||
write a single stream's data to the log file. The implementation will
|
||||
|
|
@ -456,12 +456,12 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
A file-like object.
|
||||
'''
|
||||
"""
|
||||
|
||||
return LogfileStream(self, name, chained_file)
|
||||
|
||||
def get_runner(self, name, chained_file=None):
|
||||
'''Create an object that executes processes and logs their output.
|
||||
"""Create an object that executes processes and logs their output.
|
||||
|
||||
Args:
|
||||
name: The name of this sub-process.
|
||||
|
|
@ -470,12 +470,12 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
A RunAndLog object.
|
||||
'''
|
||||
"""
|
||||
|
||||
return RunAndLog(self, name, chained_file)
|
||||
|
||||
def write(self, stream, data, implicit=False):
|
||||
'''Write stream data into the log file.
|
||||
"""Write stream data into the log file.
|
||||
|
||||
This function should only be used by instances of LogfileStream or
|
||||
RunAndLog.
|
||||
|
|
@ -491,7 +491,7 @@ class Logfile(object):
|
|||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
if stream != self.last_stream:
|
||||
self._terminate_stream()
|
||||
|
|
@ -507,13 +507,13 @@ class Logfile(object):
|
|||
self.last_stream = stream
|
||||
|
||||
def flush(self):
|
||||
'''Flush the log stream, to ensure correct log interleaving.
|
||||
"""Flush the log stream, to ensure correct log interleaving.
|
||||
|
||||
Args:
|
||||
None.
|
||||
|
||||
Returns:
|
||||
Nothing.
|
||||
'''
|
||||
"""
|
||||
|
||||
self.f.flush()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue