Skip to content

Commit 9db7882

Browse files
DominicOramDominicOram
committed
Add Optional type hint in all places where arguments are optional
1 parent 69bc2c4 commit 9db7882

File tree

12 files changed

+71
-53
lines changed

12 files changed

+71
-53
lines changed

‎exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/metrics_encoder/__init__.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# limitations under the License.
1414
import logging
1515
from os import environ
16-
from typing import Dict, List
16+
from typing import Dict, List, Optional
1717

1818
from opentelemetry.exporter.otlp.proto.common._internal import (
1919
_encode_attributes,
@@ -66,8 +66,10 @@
6666
class OTLPMetricExporterMixin:
6767
def _common_configuration(
6868
self,
69-
preferred_temporality: Dict[type, AggregationTemporality] = None,
70-
preferred_aggregation: Dict[type, Aggregation] = None,
69+
preferred_temporality: Optional[
70+
Dict[type, AggregationTemporality]
71+
] = None,
72+
preferred_aggregation: Optional[Dict[type, Aggregation]] = None,
7173
) -> None:
7274
MetricExporter.__init__(
7375
self,

‎exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/metric_exporter/__init__.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,10 @@ def __init__(
100100
] = None,
101101
timeout: Optional[int] = None,
102102
compression: Optional[Compression] = None,
103-
preferred_temporality: Dict[type, AggregationTemporality] = None,
104-
preferred_aggregation: Dict[type, Aggregation] = None,
103+
preferred_temporality: Optional[
104+
Dict[type, AggregationTemporality]
105+
] = None,
106+
preferred_aggregation: Optional[Dict[type, Aggregation]] = None,
105107
max_export_batch_size: Optional[int] = None,
106108
):
107109
if insecure is None:

‎exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/__init__.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,9 @@ def __init__(
109109
timeout: Optional[int] = None,
110110
compression: Optional[Compression] = None,
111111
session: Optional[requests.Session] = None,
112-
preferred_temporality: Optional[Dict[type, AggregationTemporality]] = None,
112+
preferred_temporality: Optional[
113+
Dict[type, AggregationTemporality]
114+
] = None,
113115
preferred_aggregation: Optional[Dict[type, Aggregation]] = None,
114116
):
115117
self._endpoint = endpoint or environ.get(

‎opentelemetry-sdk/src/opentelemetry/sdk/_configuration/__init__.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,9 @@ def _get_exporter_names(
191191

192192
def _init_tracing(
193193
exporters: Dict[str, Type[SpanExporter]],
194-
id_generator: IdGenerator = None,
195-
sampler: Sampler = None,
196-
resource: Resource = None,
194+
id_generator: Optional[IdGenerator] = None,
195+
sampler: Optional[Sampler] = None,
196+
resource: Optional[Resource] = None,
197197
):
198198
provider = TracerProvider(
199199
id_generator=id_generator,
@@ -213,7 +213,7 @@ def _init_metrics(
213213
exporters_or_readers: Dict[
214214
str, Union[Type[MetricExporter], Type[MetricReader]]
215215
],
216-
resource: Resource = None,
216+
resource: Optional[Resource] = None,
217217
):
218218
metric_readers = []
219219

@@ -235,7 +235,7 @@ def _init_metrics(
235235

236236
def _init_logging(
237237
exporters: Dict[str, Type[LogExporter]],
238-
resource: Resource = None,
238+
resource: Optional[Resource] = None,
239239
setup_logging_handler: bool = True,
240240
):
241241
provider = LoggerProvider(resource=resource)
@@ -366,7 +366,7 @@ def _initialize_components(
366366
log_exporter_names: Optional[List[str]] = None,
367367
sampler: Optional[Sampler] = None,
368368
resource_attributes: Optional[Attributes] = None,
369-
id_generator: IdGenerator = None,
369+
id_generator: Optional[IdGenerator] = None,
370370
setup_logging_handler: Optional[bool] = None,
371371
):
372372
if trace_exporter_names is None:

‎opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -602,11 +602,13 @@ def emit(self, record: LogRecord):
602602
class LoggerProvider(APILoggerProvider):
603603
def __init__(
604604
self,
605-
resource: Resource = None,
605+
resource: Optional[Resource] = None,
606606
shutdown_on_exit: bool = True,
607-
multi_log_record_processor: Union[
608-
SynchronousMultiLogRecordProcessor,
609-
ConcurrentMultiLogRecordProcessor,
607+
multi_log_record_processor: Optional[
608+
Union[
609+
SynchronousMultiLogRecordProcessor,
610+
ConcurrentMultiLogRecordProcessor,
611+
]
610612
] = None,
611613
):
612614
if resource is None:

‎opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/__init__.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,10 @@ class BatchLogRecordProcessor(LogRecordProcessor):
171171
def __init__(
172172
self,
173173
exporter: LogExporter,
174-
schedule_delay_millis: float = None,
175-
max_export_batch_size: int = None,
176-
export_timeout_millis: float = None,
177-
max_queue_size: int = None,
174+
schedule_delay_millis: Optional[float] = None,
175+
max_export_batch_size: Optional[int] = None,
176+
export_timeout_millis: Optional[float] = None,
177+
max_queue_size: Optional[int] = None,
178178
):
179179
if max_queue_size is None:
180180
max_queue_size = BatchLogRecordProcessor._default_max_queue_size()

‎opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/export/__init__.py‎

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,11 @@ class MetricExporter(ABC):
9191

9292
def __init__(
9393
self,
94-
preferred_temporality: Dict[type, AggregationTemporality] = None,
95-
preferred_aggregation: Dict[
96-
type, "opentelemetry.sdk.metrics.view.Aggregation"
94+
preferred_temporality: Optional[
95+
Dict[type, AggregationTemporality]
96+
] = None,
97+
preferred_aggregation: Optional[
98+
Dict[type, "opentelemetry.sdk.metrics.view.Aggregation"]
9799
] = None,
98100
) -> None:
99101
self._preferred_temporality = preferred_temporality
@@ -144,9 +146,11 @@ def __init__(
144146
formatter: Callable[
145147
["opentelemetry.sdk.metrics.export.MetricsData"], str
146148
] = lambda metrics_data: metrics_data.to_json() + linesep,
147-
preferred_temporality: Dict[type, AggregationTemporality] = None,
148-
preferred_aggregation: Dict[
149-
type, "opentelemetry.sdk.metrics.view.Aggregation"
149+
preferred_temporality: Optional[
150+
Dict[type, AggregationTemporality]
151+
] = None,
152+
preferred_aggregation: Optional[
153+
Dict[type, "opentelemetry.sdk.metrics.view.Aggregation"]
150154
] = None,
151155
):
152156
super().__init__(
@@ -209,9 +213,11 @@ class MetricReader(ABC):
209213

210214
def __init__(
211215
self,
212-
preferred_temporality: Dict[type, AggregationTemporality] = None,
213-
preferred_aggregation: Dict[
214-
type, "opentelemetry.sdk.metrics.view.Aggregation"
216+
preferred_temporality: Optional[
217+
Dict[type, AggregationTemporality]
218+
] = None,
219+
preferred_aggregation: Optional[
220+
Dict[type, "opentelemetry.sdk.metrics.view.Aggregation"]
215221
] = None,
216222
) -> None:
217223
self._collect: Callable[
@@ -387,9 +393,11 @@ class InMemoryMetricReader(MetricReader):
387393

388394
def __init__(
389395
self,
390-
preferred_temporality: Dict[type, AggregationTemporality] = None,
391-
preferred_aggregation: Dict[
392-
type, "opentelemetry.sdk.metrics.view.Aggregation"
396+
preferred_temporality: Optional[
397+
Dict[type, AggregationTemporality]
398+
] = None,
399+
preferred_aggregation: Optional[
400+
Dict[type, "opentelemetry.sdk.metrics.view.Aggregation"]
393401
] = None,
394402
) -> None:
395403
super().__init__(

‎opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ def __new__(cls, *args, **kwargs):
159159
def add(
160160
self,
161161
amount: Union[int, float],
162-
attributes: Dict[str, str] = None,
162+
attributes: Optional[Dict[str, str]] = None,
163163
context: Optional[Context] = None,
164164
):
165165
if amount < 0:
@@ -188,7 +188,7 @@ def __new__(cls, *args, **kwargs):
188188
def add(
189189
self,
190190
amount: Union[int, float],
191-
attributes: Dict[str, str] = None,
191+
attributes: Optional[Dict[str, str]] = None,
192192
context: Optional[Context] = None,
193193
):
194194
time_unix_nano = time_ns()
@@ -250,7 +250,7 @@ def __new__(cls, *args, **kwargs):
250250
def record(
251251
self,
252252
amount: Union[int, float],
253-
attributes: Dict[str, str] = None,
253+
attributes: Optional[Dict[str, str]] = None,
254254
context: Optional[Context] = None,
255255
):
256256
if amount < 0:
@@ -280,7 +280,7 @@ def __new__(cls, *args, **kwargs):
280280
def set(
281281
self,
282282
amount: Union[int, float],
283-
attributes: Dict[str, str] = None,
283+
attributes: Optional[Dict[str, str]] = None,
284284
context: Optional[Context] = None,
285285
):
286286
time_unix_nano = time_ns()

‎opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ def _drain_queue(self):
376376
while self.queue:
377377
self._export_batch()
378378

379-
def force_flush(self, timeout_millis: int = None) -> bool:
379+
def force_flush(self, timeout_millis: Optional[int] = None) -> bool:
380380
if timeout_millis is None:
381381
timeout_millis = self.export_timeout_millis
382382

‎opentelemetry-sdk/tests/metrics/test_view_instrument_match.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# pylint: disable=protected-access
1616

1717
from time import time_ns
18-
from typing import Callable, Sequence, Type
18+
from typing import Callable, Optional, Sequence, Type
1919
from unittest import TestCase
2020
from unittest.mock import MagicMock, Mock, patch
2121

@@ -50,7 +50,7 @@
5050

5151

5252
def generalized_reservoir_factory(
53-
size: int = 1, boundaries: Sequence[float] = None
53+
size: int = 1, boundaries: Optional[Sequence[float]] = None
5454
) -> Callable[[Type[_Aggregation]], ExemplarReservoirBuilder]:
5555
def factory(
5656
aggregation_type: Type[_Aggregation],

0 commit comments

Comments
 (0)