Stricter Linting

.pylintrc

@@ -1,4 +1,4 @@
 [MASTER]
-disable=fixme,too-few-public-methods,too-many-instance-attributes,too-many-arguments,logging-fstring-interpolation,too-many-locals,duplicate-code,    def buy_amount(self) -> Decimal:
+disable=fixme,logging-fstring-interpolation,too-many-arguments
 
 extension-pkg-allow-list=pydantic

src/models/order.py

@@ -11,7 +11,10 @@
 from src.models.exchange_rate import ExchangeRate as XRate
 from src.models.token import Token, TokenBalance
 from src.models.types import NumericType
-from src.util.constants import Constants
+from src.util.constants import (
+    RAISE_ON_MAX_SELL_AMOUNT_VIOLATION,
+    RAISE_ON_LIMIT_XRATE_VIOLATION,
+)
 from src.util.numbers import decimal_to_str
 
 OrderSerializedType = dict[str, Any]
@@ -39,6 +42,8 @@ class Order:
     a cost-bounded {buy|sell} order or a {buy|sell} market order.
     """
 
+    # pylint: disable=too-many-instance-attributes
+
     def __init__(
         self,
         order_id: str,
@@ -303,7 +308,7 @@ def execute(
                     f"sell (max)  : {ymax.balance}"
                 )
                 logging.error(message)
-                if Constants.RAISE_ON_MAX_SELL_AMOUNT_VIOLATION:
+                if RAISE_ON_MAX_SELL_AMOUNT_VIOLATION:
                     raise ValueError(message)
             sell_amount = min(sell_amount, ymax)
 
@@ -330,7 +335,7 @@ def execute(
                     f"limit (max): {self.max_limit}"
                 )
                 logging.error(message)
-                if Constants.RAISE_ON_LIMIT_XRATE_VIOLATION:
+                if RAISE_ON_LIMIT_XRATE_VIOLATION:
                     raise ValueError(message)
 
         # Store execution information.

src/models/solver_args.py

@@ -13,6 +13,8 @@
 class SolverArgs:
     """Parameters passed in POST URL"""
 
+    # pylint: disable=too-many-instance-attributes
+
     auction_id: Optional[str]
     instance_name: str
     time_limit: int

src/models/token.py

@@ -6,7 +6,7 @@
 from typing import Optional, Union
 
 from src.models.types import NumericType
-from src.util.constants import Constants
+from src.util.constants import DECIMAL_STR_PREC
 
 
 class Token:
@@ -101,7 +101,7 @@ def __str__(self) -> str:
                 "external_price",
                 "internal_buffer",
             ]:
-                value = value.quantize(Constants.DECIMAL_STR_PREC)
+                value = value.quantize(DECIMAL_STR_PREC)
             _str += f"\n-- {attr} : {value}"
 
         return _str

src/models/uniswap.py

@@ -24,6 +24,8 @@ class Uniswap:
     An Uniswap pool is represented by two token balances.
     """
 
+    # pylint: disable=too-many-instance-attributes
+
     def __init__(
         self,
         pool_id: str,

src/util/constants.py

@@ -2,17 +2,13 @@
 
 from decimal import Decimal
 
+# Precision of Decimal in strings (to be used as x.quantize(DECIMAL_STR_PREC)).
+DECIMAL_STR_PREC = Decimal("1e-10")
 
-class Constants:
-    """Configuration parameters for the solver."""
+# Should an exception be raised when the solution violates the
+# max sell amount constraint.
+RAISE_ON_MAX_SELL_AMOUNT_VIOLATION = False
 
-    # Precision of Decimal in strings (to be used as x.quantize(DECIMAL_STR_PREC)).
-    DECIMAL_STR_PREC = Decimal("1e-10")
-
-    # Should an exception be raised when the solution violates the
-    # max sell amount constraint.
-    RAISE_ON_MAX_SELL_AMOUNT_VIOLATION = False
-
-    # Should an exception be raised when the solution violates the
-    # limit exchange rate constraint.
-    RAISE_ON_LIMIT_XRATE_VIOLATION = False
+# Should an exception be raised when the solution violates the
+# limit exchange rate constraint.
+RAISE_ON_LIMIT_XRATE_VIOLATION = False

src/util/exec_plan_coords.py

@@ -2,13 +2,15 @@
 
 
 class ExecPlanCoords:
-    """The position coordinates of the uniswap in the execution plan.
+    """The position coordinates of the AMM in the execution plan.
 
     The position is defined by a pair of integers:
         * Id of the sequence.
         * Position within that sequence.
     """
 
+    # pylint: disable=too-few-public-methods
+
     def __init__(self, sequence: int, position: int):
         self.sequence = sequence
         self.position = position

src/util/schema.py

@@ -251,6 +251,7 @@ class OrderModel(BaseModel):
     class Config:
         """Includes example in generated openapi file"""
 
+        # pylint: disable=too-few-public-methods
         schema_extra = {
             "example": {
                 "sell_token": "0x6b175474e89094c44da98b954eedeac495271d0f",
@@ -326,6 +327,7 @@ class BatchAuctionModel(BaseModel):
     class Config:
         """Includes example in generated openapi file"""
 
+        # pylint: disable=too-few-public-methods
         schema_extra = {"example": example_instance}