[Python] Follow standard Python docstrings conventions (PEP-0257).

https://www.python.org/dev/peps/pep-0257/
makesoftwaresafe · Feb 20, 2016 · e395ea0 · e395ea0
1 parent 67fda25
commit e395ea0
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 26 deletions.
diff --git a/benchmark/scripts/Benchmark_Driver b/benchmark/scripts/Benchmark_Driver
@@ -124,7 +124,8 @@ def get_current_git_branch(git_repo_path):
 
 def log_results(log_directory, driver, formatted_output, swift_repo=None):
     """Log `formatted_output` to a branch specific directory in
-    `log_directory`"""
+    `log_directory`
+    """
     try:
         branch = get_current_git_branch(swift_repo)
     except:
@@ -149,7 +150,8 @@ def run_benchmarks(driver, benchmarks=[], num_samples=10, verbose=False,
                    log_directory=None, swift_repo=None):
     """Run perf tests individually and return results in a format that's
     compatible with `parse_results`. If `benchmarks` is not empty,
-    only run tests included in it."""
+    only run tests included in it.
+    """
     (total_tests, total_min, total_max, total_mean) = (0, 0, 0, 0)
     output = []
     headings = ['#', 'TEST', 'SAMPLES', 'MIN(μs)', 'MAX(μs)', 'MEAN(μs)',

diff --git a/tools/SourceKit/bindings/python/sourcekitd/capi.py b/tools/SourceKit/bindings/python/sourcekitd/capi.py
@@ -157,9 +157,7 @@ def __hash__(self):
         return hash(self._ptr())
 
 class ErrorKind(object):
-    """
-    Describes the kind of type.
-    """
+    """Describes the kind of type."""
 
     # The unique kind objects, indexed by id.
     _kinds = []
@@ -242,9 +240,7 @@ def applier(cobj, value, d):
         return d
 
 class VariantType(object):
-    """
-    Describes the kind of type.
-    """
+    """Describes the kind of type."""
 
     # The unique kind objects, indexed by id.
     _kinds = []
@@ -542,7 +538,6 @@ def register_functions(lib, ignore_errors):
     This must be called as part of library instantiation so Python knows how
     to call out to the shared library.
     """
-
     def register(item):
         return register_function(lib, item, ignore_errors)
 

diff --git a/utils/GYBUnicodeDataUtils.py b/utils/GYBUnicodeDataUtils.py
@@ -235,7 +235,6 @@ def create_tables(self):
 
         Don't change parameter values after calling this method.
         """
-
         self.BMP_data_offset_bits = 16 - self.BMP_first_level_index_bits
 
         self.supp_data_offset_bits = \
@@ -319,9 +318,7 @@ def freeze(self):
         """Compress internal trie representation.
 
         Don't mutate the trie after calling this method.
-
         """
-
         def remap_indexes(indexes, old_idx, new_idx):
             def map_index(idx):
                 if idx == old_idx:

diff --git a/utils/gyb.py b/utils/gyb.py
@@ -362,6 +362,7 @@ def codeStartsWithDedentKeyword(sourceLines):
 
 class ParseContext:
     """State carried through a parse of a template"""
+
     filename = ''
     template = ''
     lineStarts = []
@@ -385,7 +386,7 @@ def posToLine(self, pos):
         return bisect(self.lineStarts, pos) - 1
 
     def tokenGenerator(self, baseTokens):
-        r""" Given an iterator over (kind, text, match) triples (see
+        r"""Given an iterator over (kind, text, match) triples (see
         tokenizeTemplate above), return a refined iterator over
         tokenKinds.
 
@@ -527,6 +528,7 @@ def nextToken(self):
 
 class ExecutionContext:
     """State we pass around during execution of a template"""
+
     def __init__(self, lineDirective='// ###line', **localBindings):
         self.localBindings = localBindings
         self.lineDirective = lineDirective
@@ -556,6 +558,7 @@ def appendText(self, text, file, line):
 
 class ASTNode(object):
     """Abstract base class for template AST nodes"""
+
     def __init__(self):
         raise NotImplemented
 
@@ -577,6 +580,7 @@ def formatChildren(self, indent):
 
 class Block(ASTNode):
     """A sequence of other AST nodes, to be executed in order"""
+
     children = []
 
     def __init__(self, context):
@@ -598,6 +602,7 @@ def __str__(self, indent=''):
 
 class Literal(ASTNode):
     """An AST node that generates literal text"""
+
     def __init__(self, context):
         self.text = context.tokenText
         startPosition = context.tokenMatch.start(context.tokenKind)
@@ -614,6 +619,7 @@ def __str__(self, indent=''):
 
 class Code(ASTNode):
     """An AST node that is evaluated as Python"""
+
     code = None
     children = ()
     kind = None

diff --git a/utils/line-directive b/utils/line-directive
@@ -36,7 +36,7 @@ def _make_line_map(filename, stream=None):
     ... line 7
     ... '''))
     [(0, 'box', 1), (1, 'foo.bar', 3), (5, 'baz.txt', 20)]
-"""
+    """
     result = [(0, filename, 1)]
     input = stream or open(filename)
     for i, l in enumerate(input.readlines()):

diff --git a/utils/profdata_merge/config.py b/utils/profdata_merge/config.py
@@ -17,7 +17,9 @@
 
 class Config():
     """A class to store configuration information specified by command-line
-    arguments."""
+    arguments.
+    """
+
     def __init__(self, out_dir, no_remove_files):
         self.out_dir = out_dir
         self.tmp_dir = tempfile.mkdtemp()

diff --git a/utils/profdata_merge/process.py b/utils/profdata_merge/process.py
@@ -36,7 +36,8 @@ def merge_file_buffer(self):
         """Merge all files in this worker's buffer and clear them.
         This method makes a copy of the working merge progress, then
         calls llvm-cov merge with up to 10 filenames, plus the current
-        in-progress merge."""
+        in-progress merge.
+        """
         if not self.filename_buffer:
             self.report("no files to merge...")
             return
@@ -62,7 +63,8 @@ def merge_file_buffer(self):
     def run(self):
         """Blocks and waits for the file queue so it can fill its buffer and
         execute merges. If it finds None in the queue, then it knows to stop
-        waiting for the queue, merge its current buffer, and kill itself"""
+        waiting for the queue, merge its current buffer, and kill itself
+        """
         while True:
             filename = self.file_queue.get()
             self.report("received filename: %s" % filename)

diff --git a/utils/profdata_merge/server.py b/utils/profdata_merge/server.py
@@ -27,7 +27,8 @@ def report(self, msg):
     def handle(self):
         """Receive a newline-separated list of filenames from a TCP connection
         and add them to the shared merge queue, where the workers will
-        execute llvm-profdata merge commands."""
+        execute llvm-profdata merge commands.
+        """
         data = self.rfile.read()
         self.report("received data (length %d): %s" % (len(data), repr(data)))
 

diff --git a/utils/submit-benchmark-results b/utils/submit-benchmark-results
@@ -1,8 +1,6 @@
 #!/usr/bin/env python
 
-"""
-Utility script for submitting benchmark results to an LNT server.
-"""
+"""Utility script for submitting benchmark results to an LNT server."""
 
 from __future__ import print_function
 
@@ -27,7 +25,8 @@ def capture_with_result(args, include_stderr=False):
     """capture_with_result(command) -> (output, exit code)
 
     Run the given command (or argv list) in a shell and return the standard
-    output and exit code."""
+    output and exit code.
+    """
     stderr = subprocess.PIPE
     if include_stderr:
         stderr = subprocess.STDOUT
@@ -44,7 +43,8 @@ def capture_with_result(args, include_stderr=False):
 
 def capture(args, include_stderr=False):
     """capture(command) - Run the given command (or argv list) in a shell and
-    return the standard output."""
+    return the standard output.
+    """
     return capture_with_result(args, include_stderr)[0]
 
 

diff --git a/utils/swift_build_support/swift_build_support/ninja.py b/utils/swift_build_support/swift_build_support/ninja.py
@@ -12,9 +12,7 @@
 
 
 def is_ninja_installed():
-    """
-    Return whether `ninja` or `ninja-build` are available on the host machine.
-    """
+    """Return whether `ninja` or `ninja-build` are available on the host machine."""
     if which('ninja') or which('ninja-build'):
         return True
     else: