yfrake.cache.utils   A
last analyzed

Complexity

Total Complexity 7

Size/Duplication

Total Lines 71
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 23
dl 0
loc 71
rs 10
c 0
b 0
f 0
wmc 7

7 Functions

Rating   Name   Duplication   Size   Complexity  
A str_to_date() 0 2 1
A is_expired() 0 3 1
A get_expiration_date() 0 3 1
A megs_to_bytes() 0 2 1
A get_request_key() 0 4 1
A date_to_str() 0 2 1
A get_entry_size() 0 2 1
1
# ==================================================================================== #
2
#    utils.py - This file is part of the YFrake package.                               #
3
# ------------------------------------------------------------------------------------ #
4
#                                                                                      #
5
#    MIT License                                                                       #
6
#                                                                                      #
7
#    Copyright (c) 2022 Mattias Aabmets                                                #
8
#                                                                                      #
9
#    Permission is hereby granted, free of charge, to any person obtaining a copy      #
10
#    of this software and associated documentation files (the "Software"), to deal     #
11
#    in the Software without restriction, including without limitation the rights      #
12
#    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell         #
13
#    copies of the Software, and to permit persons to whom the Software is             #
14
#    furnished to do so, subject to the following conditions:                          #
15
#                                                                                      #
16
#    The above copyright notice and this permission notice shall be included in all    #
17
#    copies or substantial portions of the Software.                                   #
18
#                                                                                      #
19
#    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR        #
20
#    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,          #
21
#    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE       #
22
#    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER            #
23
#    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,     #
24
#    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE     #
25
#    SOFTWARE.                                                                         #
26
#                                                                                      #
27
# ==================================================================================== #
28
from .const import DATE_FORMAT, BYTES_OVERHEAD
29
from datetime import datetime, timedelta
30
import hashlib
31
import json
32
33
34
# ==================================================================================== #
35
def get_request_key(endpoint, params) -> str:
36
    data_string = ''.join([endpoint, json.dumps(params)])
37
    _hash = hashlib.sha3_256(data_string.encode())
38
    return _hash.hexdigest()
39
40
41
# ------------------------------------------------------------------------------------ #
42
def get_entry_size(response: str) -> int:
43
    return response.__sizeof__() + BYTES_OVERHEAD
44
45
46
# ------------------------------------------------------------------------------------ #
47
def get_expiration_date(ttl: float) -> str:
48
    exp_date = datetime.utcnow() + timedelta(seconds=ttl)
49
    return date_to_str(exp_date)
50
51
52
# ------------------------------------------------------------------------------------ #
53
def is_expired(exp_date: str) -> bool:
54
    exp_date = str_to_date(exp_date)
55
    return datetime.utcnow() >= exp_date
56
57
58
# ------------------------------------------------------------------------------------ #
59
def date_to_str(_dt: datetime) -> str:
60
    return _dt.strftime(DATE_FORMAT)
61
62
63
# ------------------------------------------------------------------------------------ #
64
def str_to_date(_str: str) -> datetime:
65
    return datetime.strptime(_str, DATE_FORMAT)
66
67
68
# ------------------------------------------------------------------------------------ #
69
def megs_to_bytes(megs: int) -> int:
70
    return megs * 1000000
71