mirror of
https://github.com/python/cpython
synced 2024-09-05 16:38:56 +00:00
![Łukasz Langa](/assets/img/avatar_default.png)
Patch by Erik Welch. bpo-19072 (#8405) allows `classmethod` to wrap other descriptors, but this does not work when the wrapped descriptor mimics classmethod. The current PR fixes this. In Python 3.8 and before, one could create a callable descriptor such that this works as expected (see Lib/test/test_decorators.py for examples): ```python class A: @myclassmethod def f1(cls): return cls @classmethod @myclassmethod def f2(cls): return cls ``` In Python 3.8 and before, `A.f2()` return `A`. Currently in Python 3.9, it returns `type(A)`. This PR make `A.f2()` return `A` again. As of #8405, classmethod calls `obj.__get__(type)` if `obj` has `__get__`. This allows one to chain `@classmethod` and `@property` together. When using classmethod-like descriptors, it's the second argument to `__get__`--the owner or the type--that is important, but this argument is currently missing. Since it is None, the "owner" argument is assumed to be the type of the first argument, which, in this case, is wrong (we want `A`, not `type(A)`). This PR updates classmethod to call `obj.__get__(type, type)` if `obj` has `__get__`. Co-authored-by: Erik Welch <erik.n.welch@gmail.com>
1181 lines
35 KiB
C
1181 lines
35 KiB
C
|
|
/* Function object implementation */
|
|
|
|
#include "Python.h"
|
|
#include "pycore_ceval.h" // _PyEval_BuiltinsFromGlobals()
|
|
#include "pycore_object.h" // _PyObject_GC_UNTRACK()
|
|
#include "pycore_pyerrors.h" // _PyErr_Occurred()
|
|
#include "structmember.h" // PyMemberDef
|
|
|
|
static uint32_t next_func_version = 1;
|
|
|
|
PyObject *
|
|
PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)
|
|
{
|
|
assert(globals != NULL);
|
|
assert(PyDict_Check(globals));
|
|
Py_INCREF(globals);
|
|
|
|
PyThreadState *tstate = _PyThreadState_GET();
|
|
|
|
PyCodeObject *code_obj = (PyCodeObject *)code;
|
|
Py_INCREF(code_obj);
|
|
|
|
PyObject *name = code_obj->co_name;
|
|
assert(name != NULL);
|
|
Py_INCREF(name);
|
|
|
|
if (!qualname) {
|
|
qualname = code_obj->co_qualname;
|
|
}
|
|
assert(qualname != NULL);
|
|
Py_INCREF(qualname);
|
|
|
|
PyObject *consts = code_obj->co_consts;
|
|
assert(PyTuple_Check(consts));
|
|
PyObject *doc;
|
|
if (PyTuple_Size(consts) >= 1) {
|
|
doc = PyTuple_GetItem(consts, 0);
|
|
if (!PyUnicode_Check(doc)) {
|
|
doc = Py_None;
|
|
}
|
|
}
|
|
else {
|
|
doc = Py_None;
|
|
}
|
|
Py_INCREF(doc);
|
|
|
|
// __module__: Use globals['__name__'] if it exists, or NULL.
|
|
_Py_IDENTIFIER(__name__);
|
|
PyObject *module = _PyDict_GetItemIdWithError(globals, &PyId___name__);
|
|
PyObject *builtins = NULL;
|
|
if (module == NULL && _PyErr_Occurred(tstate)) {
|
|
goto error;
|
|
}
|
|
Py_XINCREF(module);
|
|
|
|
builtins = _PyEval_BuiltinsFromGlobals(tstate, globals); // borrowed ref
|
|
if (builtins == NULL) {
|
|
goto error;
|
|
}
|
|
Py_INCREF(builtins);
|
|
|
|
PyFunctionObject *op = PyObject_GC_New(PyFunctionObject, &PyFunction_Type);
|
|
if (op == NULL) {
|
|
goto error;
|
|
}
|
|
/* Note: No failures from this point on, since func_dealloc() does not
|
|
expect a partially-created object. */
|
|
|
|
op->func_globals = globals;
|
|
op->func_builtins = builtins;
|
|
op->func_name = name;
|
|
op->func_qualname = qualname;
|
|
op->func_code = (PyObject*)code_obj;
|
|
op->func_defaults = NULL; // No default positional arguments
|
|
op->func_kwdefaults = NULL; // No default keyword arguments
|
|
op->func_closure = NULL;
|
|
op->func_doc = doc;
|
|
op->func_dict = NULL;
|
|
op->func_weakreflist = NULL;
|
|
op->func_module = module;
|
|
op->func_annotations = NULL;
|
|
op->vectorcall = _PyFunction_Vectorcall;
|
|
op->func_version = 0;
|
|
_PyObject_GC_TRACK(op);
|
|
return (PyObject *)op;
|
|
|
|
error:
|
|
Py_DECREF(globals);
|
|
Py_DECREF(code_obj);
|
|
Py_DECREF(name);
|
|
Py_DECREF(qualname);
|
|
Py_DECREF(doc);
|
|
Py_XDECREF(module);
|
|
Py_XDECREF(builtins);
|
|
return NULL;
|
|
}
|
|
|
|
uint32_t _PyFunction_GetVersionForCurrentState(PyFunctionObject *func)
|
|
{
|
|
if (func->func_version != 0) {
|
|
return func->func_version;
|
|
}
|
|
if (next_func_version == 0) {
|
|
return 0;
|
|
}
|
|
uint32_t v = next_func_version++;
|
|
func->func_version = v;
|
|
return v;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_New(PyObject *code, PyObject *globals)
|
|
{
|
|
return PyFunction_NewWithQualName(code, globals, NULL);
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetCode(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_code;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetGlobals(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_globals;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetModule(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_module;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetDefaults(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_defaults;
|
|
}
|
|
|
|
int
|
|
PyFunction_SetDefaults(PyObject *op, PyObject *defaults)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return -1;
|
|
}
|
|
if (defaults == Py_None)
|
|
defaults = NULL;
|
|
else if (defaults && PyTuple_Check(defaults)) {
|
|
Py_INCREF(defaults);
|
|
}
|
|
else {
|
|
PyErr_SetString(PyExc_SystemError, "non-tuple default args");
|
|
return -1;
|
|
}
|
|
((PyFunctionObject *)op)->func_version = 0;
|
|
Py_XSETREF(((PyFunctionObject *)op)->func_defaults, defaults);
|
|
return 0;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetKwDefaults(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_kwdefaults;
|
|
}
|
|
|
|
int
|
|
PyFunction_SetKwDefaults(PyObject *op, PyObject *defaults)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return -1;
|
|
}
|
|
if (defaults == Py_None)
|
|
defaults = NULL;
|
|
else if (defaults && PyDict_Check(defaults)) {
|
|
Py_INCREF(defaults);
|
|
}
|
|
else {
|
|
PyErr_SetString(PyExc_SystemError,
|
|
"non-dict keyword only default args");
|
|
return -1;
|
|
}
|
|
((PyFunctionObject *)op)->func_version = 0;
|
|
Py_XSETREF(((PyFunctionObject *)op)->func_kwdefaults, defaults);
|
|
return 0;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetClosure(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_closure;
|
|
}
|
|
|
|
int
|
|
PyFunction_SetClosure(PyObject *op, PyObject *closure)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return -1;
|
|
}
|
|
if (closure == Py_None)
|
|
closure = NULL;
|
|
else if (PyTuple_Check(closure)) {
|
|
Py_INCREF(closure);
|
|
}
|
|
else {
|
|
PyErr_Format(PyExc_SystemError,
|
|
"expected tuple for closure, got '%.100s'",
|
|
Py_TYPE(closure)->tp_name);
|
|
return -1;
|
|
}
|
|
((PyFunctionObject *)op)->func_version = 0;
|
|
Py_XSETREF(((PyFunctionObject *)op)->func_closure, closure);
|
|
return 0;
|
|
}
|
|
|
|
PyObject *
|
|
PyFunction_GetAnnotations(PyObject *op)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return NULL;
|
|
}
|
|
return ((PyFunctionObject *) op) -> func_annotations;
|
|
}
|
|
|
|
int
|
|
PyFunction_SetAnnotations(PyObject *op, PyObject *annotations)
|
|
{
|
|
if (!PyFunction_Check(op)) {
|
|
PyErr_BadInternalCall();
|
|
return -1;
|
|
}
|
|
if (annotations == Py_None)
|
|
annotations = NULL;
|
|
else if (annotations && PyDict_Check(annotations)) {
|
|
Py_INCREF(annotations);
|
|
}
|
|
else {
|
|
PyErr_SetString(PyExc_SystemError,
|
|
"non-dict annotations");
|
|
return -1;
|
|
}
|
|
((PyFunctionObject *)op)->func_version = 0;
|
|
Py_XSETREF(((PyFunctionObject *)op)->func_annotations, annotations);
|
|
return 0;
|
|
}
|
|
|
|
/* Methods */
|
|
|
|
#define OFF(x) offsetof(PyFunctionObject, x)
|
|
|
|
static PyMemberDef func_memberlist[] = {
|
|
{"__closure__", T_OBJECT, OFF(func_closure), READONLY},
|
|
{"__doc__", T_OBJECT, OFF(func_doc), 0},
|
|
{"__globals__", T_OBJECT, OFF(func_globals), READONLY},
|
|
{"__module__", T_OBJECT, OFF(func_module), 0},
|
|
{"__builtins__", T_OBJECT, OFF(func_builtins), READONLY},
|
|
{NULL} /* Sentinel */
|
|
};
|
|
|
|
static PyObject *
|
|
func_get_code(PyFunctionObject *op, void *Py_UNUSED(ignored))
|
|
{
|
|
if (PySys_Audit("object.__getattr__", "Os", op, "__code__") < 0) {
|
|
return NULL;
|
|
}
|
|
|
|
Py_INCREF(op->func_code);
|
|
return op->func_code;
|
|
}
|
|
|
|
static int
|
|
func_set_code(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
|
|
{
|
|
Py_ssize_t nclosure;
|
|
int nfree;
|
|
|
|
/* Not legal to del f.func_code or to set it to anything
|
|
* other than a code object. */
|
|
if (value == NULL || !PyCode_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"__code__ must be set to a code object");
|
|
return -1;
|
|
}
|
|
|
|
if (PySys_Audit("object.__setattr__", "OsO",
|
|
op, "__code__", value) < 0) {
|
|
return -1;
|
|
}
|
|
|
|
nfree = ((PyCodeObject *)value)->co_nfreevars;
|
|
nclosure = (op->func_closure == NULL ? 0 :
|
|
PyTuple_GET_SIZE(op->func_closure));
|
|
if (nclosure != nfree) {
|
|
PyErr_Format(PyExc_ValueError,
|
|
"%U() requires a code object with %zd free vars,"
|
|
" not %zd",
|
|
op->func_name,
|
|
nclosure, nfree);
|
|
return -1;
|
|
}
|
|
op->func_version = 0;
|
|
Py_INCREF(value);
|
|
Py_XSETREF(op->func_code, value);
|
|
return 0;
|
|
}
|
|
|
|
static PyObject *
|
|
func_get_name(PyFunctionObject *op, void *Py_UNUSED(ignored))
|
|
{
|
|
Py_INCREF(op->func_name);
|
|
return op->func_name;
|
|
}
|
|
|
|
static int
|
|
func_set_name(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
|
|
{
|
|
/* Not legal to del f.func_name or to set it to anything
|
|
* other than a string object. */
|
|
if (value == NULL || !PyUnicode_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"__name__ must be set to a string object");
|
|
return -1;
|
|
}
|
|
Py_INCREF(value);
|
|
Py_XSETREF(op->func_name, value);
|
|
return 0;
|
|
}
|
|
|
|
static PyObject *
|
|
func_get_qualname(PyFunctionObject *op, void *Py_UNUSED(ignored))
|
|
{
|
|
Py_INCREF(op->func_qualname);
|
|
return op->func_qualname;
|
|
}
|
|
|
|
static int
|
|
func_set_qualname(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
|
|
{
|
|
/* Not legal to del f.__qualname__ or to set it to anything
|
|
* other than a string object. */
|
|
if (value == NULL || !PyUnicode_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"__qualname__ must be set to a string object");
|
|
return -1;
|
|
}
|
|
Py_INCREF(value);
|
|
Py_XSETREF(op->func_qualname, value);
|
|
return 0;
|
|
}
|
|
|
|
static PyObject *
|
|
func_get_defaults(PyFunctionObject *op, void *Py_UNUSED(ignored))
|
|
{
|
|
if (PySys_Audit("object.__getattr__", "Os", op, "__defaults__") < 0) {
|
|
return NULL;
|
|
}
|
|
if (op->func_defaults == NULL) {
|
|
Py_RETURN_NONE;
|
|
}
|
|
Py_INCREF(op->func_defaults);
|
|
return op->func_defaults;
|
|
}
|
|
|
|
static int
|
|
func_set_defaults(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
|
|
{
|
|
/* Legal to del f.func_defaults.
|
|
* Can only set func_defaults to NULL or a tuple. */
|
|
if (value == Py_None)
|
|
value = NULL;
|
|
if (value != NULL && !PyTuple_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"__defaults__ must be set to a tuple object");
|
|
return -1;
|
|
}
|
|
if (value) {
|
|
if (PySys_Audit("object.__setattr__", "OsO",
|
|
op, "__defaults__", value) < 0) {
|
|
return -1;
|
|
}
|
|
} else if (PySys_Audit("object.__delattr__", "Os",
|
|
op, "__defaults__") < 0) {
|
|
return -1;
|
|
}
|
|
|
|
op->func_version = 0;
|
|
Py_XINCREF(value);
|
|
Py_XSETREF(op->func_defaults, value);
|
|
return 0;
|
|
}
|
|
|
|
static PyObject *
|
|
func_get_kwdefaults(PyFunctionObject *op, void *Py_UNUSED(ignored))
|
|
{
|
|
if (PySys_Audit("object.__getattr__", "Os",
|
|
op, "__kwdefaults__") < 0) {
|
|
return NULL;
|
|
}
|
|
if (op->func_kwdefaults == NULL) {
|
|
Py_RETURN_NONE;
|
|
}
|
|
Py_INCREF(op->func_kwdefaults);
|
|
return op->func_kwdefaults;
|
|
}
|
|
|
|
static int
|
|
func_set_kwdefaults(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
|
|
{
|
|
if (value == Py_None)
|
|
value = NULL;
|
|
/* Legal to del f.func_kwdefaults.
|
|
* Can only set func_kwdefaults to NULL or a dict. */
|
|
if (value != NULL && !PyDict_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"__kwdefaults__ must be set to a dict object");
|
|
return -1;
|
|
}
|
|
if (value) {
|
|
if (PySys_Audit("object.__setattr__", "OsO",
|
|
op, "__kwdefaults__", value) < 0) {
|
|
return -1;
|
|
}
|
|
} else if (PySys_Audit("object.__delattr__", "Os",
|
|
op, "__kwdefaults__") < 0) {
|
|
return -1;
|
|
}
|
|
|
|
op->func_version = 0;
|
|
Py_XINCREF(value);
|
|
Py_XSETREF(op->func_kwdefaults, value);
|
|
return 0;
|
|
}
|
|
|
|
static PyObject *
|
|
func_get_annotations(PyFunctionObject *op, void *Py_UNUSED(ignored))
|
|
{
|
|
if (op->func_annotations == NULL) {
|
|
op->func_annotations = PyDict_New();
|
|
if (op->func_annotations == NULL)
|
|
return NULL;
|
|
}
|
|
if (PyTuple_CheckExact(op->func_annotations)) {
|
|
PyObject *ann_tuple = op->func_annotations;
|
|
PyObject *ann_dict = PyDict_New();
|
|
if (ann_dict == NULL) {
|
|
return NULL;
|
|
}
|
|
|
|
assert(PyTuple_GET_SIZE(ann_tuple) % 2 == 0);
|
|
|
|
for (Py_ssize_t i = 0; i < PyTuple_GET_SIZE(ann_tuple); i += 2) {
|
|
int err = PyDict_SetItem(ann_dict,
|
|
PyTuple_GET_ITEM(ann_tuple, i),
|
|
PyTuple_GET_ITEM(ann_tuple, i + 1));
|
|
|
|
if (err < 0)
|
|
return NULL;
|
|
}
|
|
Py_SETREF(op->func_annotations, ann_dict);
|
|
}
|
|
Py_INCREF(op->func_annotations);
|
|
return op->func_annotations;
|
|
}
|
|
|
|
static int
|
|
func_set_annotations(PyFunctionObject *op, PyObject *value, void *Py_UNUSED(ignored))
|
|
{
|
|
if (value == Py_None)
|
|
value = NULL;
|
|
/* Legal to del f.func_annotations.
|
|
* Can only set func_annotations to NULL (through C api)
|
|
* or a dict. */
|
|
if (value != NULL && !PyDict_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"__annotations__ must be set to a dict object");
|
|
return -1;
|
|
}
|
|
op->func_version = 0;
|
|
Py_XINCREF(value);
|
|
Py_XSETREF(op->func_annotations, value);
|
|
return 0;
|
|
}
|
|
|
|
static PyGetSetDef func_getsetlist[] = {
|
|
{"__code__", (getter)func_get_code, (setter)func_set_code},
|
|
{"__defaults__", (getter)func_get_defaults,
|
|
(setter)func_set_defaults},
|
|
{"__kwdefaults__", (getter)func_get_kwdefaults,
|
|
(setter)func_set_kwdefaults},
|
|
{"__annotations__", (getter)func_get_annotations,
|
|
(setter)func_set_annotations},
|
|
{"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict},
|
|
{"__name__", (getter)func_get_name, (setter)func_set_name},
|
|
{"__qualname__", (getter)func_get_qualname, (setter)func_set_qualname},
|
|
{NULL} /* Sentinel */
|
|
};
|
|
|
|
/*[clinic input]
|
|
class function "PyFunctionObject *" "&PyFunction_Type"
|
|
[clinic start generated code]*/
|
|
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=70af9c90aa2e71b0]*/
|
|
|
|
#include "clinic/funcobject.c.h"
|
|
|
|
/* function.__new__() maintains the following invariants for closures.
|
|
The closure must correspond to the free variables of the code object.
|
|
|
|
if len(code.co_freevars) == 0:
|
|
closure = NULL
|
|
else:
|
|
len(closure) == len(code.co_freevars)
|
|
for every elt in closure, type(elt) == cell
|
|
*/
|
|
|
|
/*[clinic input]
|
|
@classmethod
|
|
function.__new__ as func_new
|
|
code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
|
|
a code object
|
|
globals: object(subclass_of="&PyDict_Type")
|
|
the globals dictionary
|
|
name: object = None
|
|
a string that overrides the name from the code object
|
|
argdefs as defaults: object = None
|
|
a tuple that specifies the default argument values
|
|
closure: object = None
|
|
a tuple that supplies the bindings for free variables
|
|
|
|
Create a function object.
|
|
[clinic start generated code]*/
|
|
|
|
static PyObject *
|
|
func_new_impl(PyTypeObject *type, PyCodeObject *code, PyObject *globals,
|
|
PyObject *name, PyObject *defaults, PyObject *closure)
|
|
/*[clinic end generated code: output=99c6d9da3a24e3be input=93611752fc2daf11]*/
|
|
{
|
|
PyFunctionObject *newfunc;
|
|
Py_ssize_t nclosure;
|
|
|
|
if (name != Py_None && !PyUnicode_Check(name)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"arg 3 (name) must be None or string");
|
|
return NULL;
|
|
}
|
|
if (defaults != Py_None && !PyTuple_Check(defaults)) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"arg 4 (defaults) must be None or tuple");
|
|
return NULL;
|
|
}
|
|
if (!PyTuple_Check(closure)) {
|
|
if (code->co_nfreevars && closure == Py_None) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"arg 5 (closure) must be tuple");
|
|
return NULL;
|
|
}
|
|
else if (closure != Py_None) {
|
|
PyErr_SetString(PyExc_TypeError,
|
|
"arg 5 (closure) must be None or tuple");
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
/* check that the closure is well-formed */
|
|
nclosure = closure == Py_None ? 0 : PyTuple_GET_SIZE(closure);
|
|
if (code->co_nfreevars != nclosure)
|
|
return PyErr_Format(PyExc_ValueError,
|
|
"%U requires closure of length %zd, not %zd",
|
|
code->co_name, code->co_nfreevars, nclosure);
|
|
if (nclosure) {
|
|
Py_ssize_t i;
|
|
for (i = 0; i < nclosure; i++) {
|
|
PyObject *o = PyTuple_GET_ITEM(closure, i);
|
|
if (!PyCell_Check(o)) {
|
|
return PyErr_Format(PyExc_TypeError,
|
|
"arg 5 (closure) expected cell, found %s",
|
|
Py_TYPE(o)->tp_name);
|
|
}
|
|
}
|
|
}
|
|
if (PySys_Audit("function.__new__", "O", code) < 0) {
|
|
return NULL;
|
|
}
|
|
|
|
newfunc = (PyFunctionObject *)PyFunction_New((PyObject *)code,
|
|
globals);
|
|
if (newfunc == NULL) {
|
|
return NULL;
|
|
}
|
|
if (name != Py_None) {
|
|
Py_INCREF(name);
|
|
Py_SETREF(newfunc->func_name, name);
|
|
}
|
|
if (defaults != Py_None) {
|
|
Py_INCREF(defaults);
|
|
newfunc->func_defaults = defaults;
|
|
}
|
|
if (closure != Py_None) {
|
|
Py_INCREF(closure);
|
|
newfunc->func_closure = closure;
|
|
}
|
|
|
|
return (PyObject *)newfunc;
|
|
}
|
|
|
|
static int
|
|
func_clear(PyFunctionObject *op)
|
|
{
|
|
op->func_version = 0;
|
|
Py_CLEAR(op->func_code);
|
|
Py_CLEAR(op->func_globals);
|
|
Py_CLEAR(op->func_builtins);
|
|
Py_CLEAR(op->func_name);
|
|
Py_CLEAR(op->func_qualname);
|
|
Py_CLEAR(op->func_module);
|
|
Py_CLEAR(op->func_defaults);
|
|
Py_CLEAR(op->func_kwdefaults);
|
|
Py_CLEAR(op->func_doc);
|
|
Py_CLEAR(op->func_dict);
|
|
Py_CLEAR(op->func_closure);
|
|
Py_CLEAR(op->func_annotations);
|
|
return 0;
|
|
}
|
|
|
|
static void
|
|
func_dealloc(PyFunctionObject *op)
|
|
{
|
|
_PyObject_GC_UNTRACK(op);
|
|
if (op->func_weakreflist != NULL) {
|
|
PyObject_ClearWeakRefs((PyObject *) op);
|
|
}
|
|
(void)func_clear(op);
|
|
PyObject_GC_Del(op);
|
|
}
|
|
|
|
static PyObject*
|
|
func_repr(PyFunctionObject *op)
|
|
{
|
|
return PyUnicode_FromFormat("<function %U at %p>",
|
|
op->func_qualname, op);
|
|
}
|
|
|
|
static int
|
|
func_traverse(PyFunctionObject *f, visitproc visit, void *arg)
|
|
{
|
|
Py_VISIT(f->func_code);
|
|
Py_VISIT(f->func_globals);
|
|
Py_VISIT(f->func_builtins);
|
|
Py_VISIT(f->func_module);
|
|
Py_VISIT(f->func_defaults);
|
|
Py_VISIT(f->func_kwdefaults);
|
|
Py_VISIT(f->func_doc);
|
|
Py_VISIT(f->func_name);
|
|
Py_VISIT(f->func_dict);
|
|
Py_VISIT(f->func_closure);
|
|
Py_VISIT(f->func_annotations);
|
|
Py_VISIT(f->func_qualname);
|
|
return 0;
|
|
}
|
|
|
|
/* Bind a function to an object */
|
|
static PyObject *
|
|
func_descr_get(PyObject *func, PyObject *obj, PyObject *type)
|
|
{
|
|
if (obj == Py_None || obj == NULL) {
|
|
Py_INCREF(func);
|
|
return func;
|
|
}
|
|
return PyMethod_New(func, obj);
|
|
}
|
|
|
|
PyTypeObject PyFunction_Type = {
|
|
PyVarObject_HEAD_INIT(&PyType_Type, 0)
|
|
"function",
|
|
sizeof(PyFunctionObject),
|
|
0,
|
|
(destructor)func_dealloc, /* tp_dealloc */
|
|
offsetof(PyFunctionObject, vectorcall), /* tp_vectorcall_offset */
|
|
0, /* tp_getattr */
|
|
0, /* tp_setattr */
|
|
0, /* tp_as_async */
|
|
(reprfunc)func_repr, /* tp_repr */
|
|
0, /* tp_as_number */
|
|
0, /* tp_as_sequence */
|
|
0, /* tp_as_mapping */
|
|
0, /* tp_hash */
|
|
PyVectorcall_Call, /* tp_call */
|
|
0, /* tp_str */
|
|
0, /* tp_getattro */
|
|
0, /* tp_setattro */
|
|
0, /* tp_as_buffer */
|
|
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
|
|
Py_TPFLAGS_HAVE_VECTORCALL |
|
|
Py_TPFLAGS_METHOD_DESCRIPTOR, /* tp_flags */
|
|
func_new__doc__, /* tp_doc */
|
|
(traverseproc)func_traverse, /* tp_traverse */
|
|
(inquiry)func_clear, /* tp_clear */
|
|
0, /* tp_richcompare */
|
|
offsetof(PyFunctionObject, func_weakreflist), /* tp_weaklistoffset */
|
|
0, /* tp_iter */
|
|
0, /* tp_iternext */
|
|
0, /* tp_methods */
|
|
func_memberlist, /* tp_members */
|
|
func_getsetlist, /* tp_getset */
|
|
0, /* tp_base */
|
|
0, /* tp_dict */
|
|
func_descr_get, /* tp_descr_get */
|
|
0, /* tp_descr_set */
|
|
offsetof(PyFunctionObject, func_dict), /* tp_dictoffset */
|
|
0, /* tp_init */
|
|
0, /* tp_alloc */
|
|
func_new, /* tp_new */
|
|
};
|
|
|
|
|
|
static int
|
|
functools_copy_attr(PyObject *wrapper, PyObject *wrapped, PyObject *name)
|
|
{
|
|
PyObject *value = PyObject_GetAttr(wrapped, name);
|
|
if (value == NULL) {
|
|
if (PyErr_ExceptionMatches(PyExc_AttributeError)) {
|
|
PyErr_Clear();
|
|
return 0;
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
int res = PyObject_SetAttr(wrapper, name, value);
|
|
Py_DECREF(value);
|
|
return res;
|
|
}
|
|
|
|
// Similar to functools.wraps(wrapper, wrapped)
|
|
static int
|
|
functools_wraps(PyObject *wrapper, PyObject *wrapped)
|
|
{
|
|
#define COPY_ATTR(ATTR) \
|
|
do { \
|
|
_Py_IDENTIFIER(ATTR); \
|
|
PyObject *attr = _PyUnicode_FromId(&PyId_ ## ATTR); \
|
|
if (attr == NULL) { \
|
|
return -1; \
|
|
} \
|
|
if (functools_copy_attr(wrapper, wrapped, attr) < 0) { \
|
|
return -1; \
|
|
} \
|
|
} while (0) \
|
|
|
|
COPY_ATTR(__module__);
|
|
COPY_ATTR(__name__);
|
|
COPY_ATTR(__qualname__);
|
|
COPY_ATTR(__doc__);
|
|
COPY_ATTR(__annotations__);
|
|
return 0;
|
|
|
|
#undef COPY_ATTR
|
|
}
|
|
|
|
|
|
/* Class method object */
|
|
|
|
/* A class method receives the class as implicit first argument,
|
|
just like an instance method receives the instance.
|
|
To declare a class method, use this idiom:
|
|
|
|
class C:
|
|
@classmethod
|
|
def f(cls, arg1, arg2, ...):
|
|
...
|
|
|
|
It can be called either on the class (e.g. C.f()) or on an instance
|
|
(e.g. C().f()); the instance is ignored except for its class.
|
|
If a class method is called for a derived class, the derived class
|
|
object is passed as the implied first argument.
|
|
|
|
Class methods are different than C++ or Java static methods.
|
|
If you want those, see static methods below.
|
|
*/
|
|
|
|
typedef struct {
|
|
PyObject_HEAD
|
|
PyObject *cm_callable;
|
|
PyObject *cm_dict;
|
|
} classmethod;
|
|
|
|
static void
|
|
cm_dealloc(classmethod *cm)
|
|
{
|
|
_PyObject_GC_UNTRACK((PyObject *)cm);
|
|
Py_XDECREF(cm->cm_callable);
|
|
Py_XDECREF(cm->cm_dict);
|
|
Py_TYPE(cm)->tp_free((PyObject *)cm);
|
|
}
|
|
|
|
static int
|
|
cm_traverse(classmethod *cm, visitproc visit, void *arg)
|
|
{
|
|
Py_VISIT(cm->cm_callable);
|
|
Py_VISIT(cm->cm_dict);
|
|
return 0;
|
|
}
|
|
|
|
static int
|
|
cm_clear(classmethod *cm)
|
|
{
|
|
Py_CLEAR(cm->cm_callable);
|
|
Py_CLEAR(cm->cm_dict);
|
|
return 0;
|
|
}
|
|
|
|
|
|
static PyObject *
|
|
cm_descr_get(PyObject *self, PyObject *obj, PyObject *type)
|
|
{
|
|
classmethod *cm = (classmethod *)self;
|
|
|
|
if (cm->cm_callable == NULL) {
|
|
PyErr_SetString(PyExc_RuntimeError,
|
|
"uninitialized classmethod object");
|
|
return NULL;
|
|
}
|
|
if (type == NULL)
|
|
type = (PyObject *)(Py_TYPE(obj));
|
|
if (Py_TYPE(cm->cm_callable)->tp_descr_get != NULL) {
|
|
return Py_TYPE(cm->cm_callable)->tp_descr_get(cm->cm_callable, type,
|
|
type);
|
|
}
|
|
return PyMethod_New(cm->cm_callable, type);
|
|
}
|
|
|
|
static int
|
|
cm_init(PyObject *self, PyObject *args, PyObject *kwds)
|
|
{
|
|
classmethod *cm = (classmethod *)self;
|
|
PyObject *callable;
|
|
|
|
if (!_PyArg_NoKeywords("classmethod", kwds))
|
|
return -1;
|
|
if (!PyArg_UnpackTuple(args, "classmethod", 1, 1, &callable))
|
|
return -1;
|
|
Py_INCREF(callable);
|
|
Py_XSETREF(cm->cm_callable, callable);
|
|
|
|
if (functools_wraps((PyObject *)cm, cm->cm_callable) < 0) {
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static PyMemberDef cm_memberlist[] = {
|
|
{"__func__", T_OBJECT, offsetof(classmethod, cm_callable), READONLY},
|
|
{"__wrapped__", T_OBJECT, offsetof(classmethod, cm_callable), READONLY},
|
|
{NULL} /* Sentinel */
|
|
};
|
|
|
|
static PyObject *
|
|
cm_get___isabstractmethod__(classmethod *cm, void *closure)
|
|
{
|
|
int res = _PyObject_IsAbstract(cm->cm_callable);
|
|
if (res == -1) {
|
|
return NULL;
|
|
}
|
|
else if (res) {
|
|
Py_RETURN_TRUE;
|
|
}
|
|
Py_RETURN_FALSE;
|
|
}
|
|
|
|
static PyGetSetDef cm_getsetlist[] = {
|
|
{"__isabstractmethod__",
|
|
(getter)cm_get___isabstractmethod__, NULL, NULL, NULL},
|
|
{"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict, NULL, NULL},
|
|
{NULL} /* Sentinel */
|
|
};
|
|
|
|
static PyObject*
|
|
cm_repr(classmethod *cm)
|
|
{
|
|
return PyUnicode_FromFormat("<classmethod(%R)>", cm->cm_callable);
|
|
}
|
|
|
|
PyDoc_STRVAR(classmethod_doc,
|
|
"classmethod(function) -> method\n\
|
|
\n\
|
|
Convert a function to be a class method.\n\
|
|
\n\
|
|
A class method receives the class as implicit first argument,\n\
|
|
just like an instance method receives the instance.\n\
|
|
To declare a class method, use this idiom:\n\
|
|
\n\
|
|
class C:\n\
|
|
@classmethod\n\
|
|
def f(cls, arg1, arg2, ...):\n\
|
|
...\n\
|
|
\n\
|
|
It can be called either on the class (e.g. C.f()) or on an instance\n\
|
|
(e.g. C().f()). The instance is ignored except for its class.\n\
|
|
If a class method is called for a derived class, the derived class\n\
|
|
object is passed as the implied first argument.\n\
|
|
\n\
|
|
Class methods are different than C++ or Java static methods.\n\
|
|
If you want those, see the staticmethod builtin.");
|
|
|
|
PyTypeObject PyClassMethod_Type = {
|
|
PyVarObject_HEAD_INIT(&PyType_Type, 0)
|
|
"classmethod",
|
|
sizeof(classmethod),
|
|
0,
|
|
(destructor)cm_dealloc, /* tp_dealloc */
|
|
0, /* tp_vectorcall_offset */
|
|
0, /* tp_getattr */
|
|
0, /* tp_setattr */
|
|
0, /* tp_as_async */
|
|
(reprfunc)cm_repr, /* tp_repr */
|
|
0, /* tp_as_number */
|
|
0, /* tp_as_sequence */
|
|
0, /* tp_as_mapping */
|
|
0, /* tp_hash */
|
|
0, /* tp_call */
|
|
0, /* tp_str */
|
|
0, /* tp_getattro */
|
|
0, /* tp_setattro */
|
|
0, /* tp_as_buffer */
|
|
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
|
|
classmethod_doc, /* tp_doc */
|
|
(traverseproc)cm_traverse, /* tp_traverse */
|
|
(inquiry)cm_clear, /* tp_clear */
|
|
0, /* tp_richcompare */
|
|
0, /* tp_weaklistoffset */
|
|
0, /* tp_iter */
|
|
0, /* tp_iternext */
|
|
0, /* tp_methods */
|
|
cm_memberlist, /* tp_members */
|
|
cm_getsetlist, /* tp_getset */
|
|
0, /* tp_base */
|
|
0, /* tp_dict */
|
|
cm_descr_get, /* tp_descr_get */
|
|
0, /* tp_descr_set */
|
|
offsetof(classmethod, cm_dict), /* tp_dictoffset */
|
|
cm_init, /* tp_init */
|
|
PyType_GenericAlloc, /* tp_alloc */
|
|
PyType_GenericNew, /* tp_new */
|
|
PyObject_GC_Del, /* tp_free */
|
|
};
|
|
|
|
PyObject *
|
|
PyClassMethod_New(PyObject *callable)
|
|
{
|
|
classmethod *cm = (classmethod *)
|
|
PyType_GenericAlloc(&PyClassMethod_Type, 0);
|
|
if (cm != NULL) {
|
|
Py_INCREF(callable);
|
|
cm->cm_callable = callable;
|
|
}
|
|
return (PyObject *)cm;
|
|
}
|
|
|
|
|
|
/* Static method object */
|
|
|
|
/* A static method does not receive an implicit first argument.
|
|
To declare a static method, use this idiom:
|
|
|
|
class C:
|
|
@staticmethod
|
|
def f(arg1, arg2, ...):
|
|
...
|
|
|
|
It can be called either on the class (e.g. C.f()) or on an instance
|
|
(e.g. C().f()). Both the class and the instance are ignored, and
|
|
neither is passed implicitly as the first argument to the method.
|
|
|
|
Static methods in Python are similar to those found in Java or C++.
|
|
For a more advanced concept, see class methods above.
|
|
*/
|
|
|
|
typedef struct {
|
|
PyObject_HEAD
|
|
PyObject *sm_callable;
|
|
PyObject *sm_dict;
|
|
} staticmethod;
|
|
|
|
static void
|
|
sm_dealloc(staticmethod *sm)
|
|
{
|
|
_PyObject_GC_UNTRACK((PyObject *)sm);
|
|
Py_XDECREF(sm->sm_callable);
|
|
Py_XDECREF(sm->sm_dict);
|
|
Py_TYPE(sm)->tp_free((PyObject *)sm);
|
|
}
|
|
|
|
static int
|
|
sm_traverse(staticmethod *sm, visitproc visit, void *arg)
|
|
{
|
|
Py_VISIT(sm->sm_callable);
|
|
Py_VISIT(sm->sm_dict);
|
|
return 0;
|
|
}
|
|
|
|
static int
|
|
sm_clear(staticmethod *sm)
|
|
{
|
|
Py_CLEAR(sm->sm_callable);
|
|
Py_CLEAR(sm->sm_dict);
|
|
return 0;
|
|
}
|
|
|
|
static PyObject *
|
|
sm_descr_get(PyObject *self, PyObject *obj, PyObject *type)
|
|
{
|
|
staticmethod *sm = (staticmethod *)self;
|
|
|
|
if (sm->sm_callable == NULL) {
|
|
PyErr_SetString(PyExc_RuntimeError,
|
|
"uninitialized staticmethod object");
|
|
return NULL;
|
|
}
|
|
Py_INCREF(sm->sm_callable);
|
|
return sm->sm_callable;
|
|
}
|
|
|
|
static int
|
|
sm_init(PyObject *self, PyObject *args, PyObject *kwds)
|
|
{
|
|
staticmethod *sm = (staticmethod *)self;
|
|
PyObject *callable;
|
|
|
|
if (!_PyArg_NoKeywords("staticmethod", kwds))
|
|
return -1;
|
|
if (!PyArg_UnpackTuple(args, "staticmethod", 1, 1, &callable))
|
|
return -1;
|
|
Py_INCREF(callable);
|
|
Py_XSETREF(sm->sm_callable, callable);
|
|
|
|
if (functools_wraps((PyObject *)sm, sm->sm_callable) < 0) {
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static PyObject*
|
|
sm_call(PyObject *callable, PyObject *args, PyObject *kwargs)
|
|
{
|
|
staticmethod *sm = (staticmethod *)callable;
|
|
return PyObject_Call(sm->sm_callable, args, kwargs);
|
|
}
|
|
|
|
static PyMemberDef sm_memberlist[] = {
|
|
{"__func__", T_OBJECT, offsetof(staticmethod, sm_callable), READONLY},
|
|
{"__wrapped__", T_OBJECT, offsetof(staticmethod, sm_callable), READONLY},
|
|
{NULL} /* Sentinel */
|
|
};
|
|
|
|
static PyObject *
|
|
sm_get___isabstractmethod__(staticmethod *sm, void *closure)
|
|
{
|
|
int res = _PyObject_IsAbstract(sm->sm_callable);
|
|
if (res == -1) {
|
|
return NULL;
|
|
}
|
|
else if (res) {
|
|
Py_RETURN_TRUE;
|
|
}
|
|
Py_RETURN_FALSE;
|
|
}
|
|
|
|
static PyGetSetDef sm_getsetlist[] = {
|
|
{"__isabstractmethod__",
|
|
(getter)sm_get___isabstractmethod__, NULL, NULL, NULL},
|
|
{"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict, NULL, NULL},
|
|
{NULL} /* Sentinel */
|
|
};
|
|
|
|
static PyObject*
|
|
sm_repr(staticmethod *sm)
|
|
{
|
|
return PyUnicode_FromFormat("<staticmethod(%R)>", sm->sm_callable);
|
|
}
|
|
|
|
PyDoc_STRVAR(staticmethod_doc,
|
|
"staticmethod(function) -> method\n\
|
|
\n\
|
|
Convert a function to be a static method.\n\
|
|
\n\
|
|
A static method does not receive an implicit first argument.\n\
|
|
To declare a static method, use this idiom:\n\
|
|
\n\
|
|
class C:\n\
|
|
@staticmethod\n\
|
|
def f(arg1, arg2, ...):\n\
|
|
...\n\
|
|
\n\
|
|
It can be called either on the class (e.g. C.f()) or on an instance\n\
|
|
(e.g. C().f()). Both the class and the instance are ignored, and\n\
|
|
neither is passed implicitly as the first argument to the method.\n\
|
|
\n\
|
|
Static methods in Python are similar to those found in Java or C++.\n\
|
|
For a more advanced concept, see the classmethod builtin.");
|
|
|
|
PyTypeObject PyStaticMethod_Type = {
|
|
PyVarObject_HEAD_INIT(&PyType_Type, 0)
|
|
"staticmethod",
|
|
sizeof(staticmethod),
|
|
0,
|
|
(destructor)sm_dealloc, /* tp_dealloc */
|
|
0, /* tp_vectorcall_offset */
|
|
0, /* tp_getattr */
|
|
0, /* tp_setattr */
|
|
0, /* tp_as_async */
|
|
(reprfunc)sm_repr, /* tp_repr */
|
|
0, /* tp_as_number */
|
|
0, /* tp_as_sequence */
|
|
0, /* tp_as_mapping */
|
|
0, /* tp_hash */
|
|
sm_call, /* tp_call */
|
|
0, /* tp_str */
|
|
0, /* tp_getattro */
|
|
0, /* tp_setattro */
|
|
0, /* tp_as_buffer */
|
|
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
|
|
staticmethod_doc, /* tp_doc */
|
|
(traverseproc)sm_traverse, /* tp_traverse */
|
|
(inquiry)sm_clear, /* tp_clear */
|
|
0, /* tp_richcompare */
|
|
0, /* tp_weaklistoffset */
|
|
0, /* tp_iter */
|
|
0, /* tp_iternext */
|
|
0, /* tp_methods */
|
|
sm_memberlist, /* tp_members */
|
|
sm_getsetlist, /* tp_getset */
|
|
0, /* tp_base */
|
|
0, /* tp_dict */
|
|
sm_descr_get, /* tp_descr_get */
|
|
0, /* tp_descr_set */
|
|
offsetof(staticmethod, sm_dict), /* tp_dictoffset */
|
|
sm_init, /* tp_init */
|
|
PyType_GenericAlloc, /* tp_alloc */
|
|
PyType_GenericNew, /* tp_new */
|
|
PyObject_GC_Del, /* tp_free */
|
|
};
|
|
|
|
PyObject *
|
|
PyStaticMethod_New(PyObject *callable)
|
|
{
|
|
staticmethod *sm = (staticmethod *)
|
|
PyType_GenericAlloc(&PyStaticMethod_Type, 0);
|
|
if (sm != NULL) {
|
|
Py_INCREF(callable);
|
|
sm->sm_callable = callable;
|
|
}
|
|
return (PyObject *)sm;
|
|
}
|