test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[3.1.x] Corrected signing.dumps()/loads() signatures in docs. 

Backport of 8703680ebe from master
This commit is contained in:
Mariusz Felisiak 2020-07-31 07:38:01 +02:00
parent 32cb1fe1c6
commit 0e02560535
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/topics/signing.txt
View File

@ -185,12 +185,12 @@ and tuples) if you pass in a tuple, you will get a list from
>>> signing.loads(value) >>> signing.loads(value)
['a', 'b', 'c'] ['a', 'b', 'c']
.. function:: dumps(obj, key=None, salt='django.core.signing', compress=False) .. function:: dumps(obj, key=None, salt='django.core.signing', serializer=JSONSerializer, compress=False)
Returns URL-safe, sha1 signed base64 compressed JSON string. Serialized Returns URL-safe, sha1 signed base64 compressed JSON string. Serialized
object is signed using :class:`~TimestampSigner`. object is signed using :class:`~TimestampSigner`.
.. function:: loads(string, key=None, salt='django.core.signing', max_age=None) .. function:: loads(string, key=None, salt='django.core.signing', serializer=JSONSerializer, max_age=None)
Reverse of ``dumps()``, raises ``BadSignature`` if signature fails. Reverse of ``dumps()``, raises ``BadSignature`` if signature fails.
Checks ``max_age`` (in seconds) if given. Checks ``max_age`` (in seconds) if given.