Move setup.cfg config settings to pyproject.toml (#919)

pyta-uoft · Jun 24, 2023 · 8bf8470 · 8bf8470
1 parent e086e54
commit 8bf8470
Show file tree

Hide file tree

Showing 88 changed files with 78 additions and 67 deletions.
diff --git a/sample_usage/__init__.py → examples/__init__.py b/sample_usage/__init__.py → examples/__init__.py
diff --git a/nodes/README.md → examples/nodes/README.md b/nodes/README.md → examples/nodes/README.md
diff --git a/nodes/ann_assign.py → examples/nodes/ann_assign.py b/nodes/ann_assign.py → examples/nodes/ann_assign.py
diff --git a/nodes/arguments.py → examples/nodes/arguments.py b/nodes/arguments.py → examples/nodes/arguments.py
diff --git a/nodes/assert.py → examples/nodes/assert.py b/nodes/assert.py → examples/nodes/assert.py
diff --git a/nodes/assign.py → examples/nodes/assign.py b/nodes/assign.py → examples/nodes/assign.py
diff --git a/nodes/assign_attr.py → examples/nodes/assign_attr.py b/nodes/assign_attr.py → examples/nodes/assign_attr.py
diff --git a/nodes/assign_name.py → examples/nodes/assign_name.py b/nodes/assign_name.py → examples/nodes/assign_name.py
diff --git a/nodes/async_for.py → examples/nodes/async_for.py b/nodes/async_for.py → examples/nodes/async_for.py
diff --git a/nodes/async_function_def.py → examples/nodes/async_function_def.py b/nodes/async_function_def.py → examples/nodes/async_function_def.py
diff --git a/nodes/async_with.py → examples/nodes/async_with.py b/nodes/async_with.py → examples/nodes/async_with.py
diff --git a/nodes/attribute.py → examples/nodes/attribute.py b/nodes/attribute.py → examples/nodes/attribute.py
diff --git a/nodes/aug_assign.py → examples/nodes/aug_assign.py b/nodes/aug_assign.py → examples/nodes/aug_assign.py
diff --git a/nodes/await.py → examples/nodes/await.py b/nodes/await.py → examples/nodes/await.py
diff --git a/nodes/bin_op.py → examples/nodes/bin_op.py b/nodes/bin_op.py → examples/nodes/bin_op.py
diff --git a/nodes/bool_op.py → examples/nodes/bool_op.py b/nodes/bool_op.py → examples/nodes/bool_op.py
diff --git a/nodes/break.py → examples/nodes/break.py b/nodes/break.py → examples/nodes/break.py
diff --git a/nodes/call.py → examples/nodes/call.py b/nodes/call.py → examples/nodes/call.py
diff --git a/nodes/class_def.py → examples/nodes/class_def.py b/nodes/class_def.py → examples/nodes/class_def.py
diff --git a/nodes/compare.py → examples/nodes/compare.py b/nodes/compare.py → examples/nodes/compare.py
diff --git a/nodes/comprehension.py → examples/nodes/comprehension.py b/nodes/comprehension.py → examples/nodes/comprehension.py
diff --git a/nodes/const.py → examples/nodes/const.py b/nodes/const.py → examples/nodes/const.py
diff --git a/nodes/continue.py → examples/nodes/continue.py b/nodes/continue.py → examples/nodes/continue.py
diff --git a/nodes/decorators.py → examples/nodes/decorators.py b/nodes/decorators.py → examples/nodes/decorators.py
diff --git a/nodes/del_attr.py → examples/nodes/del_attr.py b/nodes/del_attr.py → examples/nodes/del_attr.py
diff --git a/nodes/del_name.py → examples/nodes/del_name.py b/nodes/del_name.py → examples/nodes/del_name.py
diff --git a/nodes/delete.py → examples/nodes/delete.py b/nodes/delete.py → examples/nodes/delete.py
diff --git a/nodes/dict.py → examples/nodes/dict.py b/nodes/dict.py → examples/nodes/dict.py
diff --git a/nodes/dict_comp.py → examples/nodes/dict_comp.py b/nodes/dict_comp.py → examples/nodes/dict_comp.py
diff --git a/nodes/dict_unpack.py → examples/nodes/dict_unpack.py b/nodes/dict_unpack.py → examples/nodes/dict_unpack.py
diff --git a/nodes/ellipsis.py → examples/nodes/ellipsis.py b/nodes/ellipsis.py → examples/nodes/ellipsis.py
diff --git a/nodes/except_handler.py → examples/nodes/except_handler.py b/nodes/except_handler.py → examples/nodes/except_handler.py
diff --git a/nodes/expr.py → examples/nodes/expr.py b/nodes/expr.py → examples/nodes/expr.py
diff --git a/nodes/for.py → examples/nodes/for.py b/nodes/for.py → examples/nodes/for.py
diff --git a/nodes/formatted_value.py → examples/nodes/formatted_value.py b/nodes/formatted_value.py → examples/nodes/formatted_value.py
diff --git a/nodes/function_def.py → examples/nodes/function_def.py b/nodes/function_def.py → examples/nodes/function_def.py
diff --git a/nodes/generator_exp.py → examples/nodes/generator_exp.py b/nodes/generator_exp.py → examples/nodes/generator_exp.py
diff --git a/nodes/global.py → examples/nodes/global.py b/nodes/global.py → examples/nodes/global.py
diff --git a/nodes/if.py → examples/nodes/if.py b/nodes/if.py → examples/nodes/if.py
diff --git a/nodes/if_exp.py → examples/nodes/if_exp.py b/nodes/if_exp.py → examples/nodes/if_exp.py
diff --git a/nodes/import.py → examples/nodes/import.py b/nodes/import.py → examples/nodes/import.py
diff --git a/nodes/import_from.py → examples/nodes/import_from.py b/nodes/import_from.py → examples/nodes/import_from.py
diff --git a/nodes/joined_str.py → examples/nodes/joined_str.py b/nodes/joined_str.py → examples/nodes/joined_str.py
diff --git a/nodes/keyword.py → examples/nodes/keyword.py b/nodes/keyword.py → examples/nodes/keyword.py
diff --git a/nodes/lambda.py → examples/nodes/lambda.py b/nodes/lambda.py → examples/nodes/lambda.py
diff --git a/nodes/list.py → examples/nodes/list.py b/nodes/list.py → examples/nodes/list.py
diff --git a/nodes/list_comp.py → examples/nodes/list_comp.py b/nodes/list_comp.py → examples/nodes/list_comp.py
diff --git a/nodes/module.py → examples/nodes/module.py b/nodes/module.py → examples/nodes/module.py
diff --git a/nodes/name.py → examples/nodes/name.py b/nodes/name.py → examples/nodes/name.py
diff --git a/nodes/nonlocal.py → examples/nodes/nonlocal.py b/nodes/nonlocal.py → examples/nodes/nonlocal.py
diff --git a/nodes/pass.py → examples/nodes/pass.py b/nodes/pass.py → examples/nodes/pass.py
diff --git a/nodes/raise.py → examples/nodes/raise.py b/nodes/raise.py → examples/nodes/raise.py
diff --git a/nodes/return.py → examples/nodes/return.py b/nodes/return.py → examples/nodes/return.py
diff --git a/nodes/set.py → examples/nodes/set.py b/nodes/set.py → examples/nodes/set.py
diff --git a/nodes/set_comp.py → examples/nodes/set_comp.py b/nodes/set_comp.py → examples/nodes/set_comp.py
diff --git a/nodes/slice.py → examples/nodes/slice.py b/nodes/slice.py → examples/nodes/slice.py
diff --git a/nodes/starred.py → examples/nodes/starred.py b/nodes/starred.py → examples/nodes/starred.py
diff --git a/nodes/subscript.py → examples/nodes/subscript.py b/nodes/subscript.py → examples/nodes/subscript.py
diff --git a/nodes/try_except.py → examples/nodes/try_except.py b/nodes/try_except.py → examples/nodes/try_except.py
diff --git a/nodes/try_finally.py → examples/nodes/try_finally.py b/nodes/try_finally.py → examples/nodes/try_finally.py
diff --git a/nodes/tuple.py → examples/nodes/tuple.py b/nodes/tuple.py → examples/nodes/tuple.py
diff --git a/nodes/unary_op.py → examples/nodes/unary_op.py b/nodes/unary_op.py → examples/nodes/unary_op.py
diff --git a/nodes/while.py → examples/nodes/while.py b/nodes/while.py → examples/nodes/while.py
diff --git a/nodes/with.py → examples/nodes/with.py b/nodes/with.py → examples/nodes/with.py
diff --git a/nodes/yield.py → examples/nodes/yield.py b/nodes/yield.py → examples/nodes/yield.py
diff --git a/nodes/yield_from.py → examples/nodes/yield_from.py b/nodes/yield_from.py → examples/nodes/yield_from.py
diff --git a/sample_usage/README.md → examples/sample_usage/README.md b/sample_usage/README.md → examples/sample_usage/README.md
@@ -42,7 +42,7 @@ call `pyta_statistics` on the absolute path to the directory, as so:
 
 ```python
 >>> directory = "C:\\Users\\prof\\Documents\\course1\\projects"  # for example
->>> from sample_usage.pyta_stats import pyta_statistics          # while running python in the pyta directory
+>>> from examples.sample_usage.pyta_stats import pyta_statistics          # while running python in the pyta directory
 >>> pyta_statistics(directory)
 ```
 
@@ -54,15 +54,15 @@ aggregate (if it is a course directory).
 There are three Python files that contribute to the aggregation and calculation
 of statistics for Python TA:
 
-- `sample_usage/pyta_stats.py`
+- `examples/sample_usage/pyta_stats.py`
 
   - This module contains the `pyta_statistics` function that users run on the
     directory that they want to analyse. It aggregates statistics that are collected
     by `StatReporter` instances when `python_ta.check_all()` is run, then calls
     the actual statistics calculators contained in the `stats_analysis` module,
     and pretty-prints the results.
 
-- `sample_usage/stats_analysis.py`
+- `examples/sample_usage/stats_analysis.py`
 
   - This module performs all of the actual statistics calculation on data collected
     by `pyta_stats`. The main function, `summary`, takes in the data and calls

diff --git a/sample_usage/TODO.md → examples/sample_usage/TODO.md b/sample_usage/TODO.md → examples/sample_usage/TODO.md
@@ -7,7 +7,7 @@
     AnnAssign Node:
         An AttributeError is raised because the transformer did not add
         'end_lineno' attribute to the AnnAssign node. In the current example
-        found in `nodes/ann_assign.py`, only the last statement has the
+        found in `examples/nodes/ann_assign.py`, only the last statement has the
         'end_lineno' attribute added to it.
 
     DictUnpack Node:

diff --git a/examples/sample_usage/__init__.py b/examples/sample_usage/__init__.py
diff --git a/sample_usage/draw_cfg.py → examples/sample_usage/draw_cfg.py b/sample_usage/draw_cfg.py → examples/sample_usage/draw_cfg.py
@@ -1,6 +1,6 @@
 import python_ta.cfg
 
-USAGE = "USAGE: python -m sample_usage.draw_cfg <your-file.py>"
+USAGE = "USAGE: python -m examples.sample_usage.draw_cfg <your-file.py>"
 
 
 def main(filepath: str) -> None:

diff --git a/sample_usage/draw_tnodes.py → examples/sample_usage/draw_tnodes.py b/sample_usage/draw_tnodes.py → examples/sample_usage/draw_tnodes.py
@@ -9,7 +9,7 @@
 from python_ta.typecheck.base import TypeFail, _TNode
 from tests.custom_hypothesis_support import _parse_text
 
-USAGE = "Usage: python -m sample_usage.draw_tnodes <your-file.py>"
+USAGE = "Usage: python -m examples.sample_usage.draw_tnodes <your-file.py>"
 
 
 def _type_str(type):

diff --git a/sample_usage/print_ast.py → examples/sample_usage/print_ast.py b/sample_usage/print_ast.py → examples/sample_usage/print_ast.py
@@ -6,7 +6,7 @@
 import astroid
 from colorama import Back, Fore
 
-USAGE = "Usage: python -m sample_usage.print_ast <your-file.py>"
+USAGE = "Usage: python -m examples.sample_usage.print_ast <your-file.py>"
 FILL = "  "
 # Unicode Box Drawing Characters.
 CHAR_PIPE = "┃"

diff --git a/sample_usage/print_nodes.py → examples/sample_usage/print_nodes.py b/sample_usage/print_nodes.py → examples/sample_usage/print_nodes.py
@@ -76,7 +76,7 @@ def print_node(filename, node_class):
 if __name__ == "__main__":
     for node_class in astroid.nodes.ALL_NODE_CLASSES:
         print("=== {} ===".format(node_class.__name__))
-        file_location = "nodes/" + inflection.underscore(node_class.__name__) + ".py"
+        file_location = "examples/nodes/" + inflection.underscore(node_class.__name__) + ".py"
         try:
             print_node(file_location, node_class)
         except FileNotFoundError:

diff --git a/sample_usage/print_table.py → examples/sample_usage/print_table.py b/sample_usage/print_table.py → examples/sample_usage/print_table.py
diff --git a/sample_usage/pyta_stats.py → examples/sample_usage/pyta_stats.py b/sample_usage/pyta_stats.py → examples/sample_usage/pyta_stats.py
@@ -3,7 +3,7 @@
 
 import python_ta
 from python_ta.reporters.stat_reporter import StatReporter
-from sample_usage.stats_analysis import summary
+from examples.sample_usage.stats_analysis import summary
 
 
 def pyta_statistics(directory, config=""):

diff --git a/sample_usage/stats_analysis.py → examples/sample_usage/stats_analysis.py b/sample_usage/stats_analysis.py → examples/sample_usage/stats_analysis.py
diff --git a/...age/typecheck/fail/1_one_var_two_types.py → ...age/typecheck/fail/1_one_var_two_types.py b/...age/typecheck/fail/1_one_var_two_types.py → ...age/typecheck/fail/1_one_var_two_types.py
diff --git a/sample_usage/typecheck/fail/2_add_str_int.py → ...ple_usage/typecheck/fail/2_add_str_int.py b/sample_usage/typecheck/fail/2_add_str_int.py → ...ple_usage/typecheck/fail/2_add_str_int.py
diff --git a/...e_usage/typecheck/fail/3_comp_str_bool.py → ...e_usage/typecheck/fail/3_comp_str_bool.py b/...e_usage/typecheck/fail/3_comp_str_bool.py → ...e_usage/typecheck/fail/3_comp_str_bool.py
diff --git a/...e_usage/typecheck/fail/4_comp_int_bool.py → ...e_usage/typecheck/fail/4_comp_int_bool.py b/...e_usage/typecheck/fail/4_comp_int_bool.py → ...e_usage/typecheck/fail/4_comp_int_bool.py
diff --git a/...le_usage/typecheck/fail/5_nested_calls.py → ...le_usage/typecheck/fail/5_nested_calls.py b/...le_usage/typecheck/fail/5_nested_calls.py → ...le_usage/typecheck/fail/5_nested_calls.py
diff --git a/sample_usage/typecheck/fail/6_call_in_add.py → ...ple_usage/typecheck/fail/6_call_in_add.py b/sample_usage/typecheck/fail/6_call_in_add.py → ...ple_usage/typecheck/fail/6_call_in_add.py
diff --git a/...age/typecheck/pass/1_two_vars_one_type.py → ...age/typecheck/pass/1_two_vars_one_type.py b/...age/typecheck/pass/1_two_vars_one_type.py → ...age/typecheck/pass/1_two_vars_one_type.py
diff --git a/...e_usage/typecheck/pass/2_int_condition.py → ...e_usage/typecheck/pass/2_int_condition.py b/...e_usage/typecheck/pass/2_int_condition.py → ...e_usage/typecheck/pass/2_int_condition.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,67 @@
+[project]
+name = "python-ta"
+description = "Code checking tool for teaching Python"
+authors = [
+    {name = "David Liu", email = "david@cs.toronto.edu"},
+]
+license = {text = "MIT"}
+readme = "README.md"
+dependencies = [
+    "astroid ~= 2.15.4",
+    "click >= 8.0.1, < 9",
+    "colorama ~= 0.4.6",
+    "jinja2 ~= 3.1.2",
+    "pycodestyle ~= 2.10.0",
+    "pygments ~= 2.14.0",
+    "pylint ~= 2.17.4",
+    "requests ~= 2.28.0",
+    "six",
+    "tabulate ~= 0.9.0",
+    "toml ~= 0.10.2",
+    "typeguard >= 2.13.3, < 3",
+    "wrapt >= 1.15.0, < 2",
+]
+dynamic = ["version"]
+requires-python = ">=3.8"
+
+[project.optional-dependencies]
+dev = [
+    "graphviz",
+    "hypothesis",
+    "inflection",
+    "myst-parser",
+    "pre-commit",
+    "pytest",
+    "pytest-snapshot",
+    "pytest-cov ~= 4.0.0",
+    "sphinx",
+    "sphinx-rtd-theme",
+]
+z3 = [
+    "z3-solver",
+]
+
+[project.scripts]
+python_ta = "python_ta.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/pyta-uoft/pyta"
+Documentation = "https://www.cs.toronto.edu/~david/pyta/"
+Repository = "https://github.com/pyta-uoft/pyta.git"
+Changelog = "https://github.com/pyta-uoft/pyta/blob/master/CHANGELOG.md"
+
+
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.dynamic]
+version = {attr = "python_ta.__version__"}
+#readme = {file = "README.md", content-type = "text/markdown"}
 
 [tool.black]
 extend-exclude = '''

diff --git a/setup.cfg b/setup.cfg
diff --git a/tests/test_check.py b/tests/test_check.py
@@ -27,7 +27,7 @@ def test_check_on_dir():
 
 def test_check_on_file():
     """Test files"""
-    _inputs = [["nodes/name.py"], ["nodes/dict.py", "nodes/const.py"]]
+    _inputs = [["examples/nodes/name.py"], ["examples/nodes/dict.py", "examples/nodes/const.py"]]
     for item in _inputs:
         python_ta.check_all(
             item,
@@ -46,8 +46,8 @@ def test_check_on_bad_input():
     _inputs = [
         [222],
         222,
-        ["nodes/dict.py nodes/const.py"],
-        [222, "examples/inline_config_comment.py", "nodes/dict.py"],
+        ["examples/nodes/dict.py examples/nodes/const.py"],
+        [222, "examples/inline_config_comment.py", "examples/nodes/dict.py"],
         ["file_does_not_exist"],
     ]
     for item in _inputs:
@@ -63,7 +63,7 @@ def test_check_on_bad_input():
 
 def test_check_with_config():
     """Test inputs along with a config arg."""
-    _inputs = [["nodes/const.py"], ["nodes"]]
+    _inputs = [["examples/nodes/const.py"], ["examples/nodes"]]
     CONFIG = {
         # [ELIF]
         "max-nested-blocks": 4,
@@ -172,7 +172,7 @@ def test_check_with_config():
 
 def test_check_saves_file() -> None:
     """Test whether or not specifiying an output properly saves a file"""
-    _inputs = [["nodes/name.py"]]
+    _inputs = [["examples/nodes/name.py"]]
     for item in _inputs:
         # Note that the reporter output will be created in the main directory
         python_ta.check_all(item, output="pyta_output.html")
@@ -195,7 +195,7 @@ def test_check_no_reporter_output() -> None:
     webbrowser.open = Mock(return_value=None)
     HTTPServer.handle_request = Mock(return_value=None)
 
-    _inputs = [["nodes/name.py"]]
+    _inputs = [["examples/nodes/name.py"]]
     for item in _inputs:
         # Note that the reporter output *would have been* created in the main directory
         python_ta.check_all(item)
@@ -234,7 +234,7 @@ def test_check_errors_nonzero() -> None:
             "python_ta",
             "--config",
             "tests/test.pylintrc",
-            "nodes/name.py",
+            "examples/nodes/name.py",
         ]
     )
 
@@ -253,7 +253,7 @@ def test_check_exit_zero() -> None:
             "--exit-zero",
             "--config",
             "tests/test.pylintrc",
-            "nodes/name.py",
+            "examples/nodes/name.py",
         ]
     )
 

diff --git a/tests/test_type_constraints/test_tnode_structure.py b/tests/test_type_constraints/test_tnode_structure.py
@@ -4,8 +4,8 @@
 import pytest
 from astroid import nodes
 
+from examples.sample_usage.draw_tnodes import gen_graph_from_nodes
 from python_ta.typecheck.base import TypeConstraints, TypeFail, _TNode
-from sample_usage.draw_tnodes import gen_graph_from_nodes
 
 from .. import custom_hypothesis_support as cs