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

tests/test_config/file_fixtures/test.pylintrc

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

david-yz-liu · 2024-09-17T02:19:26Z

python_ta/contracts/__init__.py

@@ -29,12 +31,12 @@

 DEBUG_CONTRACTS = False
 """
-Set to True to display debugging messages when checking contracts.
+set to True to display debugging messages when checking contracts.


This still needs to be reverted (as below)

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

python_ta/contracts/__init__.py

-    >>> from typing import List
-    >>> _display_annotation(List[int])
-    'typing.List[int]'
+    >>> from typing import list


This entire doctest example needs to be updated (note that you can, and should, run the doctest example manually to ensure it passes)

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

tests/test_config/file_fixtures/test.pylintrc

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

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 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 17, 2024

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

Are you sure you want to change the base?

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

david-yz-liu commented Sep 15, 2024

david-yz-liu Sep 17, 2024

Choose a reason for hiding this comment

david-yz-liu Sep 17, 2024

Choose a reason for hiding this comment

david-yz-liu Sep 17, 2024

Choose a reason for hiding this comment

david-yz-liu Sep 17, 2024

Choose a reason for hiding this comment

david-yz-liu Sep 17, 2024

Choose a reason for hiding this comment

CulmoneY commented Sep 14, 2024 •

edited

Loading