Expose Ruff's public API as a Python library

Cargo.toml

@@ -66,6 +66,8 @@ walkdir = { version = "2.3.2" }
 clearscreen = { version = "1.0.10" }
 rayon = { version = "1.5.3" }
 update-informer = { version = "0.5.0", default-features = false, features = ["pypi"], optional = true }
+pyo3 = { version = "0.17.3", features = ["extension-module", "abi3", "abi3-py37", "anyhow"] }
+pythonize = "0.17.0"
 
 # https://docs.rs/getrandom/0.2.7/getrandom/#webassembly-support
 # For (future) wasm-pack support

MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include ruff *
+global-exclude __pycache__
+global-exclude *.py[co]

pyproject.toml

@@ -17,21 +17,18 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Software Development :: Quality Assurance",
 ]
-author = "Charlie Marsh"
-author_email = "charlie.r.marsh@gmail.com"
+authors = [
+  {name = "Charlie Marsh", email= "charlie.r.marsh@gmail.com" }
+]
 description = "An extremely fast Python linter, written in Rust."
 requires-python = ">=3.7"
+version = "0.0.195"
 
 [project.urls]
 repository = "https://github.com/charliermarsh/ruff"
 
 [build-system]
-requires = ["maturin>=0.14,<0.15"]
-build-backend = "maturin"
-
-[tool.maturin]
-bindings = "bin"
-strip = true
+requires = ["setuptools", "wheel", "setuptools-rust"]
 
 [tool.ruff]
 

ruff/__init__.py

@@ -0,0 +1 @@
+from ._ruff import check # noqa: F401

ruff/__init__.pyi

@@ -0,0 +1,12 @@
+class Location:
+    row: int
+    column: int
+
+
+class Message:
+    code: str
+    message: str
+    location: Location
+    end_location: Location
+
+def check(contents: str | None, path: str | None, options: Mapping[str, Any] | None) -> list(Message): ...

ruff/tests.py

@@ -0,0 +1,50 @@
+import unittest
+
+from ruff import check
+
+
+class CheckTest(unittest.TestCase):
+    def test_something(self):
+        results = check(
+            """
+import os
+import sys
+
+print(os.environ['GREETING'])
+        """
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(results[0].code, "F401")
+        self.assertEqual(results[0].message, "`sys` imported but unused")
+        self.assertEqual(results[0].location.row, 3)
+        self.assertEqual(results[0].location.column, 7)
+        self.assertEqual(results[0].end_location.row, 3)
+        self.assertEqual(results[0].end_location.column, 10)
+
+    def test_options(self):
+        results = check(
+            """
+import sys
+
+print("This is a really long text")
+            """,
+            options={"line-length": 10, "ignore": ["F401"]},
+        )
+        self.assertEqual(len(results), 1)
+        self.assertEqual(results[0].code, "E501")
+        self.assertEqual(results[0].message, "Line too long (35 > 10 characters)")
+        self.assertEqual(results[0].location.row, 4)
+        self.assertEqual(results[0].location.column, 10)
+        self.assertEqual(results[0].end_location.row, 4)
+        self.assertEqual(results[0].end_location.column, 35)
+
+    def test_invalid_options(self):
+        with self.assertRaisesRegex(
+            Exception,
+            "unknown field `line-count`, expected one of `allowed-confusables`, .*",
+        ):
+            check("print(123)", options={"line-count": 10})
+
+
+if __name__ == "__main__":
+    unittest.main()

setup.py

@@ -1,23 +1,13 @@
-import sys
-
 from setuptools import setup
-
-sys.stderr.write(
-    """
-===============================
-Unsupported installation method
-===============================
-ruff no longer supports installation with `python setup.py install`.
-Please use `python -m pip install .` instead.
-"""
+from setuptools_rust import Binding, RustExtension, RustBin, Strip
+
+setup(
+    name="ruff",
+    rust_extensions=[
+        RustExtension("ruff._ruff", binding=Binding.PyO3, strip=Strip.Debug, py_limited_api=True),
+        RustBin("ruff", strip=Strip.Debug),
+    ],
+    packages=["ruff"],
+    # rust extensions are not zip safe, just like C-extensions.
+    zip_safe=False,
 )
-sys.exit(1)
-
-
-# The below code will never execute, however GitHub is particularly
-# picky about where it finds Python packaging metadata.
-# See: https://github.com/github/feedback/discussions/6456
-#
-# To be removed once GitHub catches up.
-
-setup(name="ruff", install_requires=[])

src/lib.rs

@@ -84,6 +84,9 @@ cfg_if! {
 
         mod lib_native;
         pub use lib_native::check;
+
+        mod lib_python;
+        pub use lib_python::_ruff;
     } else {
         mod lib_wasm;
         pub use lib_wasm::check;

src/lib_native.rs

@@ -15,7 +15,9 @@ use crate::source_code_style::SourceCodeStyleDetector;
 use crate::{directives, packages, resolver};
 
 /// Load the relevant `Settings` for a given `Path`.
-fn resolve(path: &Path) -> Result<Settings> {
+/// TODO(rgerecke): Move this somewhere else as to not make it part of public
+/// API
+pub fn resolve(path: &Path) -> Result<Settings> {
     if let Some(pyproject) = pyproject::find_settings_toml(path)? {
         // First priority: `pyproject.toml` in the current `Path`.
         resolver::resolve_settings(&pyproject, &Relativity::Parent, None)