Skip to content

Commit 2707140

Browse files
committed
use explicit optional type on arguments with default None value
Signed-off-by: Oleg Höfling <[email protected]>
1 parent 3bc1096 commit 2707140

File tree

3 files changed

+34
-25
lines changed

3 files changed

+34
-25
lines changed

src/graphql/graphql.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from asyncio import ensure_future
22
from inspect import isawaitable
3-
from typing import Any, Awaitable, Dict, Union, Type, cast
3+
from typing import Any, Awaitable, Dict, Optional, Union, Type, cast
44

55
from .error import GraphQLError
66
from .execution import execute, ExecutionResult, ExecutionContext, Middleware
@@ -21,11 +21,11 @@ async def graphql(
2121
source: Union[str, Source],
2222
root_value: Any = None,
2323
context_value: Any = None,
24-
variable_values: Dict[str, Any] = None,
25-
operation_name: str = None,
26-
field_resolver: GraphQLFieldResolver = None,
27-
type_resolver: GraphQLTypeResolver = None,
28-
middleware: Middleware = None,
24+
variable_values: Optional[Dict[str, Any]] = None,
25+
operation_name: Optional[str] = None,
26+
field_resolver: Optional[GraphQLFieldResolver] = None,
27+
type_resolver: Optional[GraphQLTypeResolver] = None,
28+
middleware: Optional[Middleware] = None,
2929
execution_context_class: Type[ExecutionContext] = ExecutionContext,
3030
) -> ExecutionResult:
3131
"""Execute a GraphQL operation asynchronously.
@@ -95,11 +95,11 @@ def graphql_sync(
9595
source: Union[str, Source],
9696
root_value: Any = None,
9797
context_value: Any = None,
98-
variable_values: Dict[str, Any] = None,
99-
operation_name: str = None,
100-
field_resolver: GraphQLFieldResolver = None,
101-
type_resolver: GraphQLTypeResolver = None,
102-
middleware: Middleware = None,
98+
variable_values: Optional[Dict[str, Any]] = None,
99+
operation_name: Optional[str] = None,
100+
field_resolver: Optional[GraphQLFieldResolver] = None,
101+
type_resolver: Optional[GraphQLTypeResolver] = None,
102+
middleware: Optional[Middleware] = None,
103103
execution_context_class: Type[ExecutionContext] = ExecutionContext,
104104
) -> ExecutionResult:
105105
"""Execute a GraphQL operation synchronously.

src/graphql/subscription/subscribe.py

+17-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
from inspect import isawaitable
2-
from typing import Any, AsyncIterable, AsyncIterator, Awaitable, Dict, Union, cast
2+
from typing import (
3+
Any,
4+
AsyncIterable,
5+
AsyncIterator,
6+
Awaitable,
7+
Dict,
8+
Optional,
9+
Union,
10+
cast,
11+
)
312

413
from ..error import GraphQLError, located_error
514
from ..execution.execute import (
@@ -23,10 +32,10 @@ async def subscribe(
2332
document: DocumentNode,
2433
root_value: Any = None,
2534
context_value: Any = None,
26-
variable_values: Dict[str, Any] = None,
27-
operation_name: str = None,
28-
field_resolver: GraphQLFieldResolver = None,
29-
subscribe_field_resolver: GraphQLFieldResolver = None,
35+
variable_values: Optional[Dict[str, Any]] = None,
36+
operation_name: Optional[str] = None,
37+
field_resolver: Optional[GraphQLFieldResolver] = None,
38+
subscribe_field_resolver: Optional[GraphQLFieldResolver] = None,
3039
) -> Union[AsyncIterator[ExecutionResult], ExecutionResult]:
3140
"""Create a GraphQL subscription.
3241
@@ -91,9 +100,9 @@ async def create_source_event_stream(
91100
document: DocumentNode,
92101
root_value: Any = None,
93102
context_value: Any = None,
94-
variable_values: Dict[str, Any] = None,
95-
operation_name: str = None,
96-
field_resolver: GraphQLFieldResolver = None,
103+
variable_values: Optional[Dict[str, Any]] = None,
104+
operation_name: Optional[str] = None,
105+
field_resolver: Optional[GraphQLFieldResolver] = None,
97106
) -> Union[AsyncIterable[Any], ExecutionResult]:
98107
"""Create source even stream
99108

src/graphql/validation/validate.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from typing import Collection, List
1+
from typing import Collection, List, Optional
22

33
from ..error import GraphQLError
44
from ..language import DocumentNode, ParallelVisitor, visit
@@ -19,9 +19,9 @@ class ValidationAbortedError(RuntimeError):
1919
def validate(
2020
schema: GraphQLSchema,
2121
document_ast: DocumentNode,
22-
rules: Collection[RuleType] = None,
23-
type_info: TypeInfo = None,
24-
max_errors: int = None,
22+
rules: Optional[Collection[RuleType]] = None,
23+
type_info: Optional[TypeInfo] = None,
24+
max_errors: Optional[int] = None,
2525
) -> List[GraphQLError]:
2626
"""Implements the "Validation" section of the spec.
2727
@@ -82,8 +82,8 @@ def on_error(error: GraphQLError) -> None:
8282

8383
def validate_sdl(
8484
document_ast: DocumentNode,
85-
schema_to_extend: GraphQLSchema = None,
86-
rules: Collection[RuleType] = None,
85+
schema_to_extend: Optional[GraphQLSchema] = None,
86+
rules: Optional[Collection[RuleType]] = None,
8787
) -> List[GraphQLError]:
8888
"""Validate an SDL document.
8989

0 commit comments

Comments
 (0)