ANN401: Replace Any #3526

brunodantas · 2024-05-30T02:33:46Z

Description

Replacing a portion of the Any types with more specific types. This is my first code contribution, so I made it relatively short to make sure I'm on the right path. Does this require a RELEASE.md?

Types of Changes

Issues Fixed or Closed by This PR

Enable Ruff annotations checks #2477

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

botberry · 2024-05-30T02:35:00Z

Hi, thanks for contributing to Strawberry 🍓!

We noticed that this PR is missing a RELEASE.md file. We use that to automatically do releases here on GitHub and, most importantly, to PyPI!

So as soon as this PR is merged, a release will be made 🚀.

Here's an example of RELEASE.md:

Release type: patch

Description of the changes, ideally with some examples, if adding a new feature.

Release type can be one of patch, minor or major. We use semver, so make sure to pick the appropriate type. If in doubt feel free to ask :)

Here's the tweet text:

🆕 Release (next) is out! Thanks to Bruno Dantas for the PR 👏

Get it here 👉 https://strawberry.rocks/release/(next)

sourcery-ai

Hey @brunodantas - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 5 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

strawberry/annotation.py

sourcery-ai · 2024-05-30T02:35:03Z

strawberry/annotation.py

        try:
            return evaled_type._enum_definition
        except AttributeError:
            raise NotAStrawberryEnumError(evaled_type)

-    def create_list(self, evaled_type: Any) -> StrawberryList:
+    def create_list(self, evaled_type: TypeVar) -> StrawberryList:


question: Clarify the expected type for evaled_type.

Using TypeVar for evaled_type might be too generic. If evaled_type is expected to be a specific type or a set of types, consider using a more specific type hint or adding a type check.

sourcery-ai · 2024-05-30T02:35:03Z

strawberry/django/views.py

