Experimental support for import sorting via ruff-api

[ghstack-poisoned]

docs/guide.rst

@@ -77,7 +77,7 @@ Options available are described as follows:
       [tool.ufmt]
       sorter = "usort"
 
-    See :class:`~ufmt.types.Formatter` for list of supported choices.
+    See :class:`~ufmt.types.Sorter` for list of supported choices.
 
 
 Integrations

pyproject.toml

@@ -31,7 +31,7 @@ dependencies = [
 
 [project.optional-dependencies]
 ruff = [
-    "ruff-api>=0.0.1",
+    "ruff-api>=0.0.5",
 ]
 dev = [
     "attribution==1.7.1",

ufmt/core.py

@@ -18,6 +18,7 @@
 from moreorless import unified_diff
 from trailrunner import Trailrunner
 from usort import usort
+from usort.config import CAT_FIRST_PARTY, CAT_STANDARD_LIBRARY
 
 try:
     import ruff_api
@@ -107,6 +108,23 @@ def ufmt_bytes(
         if result.error:
             raise result.error
         content = result.output
+    elif ufmt_config.sorter == Sorter.ruff_api:
+        ruff_isort_options = ruff_api.SortOptions(
+            first_party_modules=[
+                imp
+                for imp, category in usort_config.known.items()
+                if category == CAT_FIRST_PARTY
+            ],
+            standard_library_modules=[
+                imp
+                for imp, category in usort_config.known.items()
+                if category == CAT_STANDARD_LIBRARY
+            ],
+        )
+        content_str = ruff_api.isort_string(
+            path.as_posix(), content.decode(encoding), options=ruff_isort_options
+        )
+        content = content_str.encode(encoding)
     elif ufmt_config.sorter == Sorter.skip:
         pass
     else:
@@ -127,7 +145,7 @@ def ufmt_bytes(
         except black.report.NothingChanged:
             content = result.output
     elif ufmt_config.formatter == Formatter.ruff_api:
-        options = ruff_api.FormatOptions(
+        ruff_format_options = ruff_api.FormatOptions(
             target_version=str(
                 black_config.target_versions.pop()
                 if black_config.target_versions
@@ -137,7 +155,7 @@ def ufmt_bytes(
             preview=black_config.preview,
         )
         content_str = ruff_api.format_string(
-            path.as_posix(), content_str, options=options
+            path.as_posix(), content_str, options=ruff_format_options
         )
     else:
         raise ValueError(f"{ufmt_config.formatter!r} is not a supported formatter")

ufmt/tests/core.py

@@ -221,7 +221,10 @@ def test_ufmt_bytes_alternate_formatter(
             black_mock.assert_not_called()
 
     @patch("ufmt.core.usort", wraps=usort.usort)
-    def test_ufmt_bytes_alternate_sorter(self, usort_mock: Mock) -> None:
+    @patch("ufmt.core.ruff_api.isort_string", wraps=ruff_api.isort_string)
+    def test_ufmt_bytes_alternate_sorter(
+        self, ruff_mock: Mock, usort_mock: Mock
+    ) -> None:
         black_config = BlackConfig()
         usort_config = UsortConfig()
 
@@ -249,6 +252,19 @@ def test_ufmt_bytes_alternate_sorter(self, usort_mock: Mock) -> None:
             self.assertEqual(CORRECTLY_FORMATTED_CODE.encode(), result)
             usort_mock.assert_called_once()
 
+        with self.subTest("ruff-api"):
+            usort_mock.reset_mock()
+            result = ufmt.ufmt_bytes(
+                Path("foo.py"),
+                POORLY_FORMATTED_CODE.encode(),
+                ufmt_config=UfmtConfig(sorter=Sorter.ruff_api),
+                black_config=black_config,
+                usort_config=usort_config,
+            )
+            self.assertEqual(CORRECTLY_FORMATTED_CODE.encode(), result)
+            usort_mock.assert_not_called()
+            ruff_mock.assert_called_once()
+
         with self.subTest("skip"):
             usort_mock.reset_mock()
             result = ufmt.ufmt_bytes(

ufmt/types.py

@@ -66,6 +66,18 @@ class Sorter(Enum):
     usort = "usort"
     """Use µsort (default)."""
 
+    ruff_api = "ruff-api"
+    """
+    **Experimental:**
+    Use Ruff's isort lint rules via unofficial
+    `ruff-api <https://pypi.org/project/ruff-api>`_ extension.
+
+    .. note::
+        This implementation still depends on and uses the ``[tool.usort]`` configuration
+        table from ``pyproject.toml`` rather than Ruff's own configuration options.
+        This may change in future updates.
+    """
+
 
 @dataclass
 class UfmtConfig: