jep.python

Class PyObject

java.lang.Object

jep.python.PyObject

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

PyCallable, PyClass, PyModule

public class PyObject
extends java.lang.Object
implements java.lang.AutoCloseable

A Java object that wraps a pointer to a Python object. This class is not thread safe and PyObjects can only be used on the Thread where they were created. When a Jep instance is closed all PyObjects from that instance will be invalid and can no longer be used. This class is in the process of a redesign so methods may be added, removed, or changed in ways that are not backwards compatible in the future. When using this class it may require extra effort to move to a new version of Jep.

Constructor Summary

Constructors

Constructor and Description
PyObject(long tstate, long pyObject, Jep jep) Make a new PyObject

Method Summary

Modifier and Type	Method and Description
void	close()
void	decref() Deprecated. internal use only
void	delAttr(java.lang.String attr_name) Deletes an attribute on the wrapped Python object, similar to the Python built-in function delattr.
boolean	equals(java.lang.Object obj) Checks that the Java type matches and if so then uses Python's rich compare with the == operator to check if this wrapped Python object matches the other PyObject.
java.lang.Object	getAttr(java.lang.String attr_name) Access an attribute of the wrapped Python Object, similar to the Python built-in function getattr.
<T> T	getAttr(java.lang.String attr_name, java.lang.Class<T> clazz) Access an attribute of the wrapped Python Object, similar to the Python built-in function getattr.
int	hashCode() Produces the hash code of the wrapped Python object by using the Python built-in method hash.
void	incref() Deprecated. internal use only
void	isValid() Deprecated. In a future release this method will not be public and/or its method signature may change.
void	set(java.lang.String name, boolean v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, boolean[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, byte b) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, byte[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, char v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, char[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, double v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, double[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, float v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, float[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, int v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, int[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, long v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, long[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, java.lang.Object v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, short v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, short[] v) Deprecated. Use setAttr(String, Object) instead.
void	set(java.lang.String name, java.lang.String v) Deprecated. Use setAttr(String, Object) instead.
void	setAttr(java.lang.String attr_name, java.lang.Object o) Sets an attribute on the wrapped Python object, similar to the Python built-in function setattr.
java.lang.String	toString() Produces the string representation of the wrapped Python object by using the Python built-in method str.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PyObject

public PyObject(long tstate,
                long pyObject,
                Jep jep)
         throws JepException

Make a new PyObject

Parameters:

tstate - a long value

pyObject - the address of the python object

jep - the instance of jep that created this object

Throws:

JepException - if an error occurs

Method Detail

isValid

@Deprecated
public void isValid()
                         throws JepException

Deprecated. In a future release this method will not be public and/or its method signature may change.

Check if PyObject is valid.

Throws:

JepException - if it is not safe to use this python object

decref

@Deprecated
public void decref()
                        throws JepException

Deprecated. internal use only

Throws:

JepException - if an error occurs

incref

@Deprecated
public void incref()
                        throws JepException

Deprecated. internal use only

Throws:

JepException - if an error occurs

close

public void close()
           throws JepException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

JepException

set

@Deprecated
public void set(java.lang.String name,
                            java.lang.Object v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - an Object value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            java.lang.String v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a String value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            boolean v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a boolean value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            int v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - an int value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            short v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - an int value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            char[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a char[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            char v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a char value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            byte b)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

b - a byte value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            long v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a long value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            double v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a double value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            float v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a float value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            boolean[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a boolean[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            int[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - an int[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            short[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a short[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            byte[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a byte[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            long[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a long[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            double[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a double[] value

Throws:

JepException - if an error occurs

set

@Deprecated
public void set(java.lang.String name,
                            float[] v)
                     throws JepException

Deprecated. Use setAttr(String, Object) instead.

Describe set method here.

Parameters:

name - a String value

v - a float[] value

Throws:

JepException - if an error occurs

getAttr

public java.lang.Object getAttr(java.lang.String attr_name)
                         throws JepException

Access an attribute of the wrapped Python Object, similar to the Python built-in function getattr. This is equivalent to the Python statement this.attr_name.

Parameters:

attr_name - the attribute name

Returns:

a Java version of the attribute

Throws:

JepException - if an error occurs

Since:

3.8

getAttr

public <T> T getAttr(java.lang.String attr_name,
                     java.lang.Class<T> clazz)
              throws JepException

Access an attribute of the wrapped Python Object, similar to the Python built-in function getattr. This method allows you to specify the return type, the supported types are the same as Jep.getValue(String, Class).

Type Parameters:

T - the generic type of the return type

Parameters:

attr_name - the attribute name

clazz - the Java class of the return type.

Returns:

a Java version of the attribute

Throws:

JepException - if an error occurs

Since:

3.8

setAttr

public void setAttr(java.lang.String attr_name,
                    java.lang.Object o)
             throws JepException

Sets an attribute on the wrapped Python object, similar to the Python built-in function setattr. This is equivalent to the Python statement this.attr_name = o.

Parameters:

attr_name - the attribute name

o - the object to set as an attribute

Throws:

JepException - if an error occurs

Since:

3.8

delAttr

public void delAttr(java.lang.String attr_name)
             throws JepException

Deletes an attribute on the wrapped Python object, similar to the Python built-in function delattr. This is equivalent to the Python statement del this.attr_name.

Parameters:

attr_name - the name of the attribute to be deleted

Throws:

JepException - if an error occurs

Since:

3.8

equals

public boolean equals(java.lang.Object obj)

Checks that the Java type matches and if so then uses Python's rich compare with the == operator to check if this wrapped Python object matches the other PyObject. Equals is not consistent between languages. Java is strict on equality while Python is flexible. For example in Python code: Integer.valueOf(5) == 5 will evaluate to True while in Java code: Integer.valueOf(5).equals(other) where other is a PyObject wrapping 5 will evaluate to false.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Produces the string representation of the wrapped Python object by using the Python built-in method str.

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Produces the hash code of the wrapped Python object by using the Python built-in method hash. Hash codes are not consistent between languages. For example the hash code of the string "hello" will be different in Python than in Java, even if this PyObject wrapped the string "hello".

Overrides:

hashCode in class java.lang.Object