@@ -139,7 +141,7 @@ def __init__(
        graphql_ide: Optional[GraphQL_IDE] = "graphiql",
        allow_queries_via_get: bool = True,
        subscriptions_enabled: bool = False,
-        **kwargs: Any,
+        **kwargs: Dict[Any, Any],


suggestion: Consider using Mapping instead of Dict for kwargs.

Using Mapping instead of Dict for **kwargs can provide more flexibility and better type safety, as Mapping is a more general type.

Suggested change

**kwargs: Dict[Any, Any],

**kwargs: Mapping[Any, Any],

sourcery-ai · 2024-05-30T02:35:03Z

strawberry/extensions/field_extension.py

+        next_: SyncExtensionResolver,
+        source: Any,
+        info: Info,
+        **kwargs: Dict[Any, Any],


suggestion: Consider using Mapping instead of Dict for kwargs.

Using Mapping instead of Dict for **kwargs can provide more flexibility and better type safety, as Mapping is a more general type.

Suggested change

**kwargs: Dict[Any, Any],

**kwargs: Mapping[Any, Any],

sourcery-ai · 2024-05-30T02:35:03Z

strawberry/utils/typing.py

@@ -69,7 +69,7 @@ def get_generic_alias(type_: Type) -> Type:
    raise AssertionError(f"No GenericAlias available for {type_}")  # pragma: no cover


-def is_generic_alias(type_: Any) -> TypeGuard[_GenericAlias]:
+def is_generic_alias(type_: TypeVar) -> TypeGuard[_GenericAlias]:


question: Clarify the expected type for type_.

Using TypeVar for type_ might be too generic. If type_ is expected to be a specific type or a set of types, consider using a more specific type hint or adding a type check.

codecov · 2024-05-30T02:37:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.56%. Comparing base (e0eb336) to head (e147cf8).
Report is 9 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3526   +/-   ##
=======================================
  Coverage   96.55%   96.56%           
=======================================
  Files         523      523           
  Lines       33357    33429   +72     
  Branches     5521     5540   +19     
=======================================
+ Hits        32208    32280   +72     
  Misses        914      914           
  Partials      235      235

codspeed-hq · 2024-05-30T02:40:40Z

CodSpeed Performance Report

Merging #3526 will not alter performance

_{Comparing brunodantas:fix-ann-401 (e147cf8) with main (cdf0278)}

Summary

✅ 12 untouched benchmarks

patrick91

Thanks for doing this, really appreciated 😊

I think the types might be wrong in a few places, can you double check?

patrick91 · 2024-05-30T11:28:09Z

strawberry/aiohttp/handlers/graphql_transport_ws_handler.py

@@ -21,7 +22,7 @@ def __init__(
        debug: bool,
        connection_init_wait_timeout: timedelta,
        get_context: Callable[..., Dict[str, Any]],
-        get_root_value: Any,
+        get_root_value: Callable[..., Optional[RootValue]],


mmh, I think we don't need Optional here 🤔 (same below)

I added Optional because of this implementation, is it wrong?

strawberry/strawberry/channels/handlers/ws_handler.py

Lines 118 to 119 in 2f02b49

async def get_root_value(self, request: ChannelsConsumer) -> Optional[RootValue]:

return None

patrick91 · 2024-05-30T11:28:45Z

strawberry/annotation.py

        try:
            return evaled_type._enum_definition
        except AttributeError:
            raise NotAStrawberryEnumError(evaled_type)

-    def create_list(self, evaled_type: Any) -> StrawberryList:
+    def create_list(self, evaled_type: TypeVar) -> StrawberryList:


are you sure these are typevars?

Ops, I double checked and most seem to be type: a31f23d

patrick91 · 2024-05-30T11:29:18Z

strawberry/auto.py

@@ -24,11 +24,11 @@ class StrawberryAutoMeta(type):

    """

-    def __init__(self, *args: str, **kwargs: Any) -> None:
+    def __init__(self, *args: str, **kwargs: Dict[Any, Any]) -> None:


kwargs are implicitly marked as dicts 😊

Hmm should we keep the Dict annotations? Ruff complained about the Any.

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

replace Any

04e0bb7

sourcery-ai bot reviewed May 30, 2024

View reviewed changes

patrick91 reviewed May 30, 2024

View reviewed changes

brunodantas and others added 3 commits May 30, 2024 12:03

fix incorrect TypeVar

a31f23d

add more annotations

2380626

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

e147cf8

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ANN401: Replace Any #3526

ANN401: Replace Any #3526

brunodantas commented May 30, 2024 •

edited

Loading

botberry commented May 30, 2024 •

edited

Loading

sourcery-ai bot left a comment

sourcery-ai bot May 30, 2024

sourcery-ai bot May 30, 2024

sourcery-ai bot May 30, 2024

sourcery-ai bot May 30, 2024

codecov bot commented May 30, 2024 •

edited

Loading

codspeed-hq bot commented May 30, 2024 •

edited

Loading

patrick91 left a comment

patrick91 May 30, 2024

brunodantas May 30, 2024

patrick91 May 30, 2024

brunodantas May 30, 2024

patrick91 May 30, 2024

brunodantas May 30, 2024 •

edited

Loading

	async def get_root_value(self, request: ChannelsConsumer) -> Optional[RootValue]:
	return None

ANN401: Replace Any #3526

Are you sure you want to change the base?

ANN401: Replace Any #3526

Conversation

brunodantas commented May 30, 2024 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

botberry commented May 30, 2024 • edited Loading

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot May 30, 2024

Choose a reason for hiding this comment

sourcery-ai bot May 30, 2024

Choose a reason for hiding this comment

sourcery-ai bot May 30, 2024

Choose a reason for hiding this comment

sourcery-ai bot May 30, 2024

Choose a reason for hiding this comment

codecov bot commented May 30, 2024 • edited Loading

Codecov Report

codspeed-hq bot commented May 30, 2024 • edited Loading

CodSpeed Performance Report

Merging #3526 will not alter performance

Summary

patrick91 left a comment

Choose a reason for hiding this comment

patrick91 May 30, 2024

Choose a reason for hiding this comment

brunodantas May 30, 2024

Choose a reason for hiding this comment

patrick91 May 30, 2024

Choose a reason for hiding this comment

brunodantas May 30, 2024

Choose a reason for hiding this comment

patrick91 May 30, 2024

Choose a reason for hiding this comment

brunodantas May 30, 2024 • edited Loading

Choose a reason for hiding this comment

brunodantas commented May 30, 2024 •

edited

Loading

botberry commented May 30, 2024 •

edited

Loading

codecov bot commented May 30, 2024 •

edited

Loading

codspeed-hq bot commented May 30, 2024 •

edited

Loading

brunodantas May 30, 2024 •

edited

Loading