Top Description Fields Constructors Methods
org.python.core

public Class PyClass

extends PyObject
implements Traverseproc
Class Inheritance
All Implemented Interfaces
org.python.core.Traverseproc
Annotations
@ExposedType
name:classobj
isBaseType:false
Imports
org.python.expose.ExposedNew, .ExposedType, org.python.core.finalization.FinalizeTrigger
The classic Python class.

Field Summary

Modifier and TypeField and Description
public PyTuple
__bases__

The base classes of this class

pack-priv PyObject
__contains__

pack-priv PyObject
__del__

pack-priv PyObject
__delattr__

public PyObject
__dict__

Holds the namespace for this class

pack-priv PyObject
__getattr__

public String
__name__

The name of this class

pack-priv PyObject
__setattr__

pack-priv PyObject
__tojava__

public static final PyType
TYPE

Hides org.python.core.PyObject.TYPE.

Inherited from org.python.core.PyObject:
attributesgcMonitorGlobalobjtype

Constructor Summary

AccessConstructor and Description
private
PyClass()

Create a new instance of a Python classic class.

Method Summary

Modifier and TypeMethod and Description
public PyObject
__call__(PyObject[]
all arguments to the function (including keyword arguments).
args, String[]
the keywords used for all keyword arguments.
keywords)

Overrides org.python.core.PyObject.__call__.

The basic method to override when implementing a callable object.

public int
__cmp__(PyObject
the object to compare this with.
other)

Overrides org.python.core.PyObject.__cmp__.

Equivalent to the standard Python __cmp__ method.

public void
__delattr__(String
the name which will be removed - must be an interned string .
name)

Overrides org.python.core.PyObject.__delattr__.

A variant of the __delattr__ method which accepts a String as the key.

public PyObject
__findattr_ex__(String name)

Overrides org.python.core.PyObject.__findattr_ex__.

Attribute lookup hook.

public void
__rawdir__(PyDictionary accum)

Overrides org.python.core.PyObject.__rawdir__.

public void
__setattr__(String
the name whose value will be set - must be an interned string .
name, PyObject
the value to set this name to
value)

Overrides org.python.core.PyObject.__setattr__.

A variant of the __setattr__ method which accepts a String as the key.

public PyString
__str__()

Overrides org.python.core.PyObject.__str__.

Equivalent to the standard Python __str__ method.

private void
cacheDescriptors()

Setup cached references to methods where performance really counts

public static PyObject
classobj___new__(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords)

public static PyObject
classobj___new__(PyObject name, PyObject bases, PyObject dict)

public PyObject
fastGetDict()

Overrides org.python.core.PyObject.fastGetDict.

xxx implements where meaningful

public boolean
isCallable()

Overrides org.python.core.PyObject.isCallable.

public boolean
isSubClass(PyClass superclass)

pack-priv PyObject
lookup(String name)

public void
noAttributeError(String name)

Overrides org.python.core.PyObject.noAttributeError.

Customized AttributeError for class objects.

public boolean
refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Optional operation.

public void
setBases(PyObject value)

public void
setDict(PyObject value)

Overrides org.python.core.PyObject.setDict.

public void
setName(PyObject value)

public String
toString()

Overrides org.python.core.PyObject.toString.

Returns a string representation of the object.

public int
traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects.

