p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #4558 from hyunchel/fix-incorrect-example-in-cache-doc 

Update cache doc with correct example
This commit is contained in:
Bruno Oliveira 2018-12-21 14:33:41 -02:00 committed by GitHub
parent 0a40ae4c6a ece01b0f56
commit b5cd43bc95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog/4558.doc.rst Normal file
View File

@ -0,0 +1 @@
Update cache documentation example to correctly show cache hit and miss.

10
doc/en/cache.rst
View File

@ -185,11 +185,14 @@ across pytest invocations::
import pytest import pytest
import time import time
def expensive_computation():
print("running expensive computation...")
@pytest.fixture @pytest.fixture
def mydata(request): def mydata(request):
val = request.config.cache.get("example/value", None) val = request.config.cache.get("example/value", None)
if val is None: if val is None:
time.sleep(9*0.6) # expensive computation :) expensive_computation()
val = 42 val = 42
request.config.cache.set("example/value", val) request.config.cache.set("example/value", val)
return val return val
@ -197,8 +200,7 @@ across pytest invocations::
def test_function(mydata): def test_function(mydata):
assert mydata == 23 assert mydata == 23
If you run this command once, it will take a while because If you run this command for the first time, you can see the print statement:
of the sleep:
.. code-block:: pytest .. code-block:: pytest
@ -217,7 +219,7 @@ of the sleep:
1 failed in 0.12 seconds 1 failed in 0.12 seconds
If you run it a second time the value will be retrieved from If you run it a second time the value will be retrieved from
the cache and this will be quick: the cache and nothing will be printed:
.. code-block:: pytest .. code-block:: pytest