Skip to content

Add missing return type annotations to LogRecordProcessor and LoggerProvider #5008

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

Open
joshwilhelmi wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

Add missing return type annotations to LogRecordProcessor and LoggerProvider #5008

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
10 changes: 5 additions & 5 deletions opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ def on_emit(self, log_record: ReadWriteLogRecord):
"""

@abc.abstractmethod
def on_emit(self, log_record: ReadWriteLogRecord):
def on_emit(self, log_record: ReadWriteLogRecord) -> None:
"""Emits the ``ReadWriteLogRecord``.

Implementers should handle any exceptions raised during log processing
Expand All @@ -334,7 +334,7 @@ def on_emit(self, log_record: ReadWriteLogRecord):
"""

@abc.abstractmethod
def shutdown(self):
def shutdown(self) -> None:
"""Called when a :class:`opentelemetry.sdk._logs.Logger` is shutdown"""

@abc.abstractmethod
Expand Down Expand Up @@ -448,10 +448,10 @@ def _submit_and_wait(
for future in futures:
future.result()

def on_emit(self, log_record: ReadWriteLogRecord):
def on_emit(self, log_record: ReadWriteLogRecord) -> None:
self._submit_and_wait(lambda lp: lp.on_emit, log_record)

def shutdown(self):
def shutdown(self) -> None:
self._submit_and_wait(lambda lp: lp.shutdown)

def force_flush(self, timeout_millis: int = 30000) -> bool:
Expand Down Expand Up @@ -806,7 +806,7 @@ def add_log_record_processor(
log_record_processor
)

def shutdown(self):
def shutdown(self) -> None:
"""Shuts down the log processors."""
self._multi_log_record_processor.shutdown()
if self._at_exit_handler is not None:
Expand Down
Loading