Jython 2.7.4 · org.python.core.PyType · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
protected static class	PyType.Constant Constants (singletons) for `PyType`s that we use repeatedly in the logic of `PyType` and `PyJavaType`.
pack-priv static class	PyType.MethodCache A thread safe, non-blocking version of Armin Rigo's mro cache.
pack-priv static class	PyType.MROMergeState Tracks the status of merging a single base into a subclass' mro in computeMro.
private static interface	PyType.OnType
private static class	PyType.Registry The class `PyType` contains a registry that describes Python types through a system of indexes and `PyType` objects.
pack-priv static class	PyType.TypeResolver

Modifier and Type	Field and Description
protected PyType	base __base__, the direct base type or null.
protected PyObject[]	bases __bases__, the base classes.
protected boolean	builtin Whether this is a builtin type.
protected PyObject	dict The real, internal __dict__.
pack-priv boolean	hasDelete
pack-priv boolean	hasGet Whether this type implements descriptor __get/set/delete__ methods.
pack-priv boolean	hasSet
protected boolean	instantiable Whether new instances of this type can be instantiated
private boolean	isBaseType Whether this type allows subclassing.
protected PyObject[]	mro __mro__, the method resolution.
protected String	name The type's name.
protected boolean	needs_finalizer Whether finalization is required for this type's instances (implements __del__).
protected boolean	needs_userdict Whether this type has a __dict__.
protected boolean	needs_weakref Whether this type has a __weakref__ slot (however all types are weakrefable).
private int	numSlots The number of __slots__ defined by this type + bases.
private int	ownSlots The number of __slots__ defined by this type itself.
private Set<WeakReference<PyType>>	subclasses
private transient ReferenceQueue<PyType>	subclasses_refq
private long	tp_flags __flags__, the type's options.
public static final PyType	TYPE Hides org.python.core.PyObject.TYPE. The `PyType` of `PyType` (or `type(type)`).
protected Class<?>	underlying_class The Java Class that instances of this type represent (when that is a `PyObject`), or `null` if the type is not a `PyObject`, in which case the class is indicated through a `JyAttribute#JAVA_PROXY_ATTR`.
private volatile boolean	usesObjectGetattribute Whether this type's __getattribute__ is object.__getattribute__.
private volatile Object	versionTag MethodCacheEntry version tag.

Access	Constructor and Description
protected	PyType(PyType Python subclass of this object subtype) Create a "blank" `PyType` instance, for a Python subclass of `type`, that is, for a Python metatype.
private	PyType() Create a "blank" `PyType` instance.
protected	PyType(boolean if true, this is a proxy isProxy) Create the `PyType` instance for `type` itself, or for a subclass of it.
protected	PyType(PyType subtype, Class<?> c) As `PyType(Class)`, but also specifying the sub-type of Python type for which it is created.
protected	PyType(Class<?> the underlying class or `null`. c) Create a built-in type for the given Java class.

Method Summary

