Skip to content

Modify PyTA report messages #1356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
david-yz-liu merged 20 commits into from
Jun 19, 2026
Merged

Modify PyTA report messages #1356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9919094
modify plaintext PyTA Report messages
rachelzUT Jun 12, 2026
957b250
modify html report's 'good job' message
rachelzUT Jun 12, 2026
480edbf
edited HTML report template with new logic
rachelzUT Jun 12, 2026
dad99a0
updated changelog
rachelzUT Jun 12, 2026
87e60a7
added style for the no errors message
rachelzUT Jun 12, 2026
351d439
updated html report test, used monkeypatch for random emojis
rachelzUT Jun 12, 2026
ccb48cd
updated html report tests
rachelzUT Jun 12, 2026
f297c2e
Merge branch 'master' of https://github.com/pyta-uoft/pyta into modif…
rachelzUT Jun 12, 2026
e9d6535
updated html reporter emojis
rachelzUT Jun 12, 2026
395c705
revert tests
rachelzUT Jun 13, 2026
b6f9576
updated changelog
rachelzUT Jun 13, 2026
c48e7dc
edit html tests
rachelzUT Jun 13, 2026
a189f83
fixed blank lines
rachelzUT Jun 13, 2026
0409788
edited template indentation
rachelzUT Jun 13, 2026
18765a8
fixed template indentation issues
rachelzUT Jun 13, 2026
e27fd85
trim leading whitespace
rachelzUT Jun 13, 2026
691b906
updated tests
rachelzUT Jun 13, 2026
5aa0bf3
edited properties to be in alphabetical order
rachelzUT Jun 15, 2026
b491de0
moved emojis list and no_err_message method into core.py
rachelzUT Jun 15, 2026
7c26bec
Merge branch 'master' of https://github.com/pyta-uoft/pyta into modif…
rachelzUT Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/python-ta/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- Updated `SnapshotTracer` to convert snapshots to JSON with `snapshot_to_json` and pass JSON data to the webstepper template instead of SVG.
- Added configuration options for maximum name lengths of each name category in `invalid_name_checker.py`.
- Update configuration options to support `.toml` files
- Updated plain text and HTML PyTA reports to not show sections with no errors and only show 'good job' message once when there are no errors in either section.

### 💫 New checkers

Expand Down
8 changes: 8 additions & 0 deletions packages/python-ta/src/python_ta/reporters/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from __future__ import annotations

import os.path
import random
import sys
from collections import defaultdict
from datetime import datetime
Expand Down Expand Up @@ -70,6 +71,9 @@ class PythonTaReporter(BaseReporter):
_NUM_LENGTH_SPACES = 3
_AFTER_NUM_SPACES = 2

# List of emojis to randomly choose for the no errors message.
NO_ERR_EMOJIS = ["🎉", "🥳", "🌟", "👍", "👏", "😊", "🎊", "🙌", "🕺"]

# The error messages to report, mapping filename to a list of messages.
messages: dict[str, list[Message]]
# Whether the reporter's output stream should be closed out.
Expand All @@ -84,6 +88,10 @@ def __init__(self) -> None:
self.current_file = ""
self.should_close_out = False

def no_err_message(self) -> str:
"""Return the no errors message with a random emoji."""
return "No problems detected, good job! " + random.choice(self.NO_ERR_EMOJIS)

def print_messages(self, level: str = "all") -> None:
"""Print messages for the current file.

Expand Down
1 change: 0 additions & 1 deletion packages/python-ta/src/python_ta/reporters/html_reporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class HTMLReporter(PythonTaReporter):
}
_PRE_LINE_NUM_SPACES = 0

no_err_message = "No problems detected, good job!"
no_snippet = "No code to display for this message."
code_err_title = "Code Errors or Forbidden Usage (fix: high priority)"
style_err_title = "Style or Convention Errors (fix: before submission)"
Expand Down
26 changes: 12 additions & 14 deletions packages/python-ta/src/python_ta/reporters/plain_reporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ class PlainReporter(PythonTaReporter):
_COLOURING = {}
code_err_title = "=== Code errors/forbidden usage (fix: high priority) ==="
style_err_title = "=== Style/convention errors (fix: before submission) ==="
no_err_message = "No problems detected, good job!" + _BREAK * 2
no_snippet = "No code to display for this message." + _BREAK * 2

def print_messages(self, level: str = "all") -> None:
Expand All @@ -35,20 +34,19 @@ def print_messages(self, level: str = "all") -> None:

result = "PyTA Report for: " + self._colourify("bold", self.current_file) + self._BREAK
result += self._generate_report_date_time() + self._BREAK
result += self._colourify("code-heading", self.code_err_title + self._BREAK)
messages_result = self._colour_messages_by_type(error_msgs)
if messages_result:
result += messages_result
else:
result += self.no_err_message

if level == "all":

code_msgs_result = self._colour_messages_by_type(error_msgs)
if code_msgs_result:
result += self._colourify("code-heading", self.code_err_title + self._BREAK)
result += code_msgs_result

style_msgs_result = self._colour_messages_by_type(style_msgs) if level == "all" else ""
if style_msgs_result:
result += self._colourify("style-heading", self.style_err_title + self._BREAK)
messages_result = self._colour_messages_by_type(style_msgs)
if messages_result:
result += messages_result
else:
result += self.no_err_message
result += style_msgs_result

if not code_msgs_result and (not style_msgs_result or level != "all"):
result += self.no_err_message()

@david-yz-liu david-yz-liu Jun 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to also display this message if level == "error" and there are no code messages, even when there are style messages. (This is also true of the HTML Reporter, so please double-check that.)

@rachelzUT rachelzUT Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this change to plain_reporter.py. For the HTML reporter, the level argument doesn't appear to actually be utilized or affect the output, since the report is produced by display_messages which doesn't even accept level as an argument.

pyta/packages/python-ta/src/python_ta/reporters/html_reporter.py

Lines 55 to 60 in 39191ca

def print_messages(self, level="all"):
"""Do nothing to print messages, since all are displayed in a single HTML file."""
def display_messages(self, layout: BaseLayout) -> None:
"""Hook for displaying the messages of the reporter


