Skip to content

Environment

Environment

Класс для работы с окружением и URL-адресами.

Содержит настройки для различных окружений (test, develop) и методы для работы с ними. Получает текущее окружение из переменных окружения системы.

Атрибуты

TEST (str): Константа для тестового окружения DEVELOP (str): Константа для окружения разработки URLS (dict): Словарь с базовыми URL для каждого окружения env (str): Текущее окружение access_token (str): Токен доступа

Source code in data\environment.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class Environment:
    """Класс для работы с окружением и URL-адресами.

    Содержит настройки для различных окружений (test, develop) и методы для работы с ними.
    Получает текущее окружение из переменных окружения системы.

    Атрибуты:
        TEST (str): Константа для тестового окружения
        DEVELOP (str): Константа для окружения разработки
        URLS (dict): Словарь с базовыми URL для каждого окружения
        env (str): Текущее окружение
        access_token (str): Токен доступа
    """

    TEST = 'test'
    DEVELOP = 'develop'

    URLS = {
        TEST: 'http://192.168.2.76/',
        DEVELOP: 'http://192.168.2.69/'
    }

    def __init__(self):
        """Инициализация объекта окружения.

        Устанавливает окружение из переменной окружения ENV или по умолчанию TEST.
        Инициализирует пустой access_token.
        """
        try:
            self.env = os.getenv('ENV')
            self.access_token = ""
        except KeyError:
            self.env = self.TEST

    def get_base_url(self):
        """Возвращает базовый URL для текущего окружения.

        Returns:
            str: Базовый URL с учётом особенностей окружения

        Raises:
            Exception: Если значение переменной ENV неизвестно
        """
        if self.env in self.URLS:
            if self.env == self.TEST:
                return self.URLS[self.env] + "e-nms-ui/"
            return self.URLS[self.env]
        raise Exception(f"Unknown value of ENV variable {self.env}")

    def get_request_url(self):
        """Возвращает URL для API-запросов.

        Returns:
            str: URL для запросов

        Raises:
            Exception: Если значение переменной ENV неизвестно
        """
        if self.env in self.URLS:
            return self.URLS[self.env]
        raise Exception(f"Unknown value of ENV variable {self.env}")

    def set_access_token(self, token):
        """Устанавливает токен доступа.

        Args:
            token (str): Новый токен доступа
        """
        self.token = token

    def get_access_token(self):
        """Возвращает текущий токен доступа.

        Returns:
            str: Текущий токен доступа
        """
        return self.token

__init__()

Инициализация объекта окружения.

Устанавливает окружение из переменной окружения ENV или по умолчанию TEST. Инициализирует пустой access_token.

Source code in data\environment.py 
26
27
28
29
30
31
32
33
34
35
36
def __init__(self):
    """Инициализация объекта окружения.

    Устанавливает окружение из переменной окружения ENV или по умолчанию TEST.
    Инициализирует пустой access_token.
    """
    try:
        self.env = os.getenv('ENV')
        self.access_token = ""
    except KeyError:
        self.env = self.TEST

get_access_token()

Возвращает текущий токен доступа.

Returns:

Name Type Description
str

Текущий токен доступа
Source code in data\environment.py 
74
75
76
77
78
79
80
def get_access_token(self):
    """Возвращает текущий токен доступа.

    Returns:
        str: Текущий токен доступа
    """
    return self.token

get_base_url()

Возвращает базовый URL для текущего окружения.

Returns:

Name Type Description
str

Базовый URL с учётом особенностей окружения

Raises:

Type Description
Exception

Если значение переменной ENV неизвестно
Source code in data\environment.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def get_base_url(self):
    """Возвращает базовый URL для текущего окружения.

    Returns:
        str: Базовый URL с учётом особенностей окружения

    Raises:
        Exception: Если значение переменной ENV неизвестно
    """
    if self.env in self.URLS:
        if self.env == self.TEST:
            return self.URLS[self.env] + "e-nms-ui/"
        return self.URLS[self.env]
    raise Exception(f"Unknown value of ENV variable {self.env}")

get_request_url()

Возвращает URL для API-запросов.

Returns:

Name Type Description
str

URL для запросов

Raises:

Type Description
Exception

Если значение переменной ENV неизвестно
Source code in data\environment.py 
53
54
55
56
57
58
59
60
61
62
63
64
def get_request_url(self):
    """Возвращает URL для API-запросов.

    Returns:
        str: URL для запросов

    Raises:
        Exception: Если значение переменной ENV неизвестно
    """
    if self.env in self.URLS:
        return self.URLS[self.env]
    raise Exception(f"Unknown value of ENV variable {self.env}")

set_access_token(token)

Устанавливает токен доступа.

Parameters:

Name Type Description Default
token str

Новый токен доступа

 required
Source code in data\environment.py 
66
67
68
69
70
71
72
def set_access_token(self, token):
    """Устанавливает токен доступа.

    Args:
        token (str): Новый токен доступа
    """
    self.token = token