Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
38 changes: 38 additions & 0 deletions tests/slack_sdk/web/test_web_client_logger.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import logging
import unittest

from slack_sdk import WebClient
from slack_sdk.web import base_client
from tests.slack_sdk.web.mock_web_api_handler import MockHandler
from tests.mock_web_api_server import setup_mock_web_api_server, cleanup_mock_web_api_server


class TestWebClientLogger(unittest.TestCase):
test_logger: logging.Logger

def setUp(self):
self.test_logger = logging.Logger("test-logger")
setup_mock_web_api_server(self, MockHandler)

def tearDown(self):
cleanup_mock_web_api_server(self)

def test_logger_property_returns_default_logger(self):
client = WebClient(base_url="http://localhost:8888", token="xoxb-api_test")
self.assertEqual(client.logger.name, base_client.__name__)

def test_logger_property_returns_custom_logger(self):
client = WebClient(
base_url="http://localhost:8888",
token="xoxb-api_test",
logger=self.test_logger,
)
self.assertEqual(client.logger, self.test_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 = self.test_logger
38 changes: 38 additions & 0 deletions tests/slack_sdk_async/web/test_async_web_client_logger.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import logging
import unittest

from slack_sdk.web.async_client import AsyncWebClient
from slack_sdk.web import async_base_client
from tests.slack_sdk.web.mock_web_api_handler import MockHandler
from tests.mock_web_api_server import setup_mock_web_api_server_async, cleanup_mock_web_api_server_async


class TestAsyncWebClientLogger(unittest.TestCase):
test_logger: logging.Logger

def setUp(self):
self.test_logger = logging.Logger("test-logger")
setup_mock_web_api_server_async(self, MockHandler)

def tearDown(self):
cleanup_mock_web_api_server_async(self)

def test_logger_property_returns_default_logger(self):
client = AsyncWebClient(base_url="http://localhost:8888", token="xoxb-api_test")
self.assertEqual(client.logger.name, async_base_client.__name__)

def test_logger_property_returns_custom_logger(self):
client = AsyncWebClient(
base_url="http://localhost:8888",
token="xoxb-api_test",
logger=self.test_logger,
)
self.assertEqual(client.logger, self.test_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 = self.test_logger
Loading