Opened 8 years ago

Closed 8 years ago

#2848 closed defect (fixed)

[patch] CommentManager doctest is broken.

Reported by: Maximillian Dornseif <md@…> Owned by: adrian
Component: Contrib apps Version: master
Severity: minor Keywords: cache win32 linux freebsd
Cc: md@… Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

It seems to me that a docstring in the comment model is broken - it can't wor without instantating an object. And this resultet in python manage.py test failing for my project. See below for the exact error. Since the comment system is meant to be rewritten I spent no time further investigating the issue but just disabled the docstring like this:

+++ django/contrib/comments/models.py   (working copy)
     def get_rating_options(self, rating_string):
[...]
-        >>> s = "scale:1-10|First_category|Second_category"
-        >>> get_rating_options(s)
+        >> s = "scale:1-10|First_category|Second_category"
+        >> get_rating_options(s)

(full patch at http://c0re.23.nu/c0de/misc/django-3884-comment_doctests.py#)

Error message:

======================================================================
FAIL: Doctest: django.contrib.comments.models.CommentManager.get_rating_options
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/private/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/Django-0.95-py2.4.egg/django/test/doctest.py", line 2156, in runTest
    raise self.failureException(self.format_failure(new.getvalue()))
AssertionError: Failed doctest test for django.contrib.comments.models.CommentManager.get_rating_options
  File "/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/Django-0.95-py2.4.egg/django/contrib/comments/models.py", line 33, in get_rating_options

----------------------------------------------------------------------
File "/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/Django-0.95-py2.4.egg/django/contrib/comments/models.py", line 37, in django.contrib.comments.models.CommentManager.get_rating_options
Failed example:
    get_rating_options(s)
Exception raised:
    Traceback (most recent call last):
      File "/private/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/Django-0.95-py2.4.egg/django/test/doctest.py", line 1243, in __run
        compileflags, 1) in test.globs
      File "<doctest django.contrib.comments.models.CommentManager.get_rating_options[1]>", line 1, in ?
        get_rating_options(s)
    NameError: name 'get_rating_options' is not defined

Attachments (2)

comment_test.diff (665 bytes) - added by pb@… 8 years ago.
quick patch to fix doctest
django-comment-doctest.diff (631 bytes) - added by dummy@… 8 years ago.
This fixes the doctest, the other patch file disables the doctest

Download all attachments as: .zip

Change History (6)

comment:1 Changed 8 years ago by pb@…

I ran into this problem today and wrote a quick patch before coming across this ticket. I'll attach it, FWIW.

Changed 8 years ago by pb@…

quick patch to fix doctest

comment:2 Changed 8 years ago by pb@…

  • Keywords cache win32 linux freebsd added
  • priority changed from low to normal

Changing priority to Normal

Changed 8 years ago by dummy@…

This fixes the doctest, the other patch file disables the doctest

comment:3 Changed 8 years ago by verbosus

I’ve just been bitten by this bug as well: basically whenever I run python manage.py test on my project (that includes the comments app) the comments get tested and my test suite fails.

comment:4 Changed 8 years ago by jacob

  • Resolution set to fixed
  • Status changed from new to closed

(In [4049]) Fixed #2848: broken doctest in comment app. Thanks, dummy@…

Note: See TracTickets for help on using tickets.
Back to Top