Merge branch 'develop'

Author: NaGIBIN-IGOR

README.md

@@ -14,7 +14,7 @@ python build/build.py
 
 После сборки необходимо импортировать XML файл в систему Moodle.
 
-Для этого нужно перейти в *режим редактирования*, после нажать *Добавитьэлемент или ресурс*, выбрать *Тест*, ввести необходимые настройки в частности *Название*.
+Для этого нужно перейти в *режим редактирования*, после нажать *Добавить элемент или ресурс*, выбрать *Тест*, ввести необходимые настройки в частности *Название*.
 
 После создания теста переходим в вкладку *Банк вопросов*, в выпадающем списке с названием *Вопросы* выбираем импорт, выбираем формат *Формат Moodle XML* и загружаем XML-файл
 
@@ -94,9 +94,9 @@ class PrintSeedQuestion(QuestionBase):
 ## Класс `QuestionRandomCondition`
 Класс обёртки для задания изменения массива по случайному условию.
 
-### Методы экземпляра класса:
+### Методы класса:
 
-- `__init__(self, *, seed: int, condition_length: int, array_length: int, strictness: float)` - метод инициализации экземпляра.
+- `__init__(self, *, seed: int, condition_length: int, array_length: int, strictness: float)` - метод инициализации
 
 * `seed` - случайное зерно, используемое для воспроизводимости результатов псевдослучайной генерации случайных значений;
 * `condition_length` - целое число, указывающее длину условия (количество операндов в генерируемом условии);
@@ -164,20 +164,69 @@ class PrintSeedQuestion(QuestionBase):
 
 В случае возникновения ошибки выполнение остальных тестов заканчивается и возвращается соответствующая полученной ошибке строка. Если все тесты выполнены корректно - метод возвращает строку `OK`.
 
-### Свойства экземпляра класса:
+### Свойства класса:
 
 - `questionName: str` - название вопроса.
 
 - `questionText: str` - задание/текст вопроса.
 
 - `preloadedCode: str` - код, который подгружается в поле редактирования кода.
 
+## Класс `QuestionRandomExpression`
+
+Класс для генерации и тестирования задач на вычисление выражений с использованием случайных данных.
+
+### Методы класса
+
+- `__init__(self, *, seed: int, vars=['x', 'y', 'z', 'w'], operations=['+', '-', '*', '&', '|'], length=5, minuses_threshold=0, brackets_treshold=0, minus_symbol="-", all_variables=False, strictness=0)` - Метод инициализации экземпляра.
+  - **seed**: Сид для генерации случайных данных.
+  - **vars**: Список переменных для генерации выражений (по умолчанию `['x', 'y', 'z', 'w']`).
+  - **operations**: Допустимые операции для выражений (по умолчанию `['+', '-', '*', '&', '|']`).
+  - **length**: Длина генерируемого выражения (по умолчанию `5`).
+  - **minuses_threshold**: Порог для использования унарных минусов (в диапазоне `[0; 1]`, по умолчанию `0`).
+  - **brackets_treshold**: Порог для генерации скобок (в диапазоне `[0; 1]`, по умолчанию `0`).
+  - **minus_symbol**: Символ для отображения минуса (по умолчанию `"-"`).
+  - **all_variables**: Флаг обязательного использования всех переменных (по умолчанию `False`).
+  - **strictness**: Уровень строгости проверки (в диапазоне `[0; 1]`, влияет на количество тестов).
+
+
+- `generate_c_code(self)`
+Генерирует код на языке C для вычисления сгенерированного выражения.
+
+Возвращает строку с кодом на языке C.
+
+- `test(self, code: str) -> str`
+Организует тестирование переданного кода.
+
+- **code**: Код, который необходимо протестировать.
+
+Возвращает одну из строк:
+- `"OK"` — если код прошел все тесты.
+- `"Ошибка компиляции"` — если код не компилируется.
+- `"Ошибка выполнения [{exit_code}]: {error}"` — если код завершился с ошибкой выполнения.
+- Сообщение об ошибке теста с описанием входных данных и ожидаемого результата.
+
+### Свойства класса
+
+- `preloadedCode: str`
+Код, который подгружается в поле редактирования кода.
+
+- `questionText: str`
+Текст задания. Генерируется автоматически и включает:
+    - Условие задачи.
+    - Формат ввода и вывода.
+    - Пример входных и выходных данных.
+
+- `questionExpression: str`
+Генерируемое выражение для задачи. Использует заданные переменные, операции и параметры генерации.
+
+
 ## Класс `QuestionStringOperations`
 Класс обёртки для задания применения заданных операций к строке.
 
-### Методы экземпляра класса:
+### Методы класса:
 
-- `__init__(self, *, seed: int, num_operations: int, min_length: int, max_length: int, strictness: float)` - метод инициализации экземпляра.
+- `__init__(self, *, seed: int, num_operations: int, min_length: int, max_length: int, strictness: float)` - метод инициализации класса.
 
 * `seed` - случайное зерно, используемое для воспроизводимости результатов псевдослучайной генерации случайных операций, строк и тестов;
 * `num_operations` - целое число, указывающее количество операций задания;
@@ -225,7 +274,7 @@ class PrintSeedQuestion(QuestionBase):
 * `Ошибка выполнения (код {e.exit_code}): {e}` - если код студента заврешился ошибкой выполнения.
 
 
-### Свойства экземпляра класса:
+### Свойства класса:
 
 - `questionName: str` - название вопроса.
 
@@ -261,12 +310,13 @@ class PrintSeedQuestion(QuestionBase):
 * `message` - сообщение об ошибке
 * `exit_code` - код завершения программы
 
-### Вспомогательный класс `ExitCodeHandler`:
+## Вспомогательный класс `ExitCodeHandler`:
 Класс для обработки кодов завершения и сигналов.
 
-Методы класса:
+### Методы класса:
 
 - `get_exit_message(self, exit_code) -> str` - преобразует код завершения в текстовое сообщение
+
 * `exit_code` - код завершения программы
 * *Возвращаемое значение* - текстовое описание кода завершения
 

build/build.py

@@ -51,18 +51,31 @@
 xml_template.xpath('//file')[0].text = bundle_base64
 
 
-# Класс извлечения узла аргументов из конструктора класса
-class InitArgumentsExtractor(ast.NodeVisitor):
+# Класс извлечения узла аргументов из конструктора класса и именя вопроса
+class InternalQuestionDataExtractor(ast.NodeVisitor):
     def visit_FunctionDef(self, node):
         if node.name != '__init__':
             return
 
         self.arguments_node = node.args
 
+    def visit_Assign(self, node):
+        if len(node.targets) < 1 or not isinstance(node.targets[0], ast.Name) or node.targets[0].id != 'questionName' or not isinstance(node.value, ast.Constant):
+            return
+
+        self.question_name = node.value.value
+
+    def visit_AnnAssign(self, node):
+        if not isinstance(node.target, ast.Name) or node.target.id != 'questionName' or not isinstance(node.value, ast.Constant):
+            return
+
+        self.question_name = node.value.value
+
     def extract(self, node: ast.AST) -> ast.arguments | None:
         self.arguments_node = None
+        self.question_name = None
         self.visit(node)
-        return self.arguments_node
+        return self.arguments_node, self.question_name
 
 # Класс извлечения названия класса и узла аргументов конструктора класса для потомков QuestionBase
 class QuestionDataExtractor(ast.NodeVisitor):
@@ -72,14 +85,15 @@ def visit_ClassDef(self, node):
 
         self.class_name = node.name
 
-        arguments_extractor = InitArgumentsExtractor()
-        self.arguments_node = arguments_extractor.extract(node)
+        arguments_extractor = InternalQuestionDataExtractor()
+        self.arguments_node, self.question_name = arguments_extractor.extract(node)
 
     def extract(self, node: ast.AST) -> tuple[str | None, ast.arguments | None]:
         self.class_name = None
         self.arguments_node = None
+        self.question_name = None
         self.visit(node)
-        return self.class_name, self.arguments_node
+        return self.class_name, self.arguments_node, self.question_name
 
 
 # Шаблоны кода, внедряемого в xml-файл
@@ -103,7 +117,7 @@ def extract(self, node: ast.AST) -> tuple[str | None, ast.arguments | None]:
 # Проверка для всех файлов проекта
 for file in sources:
     # Получение информации о классе вопроса из файла
-    question_class, question_arguments = QuestionDataExtractor().extract(ast.parse(file.read_text(encoding='utf-8')))
+    question_class, question_arguments, question_name = QuestionDataExtractor().extract(ast.parse(file.read_text(encoding='utf-8')))
 
     # Если в файле нет класса вопроса - пропускаем
     if question_class is None:
@@ -129,7 +143,7 @@ def extract(self, node: ast.AST) -> tuple[str | None, ast.arguments | None]:
     code = code_template.format(class_name=question_class).lstrip()
 
     # Модификация xml-шаблона
-    xml_template.xpath('//question/name/text')[0].text = question_class
+    xml_template.xpath('//question/name/text')[0].text = xml.CDATA(question_name)
     xml_template.xpath('//templateparams')[0].text = xml.CDATA(parameters_code)
     xml_template.xpath('//template')[0].text = xml.CDATA(code)
 

src/prog_questions/QuestionBase.py

@@ -4,6 +4,11 @@
 
 
 class QuestionBase(ABC):
+    questionName: str = ''
+    '''
+    Название вопроса
+    '''
+
     def __init__(self, *, seed: int, **parameters):
         self.seed = seed
         self.parameters = parameters
@@ -34,21 +39,12 @@ def getTemplateParameters(self) -> str:
         Возвращает параметры в формате JSON для шаблонизатора Twig
         '''
         return json.dumps({
-            'QUESTION_NAME': self.questionName,
             'QUESTION_TEXT': self.questionText,
             'PRELOADED_CODE': self.preloadedCode,
             'SEED': self.seed,
             'PARAMETERS': json.dumps(self.parameters | { 'seed': self.seed }),
         })
 
-    @property
-    @abstractmethod
-    def questionName(self) -> str:
-        '''
-        Название вопроса
-        '''
-        ...
-
     @property
     @abstractmethod
     def questionText(self) -> str:

src/prog_questions/QuestionRandomCondition.py

@@ -73,14 +73,15 @@
 """
 
 class QuestionRandomCondition(QuestionBase):
+    questionName = "Случайное условие"
 
-    """
-    :param seed: Seed для воспроизводимости тестов.
-    :param condition_length: Длина условия задачи.
-    :param array_length: Длина массива данных.
-    :param strictness: Параметр для регулирования количества случайных тестов (0.0 - минимум, 1.0 - максимум).
-    """
     def __init__(self, *, seed: int, condition_length: int=4, array_length: int=10, strictness: float=1):
+        """
+        :param seed: Seed для воспроизводимости тестов.
+        :param condition_length: Длина условия задачи.
+        :param array_length: Длина массива данных.
+        :param strictness: Параметр для регулирования количества случайных тестов (0.0 - минимум, 1.0 - максимум).
+        """
         super().__init__(seed=seed, condition_length=condition_length, array_length=array_length, strictness=strictness)
         self.task = Task(array_length, condition_length, seed)
         self.parse(self.task.text)
@@ -97,10 +98,6 @@ def __init__(self, *, seed: int, condition_length: int=4, array_length: int=10,
         )
         self.expected_output_runner = CProgramRunner(self.example_solution)
 
-    @property
-    def questionName(self) -> str:
-        return "Случайное условие"
-
     @property
     def questionText(self) -> str:
         cleaned_text = dedent(BASE_TEXT)

src/prog_questions/QuestionRandomExpression.py

@@ -11,7 +11,7 @@
 
 
 class QuestionRandomExpression(QuestionBase):
-    """Демонстрационный класс, реализующий задачу сложения чисел"""
+    questionName = "Вычисление выражения"
 
     def __init__(self, *, seed: int, vars=['x','y','z','w'], operations=['+','-','*','&','|'], length=5,
                  minuses_threshold=0,
@@ -49,10 +49,6 @@ def __init__(self, *, seed: int, vars=['x','y','z','w'], operations=['+','-','*'
         self.max_space_number = 15
         self.space_amount = self.min_space_number + self.strictness * (self.max_space_number - self.min_space_number)
 
-    @property
-    def questionName(self) -> str:
-        return f"Сложение чисел"
-
     def generate_c_code(self):
         # Сортируем переменные в алфавитном порядке
         sorted_vars = sorted(self.vars)

src/prog_questions/QuestionStringOperations.py

@@ -45,25 +45,23 @@
 
 
 class QuestionStringOperations(QuestionBase):
-    """
-    :param seed: Seed для воспроизводимости тестов.
-    :param num_operations: количество операций задачи.
-    :param min_length: минимальная длина входных данных.
-    :param max_length: максимальная длина входных данных.
-    :param strictness: Параметр для регулирования количества случайных тестов (0.0 - минимум, 1.0 - максимум).
-    """
+    questionName = 'Операции над строками'
+
     def __init__(self, *, seed: int, num_operations: int=3, min_length: int=30, max_length: int=100, strictness: float=1):
+        """
+        :param seed: Seed для воспроизводимости тестов.
+        :param num_operations: количество операций задачи.
+        :param min_length: минимальная длина входных данных.
+        :param max_length: максимальная длина входных данных.
+        :param strictness: Параметр для регулирования количества случайных тестов (0.0 - минимум, 1.0 - максимум).
+        """
         super().__init__(seed=seed, num_operations=num_operations,
                          min_length=min_length, max_length=max_length, strictness=strictness)
         self.strictness = strictness
         self.operations = generate_operations(seed, num_operations)
         self.min_length = min_length
         self.max_length = max_length
 
-    @property
-    def questionName(self) -> str:
-        return "Операции над строками"
-
     @property
     def questionText(self) -> str:
         dedent_question_text = dedent(QUESTION_TEXT)
@@ -80,7 +78,7 @@ def noise_input_string(self, input_string: str):
         if self.strictness == 0.0 or len(input_string) >= self.max_length:
             return input_string
 
-        noise_chars = "!@#$%^&*()[]{}/?|~ "
+        noise_chars = "!@#$%^&*()[]{}/?|~"
         noise_level = int(self.strictness * 10)
 
         words = input_string.split(" ")

tests/README.md

@@ -45,9 +45,9 @@ class TestQuestionSum:
 
 ### Функции:
 
-`moodleInit(questionClass: type[QuestionBase], *, seed: int, **parameters) -> QuestionBase` - создаёт экземпляр класса `questionClass` с эмуляцией пробрасывания параметров, как если бы это было заинтегрировано в moodle
+- `moodleInit(questionClass: type[QuestionBase], *, seed: int, **parameters) -> QuestionBase` - создаёт экземпляр класса `questionClass` с эмуляцией пробрасывания параметров, как если бы это было заинтегрировано в moodle
 
- - `questionClass` - **тип** класса вопроса, экземпляр которого будет создаваться
- - `seed` - сид, с которым будет создаваться вопрос
- - `parameters` - параметры, с которыми будет создаваться вопрос
- - *Возвращаемое значение* - созданный экземпляр класса
+    - `questionClass` - **тип** класса вопроса, экземпляр которого будет создаваться
+    - `seed` - сид, с которым будет создаваться вопрос
+    - `parameters` - параметры, с которыми будет создаваться вопрос
+    - *Возвращаемое значение* - созданный экземпляр класса