mock function arguments in python

Question

Lets say I have this function

from datetime import date

def get_next_friday(base_date=date.today()):
   next_friday = ...
   return next_friday

Then I have a celery task to call this function without passing in the base_date

@celery_app.task
def refresh_settlement_date():
   Record.objects.update(process_date=get_next_friday())

In the unittest I am running the refresh_settlement_date() task, but it's not providing the base_date when it's calling the get_next_friday(), my question is how to mock that parameter to test the days in the future?

I am trying to avoid adding parameter to become refresh_settlement_date(base_date) as it doesn't serve real purpose but only for unittest.

Community · Accepted Answer · 2017-05-23 11:56:53Z

4

An alternative approach would to be to patch the current date.

There is a relevant thread with multiple options:

Python: Trying to mock datetime.date.today() but not working

My favorite option is to use a third-party module called freezegun.

You would need only one line to add, very clean and readable:

@freeze_time("2014-10-14")
def test_refresh_settlement_date_in_the_future(self):
    ...

edited May 23, 2017 at 11:56

CommunityBot

11 silver badge

answered Sep 5, 2014 at 1:59

alecxe

476k127 gold badges1.1k silver badges1.2k bronze badges

Sign up to request clarification or add additional context in comments.

Comments

tripleee · Accepted Answer · 2023-12-28 20:14:21Z

1

You need to @patch get_next_friday() function and substitute its return value with the one you need:

date_in_the_future = date.today() + timedelta(50)
next_friday_in_the_future = get_next_friday(base_date=date_in_the_future)

with patch('module_under_test.get_next_friday') as mocked_function:
    mocked_function.return_value = next_friday_in_the_future
    
    # call refresh_settlement_date

edited Dec 28, 2023 at 20:14

tripleee

192k37 gold badges318 silver badges367 bronze badges

answered Sep 5, 2014 at 1:54

alecxe

476k127 gold badges1.1k silver badges1.2k bronze badges

1 Comment

James Lin Over a year ago

Thanks it's very similar to my own solution

James Lin · Accepted Answer · 2014-09-05 01:54:09Z

1

I just tried this out, it seems to work:

first I need to copy the function:

old_get_next_friday = get_next_friday

then patch it:

with patch.object(get_next_friday) as mocked_func:
    for i in range(8):
        mocked_func.return_value = old_get_next_friday(date.today() + timedelta(days=i))
        refresh_settlement_date()

answered Sep 5, 2014 at 1:54

James Lin

26.8k39 gold badges144 silver badges251 bronze badges

Collectives™ on Stack Overflow

mock function arguments in python

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related