From 12ac9bd354c664978523547ffac9bbebf0fcb577 Mon Sep 17 00:00:00 2001 From: jwansek Date: Fri, 22 Apr 2022 16:02:28 +0100 Subject: Moved and adapted to move folder, added rendering to pdfs --- templates/md.jinja2 | 166 ---------------------------------------------------- 1 file changed, 166 deletions(-) delete mode 100644 templates/md.jinja2 (limited to 'templates/md.jinja2') diff --git a/templates/md.jinja2 b/templates/md.jinja2 deleted file mode 100644 index e764a49..0000000 --- a/templates/md.jinja2 +++ /dev/null @@ -1,166 +0,0 @@ -{%- macro expand_function(function_name, function_contents, x = "Function") -%} - - `{{ function_name }}`: -{%- if function_contents["present"] %} - - **Arguments:** - - `{{ function_contents["arguments"] }}` - - {{ bool_to_checkbox(function_contents["minimum_arguments"] >= get_required_num_args(function_name)) }} Enough? - - **Documentation**: - - {{ len_documentation(function_contents["documentation"]["comments"], function_contents["documentation"]["doc"]) }} characters long -{%- if md_show_full_docs == "True" %} - - Comments: - {%- if function_contents["documentation"]["comments"] == "None" %} - - [ ] No comments present -{%- else %} -{{ code_block(function_contents["documentation"]["comments"])|indent(12, True) }} -{%- endif %} - - Docstring: -{%- if function_contents["documentation"]["doc"] == "None" %} - - [ ] No docstring present -{%- else %} -{{ code_block(function_contents["documentation"]["doc"])|indent(12, True) }} -{%- endif -%} -{%- endif %} - - **Source**: - - {{ get_source_numlines(function_contents["source_code"]) }} -{%- if md_show_source == "True" %} - - Code: -{{ code_block(function_contents["source_code"])|indent(12, True) }} -{%- endif %} -{%- else %} - - [ ] {{ x }} not present -{%- endif %} -{%- endmacro -%} - -{%- macro code_block(code) -%} -``` -{{ code }} -``` -{%- endmacro -%} - -# {{ name }} - Student ID: {{ student_no }} Automatic marking report -Report generated at {{ get_datetime() }} -## Class Tree: - -``` -{{ recurse_class_tree_text(class_tree) }} -``` - -## File Analysis - -{%- set flat_files = flatten_struct(files) %} -{% for filename, files_contents in flat_files.items() %} -### File `{{ filename }}`: -{%- if files_contents["present"] -%} -{%- if files_contents["has_exception"] %} -*** File cannot be run - has compile time exception *** -Please note that this file cannot be analysed or have tests preformed upon it- - this can lead to the whole test suite failing if another module imports this. - - Exception Type: `{{ files_contents["exception"]["type"] }}` - - Exception String: `{{ files_contents["exception"]["str"] }}` - - Full Traceback: -``` -{{ files_contents["exception"]["traceback"] }} -``` -{%- else %} - - #### Documentation: - {%- set len_docs = len_documentation(files_contents["documentation"]["comments"], files_contents["documentation"]["doc"]) %} - - {{ len_docs }} characters long -{%- if md_show_full_docs == "True" %} - - ##### Comments: -{%- if files_contents["documentation"]["comments"] == "None" %} - - [ ] No comments present -{%- else %} -{{ code_block(files_contents["documentation"]["comments"])|indent(8, True) }} -{%- endif %} - - ##### Docstring: -{%- if files_contents["documentation"]["doc"] == "None" %} - - [ ] No docstring present -{%- else %} -{{ code_block(files_contents["documentation"]["doc"])|indent(8, True) }} -{%- endif -%} -{%- endif %} -{%- if "classes" in files_contents.keys() %} - - #### Classes: -{%- set flat_classes = flatten_struct(files_contents["classes"]) -%} -{% for class_name, class_contents in flat_classes.items() %} - - ##### `{{ class_name}}`: -{%- if class_contents["present"] %} - - ###### Documentation: - {%- set len_docs = len_documentation(class_contents["documentation"]["comments"], class_contents["documentation"]["doc"]) %} - - {{ len_docs }} characters long -{%- if md_show_full_docs == "True" %} - - *Comments*: -{%- if class_contents["documentation"]["comments"] == "None" %} - - [ ] No comments present -{%- else %} -{{ code_block(class_contents["documentation"]["comments"])|indent(20, True) }} -{%- endif %} - - *Docstring*: -{%- if class_contents["documentation"]["doc"] == "None" %} - - [ ] No docstring present -{%- else %} -{{ code_block(class_contents["documentation"]["doc"])|indent(20, True) }} -{%- endif -%} -{%- endif %} -{%- if "methods" in class_contents.keys() %} - - ###### Methods: -{%- set flat_methods = flatten_struct(class_contents["methods"]) -%} -{%- for method_name, method_contents in flat_methods.items() %} -{{ expand_function(method_name, method_contents, "Method")|indent(16, True) }} -{%- endfor -%} -{%- endif -%} -{%- else %} - - [ ] Class not present -{%- endif -%} -{%- endfor -%} -{%- endif -%} -{% if "functions" in files_contents.keys() %} - - #### Functions: -{%- set flat_functions = flatten_struct(files_contents["functions"]) %} -{%- for function_name, function_contents in flat_functions.items() %} -{{ expand_function(function_name, function_contents)|indent(8, True) }} -{%- endfor -%} -{%- endif -%} -{% if "run" in files_contents.keys() %} - - #### Runtime Analysis: -{%- set flat_runtime = flatten_struct(files_contents["run"]) %} -{%- for cmd, runtime_contents in flat_runtime.items() %} - - ##### Command `{{ cmd }}`: - - **Monitor:** -{%- if "monitor" in runtime_contents.keys() %} - - {{ runtime_contents["monitor"] }} -{%- else %} - - stdout -{%- endif %} - - **Regexes:** -{%- for regex_, results in runtime_contents["regexes"].items() %} - - `{{regex_}}`: - - Found occurrences: {{ len_(results) }} -{%- if code_block(runtime_contents["full_output"]) == "*** File not produced ***" %} - - *** File was not produced- no occurrences *** -{%- endif -%} -{%- if md_show_all_regex_occurrences == "True" and len_(results) > 0 %} - - Occurrences list: -{%- for result in results %} - - `{{ result.replace("\n", "\\n") }}` -{%- endfor -%} -{%- if md_show_all_run_output == "True" %} - - Full runtime output: -{{ code_block(runtime_contents["full_output"])|indent(24, True) }} -{%- endif -%} -{%- endif -%} -{%- endfor -%} -{%- endfor -%} -{%- endif -%} -{%- endif -%} -{% else %} - - [ ] File not present -{% endif %} -{% endfor %} - -{% if out != "stdout" and format != "html" -%} -## Tests: -``` -{{ test_results["pytest_report"].replace("\r", "") }} -``` -{%- endif -%} \ No newline at end of file -- cgit v1.2.3