Inherited from org.python.core.PyObject:
__abs____add____and____call____call____call____call____call____call____call____call____call____call____call____call____call____call____call____coerce____coerce_ex____complex____contains____delattr____delete____delitem____delitem____delslice____delslice____dir____div____divmod____ensure_finalizer____eq____findattr____findattr____finditem____finditem____finditem____float____floordiv____format____ge____get____getattr____getattr____getitem____getitem____getnewargs____getslice____getslice____gt____hash____hex____iadd____iand____idiv____idivmod____ifloordiv____ilshift____imod____imul____index____int____invert____ior____ipow____irshift____isub____iter____iternext____itruediv____ixor____le____len____long____lshift____lt____mod____mul____ne____neg____nonzero____not____oct____or____pos____pow____pow____radd____rand____rdiv____rdivmod____reduce____reduce_ex____reduce_ex____repr____rfloordiv____rlshift____rmod____rmul____ror____rpow____rrshift____rshift____rsub____rtruediv____rxor____set____setattr____setitem____setitem____setitem____setslice____setslice____sub____tojava____truediv____trunc____unicode____xor___add_and_basic_add_basic_and_basic_div_basic_divmod_basic_floordiv_basic_iadd_basic_iand_basic_idiv_basic_idivmod_basic_ifloordiv_basic_ilshift_basic_imod_basic_imul_basic_ior_basic_ipow_basic_irshift_basic_isub_basic_itruediv_basic_ixor_basic_lshift_basic_mod_basic_mul_basic_or_basic_pow_basic_rshift_basic_sub_basic_truediv_basic_xor_callextra_cmp_coerce_div_divmod_doget_doget_doset_eq_floordiv_ge_gt_iadd_iand_idiv_idivmod_ifloordiv_ilshift_imod_imul_in_ior_ipow_irshift_is_isnot_isub_itruediv_ixor_jcall_jcallexc_jthrow_le_lshift_lt_mod_mul_ne_notin_or_pow_rshift_sub_truediv_unsupportedop_xoradaptToCoerceTupleasDoubleasIndexasIndexasIntasIntasIterableasLongasLongasNameasNameasStringasStringasStringOrNullasStringOrNullbit_lengthconjugatedelDictdelTypedispatch__init__equalsfastGetClassfinalizegetDictgetJavaProxygetTypehashCodeimpAttrimplementsDescrDeleteimplementsDescrGetimplementsDescrSetinvokeinvokeinvokeinvokeinvokeinvokeisDataDescrisIndexisIntegerisMappingTypeisNumberTypeisSequenceTypejdontdelmergeClassDictmergeDictAttrmergeListAttrobject___contains__object___delattr__object___delattr__object___findattr__object___format__object___getattribute__object___hash__object___init__object___new__object___reduce__object___reduce_ex__object___setattr__object___setattr__object___subclasshook__object_toStringproxyInitreadonlyAttributeErrorrunsupportedopMessagesetTypeunsupportedopMessage

Field Detail

__bases__back to summary
public PyTuple __bases__

The base classes of this class

__contains__back to summary
pack-priv PyObject __contains__
__del__back to summary
pack-priv PyObject __del__
__delattr__back to summary
pack-priv PyObject __delattr__
__dict__back to summary
public PyObject __dict__

Holds the namespace for this class

__getattr__back to summary
pack-priv PyObject __getattr__
__name__back to summary
public String __name__

The name of this class

__setattr__back to summary
pack-priv PyObject __setattr__
__tojava__back to summary
pack-priv PyObject __tojava__
TYPEback to summary
public static final PyType TYPE

Hides org.python.core.PyObject.TYPE.

Constructor Detail

PyClassback to summary
private PyClass()

Create a new instance of a Python classic class.

Method Detail

__call__back to summary
public PyObject __call__(PyObject[] args, String[] keywords)

Overrides org.python.core.PyObject.__call__.

Doc from org.python.core.PyObject.__call__.

The basic method to override when implementing a callable object. The first len(args)-len(keywords) members of args[] are plain arguments. The last len(keywords) arguments are the values of the keyword arguments.

Parameters
args:PyObject[]

all arguments to the function (including keyword arguments).

keywords:String[]

the keywords used for all keyword arguments.

Annotations
@Override
__cmp__back to summary
public int __cmp__(PyObject other)

Overrides org.python.core.PyObject.__cmp__.

Doc from org.python.core.PyObject.__cmp__.

Equivalent to the standard Python __cmp__ method.

Parameters
other:PyObject

the object to compare this with.

Returns:int

-1 if this<o; 0 if this==o; +1 if this>o; -2 if no comparison is implemented

