Add support for time.monotonic (and time.monotonic_ns)
#369
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmehnle
force-pushed
the
feature/time.monotonic
branch
from
399a7f8 to
05b6926
Compare
|
Looks good to me! You feel comfortable with me merging? |
jmehnle
force-pushed
the
feature/time.monotonic
branch
from
05b6926 to
8938a69
Compare
|
I added minimalistic documentation to |
|
Thanks! |
|
Can we expect a new release, say, 1.0.1, any time soon? |
|
@spulec ? |
marcinsulikowski
added a commit
to marcinsulikowski/freezegun
that referenced
this pull request
Sep 14, 2022
The following code:
async def test():
with freeze_time("2020-01-01"):
await asyncio.sleep(0.01)
hangs forever since FreezeGun 1.1.0 because 1.1.0 started patching
`time.monotonic()` (see spulec#369) which is used internally by `asyncio`
event loops to schedule code for execution in the future. This breaks
many projects that uses FreezeGun to test asynchronous code.
We fix this by changing `freeze_time` to patch asyncio event loop's
`time()` method in a way that it uses real monotnic time instead of the
frozen one. Note that we couldn't achieve this by adding `asyncio` to
`DEFAULT_IGNORE_LIST` in `freezegun/config.py` because any running async
code has functions from the `asyncio` module on its stack -- adding
`asyncio` to the ignore list would just disable freezeing time in any
async code. This is why we patch one method of a specific class instead.
This change not only fixes `asyncio.sleep()` but also things like
`asyncio.get_running_loop().call_later` (for scheduling task execution
in the future) which in turn makes things like timeouts work in async
code while time is frozen. This may not be desired because some users
may expect that execution of events scheduled to happen in the future
can be controlled using FreezeGun. However, it's not easy to distinguish
between things that users would like to see frozen time and those which
should not (like `asyncio.sleep()`) because all of them use the same
clock. Therefore, we opt for making all `asyncio` internals not affected
by FreezeGun.
We also add more tests that verify how FreezeGun interacts with asyncio
code, including tests that cover the scenario described in spulec#401 which we
aim to fix.
Closes spulec#401
marcinsulikowski
added a commit
to marcinsulikowski/freezegun
that referenced
this pull request
Sep 14, 2022
The following code:
async def test():
with freeze_time("2020-01-01"):
await asyncio.sleep(0.01)
hangs forever since FreezeGun 1.1.0 because 1.1.0 started patching
`time.monotonic()` (see spulec#369) which is used internally by `asyncio`
event loops to schedule code for execution in the future. This breaks
many projects that uses FreezeGun to test asynchronous code.
We fix this by changing `freeze_time` to patch asyncio event loop's
`time()` method in a way that it uses real monotonic time instead of the
frozen one. Note that we couldn't achieve this by adding `asyncio` to
`DEFAULT_IGNORE_LIST` in `freezegun/config.py` because any running async
code has functions from the `asyncio` module on its stack -- adding
`asyncio` to the ignore list would just disable freezing time in any
async code. This is why we patch one method of a specific class instead.
This change not only fixes `asyncio.sleep()` but also things like
`asyncio.get_running_loop().call_later` (for scheduling task execution
in the future) which in turn makes things like timeouts work in async
code while time is frozen. This may not be desired because some users
may expect that execution of events scheduled to happen in the future
can be controlled using FreezeGun. However, it's not easy to distinguish
between things that users would like to see frozen time and those which
should not (like `asyncio.sleep()`) because all of them use the same
clock. Therefore, we opt for making all `asyncio` internals not affected
by FreezeGun.
We also add more tests that verify how FreezeGun interacts with asyncio
code, including tests that cover the scenario described in spulec#401 which we
aim to fix.
Closes spulec#401
marcinsulikowski
added a commit
to marcinsulikowski/freezegun
that referenced
this pull request
Sep 14, 2022
The following code:
async def test():
with freeze_time("2020-01-01"):
await asyncio.sleep(0.01)
hangs forever since FreezeGun 1.1.0 because 1.1.0 started patching
`time.monotonic()` (see spulec#369) which is used internally by `asyncio`
event loops to schedule code for execution in the future. This breaks
many projects that uses FreezeGun to test asynchronous code.
We fix this by changing `freeze_time` to patch asyncio event loop's
`time()` method in a way that it uses real monotonic time instead of the
frozen one. Note that we couldn't achieve this by adding `asyncio` to
`DEFAULT_IGNORE_LIST` in `freezegun/config.py` because any running async
code has functions from the `asyncio` module on its stack -- adding
`asyncio` to the ignore list would just disable freezing time in any
async code. This is why we patch one method of a specific class instead.
This change not only fixes `asyncio.sleep()` but also things like
`asyncio.get_running_loop().call_later` (for scheduling task execution
in the future) which in turn makes things like timeouts work in async
code while time is frozen. This may not be desired because some users
may expect that execution of events scheduled to happen in the future
can be controlled using FreezeGun. However, it's not easy to distinguish
between things that users would like to see frozen time and those which
should not (like `asyncio.sleep()`) because all of them use the same
clock. Therefore, we opt for making all `asyncio` internals not affected
by FreezeGun.
We also add more tests that verify how FreezeGun interacts with asyncio
code, including tests that cover the scenario described in spulec#437 which we
aim to fix.
Closes spulec#401
Closes spulec#437
marcinsulikowski
added a commit
to marcinsulikowski/freezegun
that referenced
this pull request
Feb 20, 2023
The following code:
async def test():
with freeze_time("2020-01-01"):
await asyncio.sleep(0.01)
hangs forever since FreezeGun 1.1.0 because 1.1.0 started patching
`time.monotonic()` (see spulec#369) which is used internally by `asyncio`
event loops to schedule code for execution in the future. This breaks
many projects that uses FreezeGun to test asynchronous code.
We fix this by changing `freeze_time` to patch asyncio event loop's
`time()` method in a way that it uses real monotonic time instead of the
frozen one. Note that we couldn't achieve this by adding `asyncio` to
`DEFAULT_IGNORE_LIST` in `freezegun/config.py` because any running async
code has functions from the `asyncio` module on its stack -- adding
`asyncio` to the ignore list would just disable freezing time in any
async code. This is why we patch one method of a specific class instead.
This change not only fixes `asyncio.sleep()` but also things like
`asyncio.get_running_loop().call_later` (for scheduling task execution
in the future) which in turn makes things like timeouts work in async
code while time is frozen. This may not be desired because some users
may expect that execution of events scheduled to happen in the future
can be controlled using FreezeGun. However, it's not easy to distinguish
between things that users would like to see frozen time and those which
should not (like `asyncio.sleep()`) because all of them use the same
clock. Therefore, we opt for making all `asyncio` internals not affected
by FreezeGun.
We also add more tests that verify how FreezeGun interacts with asyncio
code, including tests that cover the scenario described in spulec#437 which we
aim to fix.
Closes spulec#401
Closes spulec#437
marcinsulikowski
added a commit
to marcinsulikowski/freezegun
that referenced
this pull request
Feb 20, 2023
The following code:
async def test():
with freeze_time("2020-01-01"):
await asyncio.sleep(0.01)
hangs forever since FreezeGun 1.1.0 because 1.1.0 started patching
`time.monotonic()` (see spulec#369) which is used internally by `asyncio`
event loops to schedule code for execution in the future. This breaks
many projects that uses FreezeGun to test asynchronous code.
We fix this by changing `freeze_time` to patch asyncio event loop's
`time()` method in a way that it uses real monotonic time instead of the
frozen one. Note that we couldn't achieve this by adding `asyncio` to
`DEFAULT_IGNORE_LIST` in `freezegun/config.py` because any running async
code has functions from the `asyncio` module on its stack -- adding
`asyncio` to the ignore list would just disable freezing time in any
async code. This is why we patch one method of a specific class instead.
This change not only fixes `asyncio.sleep()` but also things like
`asyncio.get_running_loop().call_later` (for scheduling task execution
in the future) which in turn makes things like timeouts work in async
code while time is frozen. This may not be desired because some users
may expect that execution of events scheduled to happen in the future
can be controlled using FreezeGun. However, it's not easy to distinguish
between things that users would like to see frozen time and those which
should not (like `asyncio.sleep()`) because all of them use the same
clock. Therefore, we opt for making all `asyncio` internals not affected
by FreezeGun.
We also add more tests that verify how FreezeGun interacts with asyncio
code, including tests that cover the scenario described in spulec#437 which we
aim to fix.
Closes spulec#401
Closes spulec#437
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's a seemingly abandoned attempt at adding support for
time.monotonicin #199. As there were major changes tofreezegunsince then, I decided to take a fresh stab at implementing such support. It's worth noting thattime.monotonicdoesn't give many guarantees to begin with, so not many are tested.I'd be happy to add a few documentation bits if this implementation and the accompanying tests work for you.