[Numpy-discussion] Stacklevel for warnings. (original) (raw)
Sebastian Berg sebastian at sipsolutions.net
Sat Aug 11 15:05:29 EDT 2018
- Previous message (by thread): [Numpy-discussion] Stacklevel for warnings.
- Next message (by thread): [Numpy-discussion] Convolution of NumPy arrays of arbitrary dimension
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
On Sat, 2018-08-11 at 11:11 -0700, Ralf Gommers wrote:
On Sat, Aug 11, 2018 at 1:22 AM, Sebastian Berg <sebastian at sipsolutio_ _ns.net> wrote: > On Fri, 2018-08-10 at 16:05 -0600, Charles R Harris wrote: > > Hi All, > > > > Do we have a policy for the stacklevel that should be used in > NumPy? > > How far back should the stack be displayed? I note that the > optimum > > stacklevel may vary between users and developers. > > > > I thought it was so that it will point to the correct user line (or > tend to point there). So stacklevel=2 for exposed and higher for > private (python) functions IIRC. > As for developers, I would hope they are OK with (and know how to) > turning the warning into an error. > > Not sure we discussed it much, I seem to have a vague memory of > asking > if we are sure this is what we want and at least Ralf agreeing. > Also I > don't know how consistent it is overall. That sounds right to me. I think when it was introduced it was quite consistent, because Sebastian replace warning filters everywhere with suppresswarnings. Would be good to document this in the devguide.
Yeah, probably reasonably consistent, but I only added a test to check that the stacklevel argument is never missing entirely, it is up to the author to figure out what is the right level (or best easily possible, since sometimes it would be pretty ugly to make it always right).
The warning testing (suppress_warnings, etc.) or any of our tests never actually check the stacklevel that I am aware of, or maybe I forgot :), could be something to think about though. I guess we did it around the same time of the general warning testing cleanup probably.
- Sebastian
Ralf
NumPy-Discussion mailing list NumPy-Discussion at python.org https://mail.python.org/mailman/listinfo/numpy-discussion -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 833 bytes Desc: This is a digitally signed message part URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20180811/3f9e6096/attachment.sig>
- Previous message (by thread): [Numpy-discussion] Stacklevel for warnings.
- Next message (by thread): [Numpy-discussion] Convolution of NumPy arrays of arbitrary dimension
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]