14049646952

Committed 25 Mar 2025 01:34AM UTC coverage: 92.557% (-0.5%) from 93.089%

Build # 14049646952

Build Type

push

github

Committed by

web-flow

Commit Message

Modify check_all to re-run checks when watch=True (#1156)

Adds the watchdog library to monitor file system events.

Run Details

192 of 218 new or added lines in 6 files covered. (88.07%)

8 existing lines in 1 file now uncovered.

3345 of 3614 relevant lines covered (92.56%)

17.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.41

/python_ta/reporters/html_server.py

import os
import sys
import webbrowser
from http.server import BaseHTTPRequestHandler, HTTPServer


def open_html_in_browser(html: bytes, watch: bool, port: int) -> None:
    """
    Display html in a web browser without creating a temp file.
    Instantiates a trivial HTTP server on the specified port (or an available port if 0 is provided)
    and uses the webbrowser module to open a URL to retrieve the HTML from that server.

    If watch is False, the server responds to exactly one request and then shuts down.
    If watch is True, the server runs indefinitely, allowing multiple requests.
    Adapted from: https://github.com/plotly/plotly.py/blob/master/packages/python/plotly/plotly/io/_base_renderers.py#L655
    """

    class RequestHandler(BaseHTTPRequestHandler):
        def do_GET(self):
            self.send_response(200)
            self.send_header("Content-type", "text/html")
            self.end_headers()

            buffer_size = 1024 * 1024
            for i in range(0, len(html), buffer_size):
                self.wfile.write(html[i : i + buffer_size])

        def log_message(self, format, *args):
            """Overridden so that no server logging is printed."""
            pass

    if watch:
        print(
            "[INFO] Your PythonTA report is being opened in your web browser.\n"
            "       Press Ctrl + C or stop this program to exit.",
            file=sys.stderr,
        )
        server = HTTPServer(("127.0.0.1", port), RequestHandler)
        webbrowser.open(f"http://127.0.0.1:{server.server_port}", new=2)
        try:
            server.serve_forever()
        except KeyboardInterrupt:
            print("\nShutting down the PythonTA server.")
            server.shutdown()
    else:
        server = HTTPServer(("127.0.0.1", port), RequestHandler)
        webbrowser.open(f"http://127.0.0.1:{server.server_port}", new=2)
        server.handle_request()
        server.server_close()
        print(
            "[INFO] Your PythonTA report is being opened in your web browser.\n"
            "       If it doesn't open, please add an output argument to python_ta.check_all\n"
            "       as follows:\n\n"
            "         check_all(..., output='pyta_report.html')\n\n"
            "       This will cause PythonTA to save the report to a file, pyta_report.html,\n"
            "       that you can open manually in a web browser.",
            file=sys.stderr,
        )

1	import os	20✔
2	import sys	20✔
3	import webbrowser	20✔
4	from http.server import BaseHTTPRequestHandler, HTTPServer	20✔
5
6
7	def open_html_in_browser(html: bytes, watch: bool, port: int) -> None:	20✔
8	"""
9	Display html in a web browser without creating a temp file.
10	Instantiates a trivial HTTP server on the specified port (or an available port if 0 is provided)
11	and uses the webbrowser module to open a URL to retrieve the HTML from that server.
12
13	If watch is False, the server responds to exactly one request and then shuts down.
14	If watch is True, the server runs indefinitely, allowing multiple requests.
15	Adapted from: https://github.com/plotly/plotly.py/blob/master/packages/python/plotly/plotly/io/_base_renderers.py#L655
16	"""
17
18	class RequestHandler(BaseHTTPRequestHandler):	20✔
19	def do_GET(self):	20✔
20	self.send_response(200)	10✔
21	self.send_header("Content-type", "text/html")	10✔
22	self.end_headers()	10✔
23
24	buffer_size = 1024 * 1024	10✔
25	for i in range(0, len(html), buffer_size):	10✔
26	self.wfile.write(html[i : i + buffer_size])	10✔
27
28	def log_message(self, format, *args):	20✔
29	"""Overridden so that no server logging is printed."""
30	pass	10✔
31
32	if watch:	20✔
UNCOV 33	print(	×
34	"[INFO] Your PythonTA report is being opened in your web browser.\n"
35	" Press Ctrl + C or stop this program to exit.",
36	file=sys.stderr,
37	)
UNCOV 38	server = HTTPServer(("127.0.0.1", port), RequestHandler)	×
UNCOV 39	webbrowser.open(f"http://127.0.0.1:{server.server_port}", new=2)	×
UNCOV 40	try:	×
UNCOV 41	server.serve_forever()	×
UNCOV 42	except KeyboardInterrupt:	×
UNCOV 43	print("\nShutting down the PythonTA server.")	×
UNCOV 44	server.shutdown()	×
45	else:
46	server = HTTPServer(("127.0.0.1", port), RequestHandler)	20✔
47	webbrowser.open(f"http://127.0.0.1:{server.server_port}", new=2)	20✔
48	server.handle_request()	20✔
49	server.server_close()	20✔
50	print(	20✔
51	"[INFO] Your PythonTA report is being opened in your web browser.\n"
52	" If it doesn't open, please add an output argument to python_ta.check_all\n"
53	" as follows:\n\n"
54	" check_all(..., output='pyta_report.html')\n\n"
55	" This will cause PythonTA to save the report to a file, pyta_report.html,\n"
56	" that you can open manually in a web browser.",
57	file=sys.stderr,
58	)

pyta-uoft / pyta / 14049646952

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous