Merge pull request #668 from BoostryJP/ruff

Introducing ruff

.github/workflows/pr.yml

@@ -8,12 +8,12 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-test-image
-  lint-black:
-    name: 'Lint check (black)'
+  lint-ruff:
+    name: 'Lint check (ruff)'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: psf/black@stable
+      - uses: chartboost/ruff-action@v1
   unit-test-postgres:
     name: 'Unit tests (PostgreSQL)'
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -1,6 +1,8 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.4
     hooks:
-      - id: black
-        language_version: python3.12
+      - id: ruff-format
+        name: ruff-format
+        entry: make format
+        language_version: python3.12

Makefile

@@ -1,4 +1,4 @@
-.PHONY: format isort black doc test test_migrations run
+.PHONY: format doc test test_migrations run
 
 install:
 	poetry install --no-root --all-extras
@@ -7,13 +7,11 @@ install:
 update:
 	poetry update
 
-format: isort black
+format:
+	poetry run ruff format && poetry run ruff check --fix --select I
 
-isort:
-	isort .
-
-black:
-	black .
+lint:
+	poetry run ruff check --fix
 
 doc:
 	poetry run python docs/generate_openapi_doc.py

alembic.ini

@@ -41,18 +41,6 @@ prepend_sys_path = .
 
 sqlalchemy.url = driver://user:pass@localhost/dbname
 
-
-[post_write_hooks]
-# post_write_hooks defines scripts or Python functions that are run
-# on newly generated revision scripts.  See the documentation for further
-# detail and examples
-
-# format using "black" - use the console_scripts runner, against the "black" entrypoint
-# hooks=black
-# black.type=console_scripts
-# black.entrypoint=black
-# black.options=-l 79
-
 # Logging configuration
 [loggers]
 keys = root,sqlalchemy,alembic

app/main.py

@@ -25,9 +25,15 @@
 from fastapi.responses import JSONResponse
 from pydantic import ValidationError
 from pydantic_core import ArgsKwargs, ErrorDetails
+from starlette import status
 from starlette.exceptions import HTTPException as StarletteHTTPException
 
