tests/test_format.py

   1 from unittest.mock import patch
   2
   3 import black
   4 import pytest
   5 from parameterized import parameterized
   6
   7 from tests.util import (
   8     BlackBaseTestCase,
   9     fs,
  10     DEFAULT_MODE,
  11     dump_to_stderr,
  12     read_data,
  13     THIS_DIR,
  14 )
  15
  16 SIMPLE_CASES = [
  17     "beginning_backslash",
  18     "bracketmatch",
  19     "class_blank_parentheses",
  20     "class_methods_new_line",
  21     "collections",
  22     "comments",
  23     "comments2",
  24     "comments3",
  25     "comments4",
  26     "comments5",
  27     "comments6",
  28     "comments_non_breaking_space",
  29     "comment_after_escaped_newline",
  30     "composition",
  31     "composition_no_trailing_comma",
  32     "docstring",
  33     "empty_lines",
  34     "expression",
  35     "fmtonoff",
  36     "fmtonoff2",
  37     "fmtonoff3",
  38     "fmtonoff4",
  39     "fmtskip",
  40     "fmtskip2",
  41     "fmtskip3",
  42     "fmtskip4",
  43     "fmtskip5",
  44     "fstring",
  45     "function",
  46     "function2",
  47     "function_trailing_comma",
  48     "import_spacing",
  49     "remove_parens",
  50     "slices",
  51     "string_prefixes",
  52     "tricky_unicode_symbols",
  53     "tupleassign",
  54 ]
  55
  56 SIMPLE_CASES_PY2 = [
  57     "numeric_literals_py2",
  58     "python2",
  59     "python2_unicode_literals",
  60 ]
  61
  62 EXPERIMENTAL_STRING_PROCESSING_CASES = [
  63     "cantfit",
  64     "comments7",
  65     "long_strings",
  66     "long_strings__edge_case",
  67     "long_strings__regression",
  68     "percent_precedence",
  69 ]
  70
  71
  72 SOURCES = [
  73     "src/black/__init__.py",
  74     "src/black/__main__.py",
  75     "src/black/brackets.py",
  76     "src/black/cache.py",
  77     "src/black/comments.py",
  78     "src/black/concurrency.py",
  79     "src/black/const.py",
  80     "src/black/debug.py",
  81     "src/black/files.py",
  82     "src/black/linegen.py",
  83     "src/black/lines.py",
  84     "src/black/mode.py",
  85     "src/black/nodes.py",
  86     "src/black/numerics.py",
  87     "src/black/output.py",
  88     "src/black/parsing.py",
  89     "src/black/report.py",
  90     "src/black/rusty.py",
  91     "src/black/strings.py",
  92     "src/black/trans.py",
  93     "src/blackd/__init__.py",
  94     "src/blib2to3/pygram.py",
  95     "src/blib2to3/pytree.py",
  96     "src/blib2to3/pgen2/conv.py",
  97     "src/blib2to3/pgen2/driver.py",
  98     "src/blib2to3/pgen2/grammar.py",
  99     "src/blib2to3/pgen2/literals.py",
 100     "src/blib2to3/pgen2/parse.py",
 101     "src/blib2to3/pgen2/pgen.py",
 102     "src/blib2to3/pgen2/tokenize.py",
 103     "src/blib2to3/pgen2/token.py",
 104     "setup.py",
 105     "tests/test_black.py",
 106     "tests/test_blackd.py",
 107     "tests/test_format.py",
 108     "tests/test_primer.py",
 109     "tests/optional.py",
 110     "tests/util.py",
 111     "tests/conftest.py",
 112 ]
 113
 114
 115 class TestSimpleFormat(BlackBaseTestCase):
 116     @parameterized.expand(SIMPLE_CASES_PY2)
 117     @pytest.mark.python2
 118     @patch("black.dump_to_file", dump_to_stderr)
 119     def test_simple_format_py2(self, filename: str) -> None:
 120         self.check_file(filename, DEFAULT_MODE)
 121
 122     @parameterized.expand(SIMPLE_CASES)
 123     @patch("black.dump_to_file", dump_to_stderr)
 124     def test_simple_format(self, filename: str) -> None:
 125         self.check_file(filename, DEFAULT_MODE)
 126
 127     @parameterized.expand(EXPERIMENTAL_STRING_PROCESSING_CASES)
 128     @patch("black.dump_to_file", dump_to_stderr)
 129     def test_experimental_format(self, filename: str) -> None:
 130         self.check_file(filename, black.Mode(experimental_string_processing=True))
 131
 132     @parameterized.expand(SOURCES)
 133     @patch("black.dump_to_file", dump_to_stderr)
 134     def test_source_is_formatted(self, filename: str) -> None:
 135         path = THIS_DIR.parent / filename
 136         self.check_file(str(path), DEFAULT_MODE, data=False)
 137
 138     def check_file(self, filename: str, mode: black.Mode, *, data: bool = True) -> None:
 139         source, expected = read_data(filename, data=data)
 140         actual = fs(source, mode=mode)
 141         self.assertFormatEqual(expected, actual)
 142         if source != actual:
 143             black.assert_equivalent(source, actual)
 144             black.assert_stable(source, actual, mode)