summaryrefslogtreecommitdiff
path: root/docs/examples.rst
blob: daf2ee4596e0ea29d13d7044188a7c864a7c47ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
Examples
--------
This section contains some complete examples that demonstrate the main features of requests-cache.

These can also be found in the
`examples/ <https://github.com/reclosedev/requests-cache/tree/master/examples>`_ folder on GitHub.


Basic usage (with sessions)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. include:: ../examples/log_requests.py
    :start-line: 2
    :end-line: 3

.. admonition:: Example code
    :class: toggle

    .. literalinclude:: ../examples/basic_usage.py
        :lines: 1,6-


Basic usage (with patching)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. include:: ../examples/session_patch.py
    :start-line: 3
    :end-line: 4

.. admonition:: Example code
    :class: toggle

    .. literalinclude:: ../examples/session_patch.py
        :lines: 1,6-


Cache expiration
~~~~~~~~~~~~~~~~
.. include:: ../examples/expiration.py
    :start-line: 2
    :end-line: 3

.. admonition:: Example code
    :class: toggle

    .. literalinclude:: ../examples/expiration.py
        :lines: 1,5-


Logging requests
~~~~~~~~~~~~~~~~
.. include:: ../examples/log_requests.py
    :start-line: 2
    :end-line: 3

.. admonition:: Example code
    :class: toggle

    .. literalinclude:: ../examples/log_requests.py
        :lines: 1,5-


Converting an old cache
~~~~~~~~~~~~~~~~~~~~~~~
.. include:: ../examples/convert_cache.py
    :start-line: 2
    :end-line: 4

.. admonition:: Example code
    :class: toggle

    .. literalinclude:: ../examples/convert_cache.py
        :lines: 1,6-