Merge pull request #105 from moevm/develop

Develop to main merge 3 iteration end

Author: NaGIBIN-IGOR

.github/images/success.png

@@ -0,0 +1,15 @@
+FROM python:3.13.2-slim-bookworm
+
+WORKDIR /app
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends git build-essential && \
+    apt-get purge -y --auto-remove && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY build build
+
+ENTRYPOINT [ "python", "build/build.py" ]

Dockerfile

@@ -16,42 +16,7 @@
 XML_TEMPLATE_PATH = ROOT / 'build' / 'template.xml'
 
 
-# Очистка папки вывода
-if OUTPUT_PATH.exists():
-    for file in OUTPUT_PATH.iterdir():
-        if file.is_dir():
-            shutil.rmtree(file)
-        else:
-            file.unlink()
-else:
-    OUTPUT_PATH.mkdir(parents=True, exist_ok=True)
-
-
-# Получение base64 от zip-архива всех файлов проекта
-sources = [*SOURCE_PATH.glob('**/*.py')]
-
-bundle_tempfile = tempfile.NamedTemporaryFile(delete=False)
-
-with zipfile.ZipFile(bundle_tempfile.name, 'w', zipfile.ZIP_DEFLATED) as bundle_file:
-    for file in sources:
-        bundle_file.write(file, file.relative_to(SOURCE_PATH))
-
-with open(bundle_tempfile.name, 'rb') as f:
-    bundle_base64 = base64.b64encode(f.read()).decode('ascii')
-
-bundle_tempfile.close()
-os.unlink(bundle_tempfile.name)
-
-
-# Загрузка xml-шаблона вопроса и создание записи об zip-архиве
-with XML_TEMPLATE_PATH.open('r', encoding='utf-8') as xml_file:
-    xml_parser = xml.XMLParser(strip_cdata=False)
-    xml_template = xml.parse(xml_file, xml_parser)
-
-xml_template.xpath('//file')[0].text = bundle_base64
-
-
-# Класс извлечения узла аргументов из конструктора класса и именя вопроса
+# Класс извлечения узла аргументов из конструктора класса и имени задачи
 class InternalQuestionDataExtractor(ast.NodeVisitor):
     def visit_FunctionDef(self, node):
         if node.name != '__init__':
@@ -96,58 +61,98 @@ def extract(self, node: ast.AST) -> tuple[str | None, ast.arguments | None]:
         return self.class_name, self.arguments_node, self.question_name
 
 
-# Шаблоны кода, внедряемого в xml-файл
-parameters_code_template = r'''import sys
+if __name__ == '__main__':
+    # Очистка папки вывода
+    if OUTPUT_PATH.exists():
+        for file in OUTPUT_PATH.iterdir():
+            if file.is_dir():
+                shutil.rmtree(file)
+            else:
+                file.unlink()
+    else:
+        OUTPUT_PATH.mkdir(parents=True, exist_ok=True)
+
+
+    # Получение base64 от zip-архива всех файлов проекта
+    sources = [*SOURCE_PATH.glob('**/*.py')]
+
+    bundle_tempfile = tempfile.NamedTemporaryFile(delete=False)
+
+    with zipfile.ZipFile(bundle_tempfile.name, 'w', zipfile.ZIP_DEFLATED) as bundle_file:
+        for file in sources:
+            bundle_file.write(file, file.relative_to(SOURCE_PATH))
+
+    with open(bundle_tempfile.name, 'rb') as f:
+        bundle_base64 = base64.b64encode(f.read()).decode('ascii')
+
+    bundle_tempfile.close()
+    os.unlink(bundle_tempfile.name)
+
+
+    # Загрузка xml-шаблона задачи и создание записи об zip-архиве
+    with XML_TEMPLATE_PATH.open('r', encoding='utf-8') as xml_file:
+        xml_parser = xml.XMLParser(strip_cdata=False)
+        xml_template = xml.parse(xml_file, xml_parser)
+
+    xml_template.xpath('//file')[0].text = bundle_base64
+
+
+    # Шаблоны кода, внедряемого в xml-файл
+    parameters_code_template = r'''import sys
 sys.path.insert(0, 'bundle.zip')
 from prog_questions import {class_name}
 
 question = {constructor_code}
 print(question.getTemplateParameters())
-'''
+    '''
 
-code_template = r'''import sys
+    code_template = r'''import sys
 sys.path.insert(0, 'bundle.zip')
 from prog_questions import {class_name}
 
 question = {class_name}.initWithParameters("""{{{{ PARAMETERS | e('py') }}}}""")
-print(question.test("""{{{{ STUDENT_ANSWER | e('py') }}}}"""))
-'''
+print(question.runTest("""{{{{ STUDENT_ANSWER | e('py') }}}}"""))
+    '''
+
 
+    # Проверка для всех файлов проекта
+    for file in sources:
+        # Получение информации о классе задачи из файла
+        question_class, question_arguments, question_name = QuestionDataExtractor().extract(ast.parse(file.read_text(encoding='utf-8')))
 
-# Проверка для всех файлов проекта
-for file in sources:
-    # Получение информации о классе вопроса из файла
-    question_class, question_arguments, question_name = QuestionDataExtractor().extract(ast.parse(file.read_text(encoding='utf-8')))
+        # Если в файле нет класса задачи - пропускаем
+        if question_class is None:
+            continue
 
-    # Если в файле нет класса вопроса - пропускаем
-    if question_class is None:
-        continue
+        # Конвертация узла arguments в массив keyword
+        keywords = [ast.keyword(arg='seed', value=ast.Constant(value=Ellipsis))]
 
