amochka 0.1.2.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

amochka/client.py

@@ -19,15 +19,7 @@ RATE_LIMIT = 7  # Максимум 7 запросов в секунду
 class Deal(dict):
     """
     Объект сделки расширяет стандартный словарь данными из custom_fields_values.
-
-    Обеспечивает два способа доступа к кастомным полям:
-      1. get(key): при обращении по названию (строкой) или по ID поля (integer)
-         возвращает текстовое значение поля (например, «Гурина Юлия»).
-      2. get_id(key): возвращает идентификатор выбранного варианта (enum_id) для полей типа select.
-         Если в данных enum_id отсутствует, производится поиск в переданной конфигурации полей,
-         сравнение выполняется без учёта регистра и лишних пробелов.
-
-    Параметр custom_fields_config – словарь, где ключи – ID полей, а значения – модели полей.
+    (Описание класса без изменений)
     """
     def __init__(self, data, custom_fields_config=None):
         super().__init__(data)
@@ -80,12 +72,7 @@ class Deal(dict):
     def get_id(self, key, default=None):
         """
         Возвращает идентификатор выбранного варианта (enum_id) для кастомного поля.
-        Если значение enum_id отсутствует в данных, производится поиск в конфигурации полей,
-        сравнение значения выполняется без учёта регистра и пробелов.
-
-        :param key: Название поля (строка) или ID поля (integer).
-        :param default: Значение по умолчанию, если enum_id не найден.
-        :return: Идентификатор выбранного варианта (целое число) или default.
+        (Описание метода без изменений)
         """
         stored = None
         if isinstance(key, str):
@@ -99,7 +86,6 @@ class Deal(dict):
             enum_id = stored.get("enum_id")
             if enum_id is not None:
                 return enum_id
-            # Если enum_id отсутствует, пробуем найти его в конфигурации кастомных полей
             if self._custom_config:
                 field_def = None
                 if isinstance(key, int):
@@ -112,7 +98,6 @@ class Deal(dict):
                 if field_def:
                     enums = field_def.get("enums") or []
                     for enum in enums:
-                        # Сравниваем текстовое значение без учёта регистра и лишних пробелов
                         if enum.get("value", "").lower().strip() == stored.get("value", "").lower().strip():
                             return enum.get("id", default)
         return default
@@ -120,27 +105,13 @@ class Deal(dict):
 class AmoCRMClient:
     """
     Клиент для работы с API amoCRM.
-
-    Основные функции:
-      - load_token: Загружает и проверяет токен авторизации.
-      - _make_request: Выполняет HTTP-запрос с учетом ограничения по скорости.
-      - get_deal_by_id: Получает данные сделки по ID и возвращает объект Deal.
-      - get_custom_fields_mapping: Загружает и кэширует список кастомных полей.
-      - find_custom_field_id: Ищет кастомное поле по его названию.
-      - update_lead: Обновляет сделку, включая стандартные и кастомные поля.
-
-    Дополнительно можно задать уровень логирования через параметр log_level,
-    либо полностью отключить логирование, установив disable_logging=True.
+    (Описание класса без изменений, за исключением добавления параметра use_file_cache)
     """
-    def __init__(self, base_url, token_file=None, cache_file=None, log_level=logging.INFO, disable_logging=False):
+    def __init__(self, base_url, token_file=None, cache_file=None, log_level=logging.INFO, disable_logging=False, use_file_cache=True):
         """
         Инициализирует клиента, задавая базовый URL, токен авторизации и файл кэша для кастомных полей.
-
-        :param base_url: Базовый URL API amoCRM.
-        :param token_file: Файл, содержащий токен авторизации.
-        :param cache_file: Файл для кэширования данных кастомных полей.
-        :param log_level: Уровень логирования (например, logging.DEBUG, logging.INFO).
-        :param disable_logging: Если True, логирование будет отключено.
+        
+        :param use_file_cache: Если True, кэш будет сохраняться в файл; иначе — только в оперативной памяти.
         """
         self.base_url = base_url.rstrip('/')
         domain = self.base_url.split("//")[-1].split(".")[0]
