mockable 0.0.1__tar.gz → 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,345 @@
1
+ Metadata-Version: 2.4
2
+ Name: mockable
3
+ Version: 0.0.2
4
+ Summary: mockable for ses
5
+ Author-email: Arimaqqe <beebo120103@gmail.com>
6
+ License: MIT
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Operating System :: OS Independent
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Dynamic: license-file
14
+
15
+ # mockable
16
+
17
+ Библиотека для управления моками через конфигурацию без изменения бизнес-логики приложения.
18
+
19
+ ## Содержание
20
+
21
+ * [Установка и настройка](#установка-и-настройка)
22
+
23
+ * [Установка](#установка)
24
+ * [Пример использования](#пример-использования)
25
+ * [Поддерживаемые сценарии](#поддерживаемые-сценарии)
26
+ * [Как пользоваться](#как-пользоваться)
27
+
28
+ * [`MockConfig`](#mockconfig)
29
+ * [`MethodMockConfig`](#methodmockconfig)
30
+ * [`MockFixture`](#mockfixture)
31
+
32
+ * [Рекомендации по `MockFixture`](#рекомендации-по-mockfixture)
33
+
34
+ ---
35
+
36
+ ## Установка и настройка
37
+
38
+ ### Установка
39
+
40
+ ```shell
41
+ pip install mockable
42
+ ```
43
+
44
+ ### Пример использования
45
+
46
+ ```py
47
+ from dataclasses import dataclass
48
+ from typing import Any, Dict
49
+
50
+ # 🔴 0. pip install mockable
51
+ # 🔴 1. Импортируем
52
+ from mockable import (
53
+ MethodMockConfig,
54
+ MockConfig,
55
+ MockFixture,
56
+ TestCaseType,
57
+ mockable,
58
+ mockable_class,
59
+ set_mock_config,
60
+ )
61
+
62
+ # 🔴 2. Создаем переменную конфига
63
+ start_config = None
64
+
65
+
66
+ # 🔴 3. Пишем функцию инициализации конфига
67
+ # Это нужно, чтобы не инициализировать конфиг
68
+ # при продовых запусках и не засорять память
69
+ def init_custom_config():
70
+ global start_config
71
+ # Конфиг моков
72
+ start_config = MockConfig(
73
+ # Какие кейсы включить, при тестировании
74
+ # ⚠️ Если в здесь будет неправильно прописано имя метода, то мок не сработает
75
+ active_cases={
76
+ "api_method_a": TestCaseType.NEGATIVE,
77
+ "api_method_b": TestCaseType.NEGATIVE,
78
+ "outside_method_a": TestCaseType.POSITIVE,
79
+ },
80
+ # Описание кейсов
81
+ # Структура ->
82
+ # <название метода>: MethodMockConfig(
83
+ # <характер случая>: MockFixture(
84
+ # result|side_effect|exception|file_path,
85
+ # description (опционально)
86
+ # )
87
+ # )
88
+ methods={
89
+ "api_method_a": MethodMockConfig(
90
+ positive=MockFixture(
91
+ result="MOCK POSITIVE api_method_a",
92
+ description="описание позитивного кейса (штатная ситуация)",
93
+ ),
94
+ negative=MockFixture(
95
+ result="MOCK NEGATIVE api_method_a",
96
+ description="описание негативного кейса (например не хватило слотов)",
97
+ ),
98
+ special=MockFixture(
99
+ result="MOCK SPECIAL api_method_a",
100
+ description="особый случай (всего один слот, особенный врач)",
101
+ ),
102
+ error=MockFixture(exception=ValueError("User not found")),
103
+ ),
104
+ "api_method_b": MethodMockConfig(
105
+ positive=MockFixture(
106
+ file_path="api_method_b_positive.json",
107
+ description="Путь к .json файлу с моком",
108
+ ),
109
+ negative=MockFixture(result="MOCK NEGATIVE api_method_b"),
110
+ ),
111
+ # ⚠️ Пример работы с функциональными моками
112
+ "outside_method_a": MethodMockConfig(
113
+ positive=MockFixture(
114
+ side_effect=lambda a: f"MOCK POSITIVE OUTSIDE A {a}",
115
+ description="Особая функциональность в моках",
116
+ ),
117
+ special=MockFixture(
118
+ side_effect=lambda a: f"MOCK SPECIAL OUTSIDE A {a}",
119
+ ),
120
+ ),
121
+ },
122
+ )
123
+
124
+ # 🔴 3.1 Устанавливаем конфиг
125
+ set_mock_config(start_config)
126
+
127
+
128
+ @dataclass
129
+ class Config:
130
+ is_mock: bool = True
131
+
132
+
133
+ @mockable
134
+ def outside_method_a(a) -> str:
135
+ return f"REAL {a}"
136
+
137
+
138
+ # 🔴 4. Добавляем @mockable_class
139
+ @mockable_class
140
+ class MedicineAPI:
141
+ def __init__(self):
142
+ self.cfg = Config()
143
+
144
+ # 🔴 5. Пишем условие для is_mock
145
+ if self.cfg.is_mock:
146
+ init_custom_config()
147
+
148
+ def api_method_a(self) -> str:
149
+ # C включенным моком код ниже не запустится
150
+ return "REAL"
151
+
152
+ def api_method_b(self) -> Dict[str, Any]:
153
+ # C включенным моком код ниже не запустится
154
+ return {"result": "REAL"}
155
+
156
+
157
+ def main():
158
+ api = MedicineAPI()
159
+ print("Результат api_method_a ->", repr(api.api_method_a()))
160
+ print("Результат api_method_b ->", repr(api.api_method_b()))
161
+ print("Результат outside_method_a ->", repr(outside_method_a("some data")))
162
+
163
+
164
+ main()
165
+ ```
166
+
167
+ ---
168
+
169
+ ## Поддерживаемые сценарии
170
+
171
+ | Сценарий | Назначение |
172
+ | ---------- | ------------------------------------ |
173
+ | `POSITIVE` | Штатное успешное выполнение |
174
+ | `NEGATIVE` | Ожидаемый негативный бизнес-сценарий |
175
+ | `SPECIAL` | Особый или граничный случай |
176
+ | `ERROR` | Генерация исключения |
177
+
178
+ ---
179
+
180
+ ## Как пользоваться
181
+
182
+ ### `MockConfig`
183
+
184
+ Основной объект конфигурации библиотеки.
185
+
186
+ Содержит список активных сценариев и описание доступных моков.
187
+
188
+ #### Поля
189
+
190
+ | Поле | Тип | Описание |
191
+ | -------------- | ----------------------------- | ------------------------------------ |
192
+ | `active_cases` | `dict[str, TestCaseType]` | Активный сценарий для каждого метода |
193
+ | `methods` | `dict[str, MethodMockConfig]` | Описание доступных моков |
194
+
195
+ #### Пример
196
+
197
+ ```py
198
+ start_config = MockConfig(
199
+ active_cases={
200
+ "method_a": TestCaseType.POSITIVE,
201
+ "method_b": TestCaseType.NEGATIVE,
202
+ "method_c": TestCaseType.SPECIAL,
203
+ "method_d": TestCaseType.ERROR,
204
+ },
205
+ methods={
206
+ "method_a": MethodMockConfig(...),
207
+ "method_b": MethodMockConfig(...),
208
+ "method_c": MethodMockConfig(...),
209
+ "method_d": MethodMockConfig(...),
210
+ }
211
+ )
212
+ ```
213
+
214
+ > ⚠️ Имя метода в `active_cases` должно точно совпадать с именем метода в `methods`, иначе мок не будет применён.
215
+
216
+ ---
217
+
218
+ ### `MethodMockConfig`
219
+
220
+ Описывает набор сценариев для одного метода.
221
+
222
+ Поле `positive` является обязательным. Остальные сценарии опциональны.
223
+
224
+ #### Поля
225
+
226
+ | Поле | Обязательное | Описание |
227
+ | ---------- | ------------ | --------------------------- |
228
+ | `positive` | Да | Штатное выполнение |
229
+ | `negative` | Нет | Негативный сценарий |
230
+ | `special` | Нет | Особый или граничный случай |
231
+ | `error` | Нет | Исключение |
232
+
233
+ #### Пример
234
+
235
+ ```py
236
+ MethodMockConfig(
237
+ positive=MockFixture(...), # Обязательное!
238
+ negative=MockFixture(...), # Опционально
239
+ special=MockFixture(...), # Опционально
240
+ error=MockFixture(...), # Опционально
241
+ )
242
+ ```
243
+
244
+ ---
245
+
246
+ ### `MockFixture`
247
+
248
+ Описывает конкретный мок.
249
+
250
+ Для результата использовать следующие параметры:
251
+
252
+ | Поле | Описание | Приоритет |
253
+ | ------------- | ------------------------------------------ | --------- |
254
+ | `result` | Возвращает заранее подготовленное значение | 4 |
255
+ | `file_path` | Загружает результат из JSON-файла | 3 |
256
+ | `side_effect` | Выполняет пользовательскую функцию | 2 |
257
+ | `exception` | Вызывает исключение | 1 |
258
+
259
+ Дополнительно можно указать:
260
+
261
+ | Поле | Описание |
262
+ | ------------- | ---------------------------- |
263
+ | `description` | Описание назначения сценария |
264
+
265
+ #### Пример
266
+
267
+ ```py
268
+ MethodMockConfig(
269
+ positive=MockFixture(
270
+ result={"status": "success"},
271
+ description="Штатное выполнение",
272
+ ),
273
+ negative=MockFixture(
274
+ result={"status": "error"},
275
+ description="Недостаточно данных",
276
+ ),
277
+ special=MockFixture(
278
+ result={"status": "special"},
279
+ description="Особый сценарий",
280
+ ),
281
+ error=MockFixture(
282
+ exception=TimeoutError("Service unavailable"),
283
+ description="Сервис недоступен",
284
+ ),
285
+ )
286
+ ```
287
+
288
+ #### Пример использования `side_effect`
289
+
290
+ Через `lambda`:
291
+
292
+ ```py
293
+ MockFixture(
294
+ side_effect=lambda value: f"Result = {value}"
295
+ )
296
+ ```
297
+
298
+ Через отдельную функцию:
299
+
300
+ ```py
301
+ def mock_user_response(user_id: int) -> dict:
302
+ return {
303
+ "user_id": user_id,
304
+ "name": "Mock User",
305
+ "status": "active",
306
+ }
307
+
308
+
309
+ MockFixture(
310
+ side_effect=mock_user_response
311
+ )
312
+ ```
313
+
314
+
315
+ #### Пример использования `file_path`
316
+
317
+ ```py
318
+ MockFixture(
319
+ file_path="mocks/method_a/positive.json"
320
+ )
321
+ ```
322
+
323
+ ---
324
+
325
+ #### Рекомендации по `MockFixture`
326
+
327
+ 1. Заполняйте поле `description`.
328
+ 2. Для сценария `ERROR` используйте `exception`.
329
+ 3. Крупные ответы рекомендуется хранить в JSON-файлах.
330
+ 4. Использовать абсолютные пути к JSON-файлам.
331
+ 5. Использовать единый стиль именования файлов.
332
+
333
+ Примеры:
334
+
335
+ ```text
336
+ /opt/mocks/method_a_positive.json
337
+ /opt/mocks/method_a_negative.json
338
+ ```
339
+
340
+ или
341
+
342
+ ```text
343
+ /opt/mocks/method_a/positive.json
344
+ /opt/mocks/method_a/negative.json
345
+ ```
@@ -0,0 +1,331 @@
1
+ # mockable
2
+
3
+ Библиотека для управления моками через конфигурацию без изменения бизнес-логики приложения.
4
+
5
+ ## Содержание
6
+
7
+ * [Установка и настройка](#установка-и-настройка)
8
+
9
+ * [Установка](#установка)
10
+ * [Пример использования](#пример-использования)
11
+ * [Поддерживаемые сценарии](#поддерживаемые-сценарии)
12
+ * [Как пользоваться](#как-пользоваться)
13
+
14
+ * [`MockConfig`](#mockconfig)
15
+ * [`MethodMockConfig`](#methodmockconfig)
16
+ * [`MockFixture`](#mockfixture)
17
+
18
+ * [Рекомендации по `MockFixture`](#рекомендации-по-mockfixture)
19
+
20
+ ---
21
+
22
+ ## Установка и настройка
23
+
24
+ ### Установка
25
+
26
+ ```shell
27
+ pip install mockable
28
+ ```
29
+
30
+ ### Пример использования
31
+
32
+ ```py
33
+ from dataclasses import dataclass
34
+ from typing import Any, Dict
35
+
36
+ # 🔴 0. pip install mockable
37
+ # 🔴 1. Импортируем
38
+ from mockable import (
39
+ MethodMockConfig,
40
+ MockConfig,
41
+ MockFixture,
42
+ TestCaseType,
43
+ mockable,
44
+ mockable_class,
45
+ set_mock_config,
46
+ )
47
+
48
+ # 🔴 2. Создаем переменную конфига
49
+ start_config = None
50
+
51
+
52
+ # 🔴 3. Пишем функцию инициализации конфига
53
+ # Это нужно, чтобы не инициализировать конфиг
54
+ # при продовых запусках и не засорять память
55
+ def init_custom_config():
56
+ global start_config
57
+ # Конфиг моков
58
+ start_config = MockConfig(
59
+ # Какие кейсы включить, при тестировании
60
+ # ⚠️ Если в здесь будет неправильно прописано имя метода, то мок не сработает
61
+ active_cases={
62
+ "api_method_a": TestCaseType.NEGATIVE,
63
+ "api_method_b": TestCaseType.NEGATIVE,
64
+ "outside_method_a": TestCaseType.POSITIVE,
65
+ },
66
+ # Описание кейсов
67
+ # Структура ->
68
+ # <название метода>: MethodMockConfig(
69
+ # <характер случая>: MockFixture(
70
+ # result|side_effect|exception|file_path,
71
+ # description (опционально)
72
+ # )
73
+ # )
74
+ methods={
75
+ "api_method_a": MethodMockConfig(
76
+ positive=MockFixture(
77
+ result="MOCK POSITIVE api_method_a",
78
+ description="описание позитивного кейса (штатная ситуация)",
79
+ ),
80
+ negative=MockFixture(
81
+ result="MOCK NEGATIVE api_method_a",
82
+ description="описание негативного кейса (например не хватило слотов)",
83
+ ),
84
+ special=MockFixture(
85
+ result="MOCK SPECIAL api_method_a",
86
+ description="особый случай (всего один слот, особенный врач)",
87
+ ),
88
+ error=MockFixture(exception=ValueError("User not found")),
89
+ ),
90
+ "api_method_b": MethodMockConfig(
91
+ positive=MockFixture(
92
+ file_path="api_method_b_positive.json",
93
+ description="Путь к .json файлу с моком",
94
+ ),
95
+ negative=MockFixture(result="MOCK NEGATIVE api_method_b"),
96
+ ),
97
+ # ⚠️ Пример работы с функциональными моками
98
+ "outside_method_a": MethodMockConfig(
99
+ positive=MockFixture(
100
+ side_effect=lambda a: f"MOCK POSITIVE OUTSIDE A {a}",
101
+ description="Особая функциональность в моках",
102
+ ),
103
+ special=MockFixture(
104
+ side_effect=lambda a: f"MOCK SPECIAL OUTSIDE A {a}",
105
+ ),
106
+ ),
107
+ },
108
+ )
109
+
110
+ # 🔴 3.1 Устанавливаем конфиг
111
+ set_mock_config(start_config)
112
+
113
+
114
+ @dataclass
115
+ class Config:
116
+ is_mock: bool = True
117
+
118
+
119
+ @mockable
120
+ def outside_method_a(a) -> str:
121
+ return f"REAL {a}"
122
+
123
+
124
+ # 🔴 4. Добавляем @mockable_class
125
+ @mockable_class
126
+ class MedicineAPI:
127
+ def __init__(self):
128
+ self.cfg = Config()
129
+
130
+ # 🔴 5. Пишем условие для is_mock
131
+ if self.cfg.is_mock:
132
+ init_custom_config()
133
+
134
+ def api_method_a(self) -> str:
135
+ # C включенным моком код ниже не запустится
136
+ return "REAL"
137
+
138
+ def api_method_b(self) -> Dict[str, Any]:
139
+ # C включенным моком код ниже не запустится
140
+ return {"result": "REAL"}
141
+
142
+
143
+ def main():
144
+ api = MedicineAPI()
145
+ print("Результат api_method_a ->", repr(api.api_method_a()))
146
+ print("Результат api_method_b ->", repr(api.api_method_b()))
147
+ print("Результат outside_method_a ->", repr(outside_method_a("some data")))
148
+
149
+
150
+ main()
151
+ ```
152
+
153
+ ---
154
+
155
+ ## Поддерживаемые сценарии
156
+
157
+ | Сценарий | Назначение |
158
+ | ---------- | ------------------------------------ |
159
+ | `POSITIVE` | Штатное успешное выполнение |
160
+ | `NEGATIVE` | Ожидаемый негативный бизнес-сценарий |
161
+ | `SPECIAL` | Особый или граничный случай |
162
+ | `ERROR` | Генерация исключения |
163
+
164
+ ---
165
+
166
+ ## Как пользоваться
167
+
168
+ ### `MockConfig`
169
+
170
+ Основной объект конфигурации библиотеки.
171
+
172
+ Содержит список активных сценариев и описание доступных моков.
173
+
174
+ #### Поля
175
+
176
+ | Поле | Тип | Описание |
177
+ | -------------- | ----------------------------- | ------------------------------------ |
178
+ | `active_cases` | `dict[str, TestCaseType]` | Активный сценарий для каждого метода |
179
+ | `methods` | `dict[str, MethodMockConfig]` | Описание доступных моков |
180
+
181
+ #### Пример
182
+
183
+ ```py
184
+ start_config = MockConfig(
185
+ active_cases={
186
+ "method_a": TestCaseType.POSITIVE,
187
+ "method_b": TestCaseType.NEGATIVE,
188
+ "method_c": TestCaseType.SPECIAL,
189
+ "method_d": TestCaseType.ERROR,
190
+ },
191
+ methods={
192
+ "method_a": MethodMockConfig(...),
193
+ "method_b": MethodMockConfig(...),
194
+ "method_c": MethodMockConfig(...),
195
+ "method_d": MethodMockConfig(...),
196
+ }
197
+ )
198
+ ```
199
+
200
+ > ⚠️ Имя метода в `active_cases` должно точно совпадать с именем метода в `methods`, иначе мок не будет применён.
201
+
202
+ ---
203
+
204
+ ### `MethodMockConfig`
205
+
206
+ Описывает набор сценариев для одного метода.
207
+
208
+ Поле `positive` является обязательным. Остальные сценарии опциональны.
209
+
210
+ #### Поля
211
+
212
+ | Поле | Обязательное | Описание |
213
+ | ---------- | ------------ | --------------------------- |
214
+ | `positive` | Да | Штатное выполнение |
215
+ | `negative` | Нет | Негативный сценарий |
216
+ | `special` | Нет | Особый или граничный случай |
217
+ | `error` | Нет | Исключение |
218
+
219
+ #### Пример
220
+
221
+ ```py
222
+ MethodMockConfig(
223
+ positive=MockFixture(...), # Обязательное!
224
+ negative=MockFixture(...), # Опционально
225
+ special=MockFixture(...), # Опционально
226
+ error=MockFixture(...), # Опционально
227
+ )
228
+ ```
229
+
230
+ ---
231
+
232
+ ### `MockFixture`
233
+
234
+ Описывает конкретный мок.
235
+
236
+ Для результата использовать следующие параметры:
237
+
238
+ | Поле | Описание | Приоритет |
239
+ | ------------- | ------------------------------------------ | --------- |
240
+ | `result` | Возвращает заранее подготовленное значение | 4 |
241
+ | `file_path` | Загружает результат из JSON-файла | 3 |
242
+ | `side_effect` | Выполняет пользовательскую функцию | 2 |
243
+ | `exception` | Вызывает исключение | 1 |
244
+
245
+ Дополнительно можно указать:
246
+
247
+ | Поле | Описание |
248
+ | ------------- | ---------------------------- |
249
+ | `description` | Описание назначения сценария |
250
+
251
+ #### Пример
252
+
253
+ ```py
254
+ MethodMockConfig(
255
+ positive=MockFixture(
256
+ result={"status": "success"},
257
+ description="Штатное выполнение",
258
+ ),
259
+ negative=MockFixture(
260
+ result={"status": "error"},
261
+ description="Недостаточно данных",
262
+ ),
263
+ special=MockFixture(
264
+ result={"status": "special"},
265
+ description="Особый сценарий",
266
+ ),
267
+ error=MockFixture(
268
+ exception=TimeoutError("Service unavailable"),
269
+ description="Сервис недоступен",
270
+ ),
271
+ )
272
+ ```
273
+
274
+ #### Пример использования `side_effect`
275
+
276
+ Через `lambda`:
277
+
278
+ ```py
279
+ MockFixture(
280
+ side_effect=lambda value: f"Result = {value}"
281
+ )
282
+ ```
283
+
284
+ Через отдельную функцию:
285
+
286
+ ```py
287
+ def mock_user_response(user_id: int) -> dict:
288
+ return {
289
+ "user_id": user_id,
290
+ "name": "Mock User",
291
+ "status": "active",
292
+ }
293
+
294
+
295
+ MockFixture(
296
+ side_effect=mock_user_response
297
+ )
298
+ ```
299
+
300
+
301
+ #### Пример использования `file_path`
302
+
303
+ ```py
304
+ MockFixture(
305
+ file_path="mocks/method_a/positive.json"
306
+ )
307
+ ```
308
+
309
+ ---
310
+
311
+ #### Рекомендации по `MockFixture`
312
+
313
+ 1. Заполняйте поле `description`.
314
+ 2. Для сценария `ERROR` используйте `exception`.
315
+ 3. Крупные ответы рекомендуется хранить в JSON-файлах.
316
+ 4. Использовать абсолютные пути к JSON-файлам.
317
+ 5. Использовать единый стиль именования файлов.
318
+
319
+ Примеры:
320
+
321
+ ```text
322
+ /opt/mocks/method_a_positive.json
323
+ /opt/mocks/method_a_negative.json
324
+ ```
325
+
326
+ или
327
+
328
+ ```text
329
+ /opt/mocks/method_a/positive.json
330
+ /opt/mocks/method_a/negative.json
331
+ ```
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "mockable"
7
- version = "0.0.1"
7
+ version = "0.0.2"
8
8
  description = "mockable for ses"
9
9
  readme = "README.md"
10
10
  authors = [
@@ -31,15 +31,15 @@ def mockable(func):
31
31
  case = _current_config.active_cases.get(method_name, TestCaseType.POSITIVE)
32
32
  fixture = method_cfg.get_fixture(case)
33
33
 
34
- if fixture.file_path:
35
- with open(fixture.file_path, "r", encoding="UTF-8") as f:
36
- return json.load(f)
37
-
38
34
  if fixture.exception:
39
35
  raise fixture.exception
40
36
 
41
37
  if fixture.side_effect:
42
38
  return fixture.side_effect(*args, **kwargs)
39
+
40
+ if fixture.file_path:
41
+ with open(fixture.file_path, "r", encoding="UTF-8") as f:
42
+ return json.load(f)
43
43
 
44
44
  return fixture.result
45
45
 
@@ -0,0 +1,345 @@
1
+ Metadata-Version: 2.4
2
+ Name: mockable
3
+ Version: 0.0.2
4
+ Summary: mockable for ses
5
+ Author-email: Arimaqqe <beebo120103@gmail.com>
6
+ License: MIT
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Operating System :: OS Independent
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Dynamic: license-file
14
+
15
+ # mockable
16
+
17
+ Библиотека для управления моками через конфигурацию без изменения бизнес-логики приложения.
18
+
19
+ ## Содержание
20
+
21
+ * [Установка и настройка](#установка-и-настройка)
22
+
23
+ * [Установка](#установка)
24
+ * [Пример использования](#пример-использования)
25
+ * [Поддерживаемые сценарии](#поддерживаемые-сценарии)
26
+ * [Как пользоваться](#как-пользоваться)
27
+
28
+ * [`MockConfig`](#mockconfig)
29
+ * [`MethodMockConfig`](#methodmockconfig)
30
+ * [`MockFixture`](#mockfixture)
31
+
32
+ * [Рекомендации по `MockFixture`](#рекомендации-по-mockfixture)
33
+
34
+ ---
35
+
36
+ ## Установка и настройка
37
+
38
+ ### Установка
39
+
40
+ ```shell
41
+ pip install mockable
42
+ ```
43
+
44
+ ### Пример использования
45
+
46
+ ```py
47
+ from dataclasses import dataclass
48
+ from typing import Any, Dict
49
+
50
+ # 🔴 0. pip install mockable
51
+ # 🔴 1. Импортируем
52
+ from mockable import (
53
+ MethodMockConfig,
54
+ MockConfig,
55
+ MockFixture,
56
+ TestCaseType,
57
+ mockable,
58
+ mockable_class,
59
+ set_mock_config,
60
+ )
61
+
62
+ # 🔴 2. Создаем переменную конфига
63
+ start_config = None
64
+
65
+
66
+ # 🔴 3. Пишем функцию инициализации конфига
67
+ # Это нужно, чтобы не инициализировать конфиг
68
+ # при продовых запусках и не засорять память
69
+ def init_custom_config():
70
+ global start_config
71
+ # Конфиг моков
72
+ start_config = MockConfig(
73
+ # Какие кейсы включить, при тестировании
74
+ # ⚠️ Если в здесь будет неправильно прописано имя метода, то мок не сработает
75
+ active_cases={
76
+ "api_method_a": TestCaseType.NEGATIVE,
77
+ "api_method_b": TestCaseType.NEGATIVE,
78
+ "outside_method_a": TestCaseType.POSITIVE,
79
+ },
80
+ # Описание кейсов
81
+ # Структура ->
82
+ # <название метода>: MethodMockConfig(
83
+ # <характер случая>: MockFixture(
84
+ # result|side_effect|exception|file_path,
85
+ # description (опционально)
86
+ # )
87
+ # )
88
+ methods={
89
+ "api_method_a": MethodMockConfig(
90
+ positive=MockFixture(
91
+ result="MOCK POSITIVE api_method_a",
92
+ description="описание позитивного кейса (штатная ситуация)",
93
+ ),
94
+ negative=MockFixture(
95
+ result="MOCK NEGATIVE api_method_a",
96
+ description="описание негативного кейса (например не хватило слотов)",
97
+ ),
98
+ special=MockFixture(
99
+ result="MOCK SPECIAL api_method_a",
100
+ description="особый случай (всего один слот, особенный врач)",
101
+ ),
102
+ error=MockFixture(exception=ValueError("User not found")),
103
+ ),
104
+ "api_method_b": MethodMockConfig(
105
+ positive=MockFixture(
106
+ file_path="api_method_b_positive.json",
107
+ description="Путь к .json файлу с моком",
108
+ ),
109
+ negative=MockFixture(result="MOCK NEGATIVE api_method_b"),
110
+ ),
111
+ # ⚠️ Пример работы с функциональными моками
112
+ "outside_method_a": MethodMockConfig(
113
+ positive=MockFixture(
114
+ side_effect=lambda a: f"MOCK POSITIVE OUTSIDE A {a}",
115
+ description="Особая функциональность в моках",
116
+ ),
117
+ special=MockFixture(
118
+ side_effect=lambda a: f"MOCK SPECIAL OUTSIDE A {a}",
119
+ ),
120
+ ),
121
+ },
122
+ )
123
+
124
+ # 🔴 3.1 Устанавливаем конфиг
125
+ set_mock_config(start_config)
126
+
127
+
128
+ @dataclass
129
+ class Config:
130
+ is_mock: bool = True
131
+
132
+
133
+ @mockable
134
+ def outside_method_a(a) -> str:
135
+ return f"REAL {a}"
136
+
137
+
138
+ # 🔴 4. Добавляем @mockable_class
139
+ @mockable_class
140
+ class MedicineAPI:
141
+ def __init__(self):
142
+ self.cfg = Config()
143
+
144
+ # 🔴 5. Пишем условие для is_mock
145
+ if self.cfg.is_mock:
146
+ init_custom_config()
147
+
148
+ def api_method_a(self) -> str:
149
+ # C включенным моком код ниже не запустится
150
+ return "REAL"
151
+
152
+ def api_method_b(self) -> Dict[str, Any]:
153
+ # C включенным моком код ниже не запустится
154
+ return {"result": "REAL"}
155
+
156
+
157
+ def main():
158
+ api = MedicineAPI()
159
+ print("Результат api_method_a ->", repr(api.api_method_a()))
160
+ print("Результат api_method_b ->", repr(api.api_method_b()))
161
+ print("Результат outside_method_a ->", repr(outside_method_a("some data")))
162
+
163
+
164
+ main()
165
+ ```
166
+
167
+ ---
168
+
169
+ ## Поддерживаемые сценарии
170
+
171
+ | Сценарий | Назначение |
172
+ | ---------- | ------------------------------------ |
173
+ | `POSITIVE` | Штатное успешное выполнение |
174
+ | `NEGATIVE` | Ожидаемый негативный бизнес-сценарий |
175
+ | `SPECIAL` | Особый или граничный случай |
176
+ | `ERROR` | Генерация исключения |
177
+
178
+ ---
179
+
180
+ ## Как пользоваться
181
+
182
+ ### `MockConfig`
183
+
184
+ Основной объект конфигурации библиотеки.
185
+
186
+ Содержит список активных сценариев и описание доступных моков.
187
+
188
+ #### Поля
189
+
190
+ | Поле | Тип | Описание |
191
+ | -------------- | ----------------------------- | ------------------------------------ |
192
+ | `active_cases` | `dict[str, TestCaseType]` | Активный сценарий для каждого метода |
193
+ | `methods` | `dict[str, MethodMockConfig]` | Описание доступных моков |
194
+
195
+ #### Пример
196
+
197
+ ```py
198
+ start_config = MockConfig(
199
+ active_cases={
200
+ "method_a": TestCaseType.POSITIVE,
201
+ "method_b": TestCaseType.NEGATIVE,
202
+ "method_c": TestCaseType.SPECIAL,
203
+ "method_d": TestCaseType.ERROR,
204
+ },
205
+ methods={
206
+ "method_a": MethodMockConfig(...),
207
+ "method_b": MethodMockConfig(...),
208
+ "method_c": MethodMockConfig(...),
209
+ "method_d": MethodMockConfig(...),
210
+ }
211
+ )
212
+ ```
213
+
214
+ > ⚠️ Имя метода в `active_cases` должно точно совпадать с именем метода в `methods`, иначе мок не будет применён.
215
+
216
+ ---
217
+
218
+ ### `MethodMockConfig`
219
+
220
+ Описывает набор сценариев для одного метода.
221
+
222
+ Поле `positive` является обязательным. Остальные сценарии опциональны.
223
+
224
+ #### Поля
225
+
226
+ | Поле | Обязательное | Описание |
227
+ | ---------- | ------------ | --------------------------- |
228
+ | `positive` | Да | Штатное выполнение |
229
+ | `negative` | Нет | Негативный сценарий |
230
+ | `special` | Нет | Особый или граничный случай |
231
+ | `error` | Нет | Исключение |
232
+
233
+ #### Пример
234
+
235
+ ```py
236
+ MethodMockConfig(
237
+ positive=MockFixture(...), # Обязательное!
238
+ negative=MockFixture(...), # Опционально
239
+ special=MockFixture(...), # Опционально
240
+ error=MockFixture(...), # Опционально
241
+ )
242
+ ```
243
+
244
+ ---
245
+
246
+ ### `MockFixture`
247
+
248
+ Описывает конкретный мок.
249
+
250
+ Для результата использовать следующие параметры:
251
+
252
+ | Поле | Описание | Приоритет |
253
+ | ------------- | ------------------------------------------ | --------- |
254
+ | `result` | Возвращает заранее подготовленное значение | 4 |
255
+ | `file_path` | Загружает результат из JSON-файла | 3 |
256
+ | `side_effect` | Выполняет пользовательскую функцию | 2 |
257
+ | `exception` | Вызывает исключение | 1 |
258
+
259
+ Дополнительно можно указать:
260
+
261
+ | Поле | Описание |
262
+ | ------------- | ---------------------------- |
263
+ | `description` | Описание назначения сценария |
264
+
265
+ #### Пример
266
+
267
+ ```py
268
+ MethodMockConfig(
269
+ positive=MockFixture(
270
+ result={"status": "success"},
271
+ description="Штатное выполнение",
272
+ ),
273
+ negative=MockFixture(
274
+ result={"status": "error"},
275
+ description="Недостаточно данных",
276
+ ),
277
+ special=MockFixture(
278
+ result={"status": "special"},
279
+ description="Особый сценарий",
280
+ ),
281
+ error=MockFixture(
282
+ exception=TimeoutError("Service unavailable"),
283
+ description="Сервис недоступен",
284
+ ),
285
+ )
286
+ ```
287
+
288
+ #### Пример использования `side_effect`
289
+
290
+ Через `lambda`:
291
+
292
+ ```py
293
+ MockFixture(
294
+ side_effect=lambda value: f"Result = {value}"
295
+ )
296
+ ```
297
+
298
+ Через отдельную функцию:
299
+
300
+ ```py
301
+ def mock_user_response(user_id: int) -> dict:
302
+ return {
303
+ "user_id": user_id,
304
+ "name": "Mock User",
305
+ "status": "active",
306
+ }
307
+
308
+
309
+ MockFixture(
310
+ side_effect=mock_user_response
311
+ )
312
+ ```
313
+
314
+
315
+ #### Пример использования `file_path`
316
+
317
+ ```py
318
+ MockFixture(
319
+ file_path="mocks/method_a/positive.json"
320
+ )
321
+ ```
322
+
323
+ ---
324
+
325
+ #### Рекомендации по `MockFixture`
326
+
327
+ 1. Заполняйте поле `description`.
328
+ 2. Для сценария `ERROR` используйте `exception`.
329
+ 3. Крупные ответы рекомендуется хранить в JSON-файлах.
330
+ 4. Использовать абсолютные пути к JSON-файлам.
331
+ 5. Использовать единый стиль именования файлов.
332
+
333
+ Примеры:
334
+
335
+ ```text
336
+ /opt/mocks/method_a_positive.json
337
+ /opt/mocks/method_a_negative.json
338
+ ```
339
+
340
+ или
341
+
342
+ ```text
343
+ /opt/mocks/method_a/positive.json
344
+ /opt/mocks/method_a/negative.json
345
+ ```
mockable-0.0.1/PKG-INFO DELETED
@@ -1,22 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: mockable
3
- Version: 0.0.1
4
- Summary: mockable for ses
5
- Author-email: Arimaqqe <beebo120103@gmail.com>
6
- License: MIT
7
- Classifier: Programming Language :: Python :: 3
8
- Classifier: License :: OSI Approved :: MIT License
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.8
11
- Description-Content-Type: text/markdown
12
- License-File: LICENSE
13
- Dynamic: license-file
14
-
15
- # mockable
16
-
17
- Моя первая библиотека.
18
-
19
- ## Установка
20
-
21
- ```bash
22
- pip install mypackage
mockable-0.0.1/README.md DELETED
@@ -1,8 +0,0 @@
1
- # mockable
2
-
3
- Моя первая библиотека.
4
-
5
- ## Установка
6
-
7
- ```bash
8
- pip install mypackage
@@ -1,22 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: mockable
3
- Version: 0.0.1
4
- Summary: mockable for ses
5
- Author-email: Arimaqqe <beebo120103@gmail.com>
6
- License: MIT
7
- Classifier: Programming Language :: Python :: 3
8
- Classifier: License :: OSI Approved :: MIT License
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.8
11
- Description-Content-Type: text/markdown
12
- License-File: LICENSE
13
- Dynamic: license-file
14
-
15
- # mockable
16
-
17
- Моя первая библиотека.
18
-
19
- ## Установка
20
-
21
- ```bash
22
- pip install mypackage
File without changes
File without changes