python-ta 2.10.0__tar.gz → 2.11.0__tar.gz

{python_ta-2.10.0/python_ta.egg-info → python_ta-2.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python-ta
-Version: 2.10.0
+Version: 2.11.0
 Summary: Code checking tool for teaching Python
 Author-email: David Liu <david@cs.toronto.edu>
 License: MIT
@@ -11,7 +11,10 @@ Project-URL: Changelog, https://github.com/pyta-uoft/pyta/blob/master/CHANGELOG.
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: aiohttp<3.13.0,>=3.11.18
 Requires-Dist: astroid~=3.3.5
+Requires-Dist: beautifulsoup4
+Requires-Dist: black
 Requires-Dist: click<9,>=8.0.1
 Requires-Dist: colorama~=0.4.6
 Requires-Dist: jinja2~=3.1.2
@@ -24,18 +27,18 @@ Requires-Dist: six
 Requires-Dist: tabulate~=0.9.0
 Requires-Dist: toml~=0.10.2
 Requires-Dist: typeguard<5,>=4.1.0
+Requires-Dist: watchdog~=6.0.0
 Requires-Dist: wrapt<2,>=1.15.0
-Requires-Dist: black
-Requires-Dist: beautifulsoup4
 Provides-Extra: dev
 Requires-Dist: hypothesis; extra == "dev"
 Requires-Dist: inflection; extra == "dev"
 Requires-Dist: myst-parser; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-cov<6.1,>=4.0; extra == "dev"
+Requires-Dist: pytest-cov<6.3,>=4.0; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: pytest-snapshot; extra == "dev"
+Requires-Dist: websocket-client; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx-rtd-theme; extra == "dev"
 Provides-Extra: cfg
@@ -43,6 +46,7 @@ Requires-Dist: graphviz; extra == "cfg"
 Provides-Extra: z3
 Requires-Dist: z3-solver; extra == "z3"
 Requires-Dist: importlib_resources; python_version < "3.9" and extra == "z3"
+Dynamic: license-file
 
 # PyTA
 
@@ -119,6 +123,7 @@ included as a library). In the Python interpreter, try running:
 
 ## Contributors
 
+Ibrahim Bilal,
 Lorena Buciu,
 Simon Chen,
 Freeman Cheng,
@@ -127,6 +132,7 @@ Yianni Culmone,
 Daniel Dervishi,
 Nigel Fong,
 Adam Gleizer,
+James Han,
 Ibrahim Hasan,
 Niayesh Ilkhani,
 Craig Katsube,
@@ -144,6 +150,7 @@ Wendy Liu,
 Yibing (Amy) Lu,
 Maria Shurui Ma,
 Aina Fatema Asim Merchant,
+Karl-Alexandre Michaud,
 Shweta Mogalapalli,
 Ignas Panero Armoska,
 Justin Park,
@@ -156,6 +163,7 @@ Richard Shi,
 Kavin Singh,
 Alexey Strokach,
 Sophy Sun,
+Ali Towaiji,
 Utku Egemen Umut,
 Sarah Wang,
 Lana Wehbeh,

{python_ta-2.10.0 → python_ta-2.11.0}/README.md

@@ -73,6 +73,7 @@ included as a library). In the Python interpreter, try running:
 
 ## Contributors
 
+Ibrahim Bilal,
 Lorena Buciu,
 Simon Chen,
 Freeman Cheng,
@@ -81,6 +82,7 @@ Yianni Culmone,
 Daniel Dervishi,
 Nigel Fong,
 Adam Gleizer,
+James Han,
 Ibrahim Hasan,
 Niayesh Ilkhani,
 Craig Katsube,
@@ -98,6 +100,7 @@ Wendy Liu,
 Yibing (Amy) Lu,
 Maria Shurui Ma,
 Aina Fatema Asim Merchant,
+Karl-Alexandre Michaud,
 Shweta Mogalapalli,
 Ignas Panero Armoska,
 Justin Park,
@@ -110,6 +113,7 @@ Richard Shi,
 Kavin Singh,
 Alexey Strokach,
 Sophy Sun,
+Ali Towaiji,
 Utku Egemen Umut,
 Sarah Wang,
 Lana Wehbeh,

