Remove non-primitive functions default args (#37)

Author: alexex10

examples/placed_order_example_advanced.py

@@ -83,7 +83,7 @@ async def order_loop(
         async with socket_connect_condition:
             await socket_connect_condition.wait()
 
-    for j in range(NUM_ORDERS_PER_PRICE_LEVEL):
+    for _ in range(NUM_ORDERS_PER_PRICE_LEVEL):
         (external_id, order_response) = await place_order(i, trading_client, markets_cache)
         print(f"placed order {external_id}")
         condition = order_condtions.get(external_id)

poetry.lock

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "x10-python-trading"
-version = "0.4.3"
+version = "0.4.4"
 description = "Python client for X10 API"
 authors = ["X10 <tech@ex10.org>"]
 repository = "https://github.com/x10xchange/python_sdk"
@@ -44,6 +44,7 @@ websockets = "==12.0"
 [tool.poetry.group.dev.dependencies]
 black = "==23.12.0"
 flake8 = "==6.1.0"
+flake8-bugbear = "==24.12.12"
 freezegun = "==1.4.0"
 isort = "==5.13.2"
 mypy = "==1.8.0"

pyproject.toml

@@ -12,6 +12,67 @@
 FROZEN_NONCE = 1473459052
 
 
+@pytest.mark.asyncio
+async def test_create_sell_order_with_default_expiration(
+    mocker: MockerFixture, create_trading_account, create_btc_usd_market
+):
+    mocker.patch("x10.utils.starkex.generate_nonce", return_value=FROZEN_NONCE)
+
+    freezer = freeze_time("2024-01-05 01:08:56.860694")
+    frozen_time = freezer.start()
+
+    from x10.perpetual.order_object import create_order_object
+
+    frozen_time.move_to("2024-01-05 01:08:57")
+
+    trading_account = create_trading_account()
+    btc_usd_market = create_btc_usd_market()
+    order_obj = create_order_object(
+        account=trading_account,
+        market=btc_usd_market,
+        amount_of_synthetic=Decimal("0.00100000"),
+        price=Decimal("43445.11680000"),
+        side=OrderSide.SELL,
+    )
+
+    freezer.stop()
+
+    assert_that(
+        order_obj.to_api_request_json(),
+        equal_to(
+            {
+                "id": "2096045681239655445582070517240411138302380632690430411530650608228763263945",
+                "market": "BTC-USD",
+                "type": "LIMIT",
+                "side": "SELL",
+                "qty": "0.00100000",
+                "price": "43445.11680000",
+                "reduceOnly": False,
+                "postOnly": False,
+                "timeInForce": "GTT",
+                "expiryEpochMillis": 1704445737000,
+                "fee": "0.0005",
+                "nonce": "1473459052",
+                "selfTradeProtectionLevel": "ACCOUNT",
+                "cancelId": None,
+                "settlement": {
+                    "signature": {
+                        "r": "0x39ff8493e8e26c9a588a7046e1380b6e1201287a179e10831b7040d3efc26d",
+                        "s": "0x5c9acd1879bf8d43e4ccd14648186d2a9edf387fe1b61e491fe0a539de3272b",
+                    },
+                    "starkKey": "0x61c5e7e8339b7d56f197f54ea91b776776690e3232313de0f2ecbd0ef76f466",
+                    "collateralPosition": "10002",
+                },
+                "trigger": None,
+                "tpSlType": None,
+                "takeProfit": None,
+                "stopLoss": None,
+                "debuggingAmounts": {"collateralAmount": "43445116", "feeAmount": "21723", "syntheticAmount": "1000"},
+            }
+        ),
+    )
+
+
 @freeze_time("2024-01-05 01:08:56.860694")
 @pytest.mark.asyncio
 async def test_create_sell_order(mocker: MockerFixture, create_trading_account, create_btc_usd_market):

tests/perpetual/test_order_object.py

@@ -34,7 +34,7 @@ def create_order_object(
     side: OrderSide,
     post_only: bool = False,
     previous_order_id: Optional[str] = None,
-    expire_time=utc_now() + timedelta(hours=8),
+    expire_time: Optional[datetime] = None,
     order_external_id: Optional[str] = None,
     time_in_force: TimeInForce = TimeInForce.GTT,
     self_trade_protection_level: SelfTradeProtectionLevel = SelfTradeProtectionLevel.ACCOUNT,
@@ -43,6 +43,7 @@ def create_order_object(
     Creates an order object to be placed on the exchange using the `place_order` method.
     """
     fees = account.trading_fee.get(market.name, DEFAULT_FEES)
+
     return __create_order_object(
         market,
         amount_of_synthetic,
@@ -72,7 +73,7 @@ def __create_order_object(
     signer: Callable[[int], Tuple[int, int]],
     public_key: int,
     exact_only: bool = False,
-    expire_time: datetime = utc_now() + timedelta(hours=1),
+    expire_time: Optional[datetime] = None,
     post_only: bool = False,
     previous_order_external_id: Optional[str] = None,
     order_external_id: Optional[str] = None,
@@ -82,6 +83,9 @@ def __create_order_object(
     if exact_only:
         raise NotImplementedError("`exact_only` option is not supported yet")
 
+    if expire_time is None:
+        expire_time = utc_now() + timedelta(hours=8)
+
     nonce = generate_nonce()
     is_buying_synthetic = side == OrderSide.BUY
     rounding_context = ROUNDING_BUY_CONTEXT if is_buying_synthetic else ROUNDING_SELL_CONTEXT

x10/perpetual/order_object.py

@@ -1,6 +1,6 @@
-from datetime import timedelta
+from datetime import datetime
 from decimal import Decimal
-from typing import Dict
+from typing import Dict, Optional
 
 from x10.perpetual.accounts import StarkPerpetualAccount
 from x10.perpetual.configuration import EndpointConfig
@@ -18,7 +18,6 @@
     MarketsInformationModule,
 )
 from x10.perpetual.trading_client.order_management_module import OrderManagementModule
-from x10.utils.date import utc_now
 from x10.utils.http import WrappedApiResponse
 from x10.utils.log import get_logger
 
@@ -46,7 +45,7 @@ async def place_order(
         side: OrderSide,
         post_only: bool = False,
         previous_order_id=None,
-        expire_time=utc_now() + timedelta(hours=8),
+        expire_time: Optional[datetime] = None,
         time_in_force: TimeInForce = TimeInForce.GTT,
         self_trade_protection_level: SelfTradeProtectionLevel = SelfTradeProtectionLevel.ACCOUNT,
     ) -> WrappedApiResponse[PlacedOrderModel]:

x10/perpetual/trading_client/trading_client.py

@@ -187,9 +187,12 @@ def get_onboarding_payload(
     account: LocalAccount,
     signing_domain: str,
     key_pair: StarkKeyPair,
-    time: datetime = datetime.now(timezone.utc),
+    time: datetime | None = None,
     referral_code: str | None = None,
 ) -> OnboardingPayLoad:
+    if time is None:
+        time = datetime.now(timezone.utc)
+
     registration_payload = get_registration_struct_to_sign(
         account_index=0, address=account.address, timestamp=time, action=register_action
     )
@@ -210,12 +213,11 @@ def get_onboarding_payload(
 
 
 def get_sub_account_creation_payload(
-    account_index: int,
-    l1_address: str,
-    key_pair: StarkKeyPair,
-    description: str,
-    time: datetime = datetime.now(timezone.utc),
+    account_index: int, l1_address: str, key_pair: StarkKeyPair, description: str, time: datetime | None = None
 ):
+    if time is None:
+        time = datetime.now(timezone.utc)
+
     registration_payload = get_registration_struct_to_sign(
         account_index=account_index,
         address=l1_address,