Skip to content

utils.py

utils

VinterError 

VinterError()
Source code in vintersdk/utils.py 
253
254
def __init__(self):
    pass

get_error_message staticmethod 

get_error_message(response: dict, status_code: int) -> str

It takes in a response and returns an error message

Parameters:

  • response (dict) –

    The response from the api.

Returns:

  • The error message is being returned. –
Source code in vintersdk/utils.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
@staticmethod
def get_error_message(response: dict, status_code: int) -> str:
    """It takes in a response and returns an error message

    Parameters
    ----------
    response : dict
        The response from the api.

    Returns
    -------
        The error message is being returned.

    """

    return {
        "result": response.get("result"),
        "message": response.get("message"),
        "status_code": status_code,
    }

VinterUrl 

VinterUrl()
Source code in vintersdk/utils.py 
123
124
def __init__(self):
    pass

get_active_url staticmethod 

get_active_url(asset_type: str) -> str

It takes in an asset type and returns a url

Parameters:

  • asset_type (str) –

    str

Returns:

  • url ( str ) –

    The url is being returned.

Raises:

  • ValueError –

    If the asset type is not in the list of valid asset types.

Source code in vintersdk/utils.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
@staticmethod
def get_active_url(asset_type: str) -> str:
    """It takes in an asset type and returns a url

    Parameters
    ----------
    asset_type : str
        str

    Returns
    -------
    url : str
        The url is being returned.

    Raises
    ------
    ValueError
        If the asset type is not in the list of valid asset types.
    """
    url = None
    for asset_url in AssetUrl:
        if (
            asset_url.value["asset_type"].value == asset_type
            and asset_url.value["frequency"] is None
        ):
            url = asset_url.value["url"]
            break

    if url is None:
        raise ValueError(f"The asset type must be in {asset_type}")

    return url

get_url staticmethod 

get_url(asset_type: str, frequency: str = None) -> str

It takes in an asset type and a frequency and returns a url

Parameters:

  • asset_type (str) –

    The type of asset you want to get data for.

  • frequency (str, default: None ) –

    The frequency of the asset you want to get data for., optional

Returns:

  • The url is being returned. –
Source code in vintersdk/utils.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
@staticmethod
def get_url(asset_type: str, frequency: str = None) -> str:
    """It takes in an asset type and a frequency and returns a url

    Parameters
    ----------
    asset_type : str
        The type of asset you want to get data for.
    frequency : str
        The frequency of the asset you want to get data for., optional

    Returns
    -------
        The url is being returned.

    """

    asset_types = [asset_type.value for asset_type in AssetType]

    url = None
    for asset_url in AssetUrl:
        if (
            asset_url.value["asset_type"].value == asset_type
            and asset_url.value["frequency"] is not None
            and asset_url.value["frequency"].value == frequency
        ):
            url = asset_url.value["url"]
            break

    if url is None:
        raise ValueError(f"The asset type must be in {asset_types}")

    return url

get_url_by_symbol staticmethod 

get_url_by_symbol(asset_type: str, symbol: str) -> str

It takes in an asset type and a symbol and returns a url

Parameters:

  • asset_type (str) –

    The type of asset you want to get data for.

  • symbol (str) –

    The symbol of the asset you want to get data for.

Returns:

  • The url is being returned. –
Source code in vintersdk/utils.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
@staticmethod
def get_url_by_symbol(asset_type: str, symbol: str) -> str:
    """It takes in an asset type and a symbol and returns a url

    Parameters
    ----------
    asset_type : str
        The type of asset you want to get data for.
    symbol : str
        The symbol of the asset you want to get data for.

    Returns
    -------
        The url is being returned.

    """

    symbol, frequency = VinterValidation.validate_symbol_frequency(symbol)
    url = VinterUrl.get_url(asset_type=asset_type, frequency=frequency)

    return url

websocket_url staticmethod 

websocket_url(asset_type: str, symbol: str = None) -> str

It takes in an asset type and a frequency and returns a websocket url

Parameters:

  • asset_type (str) –

    The type of asset you want to get data for.

  • symbol (str, default: None ) –

    The symbol of the asset you want to get data for., optional

Returns:

  • The websocket url is being returned. –
Source code in vintersdk/utils.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
@staticmethod
def websocket_url(asset_type: str, symbol: str = None) -> str:
    """It takes in an asset type and a frequency and returns a websocket url

    Parameters
    ----------
    asset_type : str
        The type of asset you want to get data for.
    symbol : str
        The symbol of the asset you want to get data for., optional

    Returns
    -------
        The websocket url is being returned.

    """

    ws_asset_types = [asset_type.value for asset_type in WsAssetType]

    if symbol is None:
        raise ValueError("The symbol must be provided.")

    symbol, frequency = VinterValidation.validate_symbol_frequency(symbol)

    url = None
    for asset_url in WsAssetUrl:
        if asset_url.value["asset_type"].value == asset_type:
            url = asset_url.value["url"]
            url = url + "/" + symbol
            break

    if url is None:
        raise ValueError(f"The asset type must be in {ws_asset_types}")

    return url