@@ -149,6 +120,7 @@ class AmoCRMClient:
         if not cache_file:
             cache_file = f"custom_fields_cache_{self.domain}.json"
         self.cache_file = cache_file
+        self.use_file_cache = use_file_cache
         self.token = self.load_token()
         self._custom_fields_mapping = None
 
@@ -160,12 +132,7 @@ class AmoCRMClient:
         logger.debug(f"AmoCRMClient initialized for domain {self.domain}")
 
     def load_token(self):
-        """
-        Загружает токен авторизации из файла или строки, проверяет его срок действия.
-
-        :return: Действительный access_token.
-        :raises Exception: Если токен не найден или истёк.
-        """
+        # Метод без изменений
         data = None
         if os.path.exists(self.token_file):
             with open(self.token_file, 'r') as f:
@@ -193,16 +160,7 @@ class AmoCRMClient:
     @sleep_and_retry
     @limits(calls=RATE_LIMIT, period=1)
     def _make_request(self, method, endpoint, params=None, data=None):
-        """
-        Выполняет HTTP-запрос к API amoCRM с учетом ограничения по скорости (rate limit).
-
-        :param method: HTTP-метод (GET, PATCH, POST, DELETE и т.д.).
-        :param endpoint: Конечная точка API (начинается с /api/v4/).
-        :param params: GET-параметры запроса.
-        :param data: Данные, отправляемые в JSON-формате.
-        :return: Ответ в формате JSON или None (если статус 204).
-        :raises Exception: При получении кода ошибки, отличного от 200/204.
-        """
+        # Метод без изменений
         url = f"{self.base_url}{endpoint}"
         headers = {
             "Authorization": f"Bearer {self.token}",
@@ -218,12 +176,7 @@ class AmoCRMClient:
         return response.json()
 
     def get_deal_by_id(self, deal_id):
-        """
-        Получает данные сделки по её ID и возвращает объект Deal.
-
-        :param deal_id: ID сделки.
-        :return: Объект Deal, включающий данные стандартных и кастомных полей.
-        """
+        # Метод без изменений
         endpoint = f"/api/v4/leads/{deal_id}"
         params = {'with': 'contacts,companies,catalog_elements,loss_reason,tags'}
         data = self._make_request("GET", endpoint, params=params)
@@ -233,10 +186,12 @@ class AmoCRMClient:
 
     def _save_custom_fields_cache(self, mapping):
         """
-        Сохраняет кэшированное отображение кастомных полей в файл.
-
-        :param mapping: Словарь с отображением кастомных полей.
+        Сохраняет кэш кастомных полей в файл, если используется файловый кэш.
+        Если файловый кэш не используется, операция пропускается.
         """
+        if not self.use_file_cache:
+            logger.debug("File caching disabled; cache stored in memory only.")
+            return
         cache_data = {"last_updated": time.time(), "mapping": mapping}
         with open(self.cache_file, "w") as f:
             json.dump(cache_data, f)
@@ -244,10 +199,12 @@ class AmoCRMClient:
 
     def _load_custom_fields_cache(self):
         """
-        Загружает кэш кастомных полей из файла.
-
-        :return: Кэшированные данные или None, если не удалось загрузить.
+        Загружает кэш кастомных полей из файла, если используется файловый кэш.
+        Если файловый кэш не используется, возвращает None.
         """
+        if not self.use_file_cache:
+            logger.debug("File caching disabled; no cache loaded from file.")
+            return None
         if os.path.exists(self.cache_file):
             with open(self.cache_file, "r") as f:
                 try:
@@ -262,12 +219,7 @@ class AmoCRMClient:
     def get_custom_fields_mapping(self, force_update=False, cache_duration_hours=24):
         """
         Возвращает словарь отображения кастомных полей для сделок.
-        Если данные кэшированы и не устарели, возвращает кэш; иначе выполняет серию запросов,
-        чтобы получить все страницы (с лимитом 250 полей на запрос).
-
-        :param force_update: Принудительное обновление кэша.
-        :param cache_duration_hours: Время жизни кэша в часах.
-        :return: Словарь mapping, где ключи – ID полей, а значения – их модели.
+        Если данные кэшированы и не устарели, возвращает кэш; иначе выполняет запросы для получения данных.
         """
         if not force_update:
             if self._custom_fields_mapping:
@@ -303,9 +255,6 @@ class AmoCRMClient:
     def find_custom_field_id(self, search_term):
         """
         Ищет кастомное поле по заданному названию (или части названия).
-
-        :param search_term: Строка для поиска по имени поля.
-        :return: Кортеж (field_id, field_obj) если найдено, иначе (None, None).
         """
         mapping = self.get_custom_fields_mapping()
         search_term_lower = search_term.lower().strip()
@@ -323,18 +272,6 @@ class AmoCRMClient:
     def update_lead(self, lead_id, update_fields: dict, tags_to_add: list = None, tags_to_delete: list = None):
         """
         Обновляет сделку, задавая новые значения для стандартных и кастомных полей.
-
-        Для кастомных полей:
-          - Если значение передается как целое число, оно интерпретируется как идентификатор варианта (enum_id)
-            для полей типа select.
-          - Если значение передается как строка, используется ключ "value".
-
-        :param lead_id: ID сделки, которую нужно обновить.
-        :param update_fields: Словарь с полями для обновления. Ключи могут быть стандартными или названием кастомного поля.
-        :param tags_to_add: Список тегов для добавления к сделке.
-        :param tags_to_delete: Список тегов для удаления из сделки.
-        :return: Ответ API в формате JSON.
-        :raises Exception: Если одно из кастомных полей не найдено.
         """
         payload = {}
         standard_fields = {
@@ -347,14 +284,11 @@ class AmoCRMClient:
                 payload[key] = value
                 logger.debug(f"Standard field {key} set to {value}")
             else:
-                # Если значение integer, интерпретируем как enum_id для полей типа select,
-                # иначе как текстовое значение.
                 if isinstance(value, int):
                     field_value_dict = {"enum_id": value}
                 else:
                     field_value_dict = {"value": value}
                 try:
-                    # Если ключ уже число, считаем его field_id
                     field_id = int(key)
                     custom_fields.append({"field_id": field_id, "values": [field_value_dict]})
                     logger.debug(f"Custom field by id {field_id} set to {value}")

{amochka-0.1.2.1.dist-info → amochka-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: amochka
-Version: 0.1.2.1
+Version: 0.1.3
 Summary: Библиотека для работы с API amoCRM
 Home-page: UNKNOWN
 Author: Timurka

amochka-0.1.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+amochka/__init__.py,sha256=92YIjNK3notY2wfG-l2jmGIIWjfE3ozpamc-e4LEILc,106
+amochka/client.py,sha256=59iYwOQ90XTJvnzQCxRG8sgpbLRaZkFfYkZCN_Zl4Y8,15354
+amochka-0.1.3.dist-info/METADATA,sha256=68jkHlxGXCk6acxCM8OVg4jluTZKy3yUdPfFOqzGK0U,445
+amochka-0.1.3.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+amochka-0.1.3.dist-info/top_level.txt,sha256=y5qXFXJUECmDwO6hyupsuYcTpZKZyByeE9e-1sa2U24,8
+amochka-0.1.3.dist-info/RECORD,,

amochka-0.1.2.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-amochka/__init__.py,sha256=92YIjNK3notY2wfG-l2jmGIIWjfE3ozpamc-e4LEILc,106
-amochka/client.py,sha256=ltU7_LwaxVPqAeLFwY-jnMDgDAQ6C1vafyKzZ0BtGjc,20816
-amochka-0.1.2.1.dist-info/METADATA,sha256=Bu4bqvfMsAKcIr9-emUpAG2_3B3iqZkwRTXSStVcjZY,447
-amochka-0.1.2.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-amochka-0.1.2.1.dist-info/top_level.txt,sha256=y5qXFXJUECmDwO6hyupsuYcTpZKZyByeE9e-1sa2U24,8
-amochka-0.1.2.1.dist-info/RECORD,,