20251004

help/class_desc/exceptions/wrong_type_exception.md

@@ -0,0 +1,63 @@
+# Класс `WrongTypeException`
+
+Класс `WrongTypeException` представляет собой настраиваемое исключение, возникающее при некорректном присваивании
+значения другому типу данных. Обычно такое исключение применяется для контроля целостности типов в строгих системах
+разработки программного обеспечения, предотвращая потенциальные проблемы и неопределённое поведение программы.
+
+## Основная информация
+
+- **Имя файла**: anb_python_components\exceptions\wrong_type_exception.py
+- **Автор**: Александр Бабаев
+- **Версия**: 1.0.0
+- **Дата начала поддержки**: с версии 1.0
+
+## Атрибуты и методы класса
+
+### Конструктор (`__init__`)
+
+Создаёт экземпляр исключения, принимая необязательные параметры для детального описания ошибки.
+
+Параметры конструктора:
+
+- `message`: Пользовательское сообщение об ошибке.
+- `type_name`: Ожидаемый тип данных (например, `int`, `float`, `str`).
+- `real_type_name`: Реальный тип данных, который был использован ошибочно.
+- `var_name`: Название переменной, вызвавшей ошибку.
+
+Пример использования:
+
+```python
+from anb_python_components.exceptions.wrong_type_exception import WrongTypeException
+
+
+# Допустим, задана какая-то функция
+def some_function(value):
+    # в этой функции стоит проверка на тип
+    if not isinstance(value, int):
+        # и в случае неудачной проверки выбрасывается исключение
+        raise WrongTypeException("Неверный тип!", "int", type(value), "value")
+
+    # Пусть эта функция для примера просто добавляет 1 к value
+    return value + 1
+
+
+try:
+    # Зададим переменную a как произвольную строку
+    a = "hello, word"
+
+    # и при вызове функции будет выброшено исключение
+    some_function(a)
+except WrongTypeException as e:
+    print(
+        f"Произошла ошибка: {e.message}. Ожидается тип {e.type_name}, а в переменную {e.var_name} передан {e.real_type_name}")
+
+# Произошла ошибка: Неверный тип!. Ожидается тип int, а в переменную value передан str
+```
+
+## Заключение
+
+Исключения играют важную роль в обеспечении надёжности и предсказуемости программ. Класс `WrongTypeException` позволяет
+разработчикам легко создавать контролируемые условия для предотвращения неправильного использования типов данных и
+повышения качества ПО.
+
+[На главную](../../index.md)

help/class_desc/extensions/array_extension.md

@@ -0,0 +1,39 @@
+# Класс `ArrayExtension`
+
+Класс `ArrayExtension` предназначен для работы с массивами строк в Python. Главная задача класса — удаление пустых строк
+из массива и возможная последующая сортировка оставшихся элементов.
+
+## Основная информация
+
+- **Имя файла**: anb_python_components\extensions\array_extension.py
+- **Автор**: Александр Бабаев
+- **Версия**: 1.0.0
+- **Дата начала поддержки**: с версии 1.0
+
+## Атрибуты и методы класса
+
+### Метод `remove_empties`
+
+Удаляет пустые строки из массива, дополнительно предоставляя возможность отсортировать оставшиеся элементы.
+
+**Параметры**:
+
+- `array`: Входной массив строк.
+- `re_sort`: Флаг, определяющий необходимость сортировки результата (по умолчанию установлен в `False`).
+
+**Пример использования**:
+
+```python
+from anb_python_components.extensions.array_extension import ArrayExtension
+
+arr = ["apple", "", "banana", " ", ""]
+clean_arr = ArrayExtension.remove_empties(arr)
+print(clean_arr)  # ['apple', 'banana']
+```
+
+## Заключение
+
+Класс `ArrayExtension` полезен при очистке массивов от ненужных элементов, улучшая качество данных и повышая
+эффективность дальнейшей обработки. Особенно удобен в приложениях, где важны чистота и порядок данных.
+
+[На главную](../../index.md)