python-ta 2.8.0__tar.gz → 2.9.0__tar.gz

{python_ta-2.8.0/python_ta.egg-info → python_ta-2.9.0}/PKG-INFO

@@ -1,159 +1,162 @@
-Metadata-Version: 2.1
-Name: python-ta
-Version: 2.8.0
-Summary: Code checking tool for teaching Python
-Author-email: David Liu <david@cs.toronto.edu>
-License: MIT
-Project-URL: Homepage, https://github.com/pyta-uoft/pyta
-Project-URL: Documentation, https://www.cs.toronto.edu/~david/pyta/
-Project-URL: Repository, https://github.com/pyta-uoft/pyta.git
-Project-URL: Changelog, https://github.com/pyta-uoft/pyta/blob/master/CHANGELOG.md
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: astroid~=3.2.4
-Requires-Dist: click<9,>=8.0.1
-Requires-Dist: colorama~=0.4.6
-Requires-Dist: jinja2~=3.1.2
-Requires-Dist: pycodestyle~=2.11
-Requires-Dist: pygments<2.19,>=2.14
-Requires-Dist: pylint~=3.2.6
-Requires-Dist: requests<2.33,>=2.28
-Requires-Dist: six
-Requires-Dist: tabulate~=0.9.0
-Requires-Dist: toml~=0.10.2
-Requires-Dist: typeguard<5,>=4.1.0
-Requires-Dist: wrapt<2,>=1.15.0
-Requires-Dist: black
-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-snapshot; extra == "dev"
-Requires-Dist: pytest-cov<5.1,>=4.0; extra == "dev"
-Requires-Dist: sphinx; extra == "dev"
-Requires-Dist: sphinx-rtd-theme; extra == "dev"
-Provides-Extra: cfg
-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"
-
-# PyTA
-
-PyTA is a Python program which uses static code analysis to help students find
-and fix common coding errors in introductory Python courses. Python already
-has great static analysis tools like pep8 and pylint, but these tools do not
-necessarily have the most beginner-friendly format. PyTA has two central goals:
-
-1. Statically identify common coding errors by using existing linting tools and
-   building custom linters (e.g., as pylint checkers).
-2. Present beautiful, intuitive messages to students that are both helpful for
-   fixing errors, and good preparation for the terser messages they will see
-   in their careers.
-
-This is a new project started in the Summer of 2016, and takes the form
-of a wrapper around [pylint](https://pylint.org) (with custom checkers) that operates
-directly on Python modules, as well as a website with some supplementary
-material going into further detail for the emitted errors.
-
-For greater details on the errors PyTA checks for: [Help Documentation](https://www.cs.toronto.edu/~david/pyta/).
-
-For help getting started using PyTA: [Quick Start](https://www.cs.toronto.edu/~david/pyta/usage/quick_start.html).
-
-## Installation
-
-If you're interested in using PyTA, you can install it using `pip` (or `pip3`, on OSX/Linux):
-
-```console
-> pip install python-ta
-```
-
-### Development
-
-If you're developing PyTA:
-
-1. First, clone this repository.
-2. Open a terminal in this repo, and run `pip install -e ".[dev, cfg, z3]"` to install the dependencies.
-3. Then run `pre-commit install` to install the pre-commit hooks (for automatically formatting and checking your code on each commit).
-
-While not strictly necessary for debugging, some debugging tools require [graphviz](https://www.graphviz.org/download/) to be installed on your system.
-
-### Tests
-
-To run the test suite, run the following command from inside the `pyta` directory:
-
-```console
-> python -m pytest tests  # Or python3 on OSX/Linux
-```
-
-## Generating the docs
-
-The PyTA documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/index.html).
-To generate the documentation locally, run the commands:
-
-```console
-> cd docs
-> make html
-```
-
-Then open the file `docs/_build/html/index.html` in your web browser!
-
-## Demo
-
-You can currently see a proof of concept in this repository. Clone it,
-and then run `python` in this directory (PyTA is primarily meant to be
-included as a library). In the Python interpreter, try running:
-
-```python
->>> import python_ta
->>> python_ta.check_all('examples.custom_checkers.e9999_forbidden_import')
-[Some output should be shown]
->>> python_ta.doc('E9999')
-```
-
-## Contributors
-
-Lorena Buciu,
-Simon Chen,
-Freeman Cheng,
-Ivan Chepelev,
-Nigel Fong,
-Adam Gleizer,
-Ibrahim Hasan,
-Niayesh Ilkhani,
-Craig Katsube,
-Rebecca Kay,
-Christopher Koehler,
-David Kim,
-Simeon Krastnikov,
-Ryan Lee,
-Christopher Li,
-Hayley Lin,
-Bruce Liu,
-Merrick Liu,
-Wendy Liu,
-Yibing (Amy) Lu,
-Maria Shurui Ma,
-Aina Fatema Asim Merchant,
-Shweta Mogalapalli,
-Ignas Panero Armoska,
-Justin Park,
-Harshkumar Patel,
-Varun Sahni,
-Eleonora Scognamiglio,
-Stephen Scott,
-Amr Sharaf,
-Richard Shi,
-Kavin Singh,
-Alexey Strokach,
-Sophy Sun,
-Utku Egemen Umut,
-Sarah Wang,
-Lana Wehbeh,
-Jasmine Wu,
-Raine Yang,
-Philippe Yu,
-Yi Cheng (Michael) Zhao
+Metadata-Version: 2.1
+Name: python-ta
+Version: 2.9.0
+Summary: Code checking tool for teaching Python
+Author-email: David Liu <david@cs.toronto.edu>
+License: MIT
+Project-URL: Homepage, https://github.com/pyta-uoft/pyta
+Project-URL: Documentation, https://www.cs.toronto.edu/~david/pyta/
+Project-URL: Repository, https://github.com/pyta-uoft/pyta.git
+Project-URL: Changelog, https://github.com/pyta-uoft/pyta/blob/master/CHANGELOG.md
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astroid~=3.3.5
+Requires-Dist: click<9,>=8.0.1
+Requires-Dist: colorama~=0.4.6
+Requires-Dist: jinja2~=3.1.2
+Requires-Dist: pycodestyle~=2.11
+Requires-Dist: pygments<2.19,>=2.14
+Requires-Dist: pylint~=3.3.1
+Requires-Dist: requests<2.33,>=2.28
+Requires-Dist: six
+Requires-Dist: tabulate~=0.9.0
+Requires-Dist: toml~=0.10.2
+Requires-Dist: typeguard<5,>=4.1.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-mock; extra == "dev"
+Requires-Dist: pytest-snapshot; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Provides-Extra: cfg
+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"
+
+# PyTA
+
+PyTA is a Python program which uses static code analysis to help students find
+and fix common coding errors in introductory Python courses. Python already
+has great static analysis tools like pep8 and pylint, but these tools do not
+necessarily have the most beginner-friendly format. PyTA has two central goals:
+
+1. Statically identify common coding errors by using existing linting tools and
+   building custom linters (e.g., as pylint checkers).
+2. Present beautiful, intuitive messages to students that are both helpful for
+   fixing errors, and good preparation for the terser messages they will see
+   in their careers.
+
+This is a new project started in the Summer of 2016, and takes the form
+of a wrapper around [pylint](https://pylint.org) (with custom checkers) that operates
+directly on Python modules, as well as a website with some supplementary
+material going into further detail for the emitted errors.
+
+For greater details on the errors PyTA checks for: [Help Documentation](https://www.cs.toronto.edu/~david/pyta/).
+
+For help getting started using PyTA: [Quick Start](https://www.cs.toronto.edu/~david/pyta/usage/quick_start.html).
+
+## Installation
+
+If you're interested in using PyTA, you can install it using `pip` (or `pip3`, on OSX/Linux):
+
+```console
+> pip install python-ta
+```
+
+### Development
+
+If you're developing PyTA:
+
+1. First, clone this repository.
+2. Open a terminal in this repo, and run `pip install -e ".[dev, cfg, z3]"` to install the dependencies.
+3. Then run `pre-commit install` to install the pre-commit hooks (for automatically formatting and checking your code on each commit).
+
+While not strictly necessary for debugging, some debugging tools require [graphviz](https://www.graphviz.org/download/) to be installed on your system.
+
+### Tests
+
+To run the test suite, run the following command from inside the `pyta` directory:
+
+```console
+> python -m pytest tests  # Or python3 on OSX/Linux
+```
+
+## Generating the docs
+
+The PyTA documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/index.html).
+To generate the documentation locally, run the commands:
+
+```console
+> cd docs
+> make html
+```
+
+Then open the file `docs/_build/html/index.html` in your web browser!
+
+## Demo
+
+You can currently see a proof of concept in this repository. Clone it,
+and then run `python` in this directory (PyTA is primarily meant to be
+included as a library). In the Python interpreter, try running:
+
+```python
+>>> import python_ta
+>>> python_ta.check_all('examples.custom_checkers.e9999_forbidden_import')
+[Some output should be shown]
+>>> python_ta.doc('E9999')
+```
+
+## Contributors
+
+Lorena Buciu,
+Simon Chen,
+Freeman Cheng,
+Ivan Chepelev,
+Yianni Culmone,
+Nigel Fong,
+Adam Gleizer,
+Ibrahim Hasan,
+Niayesh Ilkhani,
+Craig Katsube,
+Rebecca Kay,
+Christopher Koehler,
+David Kim,
+Simeon Krastnikov,
+Ryan Lee,
+Christopher Li,
+Hayley Lin,
+Bruce Liu,
+Merrick Liu,
+Wendy Liu,
+Yibing (Amy) Lu,
+Maria Shurui Ma,
+Aina Fatema Asim Merchant,
+Shweta Mogalapalli,
+Ignas Panero Armoska,
+Justin Park,
+Harshkumar Patel,
+Varun Sahni,
+Eleonora Scognamiglio,
+Stephen Scott,
+Amr Sharaf,
+Richard Shi,
+Kavin Singh,
+Alexey Strokach,
+Sophy Sun,
+Utku Egemen Umut,
+Sarah Wang,
+Lana Wehbeh,
+Jasmine Wu,
+Raine Yang,
+Philippe Yu,
+Yi Cheng (Michael) Zhao

{python_ta-2.8.0 → python_ta-2.9.0}/README.md

@@ -77,6 +77,7 @@ Lorena Buciu,
 Simon Chen,
 Freeman Cheng,
 Ivan Chepelev,
+Yianni Culmone,
 Nigel Fong,
 Adam Gleizer,
 Ibrahim Hasan,

{python_ta-2.8.0 → python_ta-2.9.0}/pyproject.toml

@@ -7,13 +7,13 @@ authors = [
 license = {text = "MIT"}
 readme = "README.md"
 dependencies = [
-    "astroid ~= 3.2.4",
+    "astroid ~= 3.3.5",
     "click >= 8.0.1, < 9",
     "colorama ~= 0.4.6",
     "jinja2 ~= 3.1.2",
     "pycodestyle ~= 2.11",
     "pygments >= 2.14,< 2.19",
-    "pylint ~= 3.2.6",
+    "pylint ~= 3.3.1",
     "requests >= 2.28,< 2.33",
     "six",
     "tabulate ~= 0.9.0",
@@ -21,9 +21,10 @@ dependencies = [
     "typeguard >= 4.1.0, < 5",
     "wrapt >= 1.15.0, < 2",
     "black",
+    "beautifulsoup4"
 ]
 dynamic = ["version"]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 
 [project.optional-dependencies]
 dev = [
@@ -32,8 +33,9 @@ dev = [
     "myst-parser",
     "pre-commit",
     "pytest",
+    "pytest-cov >= 4.0,< 6.1",
+    "pytest-mock",
     "pytest-snapshot",
-    "pytest-cov >= 4.0,< 5.1",
     "sphinx",
     "sphinx-rtd-theme",
 ]

{python_ta-2.8.0 → python_ta-2.9.0}/python_ta/__init__.py

@@ -15,8 +15,9 @@ if __name__ == '__main__':
     python_ta.check_all()
 """
 
-__version__ = "2.8.0"  # Version number
+from __future__ import annotations
 
+__version__ = "2.9.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
@@ -36,7 +37,7 @@ import tokenize
 import webbrowser
 from builtins import FileNotFoundError
 from os import listdir
-from typing import AnyStr, Generator, List, Optional, TextIO, Union
+from typing import AnyStr, Generator, Optional, TextIO, Union
 
 import pylint.config
 import pylint.lint
@@ -64,7 +65,7 @@ PYLINT_PATCHED = False
 
 
 def check_errors(
-    module_name: Union[List[str], str] = "",
+    module_name: Union[list[str], str] = "",
     config: Union[dict, str] = "",
     output: Optional[TextIO] = None,
     load_default_config: bool = True,
@@ -82,7 +83,7 @@ def check_errors(
 
 
 def check_all(
-    module_name: Union[List[str], str] = "",
+    module_name: Union[list[str], str] = "",
     config: Union[dict, str] = "",
     output: Optional[TextIO] = None,
     load_default_config: bool = True,
@@ -100,7 +101,7 @@ def check_all(
 
 
 def _check(
-    module_name: Union[List[str], str] = "",
+    module_name: Union[list[str], str] = "",
     level: str = "all",
     local_config: Union[dict, str] = "",
     output: Optional[TextIO] = None,
@@ -123,10 +124,6 @@ def _check(
     # Configuring logger
     logging.basicConfig(format="[%(levelname)s] %(message)s", level=logging.NOTSET)
 
-    # check the python version
-    if sys.version_info < (3, 7, 0):
-        logging.warning("You need Python 3.7 or later to run PythonTA.")
-
     linter = reset_linter(config=local_config, load_default_config=load_default_config)
     current_reporter = linter.reporter
     current_reporter.set_output(output)
@@ -139,7 +136,9 @@ def _check(
 
     global PYLINT_PATCHED
     if not PYLINT_PATCHED:
-        patch_all(messages_config)  # Monkeypatch pylint (override certain methods)
+        patch_all(
+            messages_config, linter.config.z3
+        )  # Monkeypatch pylint (override certain methods)
         PYLINT_PATCHED = True
 
     # Try to check file, issue error message for invalid files.
@@ -441,7 +440,7 @@ def _verify_pre_check(filepath: AnyStr, allow_pylint_comments: bool) -> bool:
     return True
 
 
-def _get_valid_files_to_check(module_name: Union[List[str], str]) -> Generator[AnyStr, None, None]:
+def _get_valid_files_to_check(module_name: Union[list[str], str]) -> Generator[AnyStr, None, None]:
     """A generator for all valid files to check."""
     # Allow call to check with empty args
     if module_name == "":

{python_ta-2.8.0 → python_ta-2.9.0}/python_ta/__main__.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 import sys
 from os import path
-from typing import List, Optional
+from typing import Optional
 
 import click
 
@@ -41,7 +43,7 @@ def main(
     version: bool,
     config: Optional[str],
     errors_only: bool,
-    filenames: List[str],
+    filenames: list[str],
     exit_zero: bool,
     generate_config: bool,
     output_format: str,

{python_ta-2.8.0 → python_ta-2.9.0}/python_ta/cfg/cfg_generator.py

@@ -2,15 +2,25 @@
 Provides a function to generate and display the control flow graph of a given module.
 """
 
+from __future__ import annotations
+
 import importlib.util
 import os.path
 import sys
-from typing import Any, Dict, Optional, Set
+from typing import 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
 
@@ -19,7 +29,7 @@ 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
 ) -> None:
     """Generate a control flow graph for the given module.
 
@@ -43,7 +53,7 @@ def generate_cfg(
 
 
 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
 ) -> None:
     """Generate a control flow graph for the given module.
 
@@ -59,6 +69,12 @@ 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:
+        z3v = Z3Visitor()
+        module = z3v.visitor.visit(module)
+
     visitor = CFGVisitor(options=visitor_options)
     module.accept(visitor)
 
@@ -92,7 +108,7 @@ def _get_valid_file_path(mod: str = "") -> Optional[str]:
 
 
 def _display(
-    cfgs: Dict[nodes.NodeNG, ControlFlowGraph], filename: str, auto_open: bool = False
+    cfgs: dict[nodes.NodeNG, ControlFlowGraph], filename: str, auto_open: bool = False
 ) -> None:
     graph = graphviz.Digraph(name=filename, **GRAPH_OPTIONS)
     for node, cfg in cfgs.items():
@@ -116,7 +132,7 @@ def _display(
     graph.render(filename, view=auto_open)
 
 
-def _visit(block: CFGBlock, graph: graphviz.Digraph, visited: Set[int], end: CFGBlock) -> None:
+def _visit(block: CFGBlock, graph: graphviz.Digraph, visited: set[int], end: CFGBlock) -> None:
     """
     Visit a CFGBlock and add it to the control flow graph.
     """
@@ -138,8 +154,11 @@ def _visit(block: CFGBlock, graph: graphviz.Digraph, visited: Set[int], end: CFG
     visited.add(node_id)
 
     for edge in block.successors:
+        color = "black" if edge.is_feasible else "lightgrey"
         if edge.get_label() is not None:
-            graph.edge(node_id, f"{graph.name}_{edge.target.id}", edge.get_label())
+            graph.edge(
+                node_id, f"{graph.name}_{edge.target.id}", label=edge.get_label(), color=color
+            )
         else:
-            graph.edge(node_id, f"{graph.name}_{edge.target.id}")
+            graph.edge(node_id, f"{graph.name}_{edge.target.id}", color=color)
         _visit(edge.target, graph, visited, end)