Skip to content

Commit d8926c0

Browse files
martinkersnermartinkersner
authored
fix: wrap implicit-Optional params in Optional[] (#153) (#161)
param: str = None -> param: Optional[str] = None across resources/ + aio/ mirrors. no runtime change, typing only.
1 parent e3b011a commit d8926c0

8 files changed

Lines changed: 56 additions & 56 deletions

File tree

‎datamaxi/aio/cex.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ async def __call__(
3737
symbol: str,
3838
currency: str = USD,
3939
interval: Interval = INTERVAL_1D,
40-
from_unix: str = None,
41-
to_unix: str = None,
40+
from_unix: Optional[str] = None,
41+
to_unix: Optional[str] = None,
4242
pandas: bool = True,
4343
) -> Union[pd.DataFrame, CandleResponse]:
4444
"""Fetch candle data (async). See ``datamaxi.Datamaxi.cex.candle``."""
@@ -79,7 +79,7 @@ async def exchanges(self, market: Market) -> List[str]:
7979
return await self.request_endpoint("cex_candle_exchanges", market=market)
8080

8181
async def symbols(
82-
self, exchange: str = None, market: Optional[Market] = None
82+
self, exchange: Optional[str] = None, market: Optional[Market] = None
8383
) -> List[Dict]:
8484
if market is not None and market not in [SPOT, FUTURES]:
8585
raise ValueError("market must be either spot or futures")
@@ -97,8 +97,8 @@ async def get(
9797
exchange: str,
9898
symbol: str,
9999
market: Market,
100-
currency: str = None,
101-
conversion_base: str = None,
100+
currency: Optional[str] = None,
101+
conversion_base: Optional[str] = None,
102102
include_source: bool = False,
103103
pandas: bool = True,
104104
) -> Union[pd.DataFrame, TickerResponse]:
@@ -154,8 +154,8 @@ async def symbols(self, exchange: str, market: Market) -> List[str]:
154154
class AsyncCexFee(AsyncResource):
155155
async def __call__(
156156
self,
157-
exchange: str = None,
158-
symbol: str = None,
157+
exchange: Optional[str] = None,
158+
symbol: Optional[str] = None,
159159
) -> List[Dict]:
160160
return await self.request_endpoint("cex_fees", exchange=exchange, symbol=symbol)
161161

‎datamaxi/aio/funding_rate.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
from __future__ import annotations
44

5-
from typing import Callable, Tuple, List, Union, TYPE_CHECKING
5+
from typing import Callable, Tuple, List, Union, Optional, TYPE_CHECKING
66

77
from datamaxi.aio._core import AsyncResource
88
from datamaxi.lib.utils import check_required_parameter, check_required_parameters
@@ -20,8 +20,8 @@ async def history(
2020
symbol: str,
2121
page: int = 1,
2222
limit: int = 1000,
23-
fromDateTime: str = None,
24-
toDateTime: str = None,
23+
fromDateTime: Optional[str] = None,
24+
toDateTime: Optional[str] = None,
2525
sort: SortOrder = DESC,
2626
pandas: bool = True,
2727
) -> Union[Tuple[pd.DataFrame, Callable], Tuple[FundingHistoryResponse, Callable]]:
@@ -75,8 +75,8 @@ async def next_request():
7575

7676
async def latest(
7777
self,
78-
exchange: str = None,
79-
symbol: str = None,
78+
exchange: Optional[str] = None,
79+
symbol: Optional[str] = None,
8080
pandas: bool = True,
8181
) -> Union[pd.DataFrame, LatestFundingRate]:
8282
res = await self.request_endpoint(

‎datamaxi/aio/premium.py‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,27 @@
1515
class AsyncPremium(AsyncResource):
1616
async def __call__( # noqa: C901
1717
self,
18-
source_exchange: str = None,
19-
target_exchange: str = None,
20-
asset: str = None,
21-
source_quote: str = None,
22-
target_quote: str = None,
18+
source_exchange: Optional[str] = None,
19+
target_exchange: Optional[str] = None,
20+
asset: Optional[str] = None,
21+
source_quote: Optional[str] = None,
22+
target_quote: Optional[str] = None,
2323
sort: Optional[SortOrder] = None,
24-
key: str = None,
24+
key: Optional[str] = None,
2525
page: int = 1,
2626
limit: int = 100,
27-
currency: str = None,
28-
conversion_base: str = None,
29-
min_sv: str = None,
30-
min_tv: str = None,
27+
currency: Optional[str] = None,
28+
conversion_base: Optional[str] = None,
29+
min_sv: Optional[str] = None,
30+
min_tv: Optional[str] = None,
3131
source_market: Optional[Market] = None,
3232
target_market: Optional[Market] = None,
3333
only_transferable: bool = False,
34-
network: str = None,
35-
premium_type: str = None,
36-
token_include: str = None,
37-
token_exclude: str = None,
38-
query: str = None,
34+
network: Optional[str] = None,
35+
premium_type: Optional[str] = None,
36+
token_include: Optional[str] = None,
37+
token_exclude: Optional[str] = None,
38+
query: Optional[str] = None,
3939
pandas: bool = True,
4040
) -> Union[pd.DataFrame, PremiumResponse]:
4141
params = {}

‎datamaxi/resources/cex_candle.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ def __call__(
3434
symbol: str,
3535
currency: str = USD,
3636
interval: Interval = INTERVAL_1D,
37-
from_unix: str = None,
38-
to_unix: str = None,
37+
from_unix: Optional[str] = None,
38+
to_unix: Optional[str] = None,
3939
pandas: bool = True,
4040
) -> Union[pd.DataFrame, CandleResponse]:
4141
"""Fetch candle data
@@ -108,7 +108,7 @@ def exchanges(self, market: Market) -> List[str]:
108108
return self.request_endpoint("cex_candle_exchanges", market=market)
109109

110110
def symbols(
111-
self, exchange: str = None, market: Optional[Market] = None
111+
self, exchange: Optional[str] = None, market: Optional[Market] = None
112112
) -> List[Dict]:
113113
"""Fetch supported symbols for candle data.
114114

‎datamaxi/resources/cex_fee.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from typing import Any, List, Dict
1+
from typing import Any, List, Dict, Optional
22
from datamaxi.api import Resource
33
from datamaxi.lib.utils import check_required_parameter
44

@@ -17,8 +17,8 @@ def __init__(self, api_key=None, **kwargs: Any):
1717

1818
def __call__(
1919
self,
20-
exchange: str = None,
21-
symbol: str = None,
20+
exchange: Optional[str] = None,
21+
symbol: Optional[str] = None,
2222
) -> List[Dict]:
2323
"""Fetch trading fee data
2424

‎datamaxi/resources/cex_ticker.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from __future__ import annotations
22

3-
from typing import Any, List, Union, TYPE_CHECKING
3+
from typing import Any, List, Union, Optional, TYPE_CHECKING
44
from datamaxi.api import Resource
55
from datamaxi.lib.utils import check_required_parameters
66
from datamaxi.resources.responses import TickerResponse
@@ -27,8 +27,8 @@ def get(
2727
exchange: str,
2828
symbol: str,
2929
market: Market,
30-
currency: str = None,
31-
conversion_base: str = None,
30+
currency: Optional[str] = None,
31+
conversion_base: Optional[str] = None,
3232
include_source: bool = False,
3333
pandas: bool = True,
3434
) -> Union[pd.DataFrame, TickerResponse]:

‎datamaxi/resources/funding_rate.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from __future__ import annotations
22

3-
from typing import Any, Callable, Tuple, List, Union, TYPE_CHECKING
3+
from typing import Any, Callable, Tuple, List, Union, Optional, TYPE_CHECKING
44
from datamaxi.api import Resource
55
from datamaxi.lib.utils import check_required_parameter
66
from datamaxi.lib.utils import check_required_parameters
@@ -30,8 +30,8 @@ def history(
3030
symbol: str,
3131
page: int = 1,
3232
limit: int = 1000,
33-
fromDateTime: str = None,
34-
toDateTime: str = None,
33+
fromDateTime: Optional[str] = None,
34+
toDateTime: Optional[str] = None,
3535
sort: SortOrder = DESC,
3636
pandas: bool = True,
3737
) -> Union[Tuple[pd.DataFrame, Callable], Tuple[FundingHistoryResponse, Callable]]:
@@ -107,8 +107,8 @@ def next_request():
107107

108108
def latest(
109109
self,
110-
exchange: str = None,
111-
symbol: str = None,
110+
exchange: Optional[str] = None,
111+
symbol: Optional[str] = None,
112112
pandas: bool = True,
113113
) -> Union[pd.DataFrame, LatestFundingRate]:
114114
"""Fetch latest funding rate data

‎datamaxi/resources/premium.py‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,27 @@ def __init__(self, api_key=None, **kwargs: Any):
2626

2727
def __call__( # noqa: C901
2828
self,
29-
source_exchange: str = None,
30-
target_exchange: str = None,
31-
asset: str = None,
32-
source_quote: str = None,
33-
target_quote: str = None,
29+
source_exchange: Optional[str] = None,
30+
target_exchange: Optional[str] = None,
31+
asset: Optional[str] = None,
32+
source_quote: Optional[str] = None,
33+
target_quote: Optional[str] = None,
3434
sort: Optional[SortOrder] = None,
35-
key: str = None,
35+
key: Optional[str] = None,
3636
page: int = 1,
3737
limit: int = 100,
38-
currency: str = None,
39-
conversion_base: str = None,
40-
min_sv: str = None,
41-
min_tv: str = None,
38+
currency: Optional[str] = None,
39+
conversion_base: Optional[str] = None,
40+
min_sv: Optional[str] = None,
41+
min_tv: Optional[str] = None,
4242
source_market: Optional[Market] = None,
4343
target_market: Optional[Market] = None,
4444
only_transferable: bool = False,
45-
network: str = None,
46-
premium_type: str = None,
47-
token_include: str = None,
48-
token_exclude: str = None,
49-
query: str = None,
45+
network: Optional[str] = None,
46+
premium_type: Optional[str] = None,
47+
token_include: Optional[str] = None,
48+
token_exclude: Optional[str] = None,
49+
query: Optional[str] = None,
5050
pandas: bool = True,
5151
) -> Union[pd.DataFrame, PremiumResponse]:
5252
"""Fetch premium data

0 commit comments

Comments
 (0)