refactor(format): replace Black with Ruff formatter

HosseinNejatiJavaremi · HosseinNejatiJavaremi · commit b7460d1b8a11 · 2025-12-13T12:31:23.000+03:30
diff --git a/.cursor/rules/checks.mdc b/.cursor/rules/checks.mdc
@@ -20,7 +20,7 @@ alwaysApply: true
 
 **Avoid Over-Engineering**: Do not add speculative generality or unnecessary abstractions unless required.
 
-**Consistent Formatting**: Follow PEP 8, Black (line length 120 characters), and project-specific style (e.g., Pydantic Field descriptions). Use double quotes for strings.
+**Consistent Formatting**: Follow PEP 8, Ruff formatter (line length 120 characters), and project-specific style (e.g., Pydantic Field descriptions). Use double quotes for strings.
 
 **Modular Design**: Organize code into modules (e.g., archipy.configs, archipy.helpers.utils) to minimize coupling and avoid divergent changes.
 
@@ -214,7 +214,7 @@ class ElasticsearchConfig(BaseModel):
 **Package Management**: `uv sync --all-extras --all-groups` or `make install-dev`
 
 **Workflow**:
-- Format: `make format` (Black, 120 chars)
+- Format: `make format` (Ruff formatter, 120 chars)
 - Lint: `make lint` (Ruff + Ty)
 - Test: `make behave`
 - Security: `make security` (Bandit)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -58,9 +58,9 @@ repos:
         entry: uv run codespell --toml pyproject.toml
         files: \.(py|pyi)$
         language: system
-      - id: black
-        name: black
-        entry: uv run black --config pyproject.toml
+      - id: ruff-format
+        name: ruff-format
+        entry: uv run ruff format --config pyproject.toml
         files: \.(py|pyi)$
         language: system
         exclude: ^(features|scripts)/
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -5,7 +5,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 ## Commands
 
 - **Setup**: `uv sync --all-extras --all-groups` or `make install-dev`