self.writeln(result)
self.out.flush()
Expand Down
7 changes: 7 additions & 0 deletions packages/python-ta/src/python_ta/reporters/templates/stylesheet.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ header {
}

.main-grid {
column-gap: 3rem;
display: grid;
flex: 1;
grid-template-columns: min-content 1fr;
Expand Down Expand Up @@ -363,6 +364,12 @@ code {
.style-error-id a:link {
}

.no-errors {
font-size: 1.1em;
padding: 25px;
text-align: center;
}

.line-num {
color: var(--text-secondary);
font-size: 90%;
Expand Down
39 changes: 28 additions & 11 deletions packages/python-ta/src/python_ta/reporters/templates/template.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
</div>
<ul>
{% for filenum, (filename, messages) in enumerate(grouped_messages.items()) %}
{% set code_messages = messages[0] -%}
{% set style_messages = messages[1] -%}
{% set has_code_messages = code_messages|length > 0 -%}
{% set has_style_messages = style_messages|length > 0 -%}
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
Expand All @@ -41,7 +45,9 @@
{{os.path.basename(filename)}}
</a>
</span>
{% if has_code_messages or has_style_messages -%}
<ul>
{% if has_code_messages -%}
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
Expand All @@ -53,15 +59,17 @@
<strong>Code Errors or Forbidden Usage</strong>
</span>
<ul>
{% for message_id in messages[0] %}
{% for message_id in code_messages %}
<li>
<a href={{'#{}-{}'.format(filenum, message_id)}}>
{{'{} ({})'.format(message_id, messages[0][message_id][0].symbol)}}
{{'{} ({})'.format(message_id, code_messages[message_id][0].symbol)}}
</a>
</li>
{% endfor %}
</ul>
</li>
{% endif -%}
{% if has_style_messages -%}
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
Expand All @@ -73,27 +81,34 @@
<strong>Style and Convention</strong>
</span>
<ul>
{% for message_id in messages[1] %}
{% for message_id in style_messages %}
<li>
<a href={{'#{}-{}'.format(filenum, message_id)}}>
{{'{} ({})'.format(message_id, messages[1][message_id][0].symbol)}}
{{'{} ({})'.format(message_id, style_messages[message_id][0].symbol)}}
</a>
</li>
{% endfor %}
</ul>
</li>
{%- endif %}
</ul>
{%- endif %}
</li>
{% endfor %}
</ul>
</section>
<main>
{% set limit = reporter.linter.config.pyta_number_of_messages %}
{% for filenum, (filename, messages) in enumerate(grouped_messages.items()) %}
{% set code_messages = messages[0] -%}
{% set style_messages = messages[1] -%}
{% set has_code_messages = code_messages|length > 0 -%}
{% set has_style_messages = style_messages|length > 0 -%}
<section id={{filenum}}>
<div class="section-header">
<h2> {{ filename }} </h2>
</div>
{% if has_code_messages -%}
<article class="error-output code-errors">
<h3 class="category-heading">
<span>{{ reporter.code_err_title }}</span>
Expand All @@ -107,8 +122,8 @@
</span>
</h3>
<div class="content collapsible expanded">
{% for message_id in messages[0] %}
{% set occurrences = messages[0][message_id] %}
{% for message_id in code_messages %}
{% set occurrences = code_messages[message_id] %}
<div class="error-instance" id={{'{}-{}'.format(filenum, message_id)}}>
<div class="info">
{% set mid = message_id.lower() %}
Expand Down Expand Up @@ -165,11 +180,11 @@
{% endfor %}
</div>
</div>
{% else %}
<span class="empty-placeholder">{{ reporter.no_err_message }}</span>
{% endfor %}
</div>
</article>
{% endif -%}
{% if has_style_messages -%}
<article class="error-output style-errors">
<h3 class="category-heading">
<span>{{ reporter.style_err_title }}</span>
Expand All @@ -183,7 +198,7 @@
</span>
</h3>
<div class="content collapsible expanded">
{% for message_id, occurrences in messages[1].items() %}
{% for message_id, occurrences in style_messages.items() %}
<div class="error-instance" id={{'{}-{}'.format(filenum, message_id)}}>
<div class="info">
{% set mid = message_id.lower() %}
Expand Down Expand Up @@ -241,11 +256,13 @@
</div>

</div>
{% else %}
<span class="empty-placeholder">{{ reporter.no_err_message }}</span>
{% endfor %}
</div>
</article>
{%- endif %}
{%- if not has_code_messages and not has_style_messages -%}
<div class="no-errors">{{ reporter.no_err_message() }}</div>
{%- endif %}
</section>
{% endfor %}
</main>
Expand Down
39 changes: 7 additions & 32 deletions ...ta/tests/test_reporters/snapshots/test_html_reporter/test_injection/script_injection.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@
}

.main-grid {
column-gap: 3rem;
display: grid;
flex: 1;
grid-template-columns: min-content 1fr;
Expand Down Expand Up @@ -369,6 +370,12 @@
.style-error-id a:link {
}

.no-errors {
font-size: 1.1em;
padding: 25px;
text-align: center;
}

.line-num {
color: var(--text-secondary);
font-size: 90%;
Expand Down Expand Up @@ -1072,20 +1079,6 @@ <h2>Table of Contents</h2>
</a>
</span>
<ul>
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" width="10" height="10">
<path stroke-linecap="round" stroke-linejoin="round" d="m19.5 8.25-7.5 7.5-7.5-7.5" />
</svg>
</button>
<span>
<strong>Code Errors or Forbidden Usage</strong>
</span>
<ul>

</ul>
</li>
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
Expand Down Expand Up @@ -1135,24 +1128,6 @@ <h2>Table of Contents</h2>
<section id=0>
<div class="section-header">
</div>
<article class="error-output code-errors">
<h3 class="category-heading">
<span>Code Errors or Forbidden Usage (fix: high priority)</span>
<span class="slider">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
<svg class="collapse-trigger" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" width="60" height="30">
<path stroke-linecap="round" stroke-linejoin="round" d="m19.5 8.25-7.5 7.5-7.5-7.5" />
</svg>
</button>
</span>
</h3>
<div class="content collapsible expanded">

<span class="empty-placeholder">No problems detected, good job!</span>

</div>
</article>
<article class="error-output style-errors">
<h3 class="category-heading">
<span>Style or Convention Errors (fix: before submission)</span>
Expand Down
39 changes: 7 additions & 32 deletions ...sts/test_reporters/snapshots/test_html_reporter/test_markdown_escape/markdown_escape.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@
}

.main-grid {
column-gap: 3rem;
display: grid;
flex: 1;
grid-template-columns: min-content 1fr;
Expand Down Expand Up @@ -369,6 +370,12 @@
.style-error-id a:link {
}

.no-errors {
font-size: 1.1em;
padding: 25px;
text-align: center;
}

.line-num {
color: var(--text-secondary);
font-size: 90%;
Expand Down Expand Up @@ -1072,20 +1079,6 @@ <h2>Table of Contents</h2>
</a>
</span>
<ul>
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" width="10" height="10">
<path stroke-linecap="round" stroke-linejoin="round" d="m19.5 8.25-7.5 7.5-7.5-7.5" />
</svg>
</button>
<span>
<strong>Code Errors or Forbidden Usage</strong>
</span>
<ul>

</ul>
</li>
<li class="collapsible expanded">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
Expand Down Expand Up @@ -1141,24 +1134,6 @@ <h2>Table of Contents</h2>
<section id=0>
<div class="section-header">
</div>
<article class="error-output code-errors">
<h3 class="category-heading">
<span>Code Errors or Forbidden Usage (fix: high priority)</span>
<span class="slider">
<button>
<!-- Chevron down icon from heroicons at https://heroicons.com/ -->
<svg class="collapse-trigger" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" width="60" height="30">
<path stroke-linecap="round" stroke-linejoin="round" d="m19.5 8.25-7.5 7.5-7.5-7.5" />
</svg>
</button>
</span>
</h3>
<div class="content collapsible expanded">

<span class="empty-placeholder">No problems detected, good job!</span>

</div>
</article>
<article class="error-output style-errors">
<h3 class="category-heading">
<span>Style or Convention Errors (fix: before submission)</span>
Expand Down
7 changes: 7 additions & 0 deletions ...est_html_server/test_no_watch_server_is_non_persistent/no_watch_html_server_snapshot.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@
}

.main-grid {
column-gap: 3rem;
display: grid;
flex: 1;
grid-template-columns: min-content 1fr;
Expand Down Expand Up @@ -369,6 +370,12 @@
.style-error-id a:link {
}

.no-errors {
font-size: 1.1em;
padding: 25px;
text-align: center;
}

.line-num {
color: var(--text-secondary);
font-size: 90%;
Expand Down
Loading