{python_ta-2.10.0 → python_ta-2.11.0}/pyproject.toml

@@ -7,7 +7,10 @@ authors = [
 license = {text = "MIT"}
 readme = "README.md"
 dependencies = [
+    "aiohttp >= 3.11.18,< 3.13.0",
     "astroid ~= 3.3.5",
+    "beautifulsoup4",
+    "black",
     "click >= 8.0.1, < 9",
     "colorama ~= 0.4.6",
     "jinja2 ~= 3.1.2",
@@ -20,9 +23,8 @@ dependencies = [
     "tabulate ~= 0.9.0",
     "toml ~= 0.10.2",
     "typeguard >= 4.1.0, < 5",
-    "wrapt >= 1.15.0, < 2",
-    "black",
-    "beautifulsoup4"
+    "watchdog ~= 6.0.0",
+    "wrapt >= 1.15.0, < 2"
 ]
 dynamic = ["version"]
 requires-python = ">=3.9"
@@ -34,9 +36,10 @@ dev = [
     "myst-parser",
     "pre-commit",
     "pytest",
-    "pytest-cov >= 4.0,< 6.1",
+    "pytest-cov >= 4.0,< 6.3",
     "pytest-mock",
     "pytest-snapshot",
+    "websocket-client",
     "sphinx",
     "sphinx-rtd-theme",
 ]
@@ -76,6 +79,7 @@ include = ["python_ta*"]
 [tool.black]
 extend-exclude = '''
 ^/examples/
+^/tests/fixtures/
 '''
 line-length = 100
 target-version = ['py38']

python_ta-2.11.0/python_ta/__init__.py

@@ -0,0 +1,207 @@
+"""Python Teaching Assistant
+
+The goal of this module is to provide automated feedback to students in our
+introductory Python courses, using static analysis of their code.
+
+To run the checker, call the check function on the name of the module to check.
+
+> import python_ta
+> python_ta.check_all('mymodule.py')
+
+Or, put the following code in your Python module:
+
+if __name__ == '__main__':
+    import python_ta
+    python_ta.check_all()
+"""
+
+from __future__ import annotations
+
+__version__ = "2.11.0"  # Version number
+# First, remove underscore from builtins if it has been bound in the REPL.
+# Must appear before other imports from pylint/python_ta.
+import builtins
+
+try:
+    del builtins._
+except AttributeError:
+    pass
+
+
+import logging
+import webbrowser
+from typing import IO, TYPE_CHECKING, Any, Literal, Optional, Union
+
+from .check.helpers import (
+    check_file,
+    get_file_paths,
+    get_valid_files_to_check,
+    setup_linter,
+    upload_linter_results,
+    verify_pre_check,
+)
+from .check.watch import watch_files
+
+if TYPE_CHECKING:
+    from .reporters.core import PythonTaReporter
+
+HELP_URL = "http://www.cs.toronto.edu/~david/pyta/checkers/index.html"
+
+
+def check_errors(
+    module_name: Union[list[str], str] = "",
+    config: Union[dict[str, Any], str] = "",
+    output: Optional[Union[str, IO]] = None,
+    load_default_config: bool = True,
+    autoformat: Optional[bool] = False,
+    on_verify_fail: Literal["log", "raise"] = "log",
+) -> PythonTaReporter:
+    """Check a module for errors, printing a report."""
+    return _check(
+        module_name=module_name,
+        level="error",
+        local_config=config,
+        output=output,
+        load_default_config=load_default_config,
+        autoformat=autoformat,
+        on_verify_fail=on_verify_fail,
+    )
+
+
+def check_all(
+    module_name: Union[list[str], str] = "",
+    config: Union[dict[str, Any], str] = "",
+    output: Optional[Union[str, IO]] = None,
+    load_default_config: bool = True,
+    autoformat: Optional[bool] = False,
+    on_verify_fail: Literal["log", "raise"] = "log",
+) -> PythonTaReporter:
+    """Analyse one or more Python modules for code issues and display the results.
+
+    Args:
+        module_name:
+            If an empty string (default), the module where this function is called is checked.
+            If a non-empty string, it is interpreted as a path to a single Python module or a
+            directory containing Python modules. If the latter, all Python modules in the directory
+            are checked.
+            If a list of strings, each string is interpreted as a path to a module or directory,
+            and all modules across all paths are checked.
+        config:
+            If a string, a path to a configuration file to use.
+            If a dictionary, a map of configuration options (each key is the name of an option).
+        output:
+            If a string, a path to a file to which the PythonTA report is written.
+            If a typing.IO object, the report is written to this stream.
+            If None, the report is written to standard out or automatically displayed in a
+            web browser, depending on which reporter is used.
+        load_default_config:
+            If True (default), additional configuration passed with the ``config`` option is
+            merged with the default PythonTA configuration file.
+            If False, the default PythonTA configuration is not used.
+        autoformat:
+            If True, autoformat all modules using the black formatting tool before analyzing code.
+        on_verify_fail:
+            Determines how to handle files that cannot be checked. If set to "log" (default), an error
+            message is logged and execution continues. If set to "raise", an error is raised immediately to stop
+            execution.
+
+    Returns:
+        The ``PythonTaReporter`` object that generated the report.
+    """
+    return _check(
+        module_name=module_name,
+        level="all",
+        local_config=config,
+        output=output,
+        load_default_config=load_default_config,
+        autoformat=autoformat,
+        on_verify_fail=on_verify_fail,
+    )
+
+
+def _check(
+    module_name: Union[list[str], str] = "",
+    level: str = "all",
+    local_config: Union[dict[str, Any], str] = "",
+    output: Optional[Union[str, IO]] = None,
+    load_default_config: bool = True,
+    autoformat: Optional[bool] = False,
+    on_verify_fail: Literal["log", "raise"] = "log",
+) -> PythonTaReporter:
+    """Check a module for problems, printing a report.
+
+    The `module_name` can take several inputs:
+      - string of a directory, or file to check (`.py` extension optional).
+      - list of strings of directories or files -- can have multiple.
+      - no argument -- checks the python file containing the function call.
+    `level` is used to specify which checks should be made.
+    `local_config` is a dict of config options or string (config file name).
+    `output` is an absolute or relative path to a file, or a typing.IO object to capture pyta data
+    output. If None, stdout is used.
+    `load_default_config` is used to specify whether to load the default .pylintrc file that comes
+    with PythonTA. It will load it by default.
+    `autoformat` is used to specify whether the black formatting tool is run. It is not run by default.
+    `on_verify_fail` determines how to handle files that cannot be checked. If set to "log" (default), an error
+     message is logged and execution continues. If set to "raise", an error is raised immediately to stop execution.
+    """
+    # Configuring logger
+    logging.basicConfig(format="[%(levelname)s] %(message)s", level=logging.INFO)
+    linter, current_reporter = setup_linter(local_config, load_default_config, output)
+    try:
+        # Flag indicating whether at least one file has been checked
+        is_any_file_checked = False
+        linted_files = set()
+        f_paths = []  # Paths to files for data submission
+        for locations in get_valid_files_to_check(module_name):
+            f_paths = []
+            for file_py in get_file_paths(locations):
+                linted_files.add(file_py)
+                if not verify_pre_check(
+                    file_py, linter.config.allow_pylint_comments, on_verify_fail=on_verify_fail
+                ):
+                    # The only way to reach this is if verify_pre_check returns False, and `on_verify_fail="log"`.
+                    continue
+                is_any_file_checked, linter = check_file(
+                    file_py=file_py,
+                    local_config=local_config,
+                    load_default_config=load_default_config,
+                    autoformat=autoformat,
+                    is_any_file_checked=is_any_file_checked,
+                    current_reporter=current_reporter,
+                    f_paths=f_paths,
+                )
+                current_reporter = linter.reporter
+                current_reporter.print_messages(level)
+            upload_linter_results(linter, current_reporter, f_paths, local_config)
+        # Only generate reports (display the webpage) if there were valid files to check
+        if is_any_file_checked:
+            linter.generate_reports()
+            if linter.config.watch:
+                watch_files(
+                    file_paths=linted_files,
+                    level=level,
+                    local_config=local_config,
+                    load_default_config=load_default_config,
+                    autoformat=autoformat,
+                    linter=linter,
+                    f_paths=f_paths,
+                )
+
+        return current_reporter
+    except Exception as e:
+        logging.error(
+            "Unexpected error encountered! Please report this to your instructor (and attach the code that caused the error)."
+        )
+        logging.error('Error message: "{}"'.format(e))
+        raise e
+
+
+def doc(msg_id: str) -> None:
+    """Open the PythonTA documentation page for the given error message id.
+
+    Args:
+        msg_id: The five-character error code, e.g. ``"E0401"``.
+    """
+    msg_url = HELP_URL + "#" + msg_id.lower()
+    print("Opening {} in a browser.".format(msg_url))
+    webbrowser.open(msg_url)

{python_ta-2.10.0 → python_ta-2.11.0}/python_ta/__main__.py

@@ -37,7 +37,7 @@ CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 @click.option(
     "--output-format",
     help="Specify the format of output report. This option is ignored if a --config argument is specified.",
-    default="python_ta.reporters.HTMLReporter",
+    default="pyta-html",
 )
 def main(
     version: bool,

python_ta-2.11.0/python_ta/cfg/__init__.py

@@ -0,0 +1,13 @@
+try:
+    from .cfg_generator import generate_cfg
+except ModuleNotFoundError:
+
+    def generate_cfg(*_args, **_kwargs) -> None:
+        """Dummy version of generate_cfg"""
+        raise Exception(
+            "This function requires additional dependencies to be installed: " "python_ta[cfg]"
+        )
+
+
+from .graph import *
+from .visitor import *

python_ta-2.11.0/python_ta/cfg/__main__.py

@@ -0,0 +1,92 @@
+from typing import Any, Dict, List, Optional, Union
+
+import click
+
+from .cfg_generator import generate_cfg
+
+
+def split_by_comma_if_outside_quotes(options_str: str) -> List[str]:
+    """Split string by commas, but not commas inside quotes."""
+    parts: List[str] = []
+    current_part: List[str] = []
+    in_quotes: bool = False
+    quote_char: Optional[str] = None
+
+    for char in options_str:
+        if char in ('"', "'") and not in_quotes:
+            in_quotes = True
+            quote_char = char
+            current_part.append(char)
+        elif char == quote_char and in_quotes:
+            in_quotes = False
+            quote_char = None
+            current_part.append(char)
+        elif char == "," and not in_quotes:
+            parts.append("".join(current_part).strip())
+            current_part = []
+        else:
+            current_part.append(char)
+
+    if current_part:
+        parts.append("".join(current_part).strip())
+
+    return parts
+
+
+def parse_visitor_options(options_str: str) -> Dict[str, Union[bool, List[str], str]]:
+    """Parse comma-separated key=value pairs."""
+    if not options_str:
+        return {}
+
+    parts = split_by_comma_if_outside_quotes(options_str)
+
+    options: Dict[str, Union[bool, List[str], str]] = {}
+    for part in parts:
+        if "=" not in part:
+            continue
+
+        key, value = part.split("=", 1)
+        value = value.strip()
+
+        # Strip any quotes if present
+        if value.startswith(("'", '"')) and value.endswith(("'", '"')):
+            value = value[1:-1]
+
+        # Type conversions
+        if value.lower() in ("true", "false"):
+            options[key] = value.lower() == "true"
+        elif "," in value:
+            options[key] = [v.strip() for v in value.split(",")]
+        else:
+            options[key] = value
+
+    return options
+
+
+@click.command()
+@click.argument("mod")
+@click.option(
+    "--auto-open", is_flag=True, default=False, help="automatically opens the cfg in the browser"
+)
+@click.option(
+    "--visitor-options",
+    type=str,
+    help="Comma-separated key=value pairs for visitor options, e.g., "
+    "\"separate-condition-blocks=true,functions='foo,bar,baz'\"",
+)
+def main(mod: str, auto_open: bool, visitor_options: Optional[str]) -> None:
+    """Generate a Control Flow Graph for a Python file."""
+    parsed_options: Optional[Dict[str, Any]] = None
+
+    if visitor_options:
+        try:
+            parsed_options = parse_visitor_options(visitor_options)
+        except ValueError as error:
+            click.echo(f"Error: {error}", err=True)
+            raise click.Abort()
+
+    generate_cfg(mod=mod, auto_open=auto_open, visitor_options=parsed_options)
+
+
+if __name__ == "__main__":
+    main()

{python_ta-2.10.0 → python_ta-2.11.0}/python_ta/cfg/cfg_generator.py

@@ -6,31 +6,30 @@ from __future__ import annotations
 
 import html
 import importlib.util
+import logging
 import os.path
 import sys
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
 import graphviz
 from astroid import nodes
 from astroid.builder import AstroidBuilder
 
-try:
-    from ..transforms.z3_visitor import Z3Visitor
-
-    z3_dependency_available = True
-except ImportError:
-    Z3Visitor = Any
-    z3_dependency_available = False
-
-from .graph import CFGBlock, ControlFlowGraph
 from .visitor import CFGVisitor
 
+if TYPE_CHECKING:
+    from ..transforms.z3_visitor import Z3Visitor
+    from .graph import CFGBlock, ControlFlowGraph
+
 GRAPH_OPTIONS = {"format": "svg", "node_attr": {"shape": "box", "fontname": "Courier New"}}
 SUBGRAPH_OPTIONS = {"fontname": "Courier New"}
 
 
 def generate_cfg(
-    mod: str = "", auto_open: bool = False, visitor_options: Optional[dict[str, Any]] = None
+    mod: str = "",
+    auto_open: bool = False,
+    visitor_options: Optional[dict[str, Any]] = None,
+    z3_enabled: bool = False,
 ) -> None:
     """Generate a control flow graph for the given module.
 
@@ -49,12 +48,16 @@ def generate_cfg(
             function is called).
         auto_open (bool): Automatically open the graph in your browser.
         visitor_options (dict): An options dict to configure how the cfgs are generated.
+        z3_enabled (bool): An option that enables z3 when True (by default False).
     """
-    _generate(mod=mod, auto_open=auto_open, visitor_options=visitor_options)
+    _generate(mod=mod, auto_open=auto_open, visitor_options=visitor_options, z3_enabled=z3_enabled)
 
 
 def _generate(
-    mod: str = "", auto_open: bool = False, visitor_options: Optional[dict[str, Any]] = None
+    mod: str = "",
+    auto_open: bool = False,
+    visitor_options: Optional[dict[str, Any]] = None,
+    z3_enabled: bool = False,
 ) -> None:
     """Generate a control flow graph for the given module.
 
@@ -71,12 +74,18 @@ def _generate(
     file_name = os.path.splitext(os.path.basename(abs_path))[0]
     module = AstroidBuilder().file_build(abs_path)
 
-    # invoke Z3Visitor if z3 dependency is available
-    if z3_dependency_available:
+    # invoke Z3Visitor if z3 dependency is enabled
+    if z3_enabled:
+        try:
+            from ..transforms.z3_visitor import Z3Visitor
+
+        except ImportError:
+            logging.error("Failed to import Z3Visitor. Aborting.")
+            raise
         z3v = Z3Visitor()
         module = z3v.visitor.visit(module)
 
-    visitor = CFGVisitor(options=visitor_options)
+    visitor = CFGVisitor(options=visitor_options, z3_enabled=z3_enabled)
     module.accept(visitor)
 
     _display(visitor.cfgs, file_name, auto_open=auto_open)
@@ -159,6 +168,10 @@ def _visit(block: CFGBlock, graph: graphviz.Digraph, visited: set[int], end: CFG
         elif isinstance(stmt.parent, nodes.For) and stmt is stmt.parent.target:
             label = f"< for<U><B>{html.escape(stmt.as_string())} </B></U> in {html.escape(stmt.parent.iter.as_string())}<BR/> >"
 
+    if block.statements and isinstance(block.statements[0], nodes.Pattern):
+        label = f"case {html.escape(block.statements[0].as_string())}"
+        label += f" if {block.statements[1].as_string()}" if len(block.statements) == 2 else ""
+
     if not label:  # Default
         label = "\n".join([s.as_string() for s in block.statements]) + "\n"