Make docstrings more consistent using format-webkitpy.

third_party/WebKit/Tools/Scripts/webkitpy/layout_tests/models/test_expectations.py

 # Copyright (C) 2010 Google Inc. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 # copyright notice, this list of conditions and the following disclaimer
@@ skipping 189 matching lines @@
         if not self._port.test_exists(expectation_line.name) and not self._port.test_exists(expectation_line.name + '-disabled'):
             # Log a warning here since you hit this case any
             # time you update TestExpectations without syncing
             # the LayoutTests directory
             expectation_line.warnings.append('Path does not exist.')
             return False
         return True
 
     def _collect_matching_tests(self, expectation_line):
         """Convert the test specification to an absolute, normalized
-        path and make sure directories end with the OS path separator."""
+        path and make sure directories end with the OS path separator.
+        """
         if not self._all_tests:
             expectation_line.matching_tests = [expectation_line.path]
             return
 
         if not expectation_line.is_file:
             # this is a test category, return all the tests of the category.
             expectation_line.matching_tests = [test for test in self._all_tests if test.startswith(expectation_line.path)]
             return
 
         # this is a test file, do a quick check if it's in the
@@ skipping 36 matching lines @@
     # FIXME: Seems like these should be classmethods on TestExpectationLine instead of TestExpectationParser.
     @classmethod
     def _tokenize_line(cls, filename, expectation_string, line_number):
         """Tokenizes a line from TestExpectations and returns an unparsed TestExpectationLine instance using the old format.
 
         The new format for a test expectation line is:
 
         [[bugs] [ "[" <configuration specifiers> "]" <name> [ "[" <expectations> "]" ["#" <comment>]
 
         Any errant whitespace is not preserved.
-
         """
         expectation_line = TestExpectationLine()
         expectation_line.original_string = expectation_string
         expectation_line.filename = filename
         expectation_line.line_numbers = str(line_number)
 
         comment_index = expectation_string.find("#")
         if comment_index == -1:
             comment_index = len(expectation_string)
         else:
@@ skipping 341 matching lines @@
                 merged_line = other_line
 
             self._test_to_expectation_line[test] = merged_line
 
         self._merge_dict_of_sets(self._expectation_to_tests, other._expectation_to_tests)
         self._merge_dict_of_sets(self._timeline_to_tests, other._timeline_to_tests)
         self._merge_dict_of_sets(self._result_type_to_tests, other._result_type_to_tests)
 
     def _dict_of_sets(self, strings_to_constants):
         """Takes a dict of strings->constants and returns a dict mapping
-        each constant to an empty set."""
+        each constant to an empty set.
+        """
         d = {}
         for c in strings_to_constants.values():
             d[c] = set()
         return d
 
     def get_test_set(self, expectation, include_skips=True):
         tests = self._expectation_to_tests[expectation]
         if not include_skips:
             tests = tests - self.get_test_set(SKIP)
         return tests
@@ skipping 19 matching lines @@
         return test in self._test_to_expectation_line
 
     def get_expectation_line(self, test):
         return self._test_to_expectation_line.get(test)
 
     def get_expectations(self, test):
         return self._test_to_expectations[test]
 
     def get_expectations_string(self, test):
         """Returns the expectations for the given test as an uppercase string.
-        If there are no expectations for the test, then "PASS" is returned."""
+        If there are no expectations for the test, then "PASS" is returned.
+        """
         if self.get_expectation_line(test).is_skipped_outside_expectations_file:
             return 'NOTRUN'
 
         expectations = self.get_expectations(test)
         retval = []
 
         # FIXME: WontFix should cause the test to get skipped without artificially adding SKIP to the expectations list.
         if WONTFIX in expectations and SKIP in expectations:
             expectations.remove(SKIP)
 
@@ skipping 32 matching lines @@
 
             self._clear_expectations_for_test(test)
             self._test_to_expectation_line[test] = expectation_line
             self._add_test(test, expectation_line)
 
     def _add_test(self, test, expectation_line):
         """Sets the expected state for a given test.
 
         This routine assumes the test has not been added before. If it has,
         use _clear_expectations_for_test() to reset the state prior to
-        calling this."""
+        calling this.
+        """
         self._test_to_expectations[test] = expectation_line.parsed_expectations
         for expectation in expectation_line.parsed_expectations:
             self._expectation_to_tests[expectation].add(test)
 
         self._test_to_specifiers[test] = expectation_line.specifiers
 
         if WONTFIX in expectation_line.parsed_expectations:
             self._timeline_to_tests[WONTFIX].add(test)
         else:
             self._timeline_to_tests[NOW].add(test)
@@ skipping 17 matching lines @@
             self._test_to_expectations.pop(test, '')
             self._remove_from_sets(test, self._expectation_to_tests)
             self._remove_from_sets(test, self._timeline_to_tests)
             self._remove_from_sets(test, self._result_type_to_tests)
 
     def _remove_from_sets(self, test, dict_of_sets_of_tests):
         """Removes the given test from the sets in the dictionary.
 
         Args:
           test: test to look for
-          dict: dict of sets of files"""
+          dict: dict of sets of files
+        """
         for set_of_tests in dict_of_sets_of_tests.itervalues():
             if test in set_of_tests:
                 set_of_tests.remove(test)
 
     def _already_seen_better_match(self, test, expectation_line):
         """Returns whether we've seen a better match already in the file.
 
         Returns True if we've already seen a expectation_line.name that matches more of the test
             than this path does
         """
@@ skipping 137 matching lines @@
     def expectation_from_string(cls, string):
         assert ' ' not in string  # This only handles one expectation at a time.
         return cls.EXPECTATIONS.get(string.lower())
 
     @staticmethod
     def result_was_expected(result, expected_results, test_needs_rebaselining):
         """Returns whether we got a result we were expecting.
         Args:
             result: actual result of a test execution
             expected_results: set of results listed in test_expectations
-            test_needs_rebaselining: whether test was marked as REBASELINE"""
+            test_needs_rebaselining: whether test was marked as REBASELINE
+        """
         if not set(expected_results) - set(TestExpectations.NON_TEST_OUTCOME_EXPECTATIONS):
             expected_results = set([PASS])
 
         if result in expected_results:
             return True
         if result in (PASS, TEXT, IMAGE, IMAGE_PLUS_TEXT, AUDIO, MISSING) and (
                 NEEDS_REBASELINE in expected_results or NEEDS_MANUAL_REBASELINE in expected_results):
             return True
         if result in (TEXT, IMAGE, IMAGE_PLUS_TEXT, AUDIO) and (FAIL in expected_results):
             return True
         if result == MISSING and test_needs_rebaselining:
             return True
         if result == SKIP:
             return True
         return False
 
     @staticmethod
     def remove_pixel_failures(expected_results):
         """Returns a copy of the expected results for a test, except that we
         drop any pixel failures and return the remaining expectations. For example,
         if we're not running pixel tests, then tests expected to fail as IMAGE
-        will PASS."""
+        will PASS.
+        """
         expected_results = expected_results.copy()
         if IMAGE in expected_results:
             expected_results.remove(IMAGE)
             expected_results.add(PASS)
         return expected_results
 
     @staticmethod
     def remove_non_sanitizer_failures(expected_results):
         """Returns a copy of the expected results for a test, except that we
-        drop any failures that the sanitizers don't care about."""
+        drop any failures that the sanitizers don't care about.
+        """
         expected_results = expected_results.copy()
         for result in (IMAGE, FAIL, IMAGE_PLUS_TEXT):
             if result in expected_results:
                 expected_results.remove(result)
                 expected_results.add(PASS)
         return expected_results
 
     @staticmethod
     def has_pixel_failures(actual_results):
         return IMAGE in actual_results or FAIL in actual_results
@@ skipping 228 matching lines @@
             # If reconstitute_only_these is an empty list, we want to return original_string.
             # So we need to compare reconstitute_only_these to None, not just check if it's falsey.
             if reconstitute_only_these is None or expectation_line in reconstitute_only_these:
                 return expectation_line.to_string(test_configuration_converter)
             return expectation_line.original_string
 
         def nones_out(expectation_line):
             return expectation_line is not None
 
         return "\n".join(filter(nones_out, map(serialize, expectation_lines)))