-    # Конвертация узла arguments в массив keyword
-    keywords = []
+        if question_arguments is not None:
+            for kw_name, kw_value in zip(question_arguments.kwonlyargs, question_arguments.kw_defaults):
+                if kw_name.arg == 'seed':
+                    continue
 
-    if question_arguments is not None:
-        for kw_name, kw_value in zip(question_arguments.kwonlyargs, question_arguments.kw_defaults):
-            if kw_name.arg == 'seed':
-                continue
+                kw_name.annotation = None
+                keywords.append(ast.keyword(arg=kw_name, value=kw_value))
 
-            kw_name.annotation = None
-            keywords.append(ast.keyword(arg=kw_name, value=kw_value))
+        # Создание куска кода с вызовом initTemplate со стандартными параметрами (полученными из кода конструктора)
+        call_node = ast.Call(func=ast.Attribute(value=ast.Name(id=question_class), attr='initTemplate'), args=[], keywords=keywords)
+        constructor_code = astor.to_source(call_node).rstrip()
 
-    # Создание куска кода с вызовом initTemplate со стандартными параметрами (полученными из кода конструктора)
-    call_node = ast.Call(func=ast.Attribute(value=ast.Name(id=question_class), attr='initTemplate'), args=[], keywords=keywords)
-    constructor_code = astor.to_source(call_node).rstrip()
+        # Подстановка в шаблоны кода
+        parameters_code = parameters_code_template.format(class_name=question_class, constructor_code=constructor_code).lstrip()
+        code = code_template.format(class_name=question_class).lstrip()
 
-    # Подстановка в шаблоны кода
-    parameters_code = parameters_code_template.format(class_name=question_class, constructor_code=constructor_code).lstrip()
-    code = code_template.format(class_name=question_class).lstrip()
+        # Модификация xml-шаблона
+        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)
 
-    # Модификация xml-шаблона
-    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)
+        # Запись в файл и вывод в консоль
+        xml_output_path = OUTPUT_PATH / f'{question_class}.xml'
+        xml_template.write(xml_output_path, xml_declaration=True, encoding='utf-8')
 
-    # Запись в файл и вывод в консоль
-    xml_output_path = OUTPUT_PATH / f'{question_class}.xml'
-    xml_template.write(xml_output_path, xml_declaration=True, encoding='utf-8')
-    print(xml_output_path)
+    # Вывод информации о собранных задачах
+    print("Задачи успешно собраны:")
+    for built_file in OUTPUT_PATH.glob('*.xml'):
+        print(built_file.name)

README.md

@@ -28,15 +28,15 @@
         <useace></useace>
         <resultcolumns></resultcolumns>
         <template></template>
-        <iscombinatortemplate>0</iscombinatortemplate>
+        <iscombinatortemplate/>
         <allowmultiplestdins></allowmultiplestdins>
         <answer></answer>
         <validateonsave>1</validateonsave>
         <testsplitterre></testsplitterre>
         <language></language>
         <acelang>c</acelang>
         <sandbox></sandbox>
-        <grader></grader>
+        <grader>TemplateGrader</grader>
         <cputimelimitsecs></cputimelimitsecs>
         <memlimitmb></memlimitmb>
         <sandboxparams></sandboxparams>

build/build.py

@@ -1,6 +1,8 @@
 from abc import ABC, abstractmethod
+from types import EllipsisType
 import sys
 import json
+from .utility import CommentMetric
 
 
 class QuestionBase(ABC):
@@ -14,15 +16,17 @@ def __init__(self, *, seed: int, **parameters):
         self.parameters = parameters
 
     @classmethod
-    def initTemplate(cls, **parameters):
+    def initTemplate(cls, *, seed: int | EllipsisType | None = None, **parameters):
         '''
         Инициализация в параметрах шаблона Twig
+        seed - сид вопроса. Если равен None или Ellipsis, то берётся тот, что предоставляет Moodle.
         parameters - любые параметры, необходимые для настройки (сложность, въедливость и т.п.).
         Ввиду особенностей coderunner и простоты реализации, параметры могут быть типами,
         поддерживающимися JSON (int, float, str, bool, None, array, dict)
         '''
-        stdinData = { parameter.split('=')[0]: parameter.split('=')[1] for parameter in sys.argv[1:] }
-        seed = int(stdinData['seed'])
+        if seed is None or seed is Ellipsis:
+            argvData = { parameter.split('=')[0]: parameter.split('=')[1] for parameter in sys.argv[1:] }
+            seed = int(argvData['seed'])
 
         return cls(seed=seed, **parameters)
 
@@ -70,3 +74,22 @@ def test(self, code: str) -> str:
         Если всё хорошо - вернуть "OK"
         '''
         ...
+
+    def runTest(self, code: str) -> str:
+        '''
+        Запуск проверки кода и подсчёта процента коментариев в коде
+        code - код, отправленный студентом на проверку
+        Возвращаемое значение - JSON в виде строки для отображения результата шаблону-комбинатору
+        '''
+        result = self.test(code)
+        success = result == 'OK'
+        output = {
+            'fraction': 1.0 if success else 0.0,
+            'testresults': [['iscorrect', 'Тест', 'Ожидаемый', 'Получено', 'iscorrect'], [success, '#1', 'OK', result, success]],
+        }
+
+        if success:
+            commentsPercent = CommentMetric(code).get_comment_percentage()
+            output['epiloguehtml'] = f'<p>Процент комментариев: {commentsPercent}%</p>'
+
+        return json.dumps(output)