support securities filters (#34)

* actualize annotations

* support securities filters

* actualize pydantic version

* add ruff & fix annotation

Author: DBoyara

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         python-version: ['3.8']
-        poetry-version: ['1.4.2']
+        poetry-version: ['1.8.1']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
@@ -29,7 +29,7 @@ jobs:
         poetry-version: ${{ matrix.poetry-version }}
     - name: Install dependencies
       run: poetry install
-    - name: Run flake8
-      run: poetry run flake8 .
+    - name: Run ruff
+      run: poetry run ruff check finam_trade_api
     - name: Run mypy
       run: poetry run mypy .

.gitignore

@@ -129,3 +129,4 @@ dmypy.json
 .pyre/
 
 .idea/
+.ruff_cache/

.isort.cfg

@@ -9,7 +9,7 @@ def __init__(self, token: str):
         super().__init__(token)
         self._url = "/api/v1/access-tokens"
 
-    async def check_token(self):
+    async def check_token(self) -> TokenResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.GET,
             f"{self._url}/check",

finam_trade_api/access/access_token.py

@@ -6,5 +6,5 @@
     Decimal,
     IntraDayCandle,
     IntraDayCandlesRequestModel,
-    IntraDayInterval
+    IntraDayInterval,
 )

finam_trade_api/candles/__init__.py

@@ -7,7 +7,7 @@
     DayCandlesResponse,
     IntraDayCandle,
     IntraDayCandlesRequestModel,
-    IntraDayCandlesResponse
+    IntraDayCandlesResponse,
 )
 from finam_trade_api.exceptions import FinamTradeApiError
 from finam_trade_api.models import ErrorBodyModel

finam_trade_api/candles/candles.py

@@ -30,6 +30,6 @@
     StopQuantityUnits,
     TakeProfitModel,
     ValidBefore,
-    ValidBeforeType
+    ValidBeforeType,
 )
 from finam_trade_api.order.order import OrderClient

finam_trade_api/order/__init__.py

@@ -1,5 +1,3 @@
-from typing import Union
-
 from finam_trade_api.base_client import BaseClient
 from finam_trade_api.exceptions import FinamTradeApiError
 from finam_trade_api.models import ErrorBodyModel
@@ -10,15 +8,12 @@
     CreateStopOrderResponseModel,
     DelOrderModel,
     DelOrderResponseModel,
-    DelStopOrderRequestModel
-)
-from finam_trade_api.order.model import \
-    DelStopOrderResponseModel as DelStopOrderResponse
-from finam_trade_api.order.model import (
+    DelStopOrderRequestModel,
     OrdersRequestModel,
     OrdersResponseModel,
-    StopOrdersResponseModel
+    StopOrdersResponseModel,
 )
+from finam_trade_api.order.model import DelStopOrderResponseModel as DelStopOrderResponse
 
 
 class OrderClient(BaseClient):
@@ -27,7 +22,7 @@ def __init__(self, token: str):
         self._order_url = "/api/v1/orders"
         self._stop_order_url = "/api/v1/stops"
 
-    async def get_orders(self, params: OrdersRequestModel) -> Union[OrdersResponseModel, ErrorBodyModel]:
+    async def get_orders(self, params: OrdersRequestModel) -> OrdersResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.GET,
             self._order_url,
@@ -38,7 +33,7 @@ async def get_orders(self, params: OrdersRequestModel) -> Union[OrdersResponseMo
             raise FinamTradeApiError(f"{err.error.code} | {err.error.data} | {err.error.message}")
         return OrdersResponseModel(**response)
 
-    async def create_order(self, payload: CreateOrderRequestModel) -> Union[CreateOrderResponseModel, ErrorBodyModel]:
+    async def create_order(self, payload: CreateOrderRequestModel) -> CreateOrderResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.POST,
             self._order_url,
@@ -49,7 +44,7 @@ async def create_order(self, payload: CreateOrderRequestModel) -> Union[CreateOr
             raise FinamTradeApiError(f"{err.error.code} | {err.error.data} | {err.error.message}")
         return CreateOrderResponseModel(**response)
 
-    async def del_order(self, params: DelOrderModel) -> Union[DelOrderResponseModel, ErrorBodyModel]:
+    async def del_order(self, params: DelOrderModel) -> DelOrderResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.DELETE,
             self._order_url,
@@ -60,7 +55,7 @@ async def del_order(self, params: DelOrderModel) -> Union[DelOrderResponseModel,
             raise FinamTradeApiError(f"{err.error.code} | {err.error.data} | {err.error.message}")
         return DelOrderResponseModel(**response)
 
-    async def get_stop_orders(self, params: OrdersRequestModel) -> Union[StopOrdersResponseModel, ErrorBodyModel]:
+    async def get_stop_orders(self, params: OrdersRequestModel) -> StopOrdersResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.GET,
             self._stop_order_url,
@@ -71,10 +66,7 @@ async def get_stop_orders(self, params: OrdersRequestModel) -> Union[StopOrdersR
             raise FinamTradeApiError(f"{err.error.code} | {err.error.data} | {err.error.message}")
         return StopOrdersResponseModel(**response)
 
-    async def create_stop_order(
-            self,
-            payload: CreateStopOrderRequestModel
-    ) -> Union[CreateStopOrderResponseModel, ErrorBodyModel]:
+    async def create_stop_order(self, payload: CreateStopOrderRequestModel) -> CreateStopOrderResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.POST,
             self._stop_order_url,
@@ -85,7 +77,7 @@ async def create_stop_order(
             raise FinamTradeApiError(f"{err.error.code} | {err.error.data} | {err.error.message}")
         return CreateStopOrderResponseModel(**response)
 
-    async def del_stop_order(self, params: DelStopOrderRequestModel) -> Union[DelStopOrderResponse, ErrorBodyModel]:
+    async def del_stop_order(self, params: DelStopOrderRequestModel) -> DelStopOrderResponse:
         response, ok = await self._exec_request(
             self.RequestMethod.DELETE,
             self._stop_order_url,

finam_trade_api/order/order.py

@@ -6,6 +6,6 @@
     PortfolioRequestOptionalModel,
     PortfolioResponseData,
     PortfolioResponseModel,
-    Position
+    Position,
 )
 from finam_trade_api.portfolio.portfolio import PortfolioClient

finam_trade_api/portfolio/__init__.py

@@ -1,20 +1,15 @@
-from typing import Union
-
 from finam_trade_api.base_client import BaseClient
 from finam_trade_api.exceptions import FinamTradeApiError
 from finam_trade_api.models import ErrorBodyModel
-from finam_trade_api.portfolio.model import (
-    PortfolioRequestModel,
-    PortfolioResponseModel
-)
+from finam_trade_api.portfolio.model import PortfolioRequestModel, PortfolioResponseModel
 
 
 class PortfolioClient(BaseClient):
     def __init__(self, token: str):
         super().__init__(token)
         self._url = "/api/v1/portfolio"
 
-    async def get_portfolio(self, params: PortfolioRequestModel) -> Union[PortfolioResponseModel, ErrorBodyModel]:
+    async def get_portfolio(self, params: PortfolioRequestModel) -> PortfolioResponseModel:
         response, ok = await self._exec_request(
             self.RequestMethod.GET,
             self._url,