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.

Sign up for GitHub

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

Jump to bottom

Handle type validation for string type hints #333

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Handle type validation for string type hints #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9cadc0
Handle type validation for string type hints (#333)
williamlw999-fb Aug 16, 2022
d9d4d52
Merge branch 'facebook:main' into handle_str_types
williamlw999-fb Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions tests/mock_callable_testslide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,36 @@ def passes_with_invalid_argument_type(self):
}
self.callable_target(*call_args, **call_kwargs)

@context.example
def passes_with_valid_str_types(self):
args = (
"str val",
1234,
{"key1": "string", "key2": 4321},
)
kwargs = {"kwarg1": 1234}
self.mock_callable(
sample_module, "instance_method_with_str_types"
).for_call(*args, **kwargs).to_return_value("hello")
sample_module.instance_method_with_str_types(
*args, **kwargs
)

@context.example
def raises_TypeCheckError_for_invalid_str_types(self):
args = (1234, 1234, 1234)
kwargs = {"kwarg1": "str val"}
self.mock_callable(
sample_module, "instance_method_with_str_types"
).for_call(*args, **kwargs).to_return_value("hello")
with self.assertRaisesRegex(
TypeCheckError,
r"(?ms)type of arg1 must be str.*type of arg3 must be a dict.*",
):
sample_module.instance_method_with_str_types(
*args, **kwargs
)

if has_return_value:

@context.sub_context
Expand All @@ -205,6 +235,43 @@ def raises_TypeCheckError(self):
*self.call_args, **self.call_kwargs
)

@context.example
def passes_with_valid_str_return_types(self):
args = (
"str val",
1234,
{"key1": "string", "key2": 4321},
)
kwargs = {"kwarg1": 1234}
self.mock_callable(
sample_module, "instance_method_with_str_types"
).to_return_value("hello")
sample_module.instance_method_with_str_types(
*args, **kwargs
)

@context.example
def raises_TypeCheckError_for_invalid_str_return_types(
self,
):
args = (
"str val",
1234,
{"key1": "string", "key2": 4321},
)
kwargs = {"kwarg1": 1234}
self.mock_callable(
sample_module, "instance_method_with_str_types"
).to_return_value(1234)
with self.assertRaisesRegex(
TypeCheckError,
r"(?ms)type of return must be one of \(str, NoneType\); "
"got int instead: 1234.*",
):
sample_module.instance_method_with_str_types(
*args, **kwargs
)

@context.sub_context(".for_call(*args, **kwargs)")
def for_call_args_kwargs(context):
@context.sub_context
Expand Down
6 changes: 6 additions & 0 deletions tests/sample_module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,12 @@ def test_function_returns_coroutine(
return async_test_function(arg1, arg2, kwarg1, kwarg2)


def instance_method_with_str_types(
arg1: "str", arg2: "Any", arg3: "UnionArgType", kwarg1: "int"
) -> "Optional[str]":
return "original response"


UnionArgType = Dict[str, Union[str, int]]


Expand Down
21 changes: 16 additions & 5 deletions testslide/lib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,17 @@
from functools import wraps
from inspect import Traceback
from types import FrameType
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Tuple, Type, Union
from typing import (
TYPE_CHECKING,
Any,
Callable,
Dict,
Optional,
Tuple,
Type,
Union,
get_type_hints,
)
from unittest.mock import Mock

import typeguard
Expand Down Expand Up @@ -244,6 +254,7 @@ def _validate_callable_arg_types(
kwargs: Dict[str, Any],
) -> None:
argspec = inspect.getfullargspec(callable_template)
type_hints = get_type_hints(callable_template)
idx_offset = 1 if skip_first_arg else 0
type_errors = []
for idx in range(0, len(args)):
Expand All @@ -254,7 +265,7 @@ def _validate_callable_arg_types(
raise TypeError("Extra argument given: ", repr(args[idx]))
argname = argspec.args[idx + idx_offset]
try:
expected_type = argspec.annotations.get(argname)
expected_type = type_hints.get(argname)
if not expected_type:
continue

Expand All @@ -264,7 +275,7 @@ def _validate_callable_arg_types(

for argname, value in kwargs.items():
try:
expected_type = argspec.annotations.get(argname)
expected_type = type_hints.get(argname)
if not expected_type:
continue

Expand Down Expand Up @@ -357,10 +368,10 @@ def _validate_return_type(
unwrap_template_awaitable: bool = False,
) -> None:
try:
argspec = inspect.getfullargspec(template)
type_hints = get_type_hints(template)
expected_type = type_hints.get("return")
except TypeError:
return
expected_type = argspec.annotations.get("return")
if expected_type:
if unwrap_template_awaitable:
type_origin = get_origin(expected_type)
Expand Down