org.python.core.PyMethod Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jython-slim Show documentation
Show all versions of jython-slim Show documentation
Jython is an implementation of the high-level, dynamic, object-oriented
language Python written in 100% Pure Java, and seamlessly integrated with
the Java platform. It thus allows you to run Python on any Java platform.
// Copyright (c) Corporation for National Research Initiatives
package org.python.core;
import org.python.expose.ExposedGet;
import org.python.expose.ExposedMethod;
import org.python.expose.ExposedNew;
import org.python.expose.ExposedSet;
import org.python.expose.ExposedType;
import org.python.expose.MethodType;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
/**
* A Python method.
*/
@ExposedType(name = "instancemethod", isBaseType = false, doc = BuiltinDocs.instancemethod_doc)
public class PyMethod extends PyObject implements InvocationHandler, Traverseproc {
public static final PyType TYPE = PyType.fromClass(PyMethod.class);
/** The class associated with a method. */
@ExposedGet(doc = BuiltinDocs.instancemethod_im_class_doc)
public PyObject im_class;
/** The function (or other callable) implementing a method, also available via im_func */
@ExposedGet(doc = BuiltinDocs.instancemethod___func___doc)
public PyObject __func__;
/** The instance to which a method is bound; None for unbound methods also available via im_self */
@ExposedGet(doc = BuiltinDocs.instancemethod___self___doc)
public PyObject __self__;
@Deprecated
@ExposedGet(name = "im_func")
public PyObject getFunc() {
return __func__;
}
@Deprecated
@ExposedGet(name = "im_self")
public PyObject getSelf() {
return __self__;
}
public PyMethod(PyObject function, PyObject self, PyObject type) {
super(TYPE);
if (self == Py.None){
self = null;
}
__func__ = function;
__self__ = self;
im_class = type;
}
@ExposedNew
static final PyObject instancemethod___new__(PyNewWrapper new_, boolean init, PyType subtype,
PyObject[] args, String[] keywords) {
ArgParser ap = new ArgParser("instancemethod", args, keywords, "func");
ap.noKeywords();
PyObject func = ap.getPyObject(0);
PyObject self = ap.getPyObject(1);
PyObject classObj = ap.getPyObject(2, null);
if (!func.isCallable()) {
throw Py.TypeError("first argument must be callable");
}
if (self == Py.None && classObj == null) {
throw Py.TypeError("unbound methods must have non-NULL im_class");
}
return new PyMethod(func, self, classObj);
}
@Override
public PyObject __findattr_ex__(String name) {
return instancemethod___findattr_ex__(name);
}
final PyObject instancemethod___findattr_ex__(String name) {
PyObject ret = super.__findattr_ex__(name);
if (ret != null) {
return ret;
}
return __func__.__findattr_ex__(name);
}
@ExposedMethod(doc = BuiltinDocs.instancemethod___getattribute___doc)
final PyObject instancemethod___getattribute__(PyObject arg0) {
String name = asName(arg0);
PyObject ret = instancemethod___findattr_ex__(name);
if (ret == null) {
noAttributeError(name);
}
return ret;
}
@Override
public PyObject __get__(PyObject obj, PyObject type) {
return instancemethod___get__(obj, type);
}
@ExposedMethod(defaults = "null", doc = BuiltinDocs.instancemethod___get___doc)
final PyObject instancemethod___get__(PyObject obj, PyObject type) {
// Only if classes are compatible
if (obj == null || __self__ != null) {
return this;
} else if (Py.isSubClass(obj.fastGetClass(), im_class)) {
return new PyMethod(__func__, obj, im_class);
} else {
return this;
}
}
@Override
public PyObject __call__() {
return __call__(Py.getThreadState());
}
@Override
public PyObject __call__(ThreadState state) {
PyObject self = checkSelf(null, null);
if (self == null) {
return __func__.__call__(state);
} else {
return __func__.__call__(state, self);
}
}
@Override
public PyObject __call__(PyObject arg0) {
return __call__(Py.getThreadState(), arg0);
}
@Override
public PyObject __call__(ThreadState state, PyObject arg0) {
PyObject self = checkSelf(arg0, null);
if (self == null) {
return __func__.__call__(state, arg0);
} else {
return __func__.__call__(state, self, arg0);
}
}
@Override
public PyObject __call__(PyObject arg0, PyObject arg1) {
return __call__(Py.getThreadState(), arg0, arg1);
}
@Override
public PyObject __call__(ThreadState state, PyObject arg0, PyObject arg1) {
PyObject self = checkSelf(arg0, null);
if (self == null) {
return __func__.__call__(state, arg0, arg1);
} else {
return __func__.__call__(state, self, arg0, arg1);
}
}
@Override
public PyObject __call__(PyObject arg0, PyObject arg1, PyObject arg2) {
return __call__(Py.getThreadState(), arg0, arg1, arg2);
}
@Override
public PyObject __call__(ThreadState state, PyObject arg0, PyObject arg1, PyObject arg2) {
PyObject self = checkSelf(arg0, null);
if (self == null) {
return __func__.__call__(state, arg0, arg1, arg2);
} else {
return __func__.__call__(state, self, arg0, arg1, arg2);
}
}
@Override
public PyObject __call__(PyObject arg0, PyObject arg1, PyObject arg2, PyObject arg3) {
return __call__(Py.getThreadState(), arg0, arg1, arg2, arg3);
}
@Override
public PyObject __call__(ThreadState state, PyObject arg0, PyObject arg1, PyObject arg2,
PyObject arg3) {
PyObject self = checkSelf(arg0, null);
if (self == null) {
return __func__.__call__(state, arg0, arg1, arg2, arg3);
} else {
return __func__.__call__(state, self, new PyObject[]{arg0, arg1, arg2, arg3},
Py.NoKeywords);
}
}
@Override
public PyObject __call__(PyObject arg1, PyObject[] args, String[] keywords) {
return __call__(Py.getThreadState(), arg1, args, keywords);
}
@Override
public PyObject __call__(ThreadState state, PyObject arg1, PyObject[] args,
String[] keywords) {
PyObject self = checkSelf(arg1, args);
if (self == null) {
return __func__.__call__(state, arg1, args, keywords);
} else {
PyObject[] newArgs = new PyObject[args.length + 1];
System.arraycopy(args, 0, newArgs, 1, args.length);
newArgs[0] = arg1;
return __func__.__call__(state, self, newArgs, keywords);
}
}
@Override
public PyObject __call__(PyObject[] args) {
return __call__(Py.getThreadState(), args);
}
@Override
public PyObject __call__(ThreadState state, PyObject[] args) {
return __call__(state, args, Py.NoKeywords);
}
@Override
public PyObject __call__(PyObject[] args, String[] keywords) {
return __call__(Py.getThreadState(), args, keywords);
}
@Override
public PyObject __call__(ThreadState state, PyObject[] args, String[] keywords) {
return instancemethod___call__(state, args, keywords);
}
@ExposedMethod(doc = BuiltinDocs.instancemethod___call___doc)
final PyObject instancemethod___call__(ThreadState state, PyObject[] args, String[] keywords) {
PyObject self = checkSelf(null, args);
if (self == null) {
return __func__.__call__(state, args, keywords);
} else {
return __func__.__call__(state, self, args, keywords);
}
}
private PyObject checkSelf(PyObject arg, PyObject[] args) {
PyObject self = __self__;
if (self == null) {
// Unbound methods must be called with an instance of the
// class (or a derived class) as first argument
boolean ok;
if (arg != null) {
self = arg;
} else if (args != null && args.length >= 1) {
self = args[0];
}
if (self == null) {
ok = false;
} else {
ok = Py.isInstance(self, im_class);
}
if (!ok) {
// XXX: Need equiv. of PyEval_GetFuncDesc instead of
// hardcoding "()"
String msg = String.format("unbound method %s%s must be called with %s instance as "
+ "first argument (got %s%s instead)",
getFuncName(), "()",
getClassName(im_class), getInstClassName(self),
self == null ? "" : " instance");
throw Py.TypeError(msg);
}
return null;
} else {
return self;
}
}
@Override
public int __cmp__(PyObject other) {
return instancemethod___cmp__(other);
}
@ExposedMethod(type = MethodType.CMP, doc = BuiltinDocs.instancemethod___cmp___doc)
final int instancemethod___cmp__(PyObject other) {
if (!(other instanceof PyMethod)) {
return -2;
}
PyMethod otherMethod = (PyMethod)other;
int cmp = __func__._cmp(otherMethod.__func__);
if (cmp != 0) {
return cmp;
}
if (__self__ == otherMethod.__self__) {
return 0;
}
if (__self__ == null || otherMethod.__self__ == null) {
return System.identityHashCode(__self__) < System.identityHashCode(otherMethod.__self__)
? -1 : 1;
} else {
return __self__._cmp(otherMethod.__self__);
}
}
@Override
public int hashCode() {
int hashCode = __self__ == null ? Py.None.hashCode() : __self__.hashCode();
return hashCode ^ __func__.hashCode();
}
@ExposedGet(name = "__doc__")
public PyObject getDoc() {
return __func__.__getattr__("__doc__");
}
// FIXME this should work, but it has a dependency on our descriptor mechanism!
// @ExposedSet(name = "__doc__")
// public void setDoc() {
// throw Py.AttributeError("attribute '__doc__' of 'instancemethod' objects is not writable");
// }
@Override
public String toString() {
String className = "?";
if (im_class != null) {
className = getClassName(im_class);
}
if (__self__ == null) {
return String.format("", className, getFuncName());
} else {
return String.format("", className, getFuncName(),
__self__.__str__());
}
}
private String getClassName(PyObject cls) {
if (cls instanceof PyClass) {
return ((PyClass)cls).__name__;
}
if (cls instanceof PyType) {
return ((PyType)cls).fastGetName();
}
return "?";
}
private String getInstClassName(PyObject inst) {
if (inst == null) {
return "nothing";
}
PyObject classObj = inst.__findattr__("__class__");
if (classObj == null) {
classObj = inst.getType();
}
return getClassName(classObj);
}
private String getFuncName() {
PyObject funcName = null;
try {
funcName = __func__.__findattr__("__name__");
} catch (PyException pye) {
// continue
}
if (funcName == null) {
return "?";
}
return funcName.toString();
}
@Override
public Object __tojava__(Class c) {
// Automatically coerce to single method interfaces
if (__self__ == null) {
return super.__tojava__(c); // not a bound method, so no special handling
}
if (c.isInstance(this) && c != InvocationHandler.class) {
// for base types, conversion is simple - so don't wrap!
// InvocationHandler is special, since it's a single method interface
// that we implement, but if we coerce to it we want the arguments
return c.cast( this );
} else if (c.isInterface()) {
if (c.getDeclaredMethods().length == 1 && c.getInterfaces().length == 0) {
// Proper single method interface
return proxy(c);
} else {
// Try coerce to interface with multiple overloaded versions of
// the same method (name)
String name = null;
for (Method method : c.getMethods()) {
if (method.getDeclaringClass() != Object.class) {
if (method.isDefault()) {
continue;
}
if (name == null || name.equals(method.getName())) {
name = method.getName();
} else {
name = null;
break;
}
}
}
if (name != null) { // single unique method name
return proxy(c);
}
}
}
return super.__tojava__(c);
}
private Object proxy( Class c ) {
return Proxy.newProxyInstance(c.getClassLoader(), new Class[]{c}, this);
}
public Object invoke( Object proxy, Method method, Object[] args ) throws Throwable {
// Handle invocation when invoked through Proxy (as coerced to single method interface)
if (method.getDeclaringClass() == Object.class || method.isDefault()) {
return method.invoke( this, args );
} else if (args == null || args.length == 0) {
return __call__().__tojava__(method.getReturnType());
} else {
return __call__(Py.javas2pys(args)).__tojava__(method.getReturnType());
}
}
/* Traverseproc implementation */
@Override
public int traverse(Visitproc visit, Object arg) {
int retVal;
if (im_class != null) {
retVal = visit.visit(im_class, arg);
if (retVal != 0) {
return retVal;
}
}
if (__func__ != null) {
retVal = visit.visit(__func__, arg);
if (retVal != 0) {
return retVal;
}
}
return __self__ == null ? 0 : visit.visit(__self__, arg);
}
@Override
public boolean refersDirectlyTo(PyObject ob) {
return ob != null && (ob == im_class || ob == __func__ || ob == __self__);
}
}