VinterValidation 

VinterValidation()
Source code in vintersdk/utils.py 
7
8
def __init__(self) -> None:
    pass

validate_api_key staticmethod 

validate_api_key(api_key: str) -> None

If the api key is not a string, then raise a TypeError

Parameters:

  • api_key (str) –

    The api key to use to get data.

Raises:

  • TypeError –

    If the api key is not a string.

Source code in vintersdk/utils.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@staticmethod
def validate_api_key(api_key: str) -> None:
    """If the api key is not a string, then raise a TypeError

    Parameters
    ----------
    api_key : str
        The api key to use to get data.

    Raises
    ------
    TypeError
        If the api key is not a string.

    """
    if not isinstance(api_key, str):
        raise TypeError("The api key must be a string.")

validate_asset_type staticmethod 

validate_asset_type(asset_type: str) -> None

If the asset type is not a valid asset_type , then raise a ValueError

Parameters:

  • asset_type (str) –

    The type of asset you want to get data for.

Raises:

  • ValueError –

    If the asset type is not a valid asset type.

Source code in vintersdk/utils.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@staticmethod
def validate_asset_type(asset_type: str) -> None:
    """If the asset type is not a valid asset_type , then raise a
    ValueError

    Parameters
    ----------
    asset_type : str
        The type of asset you want to get data for.

    Raises
    ------
    ValueError
        If the asset type is not a valid asset type.

    """
    valid_asset_types = [asset_type.value for asset_type in AssetType]
    if asset_type not in valid_asset_types:
        raise ValueError(
            f"The asset type must be one of the following : {valid_asset_types}"
        )

validate_dates staticmethod 

validate_dates(dates: list) -> None

It raises a ValueError if any of the dates in the dates list are not in the format YYYY-MM-DD

Parameters:

  • dates (list) –

    A list of dates in the format YYYY-MM-DD

Raises:

  • ValueError –

    If any of the dates in the dates list are not in the format YYYY-MM-DD

Source code in vintersdk/utils.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
@staticmethod
def validate_dates(dates: list) -> None:
    """It raises a ValueError if any of the dates in the dates list are not in the format YYYY-MM-DD

    Parameters
    ----------
    dates
        A list of dates in the format YYYY-MM-DD

    Raises
    ------
    ValueError
        If any of the dates in the dates list are not in the format YYYY-MM-DD

    """
    for date in dates:
        # Validate that the date is a valid date
        try:
            datetime.strptime(date, "%Y-%m-%d")
        except ValueError as e:
            e.args = (
                f"The date must be in the format YYYY-MM-DD : date {date}"
            )
            raise

validate_frequency staticmethod 

validate_frequency(frequency: str) -> None

If the frequency is not a valid frequency, then raise a ValueError

Parameters:

  • frequency (str) –

    The frequency of the asset you want to get data for.

Raises:

  • ValueError –

    If the frequency is not a valid frequency.

Source code in vintersdk/utils.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
@staticmethod
def validate_frequency(frequency: str) -> None:
    """If the frequency is not a valid frequency, then raise a
    ValueError

    Parameters
    ----------
    frequency : str
        The frequency of the asset you want to get data for.

    Raises
    ------
    ValueError
        If the frequency is not a valid frequency.

    """
    frequencies = [frequency.value for frequency in Frequency]
    if frequency not in frequencies:
        raise ValueError(
            "The frequency must be one of the following valid frequencies: {}".format(
                frequencies
            )
        )

validate_symbol_frequency staticmethod 

validate_symbol_frequency(symbol: str) -> tuple

It takes a string, splits it on the hyphen, and validates the last part of the string

Parameters:

  • symbol (str) –

    The symbol of the asset you want to get data for.

Returns:

  • A tuple of the symbol and the frequency. –
Source code in vintersdk/utils.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@staticmethod
def validate_symbol_frequency(symbol: str) -> tuple:
    """It takes a string, splits it on the hyphen, and validates the last part of the string

    Parameters
    ----------
    symbol : str
        The symbol of the asset you want to get data for.

    Returns
    -------
        A tuple of the symbol and the frequency.

    """

    if not symbol:
        raise ValueError("The symbol must be provided.")

    sym_frequency = symbol.split("-")[-1]
    VinterValidation.validate_frequency(sym_frequency)
    return symbol, sym_frequency

handle_response 

handle_response(response)

Raises an exception if the request fails

Parameters:

  • response (Response) –

    The response from the api.

Raises:

  • ValueError –

    If the request fails.

Source code in vintersdk/utils.py 
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
def handle_response(response):
    """
    Raises an exception if the request fails

    Parameters
    ----------
    response : httpx.Response
        The response from the api.

    Raises
    ------
    ValueError
        If the request fails.
    """
    try:
        response.raise_for_status()  # Raise an exception if the request fails
    except httpx.HTTPStatusError:
        resp_json = response.json()
        raise ValueError(
            VinterError.get_error_message(
                response=resp_json, status_code=response.status_code
            )
        )