#19683: A minor mistake?
-------------------------------+------------------------------------
Reporter: sunsongxp@… | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.4
Severity: Normal | Resolution:
Keywords: signing | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by aaugustin):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
* type: Uncategorized => Bug
* stage: Unreviewed => Accepted
Old description:
> https://docs.djangoproject.com/en/1.4/topics/signing/
>
> In this page, which is about signing, enumerates several examples about
> how to use it. When it comes to that handling Exception, to be specific,
>
> >>> value += 'm'
> >>> try:
> ... original = signer.unsign(value)
> ... except signing.BadSignature:
> ... print "Tampering detected!"
>
> I found that these lines failed, the error shows signing.BadSignature is
> not defined, I tested a while, and then I knew,
>
> from django.core import signing
>
> is required. The example miss that. I don't know if that count as a
> mistake. Besides, the information about previous line is so scarce in
> reference, do I need to check the source code?
New description:
https://docs.djangoproject.com/en/1.4/topics/signing/
In this page, which is about signing, enumerates several examples about
how to use it. When it comes to that handling Exception, to be specific,
{{{
>>> value += 'm'
>>> try:
... original = signer.unsign(value)
... except signing.BadSignature:
... print "Tampering detected!"
}}}
I found that these lines failed, the error shows signing.BadSignature is
not defined, I tested a while, and then I knew,
{{{
from django.core import signing
}}}
is required. The example miss that. I don't know if that count as a
mistake. Besides, the information about previous line is so scarce in
reference, do I need to check the source code?
--
Comment:
Yes -- it's a good practice to include relevant imports in code samples.
--
Ticket URL: <https://code.djangoproject.com/ticket/19683#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
