[Django] #30546: SimpleLazyObject not so lazy on Python3

9 views
Skip to first unread message

Django

unread,
Jun 5, 2019, 6:34:55 AM6/5/19
to django-...@googlegroups.com
#30546: SimpleLazyObject not so lazy on Python3
-------------------------------------+-------------------------------------
Reporter: Sławek | Owner: nobody
Ehlert |
Type: Bug | Status: new
Component: Utilities | Version: 2.2
Severity: Normal | Keywords: SimpleLazyObject
Triage Stage: | lazy evaluation
Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
When running this little script:

{{{
from django.utils.functional import *

def a_func():
raise Exception('naah')

slo = SimpleLazyObject(a_func)

assert not isinstance(slo, type)
}}}

I'd expect the assertion to pass. It works as I'd expect it to work on
Django 1.11 and Python 2.7. However, it does blow up with the {{{naah}}}
exception on both Django 1.11 and 2.2 on Python 3.5 (also on Python 3.6
and 3.7) with the following traceback:
{{{
Traceback (most recent call last):
File "<input>", line 1, in <module>
assert not isinstance(slo, type)
File "... /lib/python3.5/site-packages/django/utils/functional.py", line
238, in inner
self._setup()
File "... /lib/python3.5/site-packages/django/utils/functional.py", line
386, in _setup
self._wrapped = self._setupfunc()
File "<input>", line 2, in a_func
raise Exception('naah')
Exception: naah
}}}

I'm not sure if this is by design, but the behaviour is certainly
inconsistent on Py3 vs. Py2.

I found this problem while trying to run our test suite on Python 3.
Unittest framework does an obvious {{{if isinstance(obj, type) and
issubclass(obj, case.TestCase):}}} check when collecting the test suite
(see
https://github.com/python/cpython/blob/v3.5.7/Lib/unittest/loader.py#L122),
so when we have a module-level {{{SimpleLazyObject}}} (obviously it wraps
a different function than the one I've given here, but also a failing) it
gets unexpectedly evaluated and raises an exception, which prevents us
from even gathering the tests on Python 3.

I'm not really sure why this is happening. After some brief debugging, it
looks like {{{isinstance}}} function on Python 3 is accessing the
{{{__class__}}} attribute (which is wrapped with the
{{{new_method_proxy}}} function - see
https://github.com/django/django/blob/2.2.2/django/utils/functional.py#L348)
causing evaluation of the underlying function, whereas on Python 2.7
{{{isinstance}}} doesn't seem to do that.

--
Ticket URL: <https://code.djangoproject.com/ticket/30546>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 5, 2019, 6:35:49 AM6/5/19
to django-...@googlegroups.com
#30546: SimpleLazyObject not so lazy on Python3
-------------------------------------+-------------------------------------
Reporter: Sławek Ehlert | Owner: nobody

Type: Bug | Status: new
Component: Utilities | Version: 2.2
Severity: Normal | Resolution:

Keywords: SimpleLazyObject | Triage Stage:
lazy evaluation | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by Sławek Ehlert:

Old description:

New description:

{{{
from django.utils.functional import *

slo = SimpleLazyObject(a_func)

assert not isinstance(slo, type)
}}}

a different function than the one I've given here, but also a failing one)


it gets unexpectedly evaluated and raises an exception, which prevents us
from even gathering the tests on Python 3.

I'm not really sure why this is happening. After some brief debugging, it
looks like {{{isinstance}}} function on Python 3 is accessing the
{{{__class__}}} attribute (which is wrapped with the
{{{new_method_proxy}}} function - see
https://github.com/django/django/blob/2.2.2/django/utils/functional.py#L348)
causing evaluation of the underlying function, whereas on Python 2.7
{{{isinstance}}} doesn't seem to do that.

--

--
Ticket URL: <https://code.djangoproject.com/ticket/30546#comment:1>

Django

unread,
Jun 5, 2019, 11:33:13 AM6/5/19
to django-...@googlegroups.com
#30546: SimpleLazyObject not so lazy on Python3
-------------------------------------+-------------------------------------
Reporter: Sławek Ehlert | Owner: nobody

Type: Bug | Status: new
Component: Utilities | Version: 2.2
Severity: Normal | Resolution:

Keywords: SimpleLazyObject | Triage Stage:
lazy evaluation | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Sławek Ehlert):

To add more info. The behaviour of the example I gave is actually more
nuanced than I thought. The function actually does get called on both
Python 2 and 3. I've added a simple {{{print("inside a_func")}}} inside
that function and it turns out it gets printed in both cases. The
exception however occurs only on Python 3 and it seems it's... getting
swallowed by {{{isinstance}}} on Python 2 (?). IDK.

--
Ticket URL: <https://code.djangoproject.com/ticket/30546#comment:2>

Django

unread,
Jun 6, 2019, 2:45:11 AM6/6/19
to django-...@googlegroups.com
#30546: isinstance() call on SimpleLazyObject doesn't swallow evaluation exceptions
on Python3.

-------------------------------------+-------------------------------------
Reporter: Sławek Ehlert | Owner: nobody
Type: Bug | Status: closed
Component: Utilities | Version: master
Severity: Normal | Resolution: wontfix
Keywords: SimpleLazyObject | Triage Stage: Accepted
lazy evaluation |

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by felixxm):

* status: new => closed
* version: 2.2 => master
* resolution: => wontfix
* stage: Unreviewed => Accepted


Comment:

Thanks for the report. I was able to reproduce this issue, but to be
honest Python3 behavior looks more correctly to me. In both cases
`isinstance()` evaluates an objects, so it is not a matter of laziness. We
could accept this as a bug for Python2, but first of all this doesn't
qualify for a backport and secondly fixing this on Python2 is not what you
expect.

--
Ticket URL: <https://code.djangoproject.com/ticket/30546#comment:3>

Reply all
Reply to author
Forward
0 new messages