-from app.exceptions import *
+from app.exceptions import (
+    AuthorizationError,
+    BadRequestError,
+    ContractRevertError,
+    ServiceUnavailableError,
+)
 from app.log import output_access_log
 from app.routers.issuer import (
     account,

app/model/__init__.py

@@ -31,7 +31,7 @@ def ethereum_address_validator(
     """Validator for ethereum address"""
     if value is not None:
         if not isinstance(value, str):
-            raise ValueError(f"value must be of string")
+            raise ValueError("value must be of string")
         if not Web3.is_address(value):
             raise ValueError("invalid ethereum address")
     return value
@@ -51,14 +51,14 @@ def datetime_string_validator(
         datetime_format = "%Y-%m-%d %H:%M:%S"
 
         if not isinstance(value, str):
-            raise ValueError(f"value must be of string datetime format")
+            raise ValueError("value must be of string datetime format")
 
         try:
             converted = datetime.strptime(value, datetime_format)
             if value != converted.strftime(datetime_format):
-                raise ValueError(f"value must be string datetime format")
+                raise ValueError("value must be string datetime format")
         except ValueError:
-            raise ValueError(f"value must be of string datetime format")
+            raise ValueError("value must be of string datetime format")
     return value
 
 

app/model/db/batch_issue_redeem.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import BigInteger, Boolean, Integer, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -44,7 +44,7 @@ class BatchIssueRedeemUpload(Base):
     processed: Mapped[bool | None] = mapped_column(Boolean, default=False, index=True)
 
 
-class BatchIssueRedeemProcessingCategory(str, Enum):
+class BatchIssueRedeemProcessingCategory(StrEnum):
     """Batch Issue/Redeem Category"""
 
     ISSUE = "Issue"

app/model/db/batch_register_personal_info.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import JSON, Integer, String
 from sqlalchemy.ext.hybrid import hybrid_property
@@ -39,7 +39,7 @@ class BatchRegisterPersonalInfoUpload(Base):
     status: Mapped[str] = mapped_column(String, nullable=False, index=True)
 
 
-class BatchRegisterPersonalInfoUploadStatus(str, Enum):
+class BatchRegisterPersonalInfoUploadStatus(StrEnum):
     """Batch Register PersonalInfo Upload Status"""
 
     PENDING = "pending"

app/model/db/bulk_transfer.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from sqlalchemy import BigInteger, Boolean, Integer, String
+from sqlalchemy import BigInteger, Integer, String
 from sqlalchemy.orm import Mapped, mapped_column
 
 from .base import Base

app/model/db/idx_issue_redeem.py

@@ -18,7 +18,7 @@
 """
 
 from datetime import datetime
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import BigInteger, DateTime, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -48,14 +48,14 @@ class IDXIssueRedeem(Base):
     block_timestamp: Mapped[datetime | None] = mapped_column(DateTime)
 
 
-class IDXIssueRedeemEventType(str, Enum):
+class IDXIssueRedeemEventType(StrEnum):
     """Issue/Redeem event type"""
 
     ISSUE = "Issue"
     REDEEM = "Redeem"
 
 
-class IDXIssueRedeemSortItem(str, Enum):
+class IDXIssueRedeemSortItem(StrEnum):
     """Issue/Redeem sort item"""
 
     BLOCK_TIMESTAMP = "block_timestamp"

app/model/db/idx_transfer.py

@@ -18,15 +18,15 @@
 """
 
 from datetime import datetime
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import JSON, BigInteger, DateTime, String
 from sqlalchemy.orm import Mapped, mapped_column
 
 from .base import Base
 
 
-class IDXTransferSourceEventType(str, Enum):
+class IDXTransferSourceEventType(StrEnum):
     """Transfer source event type"""
 
     TRANSFER = "Transfer"

app/model/db/idx_transfer_approval.py

@@ -18,7 +18,7 @@
 """
 
 from datetime import datetime
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import BigInteger, Boolean, DateTime, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -85,7 +85,7 @@ def json(self):
         }
 
 
-class IDXTransferApprovalsSortItem(str, Enum):
+class IDXTransferApprovalsSortItem(StrEnum):
     ID = "id"
     EXCHANGE_ADDRESS = "exchange_address"
     APPLICATION_ID = "application_id"

app/model/db/ledger_template.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import JSON, Integer, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -66,6 +66,6 @@ class LedgerDetailsTemplate(Base):
     data_source: Mapped[str | None] = mapped_column(String(42))
 
 
-class LedgerDetailsDataType(str, Enum):
+class LedgerDetailsDataType(StrEnum):
     IBET_FIN = "ibetfin"
     DB = "db"

app/model/db/notification.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import JSON, Integer, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -92,7 +92,7 @@ class Notification(Base):
     metainfo: Mapped[dict | None] = mapped_column(JSON)
 
 
-class NotificationType(str, Enum):
+class NotificationType(StrEnum):
     ISSUE_ERROR = "IssueError"
     BULK_TRANSFER_ERROR = "BulkTransferError"
     BATCH_REGISTER_PERSONAL_INFO_ERROR = "BatchRegisterPersonalInfoError"

app/model/db/scheduled_events.py

@@ -15,7 +15,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 from datetime import datetime
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import JSON, DateTime, Integer, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -48,5 +48,5 @@ class ScheduledEvents(Base):
     data: Mapped[dict] = mapped_column(JSON, nullable=False)
 
 
-class ScheduledEventType(str, Enum):
+class ScheduledEventType(StrEnum):
     UPDATE = "Update"

app/model/db/token.py

@@ -18,15 +18,15 @@
 """
 
 from datetime import datetime
-from enum import Enum, StrEnum
+from enum import StrEnum
 
 from sqlalchemy import JSON, Boolean, DateTime, Integer, String
 from sqlalchemy.orm import Mapped, mapped_column
 
 from .base import Base, naive_utcnow
 
 
-class TokenType(str, Enum):
+class TokenType(StrEnum):
     IBET_STRAIGHT_BOND = "IbetStraightBond"
     IBET_SHARE = "IbetShare"
 

app/model/db/token_holders.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 
 from sqlalchemy import BigInteger, String
 from sqlalchemy.orm import Mapped, mapped_column
@@ -41,7 +41,7 @@ class TokenHoldersList(Base):
     batch_status: Mapped[str | None] = mapped_column(String(256))
 
 
-class TokenHolderBatchStatus(str, Enum):
+class TokenHolderBatchStatus(StrEnum):
     PENDING = "pending"
     DONE = "done"
     FAILED = "failed"

app/model/db/transfer_appoval_history.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 from typing import Optional
 
 from sqlalchemy import JSON, BigInteger, String
@@ -59,6 +59,6 @@ def json(self):
         }
 
 
-class TransferApprovalOperationType(str, Enum):
+class TransferApprovalOperationType(StrEnum):
     APPROVE = "approve"
     CANCEL = "cancel"

app/model/schema/base/base.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum, IntEnum, StrEnum
+from enum import IntEnum, StrEnum
 from typing import Literal, Optional
 
 from pydantic import BaseModel, Field, StringConstraints
@@ -53,7 +53,7 @@ class IbetShareContractVersion(StrEnum):
 EMPTY_str = Literal[""]
 
 
-class TokenType(str, Enum):
+class TokenType(StrEnum):
     IBET_STRAIGHT_BOND = "IbetStraightBond"
     IBET_SHARE = "IbetShare"
 

app/model/schema/bulk_transfer.py

@@ -17,8 +17,6 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from typing import Optional
-
 from pydantic import BaseModel, Field
 
 from .base import TokenType

app/model/schema/position.py

@@ -17,7 +17,7 @@
 SPDX-License-Identifier: Apache-2.0
 """
 
-from enum import Enum
+from enum import StrEnum
 from typing import Annotated, List, Optional
 
 from fastapi import Query
@@ -58,7 +58,7 @@ class LockedPosition(BaseModel):
     locked: int = Field(description="Locked amount")
 
 
-class LockEventCategory(str, Enum):
+class LockEventCategory(StrEnum):
     Lock = "Lock"
     Unlock = "Unlock"
 
@@ -88,7 +88,7 @@ class LockEvent(BaseModel):
 ############################
 
 
-class ListAllLockEventsSortItem(str, Enum):
+class ListAllLockEventsSortItem(StrEnum):
     token_address = "token_address"
     lock_address = "lock_address"
     recipient_address = "recipient_address"