20251002

help/class_desc/extensions/string_extension_constant.md

@@ -0,0 +1,60 @@
+# Класс `StringExtensionConstants`
+
+Этот класс предназначен для хранения констант, используемых при расширениях функционала работы со строками на Python.
+Основные цели класса включают поддержку русской транслитерации и удобство обработки текста на кириллице.
+
+Класс включает два основных атрибута-константы:
+* атрибут `russian_letters`;
+* атрибут `russian_letters_transliteration`.
+
+## Основная информация
+
+- **Имя файла**: anb_python_components\extensions\string_extension_constant.py
+- **Автор**: Александр Бабаев
+- **Версия**: 1.0.0
+- **Дата начала поддержки**: с версии 1.0
+
+## Атрибуты и методы класса
+### Атрибут `russian_letters`
+Это кортеж, содержащий все русские буквы (строчные и прописные). Используется для проверки принадлежности символов
+русским буквам, операций сортировки и фильтрации текста.
+
+Пример использования:
+```python
+from anb_python_components.extensions.string_extension_constant import StringExtensionConstants
+
+char = 'в'
+
+if char in StringExtensionConstants.russian_letters:
+    print("Символ является русской буквой")
+```
+
+### Атрибут `russian_letters_transliteration`
+Это кортеж, соответствующий русскому алфавиту в транслитерированном виде латиницей. Например, русская буква «А»
+соответствует английскому символу «A», а буква «Ч» соответствует последовательности «Ch».
+
+Используется для преобразования русского текста в транслитерационный вид, что полезно для интеграции с международными
+системами, упрощения экспорта данных и поддержки кросс-платформенных решений.
+
+Пример использования:
+
+```python
+from anb_python_components.extensions.string_extension_constant import StringExtensionConstants
+
+translit_map = dict(
+    zip(
+        StringExtensionConstants.russian_letters,
+        StringExtensionConstants.russian_letters_transliteration
+    ))
+
+
+def transliterate(text):
+    return ''.join(translit_map.get(char, char) for char in text)
+```
+
+## Вывод
+
+Таким образом, этот класс позволяет легко реализовать базовые операции для нормализации и трансформации строки на
+русском языке.
+
+[На главную](../../index.md)