Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
11 changes: 11 additions & 0 deletions slack_sdk/web/async_base_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ def __init__(
if env_variable is not None:
self.proxy = env_variable

# -------------------------
# accessors

@property
def logger(self) -> logging.Logger:
"""The logger this client uses."""
return self._logger

# -------------------------
# api call

async def api_call(
self,
api_method: str,
Expand Down
11 changes: 11 additions & 0 deletions slack_sdk/web/base_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,17 @@ def __init__(
if env_variable is not None:
self.proxy = env_variable

# -------------------------
# accessors

@property
def logger(self) -> logging.Logger:
"""The logger this client uses."""
return self._logger

# -------------------------
# api call

def api_call(
self,
api_method: str,
Expand Down
17 changes: 17 additions & 0 deletions tests/slack_sdk/web/test_web_client_issue_921_custom_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@ def test_if_it_uses_custom_logger(self):
client.chat_postMessage(channel="C111", text="hello")
self.assertTrue(logger.called)

def test_if_property_returns_custom_logger(self):
logger = CustomLogger("test-logger")
client = WebClient(
base_url="http://localhost:8888",
token="xoxb-api_test",
logger=logger,
)
self.assertEqual(client.logger, logger)

def test_logger_property_has_no_setter(self):
client = WebClient(
base_url="http://localhost:8888",
token="xoxb-api_test",
)
with self.assertRaises(AttributeError):
client.logger = CustomLogger("test-logger")


class CustomLogger(Logger):
called: bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,23 @@ async def test_if_it_uses_custom_logger(self):
await client.chat_postMessage(channel="C111", text="hello")
self.assertTrue(logger.called)

def test_if_property_returns_custom_logger(self):
logger = CustomLogger("test-logger")
client = AsyncWebClient(
base_url="http://localhost:8888",
token="xoxb-api_test",
logger=logger,
)
self.assertEqual(client.logger, logger)

def test_logger_property_has_no_setter(self):
client = AsyncWebClient(
base_url="http://localhost:8888",
token="xoxb-api_test",
)
with self.assertRaises(AttributeError):
client.logger = CustomLogger("test-logger")


class CustomLogger(Logger):
called: bool
Expand Down
Loading