Modifier and Type	Method 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 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.
protected 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 Object	__tojava__(Class<?> the Class to convert this `PyObject` to. c) Overrides org.python.core.PyObject.__tojava__. Equivalent to the Jython __tojava__ method.
public static void	addBuilder(Class<?> class for which this is the builder c, TypeBuilder to register builder) Register the `TypeBuilder` for the given class.
public void	addMethod(PyBuiltinMethod meth) Adds the given method to this type's dict under its name in its descriptor.
private synchronized void	attachSubclass(PyType subtype)
private static PyType	best_base(PyObject[] bases) Find the base selected from a `bases` array that has the "most derived solid base".
private void	cacheDescrBinds() Determine if this type is a descriptor, and if so what kind.
protected void	checkDelattr()
private static PyObject[]	classic_mro(PyClass classic_cl)
private void	cleanup_subclasses()
public void	compatibleForAssignment(PyType other, String attribute) Ensures that the physical layout between this type and `other` are compatible.
protected void	computeLinearMro(Class<?> baseClass) Fills the base and bases of this type with the type of baseClass as sets its mro to this type followed by the mro of baseClass.
pack-priv PyObject[]	Returns: the MRO of this class computeMro() Examine the bases (which must contain no repetition) and the MROs of these bases and return the MRO of this class.
pack-priv PyObject[]	Returns: the MRO of this class computeMro(PyType.MROMergeState[] data structure representing the (partly processed) MROs of bases. toMerge, List<PyObject> partial MRO (initially only this class) mro) Core algorithm for computing the MRO for "new-style" (although it's been a while) Python classes.
private static String	confirmIdentifier(PyObject obj)
private void	createAllSlots(boolean whether a __dict__ descriptor is allowed on this type mayAddDict, boolean whether a __weakref__ descriptor is allowed on this type mayAddWeak) Create all slots and related descriptors.
private void	createDictSlot() Create the __dict__ descriptor.
private void	createWeakrefSlot() Create the __weakref__ descriptor.
public void	delBases()
public void	delDict() Overrides org.python.core.PyObject.delDict.
public void	delModule()
private synchronized void	detachSubclass(PyType subtype)
private void	ensureAttributes() Setup this type's special attributes.
public static synchronized boolean	Returns: whether bootstrapping was successful ensureBootstrapped() Attempt to ensure that the that the type system has fully constructed the types necessary to build a fully-working, exposed, `PyObject` (the "bootstrap types").
public static void	ensureDoc(PyObject a PyObject mapping dict) Ensure dict contains a __doc__.
public static void	ensureModule(PyObject a PyObject mapping dict) Ensure dict contains a __module__, retrieving it from the current frame if it doesn't exist.
public PyObject	fastGetDict() Overrides org.python.core.PyObject.fastGetDict. Returns the actual dict underlying this type instance.
public String	fastGetName()
private static void	fill_classic_mro(List<PyObject> acc, PyClass classic_cl)
private static PyType	findMostDerivedMetatype(PyObject[] bases_list, PyType initialMetatype) Finds the most derived subtype of initialMetatype in the types of bases, or initialMetatype if it is already the most derived.
private static int	Returns: position of first ancestor that is not equal to or ancestor of primary base findSlottedAncestors(PyType type to be investigated tp, List<PyType> list collecting all ancestors dest, Map<PyType, PyObject> map linking each type to its slots slotsMap) Used internally by `createAllSlots()`.
public static PyType	Returns: the `PyType` found or created fromClass(Class<?> for which the corresponding `PyType` is to be found c, boolean ignored hardRef) Equivalent to `fromClass(Class)`, which is to be preferred.
public static PyType	Returns: the `PyType` found or created fromClass(Class<?> for which the corresponding `PyType` is to be found c) Look up (create if necessary) the `PyType` for the given target Java class.
public PyObject	getAbstractmethods()
public PyObject	getBase()
public PyObject	getBases()
public PyObject	getDict() Overrides org.python.core.PyObject.getDict. xxx implements where meaningful
public PyObject	getDoc() Equivalent of CPython's typeobject.c::type_get_doc; handles __doc__ descriptors.
public PyLong	getFlags()
private static Class<?>	Returns: base Java proxy Class getJavaLayout(PyObject[] array of base Jython classes bases, List<Class<?>> List for collecting interfaces to interfaces) Get the most parent Java proxy Class from bases, tallying any encountered Java interfaces.
private PyType	getLayout() Gets the most parent PyType that determines the layout of this type, ie it has slots or an underlying_class.
public PyObject	getModule()
public PyTuple	getMro()
public String	getName()
public int	getNumSlots()
pack-priv static Object	getProxyAttr(PyObject obj) Brevity for `JyAttribute.getAttr(obj, JyAttribute.JAVA_PROXY_ATTR)`.
public Class<?>	getProxyType() Returns the Java Class that this type inherits from, or null if this type is Python-only.
public PyObject	getStatic()
pack-priv boolean	getUsesObjectGetattribute()
pack-priv void	handleMroError(PyType.MROMergeState[] partially processed algorithm state toMerge, List<PyObject> output MRO (incomplete) mro) This method is called when the `computeMro(MROMergeState[], List)` reaches an impasse as far as its official algorithm is concerned, with the partial MRO and current state of the working lists at the point the problem is detected.
pack-priv static boolean	hasProxyAttr(PyObject obj) Brevity for `JyAttribute.hasAttr(obj, JyAttribute.JAVA_PROXY_ATTR)`.
private void	inheritSpecial() Inherit special attributes from the dominant base.
protected void	init(Set<PyJavaType> ignored in the base implementation (see `PyJavaType#init(Set)` needsInners) Complete the initialisation of the `PyType` for an exposed `PyObject`.
private static void	insertSlots(PyObject names to be added as slots slots, Set<String> set collecting all slots dest) Used internally by `createAllSlots()`.
public PyObject	instDict()
protected void	invalidateMethodCache() Invalidate this type's MethodCache entries.
private static PyObject	invokeNew(PyObject new_, PyType type, boolean init, PyObject[] args, String[] keywords)
pack-priv boolean	isAbstract()
private static boolean	isJavaRootClass(PyType type)
private static boolean	isSolidBase(PyType type) A "solid base" is a type that has an `underlying_class`, or defines `__slots__` and no instance level dictionary (no `__dict__` attribute).
public boolean	isSubType(PyType supertype)
public PyObject	Returns: found object or null lookup(String attribute name (must be interned) name) Attribute lookup for name through mro objects' dicts.
protected PyObject	Returns: found object or null lookup_mro(String attribute name (must be interned) name) Attribute lookup for name directly through mro objects' dicts.
public PyObject	Returns: found object or null lookup_where(String attribute name (must be interned) name, PyObject[] Where in the mro the attribute was found is written to index 0 where) Attribute lookup for name through mro objects' dicts.
protected PyObject	Returns: found object or null lookup_where_mro(String attribute name (must be interned) name, PyObject[] Where in the mro the attribute was found is written to index 0 where) Attribute lookup for name through mro objects' dicts.
private static String	mangleName(String classname, String methodname)
private void	mro_internal() Set the `mro` field from the Python `mro()` method which uses (`computeMro()` by default.
private void	mro_subclasses(List<Object> mroCollector) Collects the subclasses and current mro of this type in mroCollector.
public final boolean	Returns: a boolean indicating whether the type implements __del__ needsFinalizer() Offers public read-only access to the protected field needs_finalizer.
public static PyObject	newType(PyNewWrapper new_, PyType metatype, String name, PyTuple bases, PyObject dict)
public void	noAttributeError(String name) Overrides org.python.core.PyObject.noAttributeError. Raises AttributeError on type objects.
pack-priv void	postDelattr(String name)
pack-priv void	postSetattr(String name)
public void	pyDelName()
public PyObject	pyGetName()
public void	pySetName(PyObject name)
public boolean	refersDirectlyTo(PyObject ob) Implements org.python.core.Traverseproc.refersDirectlyTo. Optional operation.
public void	removeMethod(PyBuiltinMethod meth) Removes the given method from this type's dict or raises a KeyError.
protected PyObject	richCompare(PyObject other, cmpopType op)
public void	setAbstractmethods(PyObject value)
public void	setBases(PyObject newBasesTuple)
public void	setDict(PyObject newDict) Overrides org.python.core.PyObject.setDict.
private void	setIsBaseType(boolean isBaseType)
public void	setName(String name)
pack-priv static void	setProxyAttr(PyObject obj, Object value) Brevity for `JyAttribute.setAttr(obj, JyAttribute.JAVA_PROXY_ATTR, value)`.
private void	setupProxy(Class<?> this type's base proxyClass baseProxyClass, List<Class<?>> a list of Java interfaces in bases interfaces) Setup the javaProxy for this type.
pack-priv void	setUsesObjectGetattribute(boolean usesObjectGetattribute)
private static PyType	solid_base(PyType type) Finds the first super-type of the given `type` that is a "solid base" of the type, that is, the returned type has an `underlying_class`, or it defines `__slots__` and no instance level dictionary (`__dict__` attribute).
public PyObject	super_lookup(PyType ref, String name)
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 `PyObject`s.
private synchronized void	traverse_hierarchy(boolean top, PyType.OnType behavior)
pack-priv final PyObject	type___call__(PyObject[] args, String[] keywords)
pack-priv final void	type___delattr__(PyObject name)
pack-priv void	type___delattr__(String name)
public PyObject	type___eq__(PyObject other)
pack-priv final PyObject	type___findattr_ex__(String name)
public PyObject	type___ge__(PyObject other)
pack-priv final PyObject	type___getattribute__(PyObject name)
public PyObject	type___gt__(PyObject other)
pack-priv final void	type___init__(PyObject[] args, String[] kwds)
public final synchronized boolean	type___instancecheck__(PyObject inst)
public PyObject	type___le__(PyObject other)
public PyObject	type___lt__(PyObject other)
public PyObject	type___ne__(PyObject other)
pack-priv static final PyObject	type___new__(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords)
pack-priv final void	type___setattr__(PyObject name, PyObject value)
pack-priv void	type___setattr__(String name, PyObject value)
public final synchronized boolean	type___subclasscheck__(PyObject inst)
public final synchronized PyObject	type___subclasses__()
pack-priv final PyList	type_mro(PyObject X)
pack-priv final String	type_toString()
protected boolean	useMetatypeFirst(PyObject attr) Returns true if the given attribute retrieved from an object's metatype should be used before looking for the object on the actual object.
protected Object	writeReplace() Used when serializing this type.

Inherited from org.python.core.PyObject:: __abs____add____and____call____call____call____call____call____call____call____call____call____call____call____call____call____call____call____cmp____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____str____sub____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 _xor adaptToCoerceTuple asDouble asIndex asIndex asInt asInt asIterable asLong asLong asName asName asString asString asStringOrNull asStringOrNull bit_length conjugate delType dispatch__init__equals fastGetClass finalize getJavaProxy getType hashCode impAttr implementsDescrDelete implementsDescrGet implementsDescrSet invoke invoke invoke invoke invoke invoke isCallable isDataDescr isIndex isInteger isMappingType isNumberType isSequenceType jdontdel mergeClassDict mergeDictAttr mergeListAttr object___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_toString proxyInit readonlyAttributeError runsupportedopMessage setType unsupportedopMessage

public Class PyType

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary