Replaced all instances of outdated type annotations (List, Dict, etc.…) #1081

CulmoneY · 2024-09-14T14:31:15Z

Proposed Changes

Updated the PythonTA codebase to use modern type annotations. Specifically, I replaced List with list, Dict with dict, Set with set, and Tuple with tuple. I addressed the following two requirements:

Added from __future__ import annotations to the top of each file where these type annotations are used, if it wasn't present already.
Removed any unused imports of List, Dict, Set, and Tuple to clean up the codebase.

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type	Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
✨ New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
♻️ Refactoring (internal change to codebase, without changing functionality)	X
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

I have performed a self-review of my changes.
- Check that all changed files included in this pull request are intentional changes.
- Check that all changes are relevant to the purpose of this pull request, as described above.
I have added tests for my changes, if applicable.
- This is required for all bug fixes and new features.
I have updated the project documentation, if applicable.
- This is required for new features.
I have updated the project Changelog (this is required for all changes).
If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

I have verified that the pre-commit.ci checks have passed.
I have verified that the CI tests have passed.
I have reviewed the test coverage changes reported by Coveralls.
I have requested a review from a project maintainer.

…) with the current built-in types (list, dict, etc.) .

david-yz-liu

@CulmoneY okay good work, though overall you were a bit too broad with your find-and-replace (see inline comments).

In addition to the comments I left inline, I have two additional comments:

You'll need to update your branch since I merged in @Raine-Yang-UofT's PR (see my message on Slack). There will be merge conflicts, so you have a good opportunity to practice resolving those.
Update the Changelog. This is an internal change.

docs/checkers/index.md

examples/ending_locations/subscript.py

python_ta/checkers/forbidden_io_function_checker.py

python_ta/checkers/forbidden_python_syntax_checker.py

tests/test_cfg/test_cfg_generator.py

david-yz-liu · 2024-09-15T00:08:41Z

tests/test_config/file_fixtures/test.pylintrc

@@ -3,15 +3,15 @@
 # Default max amount of messages for reporter to display.
 pyta-number-of-messages = 10

-# Set whether the default error messages by pylint should be overwritten by python TA's custom messages
+# set whether the default error messages by pylint should be overwritten by python TA's custom messages


Don't change this file

I'm not sure why you marked this comment as resolved; perhaps you meant to make this change, but either forgot or did not commit the change. Either way, please ensure that you double-check your work before resolving my comments, as I don't want to repeat comments.

tests/test_contracts/test_class_forward_reference.py

tests/test_custom_checkers/test_type_annotation_checker.py

tests/test_messages_config/test_no_user_config_no_pyta_overwrite.pylintrc

david-yz-liu · 2024-09-15T00:14:05Z

@CulmoneY oh sorry I realized you hadn't yet requested a review, so I may have been a bit premature! Well, keep working :)

for more information, see https://pre-commit.ci

python_ta/contracts/__init__.py

david-yz-liu · 2024-09-17T02:20:48Z

python_ta/transforms/setendings.py

@@ -478,7 +478,7 @@ def end_setter_from_source(source_code, pred, only_consumables=False):
    def set_endings_from_source(node):
        # Tuple nodes have an end_col_offset that includes the end paren,
        # but their col_offset does not include the start paren.
-        # To address this, we override the Tuple node's end_col_offset.
+        # To address this, we override the tuple node's end_col_offset.


revert this change

david-yz-liu · 2024-09-17T02:21:12Z

python_ta/z3/z3_parser.py

-    ) -> List[z3.ExprRef]:
-        """Convert an astroid List, Set, Tuple node to a list of z3 expressions."""
+    ) -> list[z3.ExprRef]:
+        """Convert an astroid list, Set, tuple node to a list of z3 expressions."""


Revert these changes

david-yz-liu · 2024-09-17T02:21:21Z

tests/test_cfg/test_cfg_generator.py

@@ -43,7 +43,7 @@ def create_cfg_funcs_only():

    This fixture specifies that cfgs will only be created for functions.
    """
-    # Setup: store the paths of the files being used/created
+    # setup: store the paths of the files being used/created


revert this change

david-yz-liu · 2024-09-17T02:22:09Z

tests/test_config/file_fixtures/test.pylintrc

@@ -3,15 +3,15 @@
 # Default max amount of messages for reporter to display.
 pyta-number-of-messages = 10

-# Set whether the default error messages by pylint should be overwritten by python TA's custom messages
+# set whether the default error messages by pylint should be overwritten by python TA's custom messages


I'm not sure why you marked this comment as resolved; perhaps you meant to make this change, but either forgot or did not commit the change. Either way, please ensure that you double-check your work before resolving my comments, as I don't want to repeat comments.

…oring_type_annotations

david-yz-liu · 2024-09-24T13:24:09Z

tests/test_contracts/test_class_contracts.py

@@ -25,7 +26,7 @@ class Person:

    age: int
    name: str
-    fav_foods: List[str]
+    fav_foods: list[str]


Okay so the tests on 3.8 are failing, and not just because of the flaky test we previously discussed. I realized that because 3.8 doesn't support the newer type annotations, we can't change these type annotations *for functions and classes that are used for contract-checking testing. This includes the functions/classes in this file and other files under tests/test_contracts. Please revert those changes.

coveralls · 2024-09-25T02:23:27Z

Pull Request Test Coverage Report for Build 11047801951

Details

59 of 62 (95.16%) changed or added relevant lines in 16 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.001%) to 92.051%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
python_ta/contracts/main.py	0	3	0.0%

Totals
Change from base Build 11018465322:	0.001%
Covered Lines:	3057
Relevant Lines:	3321

💛 - Coveralls

david-yz-liu

@CulmoneY it's great to see that the tests are passing. I left a few more comments, but also it appears you haven't addressed all of the comments I left in my previous review. You should go through each of these carefully; one strategy to keep track of your progress is to use an emoji reaction to indicate when you've fixed (and committed) a change for a particular comment.

Don't resolve any comments until you've pushed your changes and verified that the issue is actually fixed (there was at least one instance I saw where you had resolved a comment but hadn't actually made the corresponding change).

david-yz-liu · 2024-09-25T02:59:50Z

tests/test_subclass_contracts.py

@@ -9,6 +11,7 @@ class Employee:
    """
    Represents an employee

+    Representation Invariants:


delete this line

david-yz-liu · 2024-09-25T02:59:58Z

tests/test_custom_checkers/test_type_annotation_checker.py

