Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ASF: Ignore optional-ness when comparing argument types #12605

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

Merged
merged 1 commit into from
May 12, 2025
Merged

ASF: Ignore optional-ness when comparing argument types #12605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions localstack-core/localstack/services/transcribe/provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,10 @@ def start_transcription_job(
def list_transcription_jobs(
self,
context: RequestContext,
status: TranscriptionJobStatus = None,
job_name_contains: TranscriptionJobName = None,
next_token: NextToken = None,
max_results: MaxResults = None,
status: TranscriptionJobStatus | None = None,
job_name_contains: TranscriptionJobName | None = None,
next_token: NextToken | None = None,
max_results: MaxResults | None = None,
**kwargs,
) -> ListTranscriptionJobsResponse:
store = transcribe_stores[context.account_id][context.region]
Expand Down
45 changes: 40 additions & 5 deletions localstack-core/localstack/testing/aws/asf_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
import inspect
import pkgutil
import re
from types import FunctionType, ModuleType
from typing import Optional, Pattern
from types import FunctionType, ModuleType, NoneType, UnionType
from typing import Optional, Pattern, get_args


def _import_submodules(
Expand Down Expand Up @@ -123,10 +123,45 @@ def check_provider_signature(sub_class: type, base_class: type, method_name: str

sub_spec = inspect.getfullargspec(sub_function)
base_spec = inspect.getfullargspec(base_function)
assert sub_spec == base_spec, (
f"{sub_class.__name__}#{method_name} breaks with {base_class.__name__}#{method_name}. "
f"This can also be caused by 'from __future__ import annotations' in a provider file!"

error_msg = f"{sub_class.__name__}#{method_name} breaks with {base_class.__name__}#{method_name}. This can also be caused by 'from __future__ import annotations' in a provider file!"

# Assert that the signature is correct
assert sub_spec.args == base_spec.args, error_msg
assert sub_spec.varargs == base_spec.varargs, error_msg
assert sub_spec.varkw == base_spec.varkw, error_msg
assert sub_spec.defaults == base_spec.defaults, (
error_msg + f"\n{sub_spec.defaults} != {base_spec.defaults}"
)
assert sub_spec.kwonlyargs == base_spec.kwonlyargs, error_msg
assert sub_spec.kwonlydefaults == base_spec.kwonlydefaults, error_msg

# Assert that the typing of the implementation is equal to the base
for kwarg in sub_spec.annotations:
if kwarg == "return":
assert sub_spec.annotations[kwarg] == base_spec.annotations[kwarg]
else:
# The API currently marks everything as required, and optional args are configured as:
# arg: ArgType = None
# which is obviously incorrect.
# Implementations sometimes do this correctly:
# arg: ArgType | None = None
# These should be considered equal, so until the API is fixed, we remove any Optionals
# This also gives us the flexibility to correct the API without fixing all implementations at the same time
sub_type = _remove_optional(sub_spec.annotations[kwarg])
base_type = _remove_optional(base_spec.annotations[kwarg])
assert sub_type == base_type, (
f"Types for {kwarg} are different - {sub_type} instead of {base_type}"
)

except AttributeError:
# the function is not defined in the superclass
pass


def _remove_optional(_type: type) -> list[type]:
if type(_type) == UnionType:
union_types = list(get_args(_type))
union_types.remove(NoneType)
return union_types
return [_type]
Loading