Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix crash on functions with complex type hints #129 #156

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MahmoodAbuGneam
Copy link

Fix crash on functions with complex type hints

Fixes #129

Problem

Bowler currently crashes when attempting to process functions that have complex type hints (e.g., typing.List[str]). The error occurs because the code attempts to access the .value attribute of a Node object that represents the type hint, but complex type hints are represented as nested Node objects rather than simple values.

Solution

I modified how FunctionArgument handles type annotations by:

  1. Storing the entire AST node for type hints instead of just its value
  2. Adding proper handling for different annotation types (Node, str, Leaf)
  3. Implementing safe cloning of complex type hint nodes

Changes

  • In bowler/imr.py:

    • Updated FunctionArgument.build() to store complete annotation nodes
    • Enhanced FunctionArgument.explode() to handle all annotation types
    • Added proper node cloning to preserve type hint structure
  • In bowler/tests/query.py:

    • Added comprehensive test suite for type hint handling
    • Test coverage includes:
      • Basic complex types (List[str])
      • Nested type hints (Dict[str, List[int]])
      • Multiple type hints in same function
      • Modifying existing type hints

Testing

✅ All tests pass
✅ Code formatted with black and isort
✅ New test cases added to verify the fix

Example

Before this fix:

def process_items(items: typing.List[str]): pass
# ❌ Would crash when trying to modify this function

After this fix :

def process_items(items: typing.List[str]): pass
# ✅ Can now safely:
# - Add new arguments
# - Modify type hints
# - Handle nested type hints

This commit fixes issue facebookincubator#129 where Bowler would crash when handling functions with complex type hints like typing.List[str]. Changes include:

1. Modified FunctionArgument to properly store and handle complex type annotations
2. Added comprehensive test cases for various type hint scenarios:
   - Basic complex types (List[str])
   - Nested type hints (Dict[str, List[int]])
   - Multiple type hints in same function
   - Modifying existing type hints

The fix ensures that Bowler can now safely:
- Parse functions with complex type hints
- Add new arguments to functions with type hints
- Modify existing type hints without crashing
@facebook-github-bot
Copy link

Hi @MahmoodAbuGneam!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Feb 7, 2025
@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Crash on functions with certain typehinting
2 participants