@@ -14,7 +14,6 @@ def test_type_is_assigned_for_function(self):
        src = """
        from typing import List

-


revert this change

CulmoneY · 2024-09-26T07:50:35Z

Hi David,

All the requested changes have been implemented. I double-checked everything to ensure that there are no unnecessary or incomplete modifications. However, I would like to apologize for any inconvenience caused by premature reviews. I converted my PR from draft status to run the tests, which is why some of your requested corrections weren't implemented at the time.

Moving forward, I’ll be more mindful to avoid this and ensure that my PR is fully ready before requesting a review.

Thank you for your understanding, and I appreciate your time and feedback.

david-yz-liu

@CulmoneY looks great! For future reference, you can unmark a PR as draft in order to trigger the CI tests, and that's a separate actions from "requesting a review" from me (the latter is a separate action on GitHub). This lets you run the CI tests without yet asking for me to review it.

Replaced all instances of outdated type annotations (List, Dict, etc.…

327a861

…) with the current built-in types (list, dict, etc.) .

david-yz-liu reviewed Sep 15, 2024

View reviewed changes

Integrating manual changes and refactoring updates

ab8fc96

CulmoneY marked this pull request as draft September 15, 2024 20:23

Made fixes according to PR specifications

655c16c

CulmoneY marked this pull request as ready for review September 15, 2024 21:22

CulmoneY and others added 5 commits September 15, 2024 17:29

Merge branch 'master' into refactoring_type_annotations

43b6444

[pre-commit.ci] auto fixes from pre-commit.com hooks

5612a0c

for more information, see https://pre-commit.ci

Resolved issue with test_invalid_for_target_checker.py

e998c84

Fixed error with subscript.py

802d460

Fixed test_snapshot.py

c266525

CulmoneY marked this pull request as draft September 16, 2024 01:21

CulmoneY marked this pull request as ready for review September 16, 2024 01:21

Reverted test_snapshot.py to check for error

c34f390

david-yz-liu reviewed Sep 17, 2024

View reviewed changes

CulmoneY marked this pull request as draft September 19, 2024 22:20

CulmoneY added 2 commits September 23, 2024 12:48

Merge branch 'master' of https://github.com/CulmoneY/pyta into refact…

1fba7c1

…oring_type_annotations

Modified Change Log

59f5fb9

CulmoneY marked this pull request as ready for review September 23, 2024 16:54

david-yz-liu reviewed Sep 24, 2024

View reviewed changes

CulmoneY and others added 2 commits September 24, 2024 13:58

Reverted test_class_contracts

629e43f

Merge branch 'master' into refactoring_type_annotations

b4d4cc8

CulmoneY marked this pull request as draft September 24, 2024 18:04

CulmoneY added 4 commits September 24, 2024 17:12

modified Classes to revert to older type annotations

cd3aa97

Continued to revert classes

3ddb726

Reverted test_z3_visitor

88fc286

Reverted test_z3 and graph.py to master

fcff0d6

CulmoneY marked this pull request as ready for review September 25, 2024 02:18

CulmoneY marked this pull request as draft September 25, 2024 02:18

CulmoneY marked this pull request as ready for review September 25, 2024 02:21

CulmoneY requested a review from david-yz-liu September 25, 2024 02:21

david-yz-liu reviewed Sep 25, 2024

View reviewed changes

CulmoneY added 15 commits September 26, 2024 02:11

modified subscript.py

1e7a98f

Reverted previous Commit

de6f5bc

Fixed issue within subscript.py

ef0a8a5

Removed blank line in subscript.py

76ad655

Changes to __init__.py

6e34d0a

added test.pylintrc

04aa6fd

Fixed issue in setending.py

0231ee0

reverted changes in z3_parser.py

ccb2c7d

reverted change in test_cfg_generator

feca349

test_subclass_contracts.py

d7dcd57

Reverted changes in test_type_is_assigned_for_function

8540bee

reverted tuple in __init__

9c6a183

Reverted change in contracts/init

274c1ec

Reverted change in upload.py

fdc7d07

Reverted change in test_contracts.py

47f100d

CulmoneY requested a review from david-yz-liu September 26, 2024 07:50

david-yz-liu reviewed Sep 27, 2024

View reviewed changes

david-yz-liu merged commit 2e3061a into pyta-uoft:master Sep 27, 2024
15 checks passed

CulmoneY deleted the refactoring_type_annotations branch September 27, 2024 01:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replaced all instances of outdated type annotations (List, Dict, etc.…) #1081

Replaced all instances of outdated type annotations (List, Dict, etc.…) #1081

CulmoneY commented Sep 14, 2024 •

edited

Loading

david-yz-liu left a comment

david-yz-liu Sep 15, 2024

david-yz-liu Sep 17, 2024

david-yz-liu commented Sep 15, 2024

david-yz-liu Sep 17, 2024

david-yz-liu Sep 17, 2024

david-yz-liu Sep 17, 2024

david-yz-liu Sep 17, 2024

david-yz-liu Sep 24, 2024

coveralls commented Sep 25, 2024 •

edited

Loading

david-yz-liu left a comment

david-yz-liu Sep 25, 2024

david-yz-liu Sep 25, 2024

CulmoneY commented Sep 26, 2024

david-yz-liu left a comment

		@@ -14,7 +14,6 @@ def test_type_is_assigned_for_function(self):
		src = """
		from typing import List

Replaced all instances of outdated type annotations (List, Dict, etc.…) #1081

Replaced all instances of outdated type annotations (List, Dict, etc.…) #1081

Conversation

CulmoneY commented Sep 14, 2024 • edited Loading

Proposed Changes

Type of Change

Checklist

david-yz-liu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-yz-liu commented Sep 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Sep 25, 2024 • edited Loading

Pull Request Test Coverage Report for Build 11047801951

Details

💛 - Coveralls

david-yz-liu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CulmoneY commented Sep 26, 2024

david-yz-liu left a comment

Choose a reason for hiding this comment

CulmoneY commented Sep 14, 2024 •

edited

Loading

coveralls commented Sep 25, 2024 •

edited

Loading