summaryrefslogtreecommitdiffstats
path: root/templates
diff options
context:
space:
mode:
Diffstat (limited to 'templates')
-rw-r--r--templates/html.jinja20
-rw-r--r--templates/md.jinja2306
l---------[-rw-r--r--]templates/text.jinja2bin28 -> 10 bytes
-rw-r--r--templates/txt.jinja238
4 files changed, 196 insertions, 148 deletions
diff --git a/templates/html.jinja2 b/templates/html.jinja2
deleted file mode 100644
index e69de29..0000000
--- a/templates/html.jinja2
+++ /dev/null
diff --git a/templates/md.jinja2 b/templates/md.jinja2
index f998f7c..e1d95ca 100644
--- a/templates/md.jinja2
+++ b/templates/md.jinja2
@@ -1,142 +1,166 @@
-{%- 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 "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 -%}
-{%- 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 md_show_all_regex_occurrences == "True" and len_(results) > 0 %}
- - Occurrences list:
-{%- for result in results %}
- - `{{ result }}`
-{%- endfor -%}
-{%- if txt_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("\n", "") }}
-```
+{%- 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 }}`
+{%- 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"] }}
+```
{%- endif -%} \ No newline at end of file
diff --git a/templates/text.jinja2 b/templates/text.jinja2
index eca6ebd..aad87bd 100644..120000
--- a/templates/text.jinja2
+++ b/templates/text.jinja2
Binary files differ
diff --git a/templates/txt.jinja2 b/templates/txt.jinja2
index 5ca0c62..0d31047 100644
--- a/templates/txt.jinja2
+++ b/templates/txt.jinja2
@@ -69,17 +69,17 @@ Report generated at {{ get_datetime() }}
{%- if files_contents["documentation"]["comments"] == "None" %}
*** No comments present ***
{%- else %}
- ```
- {{ files_contents["documentation"]["comments"]|indent(8, False) }}
- ```
+ ```
+ {{ files_contents["documentation"]["comments"]|indent(16, False) }}
+ ```
{%- endif %}
Docstring:
{%- if files_contents["documentation"]["doc"] == "None" %}
*** No docstring present ***
{%- else %}
- ```
- {{ files_contents["documentation"]["doc"]|indent(8, False) }}
- ```
+ ```
+ {{ files_contents["documentation"]["doc"]|indent(16, False) }}
+ ```
{%- endif -%}
{%- endif %}
{%- if "classes" in files_contents.keys() %}
@@ -87,6 +87,27 @@ Report generated at {{ get_datetime() }}
{%- set flat_classes = flatten_struct(files_contents["classes"]) -%}
{% for class_name, class_contents in flat_classes.items() %}
{{ class_name + ":" }}
+ {%- if class_contents["present"] %}
+ Documentation:
+ {{ len_documentation(class_contents["documentation"]["comments"], class_contents["documentation"]["doc"]) }} characters long
+ {%- if txt_show_full_docs == "True" %}
+ Comments:
+ {%- if class_contents["documentation"]["comments"] == "None" %}
+ *** No comments present ***
+ {%- else %}
+ ```
+ {{ class_contents["documentation"]["comments"]|indent(16, False) }}
+ ```
+ {%- endif %}
+ Docstring:
+ {%- if class_contents["documentation"]["doc"] == "None" %}
+ *** No docstring present ***
+ {%- else %}
+ ```
+ {{ class_contents["documentation"]["doc"]|indent(16, False) }}
+ ```
+ {%- endif -%}
+ {%- endif %}
{%- if "methods" in class_contents.keys() %}
Methods:
{%- set flat_methods = flatten_struct(class_contents["methods"]) -%}
@@ -94,6 +115,9 @@ Report generated at {{ get_datetime() }}
{{ expand_function(method_name, method_contents, "Method")|indent(20, False) }}
{%- endfor -%}
{%- endif -%}
+ {%- else %}
+ *** Class not present ***
+ {%- endif -%}
{%- endfor -%}
{%- endif -%}
{% if "functions" in files_contents.keys() %}
@@ -140,5 +164,5 @@ Report generated at {{ get_datetime() }}
{% endfor %}
{% if out != "stdout" -%}
-{{ test_results["pytest_report"].replace("\n", "") }}
+{{ test_results["pytest_report"] }}
{%- endif -%} \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-31 11:55:56 +0000