Skip to content
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

Changed TargetOnKart.wrap_with_lock to TargetOnKart.wrap_with_run_lock #332

Merged
merged 2 commits into from
Nov 9, 2023
Merged

Changed TargetOnKart.wrap_with_lock to TargetOnKart.wrap_with_run_lock #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0924d54
add
mski-iksm Nov 9, 2023
a701647
fix isort
mski-iksm Nov 9, 2023
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
2 changes: 1 addition & 1 deletion gokart/redis_lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def wrapper(*args, **kwargs):
return wrapper


def wrap_with_run_lock(func, redis_params: RedisParams):
def wrap_with_run_lock(func: Callable, redis_params: RedisParams):
"""Redis lock wrapper function for RunWithLock.
When a fucntion is wrapped by RunWithLock, the wrapped function will be simply wrapped with redis lock.
https://github.com/m3dev/gokart/issues/265
Expand Down
2 changes: 1 addition & 1 deletion gokart/run_with_lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ def _run_with_lock(cls, func, output_list: list):
return func()

output = output_list.pop()
wrapped_func = output.wrap_with_lock(func)
wrapped_func = output.wrap_with_run_lock(func)
return cls._run_with_lock(func=wrapped_func, output_list=output_list)
2 changes: 1 addition & 1 deletion gokart/target.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def last_modification_time(self) -> datetime:
def path(self) -> str:
return self._path()

def wrap_with_lock(self, func):
def wrap_with_run_lock(self, func):
return wrap_with_run_lock(func=func, redis_params=self._get_redis_params())

@abstractmethod
Expand Down
13 changes: 7 additions & 6 deletions test/test_redis_lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

import fakeredis

from gokart.redis_lock import RedisClient, RedisParams, make_redis_key, make_redis_params, wrap_with_dump_lock, wrap_with_remove_lock, wrap_with_run_lock
from gokart.redis_lock import (RedisClient, RedisParams, make_redis_key, make_redis_params, wrap_with_dump_lock, wrap_with_load_lock, wrap_with_remove_lock,
wrap_with_run_lock)


class TestRedisClient(unittest.TestCase):
Expand Down Expand Up @@ -253,7 +254,7 @@ def test_no_redis(self):
redis_port=None,
)
mock_func = MagicMock()
resulted = wrap_with_run_lock(func=mock_func, redis_params=redis_params)(123, b='abc')
resulted = wrap_with_load_lock(func=mock_func, redis_params=redis_params)(123, b='abc')
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TestWrapWithLoadLock was suppose to test wrap_with_load_lock(), but accidentally tested wrap_with_run_lock() in mistake.


mock_func.assert_called_once()
called_args, called_kwargs = mock_func.call_args
Expand All @@ -273,7 +274,7 @@ def test_use_redis(self):
with patch('gokart.redis_lock.redis.Redis') as redis_mock:
redis_mock.side_effect = fakeredis.FakeRedis
mock_func = MagicMock()
resulted = wrap_with_run_lock(func=mock_func, redis_params=redis_params)(123, b='abc')
resulted = wrap_with_load_lock(func=mock_func, redis_params=redis_params)(123, b='abc')

mock_func.assert_called_once()
called_args, called_kwargs = mock_func.call_args
Expand All @@ -294,7 +295,7 @@ def test_check_lock_extended(self):

with patch('gokart.redis_lock.redis.Redis') as redis_mock:
redis_mock.side_effect = fakeredis.FakeRedis
resulted = wrap_with_run_lock(func=_sample_long_func, redis_params=redis_params)(123, b='abc')
resulted = wrap_with_load_lock(func=_sample_long_func, redis_params=redis_params)(123, b='abc')
expected = dict(a=123, b='abc')
self.assertEqual(resulted, expected)

Expand All @@ -311,7 +312,7 @@ def test_lock_is_removed_after_func_is_finished(self):
with patch('gokart.redis_lock.redis.Redis') as redis_mock:
redis_mock.return_value = fakeredis.FakeRedis(server=server, host=redis_params.redis_host, port=redis_params.redis_port)
mock_func = MagicMock()
resulted = wrap_with_run_lock(func=mock_func, redis_params=redis_params)(123, b='abc')
resulted = wrap_with_load_lock(func=mock_func, redis_params=redis_params)(123, b='abc')

mock_func.assert_called_once()
called_args, called_kwargs = mock_func.call_args
Expand All @@ -336,7 +337,7 @@ def test_lock_is_removed_after_func_is_finished_with_error(self):
with patch('gokart.redis_lock.redis.Redis') as redis_mock:
redis_mock.return_value = fakeredis.FakeRedis(server=server, host=redis_params.redis_host, port=redis_params.redis_port)
try:
wrap_with_run_lock(func=_sample_func_with_error, redis_params=redis_params)(123, b='abc')
wrap_with_load_lock(func=_sample_func_with_error, redis_params=redis_params)(123, b='abc')
except Exception:
fake_redis = fakeredis.FakeStrictRedis(server=server)
with self.assertRaises(KeyError):
Expand Down
6 changes: 3 additions & 3 deletions test/test_task_on_kart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ def test_run_with_lock_decorator(self):
def _wrap(func):
return func

with patch('gokart.target.TargetOnKart.wrap_with_lock') as mock_obj:
with patch('gokart.target.TargetOnKart.wrap_with_run_lock') as mock_obj:
mock_obj.side_effect = _wrap
task.run()
mock_obj.assert_called_once()
Expand All @@ -533,7 +533,7 @@ def test_run_with_lock_decorator_multiple_output(self):
def _wrap(func):
return func

with patch('gokart.target.TargetOnKart.wrap_with_lock') as mock_obj:
with patch('gokart.target.TargetOnKart.wrap_with_run_lock') as mock_obj:
mock_obj.side_effect = _wrap
task.run()
self.assertEqual(mock_obj.call_count, 2)
Expand All @@ -544,7 +544,7 @@ def test_run_without_lock_decorator(self):
def _wrap(func):
return func

with patch('gokart.target.TargetOnKart.wrap_with_lock') as mock_obj:
with patch('gokart.target.TargetOnKart.wrap_with_run_lock') as mock_obj:
mock_obj.side_effect = _wrap
task.run()
mock_obj.assert_not_called()
Expand Down