anb-python-components 1.3.0__tar.gz → 1.4.0__tar.gz

{anb_python_components-1.3.0 → anb_python_components-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anb_python_components
-Version: 1.3.0
+Version: 1.4.0
 Summary: Набор компонентов Python, которые упрощают разработку / A set of Python components that simplify development
 Home-page: https://gitflic.ru/project/babaev-an/anb-python-components
 Author: Александр Бабаев
@@ -19,6 +19,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.14.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: setuptools>=80.9.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -28,6 +29,7 @@ Dynamic: home-page
 Dynamic: keywords
 Dynamic: license-file
 Dynamic: project-url
+Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 

anb_python_components-1.4.0/anb_python_components/__init__.py

@@ -0,0 +1,46 @@
+# anb_python_components/__init__.py
+
+# classes
+from anb_python_components.classes import ActionState, DataclassAnalyzer, Directory, File, Interface, ShortCodeParser
+# custom_types
+from anb_python_components.custom_types import GUID, ObjectArray, ShortCodeAttributes, TwoDimSize, VersionInfo
+# decorators
+from anb_python_components.decorators import implement, interface_required
+# enums
+from anb_python_components.enums import MessageType, NotBoolAction, TypeCopyStrategy
+# exceptions
+from anb_python_components.exceptions import WrongTypeException
+# extensions
+from anb_python_components.extensions import (
+    ArrayExtension, BoolExtension, DataClassExtension, StringExtension,
+    TypeExtension
+    )
+# models
+from anb_python_components.models import ActionStateMessage, ShortCodeModel
+
+__all__ = [
+        'ActionState',
+        'Directory',
+        'File',
+        'DataclassAnalyzer',
+        'Interface',
+        'ShortCodeParser',
+        'GUID',
+        'ObjectArray',
+        'ShortCodeAttributes',
+        'TwoDimSize',
+        'VersionInfo',
+        'interface_required',
+        'implement',
+        'MessageType',
+        'NotBoolAction',
+        'TypeCopyStrategy',
+        'WrongTypeException',
+        'ArrayExtension',
+        'BoolExtension',
+        'StringExtension',
+        "TypeExtension",
+        "DataClassExtension",
+        'ActionStateMessage',
+        'ShortCodeModel'
+        ]

{anb_python_components-1.3.0 → anb_python_components-1.4.0}/anb_python_components/classes/__init__.py

@@ -1,6 +1,7 @@
 # anb_python_components/classes/__init__.py
 
 from anb_python_components.classes.action_state import ActionState
+from anb_python_components.classes.dataclass_analyzer import DataclassAnalyzer
 from anb_python_components.classes.directory import Directory
 from anb_python_components.classes.file import File
 from anb_python_components.classes.interface import Interface

anb_python_components-1.4.0/anb_python_components/classes/dataclass_analyzer.py

@@ -0,0 +1,97 @@
+# anb_python_components/classes/dataclass_analyzer.py
+from dataclasses import fields, is_dataclass
+from typing import Any
+
+class DataclassAnalyzer:
+    """
+    Класс анализа классов отмеченных как dataclass.
+    """
+    
+    @staticmethod
+    def analyze_properties (cls, prop_name: str) -> dict[str, Any]:
+        """
+        Анализирует декораторы (метаданные) указанного свойства класса.
+        :param cls: Класс (должен реализовывать dataclass).
+        :param prop_name: Имя свойства.
+        :return: Словарь с информацией о применённых декораторах.
+        """
+        # Проверяем, что класс является dataclass
+        if not is_dataclass(cls):
+            # - иначе бросаем исключение
+            raise TypeError(f"Класс {cls.__name__} не является dataclass / Class {cls.__name__} is not a dataclass")
+        
+        # Находим поле по имени
+        # - задаём начальное значение None
+        field_obj = None
+        
+        # Перебираем поля класса
+        for field in fields(cls):
+            # - ищем поле с указанным именем
+            if field.name == prop_name:
+                # - если нашли, сохраняем объект поля
+                field_obj = field
+                # - и выходим из цикла
+                break
+        
+        # Если поле не найдено
+        if field_obj is None:
+            # - бросаем исключение
+            raise AttributeError(
+                    f"Свойство '{prop_name}' не найдено в классе {cls.__name__} / Property '{prop_name}' not found in class {cls.__name__}"
+                    )
+        
+        # Создаем словарь для результатов
+        results = {}
+        
+        # Собираем метаданные
+        metadata = field_obj.metadata or {}
+        
+        # Перебираем метаданные
+        for key, value in metadata.items():
+            # - добавляем в словарь
+            results[key] = value
+        
+        # Возвращаем результаты
+        return results
+    
+    @staticmethod
+    def analyze_class (cls) -> dict[str, dict[str, Any]]:
+        """
+        Анализирует все свойства dataclass-класса и класс‑уровневые метаданные.
+        :param cls: Dataclass-класс.
+        :return: Словарь с метаданными полей и класса.
+        """
+        # Проверяем, что класс является dataclass
+        if not is_dataclass(cls):
+            # - иначе бросаем исключение
+            raise TypeError(f"Класс {cls.__name__} не является dataclass / Class {cls.__name__} is not a dataclass")
+        
+        results = {}
+        
+        # Собираем класс‑уровневые метаданные (всё, что начинается с __meta_)
+        # - создаём пустой словарь
+        class_metadata = {}
+        
+        # Перебираем атрибуты класса
+        for attr_name in dir(cls):
+            # - ищем атрибуты, начинающиеся с __meta_
+            if attr_name.startswith("__meta_"):
+                # -- удаляем префикс __meta_ и берём значение
+                key = attr_name[len("__meta_"):]
+                # -- добавляем в словарь
+                class_metadata[key] = getattr(cls, attr_name)
+        
+        # Если есть метаданные
+        if class_metadata:
+            # - добавляем в результаты
+            results["__CLASS__"] = class_metadata
+        
+        # Анализируем каждое поле
+        for field in fields(cls):
+            # - получаем имя поля
+            field_name = field.name
+            # - анализируем поле и сохраняем результаты в словарь
+            results[field_name] = DataclassAnalyzer.analyze_properties(cls, field_name)
+        
+        # Возвращаем результаты
+        return results

anb_python_components-1.4.0/anb_python_components/exceptions/__init__.py

@@ -0,0 +1,3 @@
+# anb_python_components/exceptions/__init__.py
+
+from anb_python_components.exceptions.wrong_type_exception import WrongTypeException

{anb_python_components-1.3.0 → anb_python_components-1.4.0}/anb_python_components/extensions/__init__.py

@@ -2,5 +2,6 @@
 
 from anb_python_components.extensions.array_extension import ArrayExtension
 from anb_python_components.extensions.bool_extension import BoolExtension
+from anb_python_components.extensions.dataclass_extension import DataClassExtension
 from anb_python_components.extensions.string_extension import StringExtension
 from anb_python_components.extensions.type_extension import TypeExtension

anb_python_components-1.4.0/anb_python_components/extensions/dataclass_extension.py

@@ -0,0 +1,59 @@
+# anb_python_components/extensions/dataclass_extension.py
+import copy
+from dataclasses import Field, field
+from typing import Any
+
+from anb_python_components.extensions.type_extension import TypeExtension
+
+# Базовая структура для представления расширенного типа
+class DataClassExtension:
+    @staticmethod
+    def define (default: Any = None, metadata: dict[str, Any] = None) -> Field:
+        """
+        Определяет поле с расширенными метаданными.
+        :param default: Значение по умолчанию для поля.
+        :param metadata: Метаданные для поля.
+        :return: Объект поля.
+        """
+        # Создаём словарь метаданных
+        meta = {} if metadata is None else metadata
+        
+        # Если значение по умолчанию не передано
+        if default is None:
+            # - то создаём поле без значения по умолчанию
+            return field(metadata = meta)
+        
+        # Если значение по умолчанию передано неизменяемым типом, то создаём поле с этим значением по умолчанию, иначе с функцией-фабрикой
+        return field(default = default, metadata = meta) if TypeExtension.check_immutability(default) else field(
+                default_factory = lambda: copy.copy(default), metadata = meta
+                )
+    
+    @staticmethod
+    def defines (default: Any, *fields: Field) -> Field:
+        """
+        Определяет поле с расширенными метаданными и переданными полями.
+        :param default: Значение по умолчанию для поля.
+        :param fields: Поля для расширения.
+        :return: Объект поля.
+        """
+        # Создаём словарь метаданных
+        metas = {}
+        
+        # Проверяем, что все аргументы — экземпляры Field
+        for i, f in enumerate(fields):
+            # - если хоть один аргумент не является полем
+            if not isinstance(f, Field):
+                # -- то создаём текстовое описание ошибки
+                error = [
+                        f"Аргумент fields[{i}] должен быть экземпляром dataclasses.Field, получено {type(f).__name__}",
+                        f"Argument fields[{i}] must be an instance of dataclasses.Field, got {type(f).__name__}"
+                        ]
+                # -- и выбрасываем исключение
+                raise TypeError("\n".join(error))
+        
+        # Собираем все метаданные из переданных полей
+        for f in fields:
+            if f.metadata:
+                metas.update(f.metadata)
+        
+        return DataClassExtension.define(default, metas)

{anb_python_components-1.3.0 → anb_python_components-1.4.0}/anb_python_components/extensions/type_extension.py

@@ -109,4 +109,29 @@ class TypeExtension:
             inner_type = args[0]  # Получаем T из list[T]
             return TypeExtension.is_immutable_type(inner_type)  # Проверяем T
         
-        return False
+        return False
+    
+    @staticmethod
+    def check_immutability (value: Any) -> bool:
+        """
+        Проверяет, является ли значение `value` неизменяемым по типу.
+        :param value: Проверяемое значение.
+        :return: True, если тип значения неизменяемый, иначе False.
+        """
+        # None — неизменяемый
+        if value is None:
+            return True
+        
+        # Получаем фактический тип значения
+        value_type = type(value)
+        
+        # Используем get_origin/get_args для анализа
+        origin = get_origin(value_type)
+        
+        # Если это параметризованный тип (list[int], Union[str, int] и т.п.),
+        if origin is not None:
+            # - передаём сам параметризованный тип в is_immutable_type
+            return TypeExtension.is_immutable_type(origin)
+        else:
+            # - иначе проверяем тип напрямую (для простых типов, таких как int, str и т.п.)
+            return TypeExtension.is_immutable_type(value_type)

{anb_python_components-1.3.0 → anb_python_components-1.4.0}/anb_python_components.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anb_python_components
-Version: 1.3.0
+Version: 1.4.0
 Summary: Набор компонентов Python, которые упрощают разработку / A set of Python components that simplify development
 Home-page: https://gitflic.ru/project/babaev-an/anb-python-components
 Author: Александр Бабаев
@@ -19,6 +19,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.14.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: setuptools>=80.9.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -28,6 +29,7 @@ Dynamic: home-page
 Dynamic: keywords
 Dynamic: license-file
 Dynamic: project-url
+Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 

{anb_python_components-1.3.0 → anb_python_components-1.4.0}/anb_python_components.egg-info/SOURCES.txt

@@ -6,9 +6,11 @@ anb_python_components.egg-info/PKG-INFO
 anb_python_components.egg-info/SOURCES.txt
 anb_python_components.egg-info/dependency_links.txt
 anb_python_components.egg-info/not-zip-safe
+anb_python_components.egg-info/requires.txt
 anb_python_components.egg-info/top_level.txt
 anb_python_components/classes/__init__.py
 anb_python_components/classes/action_state.py
+anb_python_components/classes/dataclass_analyzer.py
 anb_python_components/classes/directory.py
 anb_python_components/classes/file.py
 anb_python_components/classes/interface.py
@@ -30,6 +32,7 @@ anb_python_components/exceptions/wrong_type_exception.py
 anb_python_components/extensions/__init__.py
 anb_python_components/extensions/array_extension.py
 anb_python_components/extensions/bool_extension.py
+anb_python_components/extensions/dataclass_extension.py
 anb_python_components/extensions/string_extension.py
 anb_python_components/extensions/string_extension_constant.py
 anb_python_components/extensions/type_extension.py
@@ -39,6 +42,7 @@ anb_python_components/models/shortcode_model.py
 tests/__init__.py
 tests/classes/__init__.py
 tests/classes/action_state_test.py
+tests/classes/dataclass_analyzer_test.py
 tests/classes/directory_test.py
 tests/classes/file_test.py
 tests/classes/interface_test.py

anb_python_components-1.4.0/anb_python_components.egg-info/requires.txt

@@ -0,0 +1 @@
+setuptools>=80.9.0

anb_python_components-1.4.0/setup.py

@@ -0,0 +1,74 @@
+from os import path
+
+from setuptools import find_packages, setup
+
+# Получаем текущую директорию
+this_directory = path.abspath(path.dirname(__file__))
+
+# Функция для чтения requirements.txt
+def read_requirements () -> list[str]:
+    """
+    Читает файл requirements.txt и возвращает список зависимостей.
+    :return: Список зависимостей.
+    """
+    # Путь к файлу requirements.txt в текущей директории
+    requirements_path = path.join(this_directory, 'requirements.txt')
+    
+    # Проверяем, существует ли файл requirements.txt
+    if not path.exists(requirements_path):
+        # - если нет, возвращаем пустой список
+        return []
+    
+    # Читаем файл requirements.txt
+    with open(requirements_path, encoding = 'utf-8') as f:
+        # - возвращаем список зависимостей, предварительно убрав пустые строки и комментарии
+        lines = [line.strip() for line in f if line.strip() and not line.startswith('#')]
+    
+    # Возвращаем список зависимостей
+    return lines
+
+def read_readme () -> str:
+    """
+    Получает содержимое файла README.md и возвращает его в виде строки.
+    :return: Содержимое файла README.md.
+    """
+    # Задаём переменную для хранения содержимого файла README.md
+    readme_content = ''
+    
+    # Открываем файл README.md
+    with open(path.join(this_directory, 'README.md'), encoding = 'utf-8') as f:
+        # - и читаем его содержимое
+        readme_content = f.read()
+    
+    # Возвращаем содержимое файла README.md
+    return readme_content
+
+setup(
+        name = 'anb_python_components',
+        version = '1.4.0',
+        description = 'Набор компонентов Python, которые упрощают разработку / A set of Python components that simplify development',
+        long_description = read_readme(),
+        long_description_content_type = 'text/markdown',
+        author = 'Александр Бабаев',
+        author_email = 'contact_with_us@babaev-an.ru',
+        url = 'https://gitflic.ru/project/babaev-an/anb-python-components',
+        packages = find_packages(),
+        install_requires = read_requirements(),
+        python_requires = '>=3.14.0',
+        classifiers = [
+                'Development Status :: 5 - Production/Stable',
+                'Intended Audience :: Developers',
+                'License :: OSI Approved :: MIT License',
+                'Programming Language :: Python :: 3',
+                'Programming Language :: Python :: 3.14',
+                'Operating System :: OS Independent',
+                'Topic :: Software Development :: Libraries :: Python Modules',
+                ],
+        keywords = 'python components development utils',
+        project_urls = {
+                'Documentation': 'https://gitflic.ru/project/babaev-an/anb-python-components/wiki',
+                'Source': 'https://gitflic.ru/project/babaev-an/anb-python-components',
+                'Tracker': 'https://gitflic.ru/project/babaev-an/anb-python-components/issue?page=0',
+                },
+        zip_safe = False,
+        )

anb_python_components-1.4.0/tests/classes/dataclass_analyzer_test.py

@@ -0,0 +1,62 @@
+# tests/dataclass_analyzer_test.py
+
+import unittest
+from dataclasses import dataclass, is_dataclass
+
+from anb_python_components import DataClassExtension, DataclassAnalyzer
+
+class Fields:
+    @staticmethod
+    def primary_key (default = None):
+        return DataClassExtension.define(default, metadata = {'db_primary_key': True})
+    
+    @staticmethod
+    def unique (default = None):
+        return DataClassExtension.define(default, metadata = {'db_unique': True})
+    
+    @staticmethod
+    def indexed (default = None):
+        return DataClassExtension.define(default, metadata = {'db_indexed': True})
+    
+    @staticmethod
+    def compose (default, *fields):
+        return DataClassExtension.defines(default, *fields)
+
+def table_name (name: str):
+    """
+    Декоратор для dataclass-класса, задающий имя таблицы в СУБД.
+    :param name: Имя таблицы.
+    :return: Обогащённый класс.
+    """
+    
+    def decorator (cls):
+        if not is_dataclass(cls):
+            raise TypeError(f"Класс {cls.__name__} должен быть dataclass")
+        
+        # Сохраняем имя таблицы как атрибут класса (начинается с __meta_)
+        cls.__meta_table_name = name
+        return cls
+    
+    return decorator
+
+@table_name("ANB")
+@dataclass
+class A:
+    a: int = Fields.primary_key(0)
+    b: str = Fields.compose("", Fields.unique(), Fields.indexed())
+
+class DataclassAnalyzerTest(unittest.TestCase):
+    def test_analyze (self):
+        analyze_result = DataclassAnalyzer.analyze_class(A)
+        self.assertEqual("ANB", analyze_result["__CLASS__"]["table_name"])
+        self.assertTrue(analyze_result["a"]["db_primary_key"])
+        
+        analyze_result = DataclassAnalyzer.analyze_properties(A, "a")
+        self.assertTrue(analyze_result["db_primary_key"])
+        
+        analyze_result = DataclassAnalyzer.analyze_properties(A, "b")
+        self.assertTrue(analyze_result["db_unique"])
+        self.assertTrue(analyze_result["db_indexed"])
+
+if __name__ == '__main__':
+    unittest.main()

anb_python_components-1.3.0/anb_python_components/__init__.py

@@ -1,55 +0,0 @@
-# anb_python_components/__init__.py
-
-# classes
-from anb_python_components.classes.action_state import ActionState
-from anb_python_components.classes.directory import Directory
-from anb_python_components.classes.file import File
-from anb_python_components.classes.interface import Interface
-from anb_python_components.classes.shortcode_parser import ShortCodeParser
-# custom_types
-from anb_python_components.custom_types.guid import GUID
-from anb_python_components.custom_types.object_array import ObjectArray
-from anb_python_components.custom_types.shortcode_attributes import ShortCodeAttributes
-from anb_python_components.custom_types.two_dim_size import TwoDimSize
-from anb_python_components.custom_types.version_info import VersionInfo
-# decorators
-from anb_python_components.decorators.interface_decorators import implement, interface_required
-# enums
-from anb_python_components.enums.message_type import MessageType
-from anb_python_components.enums.not_bool_action import NotBoolAction
-from anb_python_components.enums.type_copy_strategy import TypeCopyStrategy
-# exceptions
-from anb_python_components.exceptions.wrong_type_exception import WrongTypeException
-# extensions
-from anb_python_components.extensions.array_extension import ArrayExtension
-from anb_python_components.extensions.bool_extension import BoolExtension
-from anb_python_components.extensions.string_extension import StringExtension
-from anb_python_components.extensions.type_extension import TypeExtension
-# models
-from anb_python_components.models.action_state_message import ActionStateMessage
-from anb_python_components.models.shortcode_model import ShortCodeModel
-
-__all__ = [
-        'ActionState',
-        'Directory',
-        'File',
-        'Interface',
-        'ShortCodeParser',
-        'GUID',
-        'ObjectArray',
-        'ShortCodeAttributes',
-        'TwoDimSize',
-        'VersionInfo',
-        'interface_required',
-        'implement',
-        'MessageType',
-        'NotBoolAction',
-        'TypeCopyStrategy',
-        'WrongTypeException',
-        'ArrayExtension',
-        'BoolExtension',
-        'StringExtension',
-        "TypeExtension",
-        'ActionStateMessage',
-        'ShortCodeModel'
-        ]

anb_python_components-1.3.0/anb_python_components/exceptions/__init__.py

@@ -1,3 +0,0 @@
-# anb_python_components/exceptions/__init__.py
-
-# from anb_python_components.exceptions.wrong_type_exception import WrongTypeException

anb_python_components-1.3.0/setup.py

@@ -1,38 +0,0 @@
-from os import path
-
-from setuptools import find_packages, setup
-
-# Получаем длинное описание из README.md
-this_directory = path.abspath(path.dirname(__file__))
-with open(path.join(this_directory, 'README.md'), encoding = 'utf-8') as f:
-    long_description = f.read()
-
-setup(
-        name = 'anb_python_components',
-        version = '1.3.0',
-        description = 'Набор компонентов Python, которые упрощают разработку / A set of Python components that simplify development',
-        long_description = long_description,
-        long_description_content_type = 'text/markdown',
-        author = 'Александр Бабаев',
-        author_email = 'contact_with_us@babaev-an.ru',
-        url = 'https://gitflic.ru/project/babaev-an/anb-python-components',
-        packages = find_packages(),
-        install_requires = [],
-        python_requires = '>=3.14.0',
-        classifiers = [
-                'Development Status :: 5 - Production/Stable',
-                'Intended Audience :: Developers',
-                'License :: OSI Approved :: MIT License',
-                'Programming Language :: Python :: 3',
-                'Programming Language :: Python :: 3.14',
-                'Operating System :: OS Independent',
-                'Topic :: Software Development :: Libraries :: Python Modules',
-                ],
-        keywords = 'python components development utils',
-        project_urls = {
-                'Documentation': 'https://gitflic.ru/project/babaev-an/anb-python-components/wiki',
-                'Source': 'https://gitflic.ru/project/babaev-an/anb-python-components',
-                'Tracker': 'https://gitflic.ru/project/babaev-an/anb-python-components/issue?page=0',
-                },
-        zip_safe = False,
-        )