[Misc] Add python format script (#357)

* add ruff lint and format rules

* add format scripts

* doc: format

* add version check

* refact: tool version check

* format with new rules

python/aibrix/README.md

@@ -25,7 +25,26 @@ At present, `vLLM` engine is supported, and in the future, `SGLang` and other in
 For more details on integrate with `vLLM`, please refer to our [Runtime docs](https://github.com/aibrix/aibrix/blob/main/docs/source/features/runtime.rst#metric-standardization).
 
 ## Contributing
-We welcome contributions from the community! Check out our [contributing guidelines](https://github.com/aibrix/aibrix/CONTRIBUTING.md) to see how you can make a difference.
+We welcome contributions from the community! Check out our [contributing guidelines](https://github.com/aibrix/aibrix/blob/main/CONTRIBUTING.md) to see how you can make a difference.
+
+### Build from source
+
+```bash
+# This may take several minutes
+pip install -e .
+```
+
+### Lint, Format and Type Check
+
+Before contribute your code, please run the following commands to ensure that your code passes the tests and linting checks.
+
+```bash
+# install dependencies
+poetry install --no-root --with dev
+
+# linting, formatting and type checking
+bash ./scripts/format.sh
+```
 
 ## License
 

python/aibrix/aibrix/app.py

@@ -1,17 +1,10 @@
 import argparse
 import os
 import shutil
-from pathlib import Path
 import time
+from pathlib import Path
 from urllib.parse import urljoin
 
-from aibrix.config import EXCLUDE_METRICS_HTTP_ENDPOINTS
-from aibrix.metrics.metrics import (
-    HTTP_COUNTER_METRICS,
-    HTTP_LATENCY_METRICS,
-    INFO_METRICS,
-    REGISTRY,
-)
 import uvicorn
 from fastapi import APIRouter, FastAPI, Request, Response
 from fastapi.datastructures import State
@@ -20,9 +13,16 @@
 from starlette.routing import Mount
 
 from aibrix import __version__, envs
+from aibrix.config import EXCLUDE_METRICS_HTTP_ENDPOINTS
 from aibrix.logger import init_logger
 from aibrix.metrics.engine_rules import get_metric_standard_rules
 from aibrix.metrics.http_collector import HTTPCollector
+from aibrix.metrics.metrics import (
+    HTTP_COUNTER_METRICS,
+    HTTP_LATENCY_METRICS,
+    INFO_METRICS,
+    REGISTRY,
+)
 from aibrix.openapi.engine.base import InferenceEngine, get_inference_engine
 from aibrix.openapi.protocol import (
     ErrorResponse,

python/aibrix/aibrix/batch/driver.py

@@ -13,12 +13,12 @@
 # limitations under the License.
 
 import asyncio
-from aibrix.batch.constant import DEFAULT_JOB_POOL_SIZE
 
 import aibrix.batch.storage as _storage
-from aibrix.batch.scheduler import JobScheduler
+from aibrix.batch.constant import DEFAULT_JOB_POOL_SIZE
 from aibrix.batch.job_manager import JobManager
 from aibrix.batch.request_proxy import RequestProxy
+from aibrix.batch.scheduler import JobScheduler
 
 
 class BatchDriver:

python/aibrix/aibrix/batch/job_manager.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import time
 import asyncio
+import time
 from enum import Enum
+
 import aibrix.batch.storage as _storage
 
 

python/aibrix/aibrix/batch/scheduler.py

@@ -12,14 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from enum import Enum
-import time
 import asyncio
 import bisect
 import queue
+import time
 from abc import ABC, abstractmethod
+from enum import Enum
 
-from aibrix.batch.constant import EXPIRE_INTERVAL, DEFAULT_JOB_POOL_SIZE
+from aibrix.batch.constant import DEFAULT_JOB_POOL_SIZE, EXPIRE_INTERVAL
 from aibrix.batch.job_manager import JobStatus
 
 

python/aibrix/aibrix/batch/storage/__init__.py

@@ -12,16 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from aibrix.batch.storage.generic_storage import StorageType
 from aibrix.batch.storage.batch_storage import (
     get_job_request_len,
     get_storage_job_results,
+    initialize_batch_storage,
     put_storage_job_results,
     read_job_requests,
     remove_storage_job_data,
     upload_input_data,
-    initialize_batch_storage,
 )
+from aibrix.batch.storage.generic_storage import StorageType
 
 
 def initialize_storage(storage_type=StorageType.LocalDiskFile, params={}):

python/aibrix/aibrix/batch/storage/batch_storage.py

@@ -14,10 +14,10 @@
 
 import uuid
 
+from aibrix.batch.storage.generic_storage import LocalDiskFiles, StorageType
+
 # [TODO] Add S3 as another storage
 from aibrix.batch.storage.tos_storage import TOSStorage
-from aibrix.batch.storage.generic_storage import LocalDiskFiles
-from aibrix.batch.storage.generic_storage import StorageType
 
 current_job_offsets = {}
 job_input_requests = {}

python/aibrix/aibrix/batch/storage/generic_storage.py

@@ -14,9 +14,8 @@
 
 import json
 import os
-from enum import Enum
 from abc import ABC, abstractmethod
-
+from enum import Enum
 
 LOCAL_STORAGE_PATH_VAR = "LOCAL_STORAGE_PATH"
 

python/aibrix/aibrix/batch/storage/tos_storage.py

@@ -12,10 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import json
 import logging
-import tos
 from io import StringIO
-import json
+
+import tos
+
 from aibrix.batch.storage.generic_storage import PersistentStorage
 
 

python/aibrix/aibrix/downloader/utils.py

@@ -19,7 +19,6 @@
 from aibrix.config import DOWNLOAD_CACHE_DIR
 from aibrix.logger import init_logger
 
-
 logger = init_logger(__name__)
 
 

python/aibrix/aibrix/metrics/metrics.py

@@ -14,7 +14,6 @@
 
 from prometheus_client import CollectorRegistry, Counter, Histogram, Info
 
-
 REGISTRY = CollectorRegistry()
 
 INFO_METRICS = Info(