format: move to ruff (closes #86)

Author: ebonnal

.github/workflows/lint.yml renamed to .github/workflows/formatting.yml

@@ -1,4 +1,4 @@
-name: lint
+name: formatting
 
 on:
   push:
@@ -8,7 +8,7 @@ on:
       - '.github/workflows/lint.yml'
 
 jobs:
-  lint:
+  formatting:
     runs-on: ubuntu-latest
 
     steps:
@@ -19,4 +19,4 @@ jobs:
         python-version: 3.9
 
     - name: checks
-      run: make venv lint
+      run: make venv format-check

.github/workflows/typing.yml

@@ -8,7 +8,7 @@ on:
       - '.github/workflows/typing.yml'
 
 jobs:
-  mypy:
+  typing:
     runs-on: ubuntu-latest
 
     steps:

CONTRIBUTING.md

@@ -5,7 +5,7 @@
 make venv
 make test
 make type-check
-make lint
+make format
 ```
 
 Run a specific test:

Makefile

@@ -1,14 +1,14 @@
 VENV_DIR := .venv
 
-all: venv test type-check lint
+all: venv test type-check format
 
 help:
 	@echo "Available commands:"
-	@echo "  make all             - Run all tasks: venv, test, type-check, lint"
+	@echo "  make all             - Run all tasks: venv, test, type-check, format"
 	@echo "  make venv            - Create a virtual environment and install dependencies"
 	@echo "  make test            - Run unittests and check coverage"
 	@echo "  make type-check      - Check typing with mypy"
-	@echo "  make lint            - Lint the codebase"
+	@echo "  make format          - Format the codebase"
 
 venv:
 	python3 -m venv $(VENV_DIR) --clear
@@ -22,7 +22,8 @@ test:
 type-check:
 	$(VENV_DIR)/bin/python -m mypy --install-types --non-interactive streamable tests
 
-lint:
-	$(VENV_DIR)/bin/python -m autoflake --in-place --remove-all-unused-imports --remove-unused-variables --ignore-init-module -r streamable tests
-	$(VENV_DIR)/bin/python -m isort streamable tests
-	$(VENV_DIR)/bin/python -m black .
+format:
+	$(VENV_DIR)/bin/python -m ruff format streamable tests
+
+format-check:
+	$(VENV_DIR)/bin/python -m ruff format --check streamable tests

README.md

@@ -1,7 +1,7 @@
 [![coverage](https://codecov.io/gh/ebonnal/streamable/graph/badge.svg?token=S62T0JQK9N)](https://codecov.io/gh/ebonnal/streamable)
 [![unittest](https://github.com/ebonnal/streamable/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/ebonnal/streamable/actions)
 [![typing](https://github.com/ebonnal/streamable/actions/workflows/typing.yml/badge.svg?branch=main)](https://github.com/ebonnal/streamable/actions)
-[![lint](https://github.com/ebonnal/streamable/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/ebonnal/streamable/actions)
+[![formatting](https://github.com/ebonnal/streamable/actions/workflows/formatting.yml/badge.svg?branch=main)](https://github.com/ebonnal/streamable/actions)
 [![PyPI](https://github.com/ebonnal/streamable/actions/workflows/pypi.yml/badge.svg?branch=main)](https://pypi.org/project/streamable)
 
 # ༄ `streamable`

requirements-dev.txt

@@ -1,6 +1,4 @@
-autoflake==2.2.1
-black==24.3.0
-isort==5.12.0
+ruff==0.9.10
 mypy==1.7.1
 mypy-extensions==1.0.0
 parameterized==0.9.0

streamable/util/functiontools.py

@@ -43,7 +43,7 @@ def sidify(func: Callable[[T], Any]) -> Callable[[T], T]:
 
 
 def async_sidify(
-    func: Callable[[T], Coroutine]
+    func: Callable[[T], Coroutine],
 ) -> Callable[[T], Coroutine[Any, Any, T]]:
     async def wrap(arg: T) -> T:
         coroutine = func(arg)
@@ -75,6 +75,7 @@ def __call__(self, args: Tuple) -> R:
 T8 = TypeVar("T8")
 T9 = TypeVar("T9")
 
+
 # fmt: off
 @overload
 def star(func: Callable[[T], R]) -> Callable[[Tuple], R]: ...

tests/test_readme.py

@@ -15,6 +15,7 @@
 
 three_integers_per_second: Stream[int] = integers.throttle(5, per=timedelta(seconds=1))
 
+
 # fmt: off
 class TestReadme(unittest.TestCase):
     def test_collect_it(self) -> None:

tests/test_stream.py

@@ -577,7 +577,9 @@ def test_map_or_foreach_with_exception(
         self.assertListEqual(
             list(
                 method(
-                    Stream(src), throw_for_odd_func(raised_exc), concurrency=concurrency  # type: ignore
+                    Stream(src),
+                    throw_for_odd_func(raised_exc),
+                    concurrency=concurrency,  # type: ignore
                 ).catch(*catched_exc)
             ),
             list(even_src),
@@ -989,13 +991,14 @@ def test_group(self) -> None:
                     Stream([1]).group(
                         size=100, interval=datetime.timedelta(seconds=seconds)
                     )
-                ),
+                )
+
         for size in [-1, 0]:
             with self.assertRaises(
                 ValueError,
                 msg="`group` should raise error when called with `size` < 1.",
             ):
-                list(Stream([1]).group(size=size)),
+                list(Stream([1]).group(size=size))
 
         # group size
         self.assertListEqual(