Annotations
@Override

__delattr__back to summary
public void __delattr__(String name)

Overrides org.python.core.PyObject.__delattr__.

Doc from org.python.core.PyObject.__delattr__.

A variant of the __delattr__ method which accepts a String as the key. This String must be interned. By default, this will call __delattr__(PyString name) with the appropriate args. The only reason to override this method is for performance.

Parameters
name:String

the name which will be removed - must be an interned string .

Annotations
@Override
__findattr_ex__back to summary
public PyObject __findattr_ex__(String name)

Overrides org.python.core.PyObject.__findattr_ex__.

Doc from org.python.core.PyObject.__findattr_ex__.

Attribute lookup hook. If the attribute is not found, null may be returned or a Py.AttributeError can be thrown, whatever is more correct, efficient and/or convenient for the implementing class. Client code should use __getattr__(String) or __findattr__(String). Both methods have a clear policy for failed lookups.

Returns:PyObject

The looked up value. May return null if the attribute is not found

Annotations
@Override

__rawdir__back to summary
public void __rawdir__(PyDictionary accum)

Overrides org.python.core.PyObject.__rawdir__.

Annotations
@Override
__setattr__back to summary
public void __setattr__(String name, PyObject value)

Overrides org.python.core.PyObject.__setattr__.

Doc from org.python.core.PyObject.__setattr__.

A variant of the __setattr__ method which accepts a String as the key. This String must be interned.

Parameters
name:String

the name whose value will be set - must be an interned string .

value:PyObject

the value to set this name to

Annotations
@Override
__str__back to summary
public PyString __str__()

Overrides org.python.core.PyObject.__str__.

Doc from org.python.core.PyObject.__str__.

Equivalent to the standard Python __str__ method. The default implementation (in PyObject) calls __repr__(), making it unnecessary to override __str__ in sub-classes of PyObject where both forms are the same. A common choice is to provide the same implementation to __str__ and toString, for consistency in the printed form of objects between Python and Java.

Annotations
@Override
cacheDescriptorsback to summary
private void cacheDescriptors()

Setup cached references to methods where performance really counts

classobj___new__back to summary
public static PyObject classobj___new__(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords)
Annotations
@ExposedNew
classobj___new__back to summary
public static PyObject classobj___new__(PyObject name, PyObject bases, PyObject dict)
fastGetDictback to summary
public PyObject fastGetDict()

Overrides org.python.core.PyObject.fastGetDict.

Doc from org.python.core.PyObject.fastGetDict.

xxx implements where meaningful

Returns:PyObject

internal object per instance dict or null

Annotations
@Override

isCallableback to summary
public boolean isCallable()

Overrides org.python.core.PyObject.isCallable.

Annotations
@Override
isSubClassback to summary
public boolean isSubClass(PyClass superclass)
lookupback to summary
pack-priv PyObject lookup(String name)
noAttributeErrorback to summary
public void noAttributeError(String name)

Overrides org.python.core.PyObject.noAttributeError.

Customized AttributeError for class objects.

Annotations
@Override
refersDirectlyToback to summary
public boolean refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Doc from org.python.core.Traverseproc.refersDirectlyTo.

Optional operation. Should only be implemented if it is more efficient than calling traverse(Visitproc, Object) with a visitproc that just watches out for ob. Must return false if ob is null.

Annotations
@Override
setBasesback to summary
public void setBases(PyObject value)
setDictback to summary
public void setDict(PyObject value)

Overrides org.python.core.PyObject.setDict.

setNameback to summary
public void setName(PyObject value)
toStringback to summary
public String toString()

Overrides org.python.core.PyObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override

traverseback to summary
public int traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Doc from org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects. Like in CPython, arg must be passed unmodified to visit as its second parameter. If Visitproc#visit(PyObject, Object) returns nonzero, this return value must be returned immediately by traverse. Visitproc#visit(PyObject, Object) must not be called with a null PyObject-argument.

Annotations
@Override