-- **Format**: `make format` (Black, 120 char line length)
+- **Format**: `make format` (Ruff formatter, 120 char line length)
 - **Lint**: `make lint` (Ruff + Ty)
 - **Test**: `make behave` (all tests with Behave BDD framework)
 - **Single test**: `uv run --extra behave behave features/file_name.feature`
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -121,7 +121,7 @@ make update
 #### Code Quality
 
 ```bash
-# Format code with black
+# Format code with Ruff formatter
 make format
 
 # Run all linters (ruff, ty)
diff --git a/Makefile b/Makefile
@@ -69,9 +69,9 @@ clean: ## Remove build artifacts and cache directories
 	find . -type f -name "*.pyc" -delete
 
 .PHONY: format
-format: ## Format code using black
+format: ## Format code using ruff
 	@echo "${BLUE}Formatting code...${NC}"
-	$(PYTHON) black --config pyproject.toml $(PYTHON_FILES)
+	$(PYTHON) ruff format --config pyproject.toml $(PYTHON_FILES)
 
 .PHONY: lint
 lint: ## Run all linters
@@ -147,7 +147,7 @@ pre-commit: ## Run pre-commit hooks
 	$(PRE_COMMIT) run --all-files
 
 .PHONY: check
-check: lint security behave ## Run all checks (linting, security, and tests)
+check: format lint security behave ## Run all checks (format, linting, security, and tests)
 
 .PHONY: ci
 ci: ## Run CI pipeline locally
diff --git a/archipy/adapters/email/ports.py b/archipy/adapters/email/ports.py
@@ -21,7 +21,7 @@ class EmailPort:
     email service, managing connections, and ensuring reliable delivery.
 
     Examples:
-        >>> from archipy.adapters.email.email_port import EmailPort
+        >>> from archipy.adapters.email.ports import EmailPort
         >>>
         >>> class CustomEmailAdapter(EmailPort):
         ...     def __init__(self, config):
@@ -37,7 +37,7 @@ class EmailPort:
         ...         attachments=None,
         ...         html=False,
         ...         template=None,
-        ...         template_vars=None
+        ...         template_vars=None,
         ...     ):
         ...         # Implementation details...
         ...         pass
@@ -77,19 +77,15 @@ def send_email(
 
         Examples:
             >>> # Simple text email
-            >>> adapter.send_email(
-            ...     to_email="user@example.com",
-            ...     subject="Hello",
-            ...     body="This is a test email"
-            ... )
+            >>> adapter.send_email(to_email="user@example.com", subject="Hello", body="This is a test email")
             >>>
             >>> # HTML email with attachment
             >>> adapter.send_email(
             ...     to_email=["user1@example.com", "user2@example.com"],
             ...     subject="Report",
             ...     body="<h1>Monthly Report</h1><p>Please see attached</p>",
             ...     html=True,
-            ...     attachments=["path/to/report.pdf"]
+            ...     attachments=["path/to/report.pdf"],
             ... )
             >>>
             >>> # Template-based email
@@ -99,7 +95,7 @@ def send_email(
             ...     subject="Account Expiration",
             ...     body="",  # Body will be rendered from template
             ...     template=template,
-            ...     template_vars={"name": "John", "date": "2023-12-31"}
+            ...     template_vars={"name": "John", "date": "2023-12-31"},
             ... )
         """
         raise NotImplementedError
diff --git a/archipy/adapters/minio/adapters.py b/archipy/adapters/minio/adapters.py
@@ -294,7 +294,11 @@ def put_object(self, bucket_name: str, object_name: str, file_path: str) -> None
                     argument_name=(
                         "bucket_name, object_name or file_path"
                         if not all([bucket_name, object_name, file_path])
-                        else "bucket_name" if not bucket_name else "object_name" if not object_name else "file_path"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "object_name"
+                        if not object_name
+                        else "file_path"
                     ),
                 )
             self._adapter.fput_object(bucket_name, object_name, file_path)
@@ -330,7 +334,11 @@ def get_object(self, bucket_name: str, object_name: str, file_path: str) -> None
                     argument_name=(
                         "bucket_name, object_name or file_path"
                         if not all([bucket_name, object_name, file_path])
-                        else "bucket_name" if not bucket_name else "object_name" if not object_name else "file_path"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "object_name"
+                        if not object_name
+                        else "file_path"
                     ),
                 )
             self._adapter.fget_object(bucket_name, object_name, file_path)
@@ -363,7 +371,9 @@ def remove_object(self, bucket_name: str, object_name: str) -> None:
                     argument_name=(
                         "bucket_name or object_name"
                         if not all([bucket_name, object_name])
-                        else "bucket_name" if not bucket_name else "object_name"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "object_name"
                     ),
                 )
             self._adapter.remove_object(bucket_name, object_name)
@@ -449,7 +459,9 @@ def stat_object(self, bucket_name: str, object_name: str) -> MinioObjectType:
                     argument_name=(
                         "bucket_name or object_name"
                         if not all([bucket_name, object_name])
-                        else "bucket_name" if not bucket_name else "object_name"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "object_name"
                     ),
                 )
             obj = self._adapter.stat_object(bucket_name, object_name)
@@ -497,7 +509,9 @@ def presigned_get_object(self, bucket_name: str, object_name: str, expires: int
                     argument_name=(
                         "bucket_name or object_name"
                         if not all([bucket_name, object_name])
-                        else "bucket_name" if not bucket_name else "object_name"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "object_name"
                     ),
                 )
             url = self._adapter.presigned_get_object(
@@ -544,7 +558,9 @@ def presigned_put_object(self, bucket_name: str, object_name: str, expires: int
                     argument_name=(
                         "bucket_name or object_name"
                         if not all([bucket_name, object_name])
-                        else "bucket_name" if not bucket_name else "object_name"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "object_name"
                     ),
                 )
             url = self._adapter.presigned_put_object(
@@ -587,7 +603,9 @@ def set_bucket_policy(self, bucket_name: str, policy: str) -> None:
                     argument_name=(
                         "bucket_name or policy"
                         if not all([bucket_name, policy])
-                        else "bucket_name" if not bucket_name else "policy"
+                        else "bucket_name"
+                        if not bucket_name
+                        else "policy"
                     ),
                 )
             self._adapter.set_bucket_policy(bucket_name, policy)
diff --git a/archipy/adapters/temporal/base.py b/archipy/adapters/temporal/base.py
@@ -567,6 +567,7 @@ async def custom_logic():
                 # Custom database operations
                 return await some_database_work()
 
+
             result = await self.execute_custom_atomic_operation(custom_logic)
             ```
         """
diff --git a/archipy/configs/base_config.py b/archipy/configs/base_config.py
@@ -96,10 +96,7 @@ class BaseConfig[R](BaseSettings):
         ...     DEBUG = True
         ...
         ...     # Custom configuration
-        ...     FEATURE_FLAGS = {
-        ...         "new_ui": True,
-        ...         "advanced_search": False
-        ...     }
+        ...     FEATURE_FLAGS = {"new_ui": True, "advanced_search": False}
         >>>
         >>> # Set as global configuration
         >>> config = MyAppConfig()
diff --git a/archipy/helpers/decorators/cache.py b/archipy/helpers/decorators/cache.py
@@ -15,6 +15,7 @@ class CachedFunction[**P, R]:
         def expensive_function(x: int) -> int:
             return x * 2
 
+
         # First call executes the function
         result = expensive_function(5)  # Returns 10
 
@@ -135,6 +136,7 @@ def fetch_data(self, key: str) -> dict:
                 # Expensive operation
                 return {"data": key}
 
+
         service1 = DataService()
         service2 = DataService()
 
diff --git a/archipy/helpers/decorators/deprecation_exception.py b/archipy/helpers/decorators/deprecation_exception.py
@@ -40,6 +40,7 @@ class MyClass:
             def old_method(self):
                 return "This is the old method."
 
+
         # Calling the method will raise a DeprecationException
         obj = MyClass()
         result = obj.old_method()
@@ -86,6 +87,7 @@ class OldClass:
             def __init__(self):
                 pass
 
+
         # Instantiating the class will raise a DeprecationException
         obj = OldClass()
         ```
diff --git a/archipy/helpers/decorators/deprecation_warnings.py b/archipy/helpers/decorators/deprecation_warnings.py
@@ -29,6 +29,7 @@ class MyClass:
             def old_method(self):
                 return "This is the old method."
 
+
         # Calling the method will issue a deprecation warning
         obj = MyClass()
         result = obj.old_method()
@@ -75,6 +76,7 @@ class OldClass:
             def __init__(self):
                 pass
 
+
         # Instantiating the class will issue a deprecation warning
         obj = OldClass()
         ```
diff --git a/archipy/helpers/decorators/retry.py b/archipy/helpers/decorators/retry.py
@@ -43,6 +43,7 @@ def unreliable_function():
                 raise ValueError("Temporary failure")
             return "Success"
 
+
         result = unreliable_function()
         ```
 
diff --git a/archipy/helpers/decorators/singleton.py b/archipy/helpers/decorators/singleton.py
@@ -26,6 +26,7 @@ class MySingletonClass:
             def __init__(self, value):
                 self.value = value
 
+
         # Create instances of MySingletonClass
         instance1 = MySingletonClass(10)
         instance2 = MySingletonClass(20)
diff --git a/archipy/helpers/decorators/timeout.py b/archipy/helpers/decorators/timeout.py
@@ -31,6 +31,7 @@ def long_running_function():
             time.sleep(5)  # This will take longer than the timeout
             return "Finished"
 
+
         try:
             result = long_running_function()
         except DeadlineExceededException as e:
diff --git a/archipy/helpers/decorators/timing.py b/archipy/helpers/decorators/timing.py
@@ -23,6 +23,7 @@ def example_function(n: int) -> str:
             time.sleep(n)
             return f"Slept for {n} seconds"
 
+
         result = example_function(2)
         ```
 
diff --git a/archipy/helpers/decorators/tracing.py b/archipy/helpers/decorators/tracing.py
@@ -40,6 +40,7 @@ def process_user_data(user_id: int) -> dict[str, Any]:
             # Your business logic here
             return {"user_id": user_id, "status": "processed"}
 
+
         # Transaction will be automatically captured when function is called
         result = process_user_data(123)
         ```
@@ -160,16 +161,19 @@ def process_user_data(user_id: int) -> dict[str, Any]:
             save_result(processed_data)
             return processed_data
 
+
         @capture_span(name="database_query", op="db")
         def get_user(user_id: int) -> dict[str, Any]:
             # Database query logic here
             return {"id": user_id, "name": "John"}
 
+
         @capture_span(name="data_transformation", op="processing")
         def transform_data(user: dict[str, Any]) -> dict[str, Any]:
             # Data transformation logic
             return {"processed": True, **user}
 
+
         @capture_span(name="save_operation", op="db")
         def save_result(data: dict[str, Any]) -> None:
             # Save logic here
diff --git a/archipy/helpers/interceptors/fastapi/rate_limit/fastapi_rest_rate_limit_handler.py b/archipy/helpers/interceptors/fastapi/rate_limit/fastapi_rest_rate_limit_handler.py
@@ -64,11 +64,7 @@ def __init__(
             >>> handler = FastAPIRestRateLimitHandler(calls_count=100, minutes=1)
             >>>
             >>> # Allow 1000 requests per day with specific query params
-            >>> handler = FastAPIRestRateLimitHandler(
-            ...     calls_count=1000,
-            ...     days=1,
-            ...     query_params={'user_id', 'action'}
-            ... )
+            >>> handler = FastAPIRestRateLimitHandler(calls_count=1000, days=1, query_params={"user_id", "action"})
         """
         self.query_params = query_params or set()
         self.calls_count = calls_count
