classification
Title: Document PyFrame_FastToLocals() and PyFrame_FastToLocalsWithError()
Type: Stage:
Components: Documentation Versions: Python 3.3, Python 3.4
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: csabella, docs@python, georg.brandl, haypo, pitrou, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2013-10-29 09:55 by haypo, last changed 2017-08-28 06:57 by serhiy.storchaka.

Files
File name Uploaded Description Edit
c_api_frame.patch haypo, 2013-11-07 21:34 review
Messages (4)
msg201618 - (view) Author: STINNER Victor (haypo) * (Python committer) Date: 2013-10-29 09:55
(Copy of an email) Georg Brandl via python.org 
	
Am 29.10.2013 01:19, schrieb victor.stinner:
> http://hg.python.org/cpython/rev/4ef4578db38a
> changeset:   86715:4ef4578db38a
> user:        Victor Stinner <victor.stinner@gmail.com>
> date:        Tue Oct 29 01:19:37 2013 +0100
> summary:
>   Issue #18408: Add a new PyFrame_FastToLocalsWithError() function to handle
> exceptions when merging fast locals into f_locals of a frame.
> PyEval_GetLocals() now raises an exception and return NULL on failure.

You'll have to either make this private or document it.
msg202387 - (view) Author: STINNER Victor (haypo) * (Python committer) Date: 2013-11-07 21:34
c_api_frame.patch: document some C functions of the frame object in the C API.
msg300917 - (view) Author: Cheryl Sabella (csabella) * Date: 2017-08-27 13:54
Victor,

Should there be a PR for this?
msg300941 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-08-28 06:57
PyFrameObject already is documented in Doc/c-api/veryhigh.rst.
PyFrame_GetLineNumber() already is documented in Doc/c-api/reflection.rst.

PyFrame_FastToLocals() and PyFrame_LocalsToFast() are not documented and have weird interface. I think the use of them should be discouraged.
History
Date User Action Args
2017-08-28 06:57:16serhiy.storchakasetnosy: + serhiy.storchaka
messages: + msg300941
2017-08-27 13:54:50csabellasetnosy: + csabella
messages: + msg300917
2013-11-07 21:34:52hayposetfiles: + c_api_frame.patch
keywords: + patch
messages: + msg202387
2013-10-29 09:55:35haypocreate