format/formatters/python_unittest.py

# Copyright 2023 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Test the python module."""

import pytest

from chromite.format.formatters import python


# pylint: disable=protected-access


# None means input is already formatted to avoid having to repeat.
@pytest.mark.parametrize(
    "data,exp",
    (
        ("", None),
        ("#", ""),
        ("\n#\n", ""),
        ("#\n#!/\n#\n", "#!/\n"),
        ("#!/\n\n# foo\n", "#!/\n# foo\n"),
        ('# foo\n#\n"""."""\n', '# foo\n\n"""."""\n'),
        # Trim blank lines after module docstring.
        (
            '"""module\n\nblah\n"""\n\n\nimport foo\n',
            '"""module\n\nblah\n"""\n\nimport foo\n',
        ),
        # Don't crash if docstring is the entire module.
        ('"""module\n\nblah\n"""\n', '"""module\n\nblah\n"""\n'),
        # Don't crash if docstring isn't found.
        ('"""one-line"""\n', '"""one-line"""\n'),
        (
            '"""one-line"""\n\n\n\nFOO = """\nblah\n"""\nBAR = 1\n',
            '"""one-line"""\n\nFOO = """\nblah\n"""\nBAR = 1\n',
        ),
    ),
)
def test_check_custom_format(data, exp) -> None:
    """Verify inputs match expected outputs."""
    if exp is None:
        exp = data
    assert exp == python._custom_format_data(data)