diff --git a/archipy/helpers/metaclasses/singleton.py b/archipy/helpers/metaclasses/singleton.py
@@ -26,6 +26,7 @@ class MySingletonClass(metaclass=Singleton, thread_safe=True):
             def __init__(self, value):
                 self.value = value
 
+
         # Create instances of MySingletonClass
         instance1 = MySingletonClass(10)
         instance2 = MySingletonClass(20)
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -361,7 +361,6 @@ All notable changes to ArchiPy are documented in this changelog, organized by ve
     - Updated confluent-kafka from 2.12.1 to 2.12.2 for improved Kafka messaging reliability and performance
     - Updated psycopg from 3.2.11 to 3.2.12 for enhanced PostgreSQL driver stability and bug fixes
     - Updated pydantic-settings from 2.11.0 to 2.12.0 for improved settings management and validation
-    - Updated black from 25.9.0 to 25.11.0 for enhanced code formatting capabilities
     - Updated pre-commit from 4.3.0 to 4.4.0 for improved git hook management
     - Updated ruff from 0.14.3 to 0.14.4 for enhanced linting capabilities and bug fixes
 
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -38,9 +38,8 @@ contributing to ArchiPy.
 
 ArchiPy follows a strict code style to maintain consistency across the codebase:
 
-- **Black**: For code formatting
-- **Ruff**: For linting
-- **Mypy**: For type checking
+- **Ruff**: For linting and code formatting
+- **Ty**: For type checking
 
 All code must pass these checks before being merged:
 
diff --git a/docs/development.md b/docs/development.md
@@ -31,7 +31,7 @@
 Run checks:
 
 ```bash
-make check  # Runs ruff, black, ty
+make check  # Runs ruff, ruff format, ty
 ```
 
 ### Testing
diff --git a/docs/features.md b/docs/features.md
@@ -64,7 +64,7 @@ productivity.
 - **Code Quality**:
     - Automated linting with ruff
     - Type checking with Ty
-    - Code formatting with black
+    - Code formatting with Ruff formatter
     - Pre-commit hooks for quality assurance
 
 ## Best Practices & Tooling
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/uv.lock b/uv.lock
