Modifier and Type	Class and Description
private class	PyDict.EntrySetImpl An instance of this class is returned by `PyDict#entrySet()`, and provides the view of the entries in the `PyDict` mentioned there.
private class	PyDict.EntrySetIteratorImpl An instance of this class is returned by `EntrySetImpl#iterator()`.
pack-priv static interface	PyDict.Key A `PyDict` is a `Map<Object, Object>`, but contains a private implementation of `java.utilMap<Key, Object>`.
pack-priv static class	PyDict.KeyHolder This is a wrapper that gives Python semantics to objects used as keys.
pack-priv static enum	PyDict.MergeMode Modes for use with `merge(Object, MergeMode)`.

Modifier and Type	Field and Description
private static final String	CANNOT_CONVERT_SEQ
private static final String	ELEMENT_N
private static final String	KV_TUPLE_LENGTH
private final LinkedHashMap<PyDict.Key, Object>	map The dictionary as a hash map preserving insertion order.
public static final PyType	TYPE The type of Python object this class implements.
protected final PyType	type The Python type of this instance.

Access	Constructor and Description
protected	PyDict(PyType sub-type for which this is being created type) Construct an empty dictionary of a specified Python sub-class of `dict`.
protected < key type of incoming map K, value type of incoming map V>	PyDict(PyType sub-type for which this is being created type, Map<K, V> Java map from which to copy map) Construct a dictionary of a specified Python sub-class of `dict`, filled by copying from a given Java map.
public	PyDict() Construct an empty `dict`.

Method Summary

Modifier and Type	Method and Description
private void	__delitem__(Object key)
private Object	__eq__(Object o)
private Object	__getitem__(Object key)
private Object	__ne__(Object o)
private Object	__repr__()
private void	__setitem__(Object key, Object value)
private boolean	Returns: `true` if equal, `false` if not. compareEQ(PyDict `dict` other) Compare this dictionary with the other `dict` for equality.
public Set<Map.Entry<Object, Object>>	entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
pack-priv static PyDict	Returns: a new `dict` fromKeyValuePairs(Object[] array containing key-value pairs stack, int index of first key start, int number of pairs count) Create a `dict` and add entries from key-value pairs that are supplied as successive values in an array slice.
public static PyDict	Returns: new `dict` fromKeyValuePairs(PyTuple... specifying key-value pairs to enter tuples) Create a `dict` and add entries from key-value pairs.
public Object	Returns: value at `key` or `null` if not found get(Object whose associated value is to be returned key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Override `Map.get` to give keys Python semantics.
public PyType	getType() Implements org.python.core.CraftedPyObject.getType. The Python `type` of this object.
pack-priv final Object	Returns: found object or `null` loadGlobal(Map<Object, Object> final mapping to search builtins, String to find key) Optimised get on this `PyDict` and some other `Map`, specifically to support the `LOAD_GLOBAL` opcode.
pack-priv void	merge(Object to merge into this dictionary o, PyDict.MergeMode policy on replacement mode) Merge the contents of another mapping into this dictionary allowing replacement of matching keys only as specified.
pack-priv void	mergeFromSeq(Object sequence of KV pairs to merge seq, PyDict.MergeMode merge policy mode) Update this dictionary from a sequence of key-value pairs, in the chosen mode.
private void	mergeObject(Object a mapping to merge in src, PyDict.MergeMode what to do about duplicates mode) Merge the mapping `src` into this `dict`.
private void	mergeSingle(Object key k, Object value v, PyDict.MergeMode what to do about duplicates mode) Merge a key-value pair into this `dict`.
public Object	Returns: previous value associated put(Object with which the specified value is to be associated key, Object to be associated value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Override `Map.put` to give keys Python semantics.
public Object	Returns: previous value associated putIfAbsent(Object with which the specified value is to be associated key, Object to be associated value) Overrides default java.util.Map.putIfAbsent. Override `Map.putIfAbsent` to give keys Python semantics.
public static boolean	Returns: whether equal pythonEquals(PyDict.Key to test equal key, Object to test equal other) Convenience function for Python objects that implement `PyDict.`
public static int	Returns: the hash pythonHash(PyDict.Key to hash key) Convenience function for Python objects that implement `PyDict.`
private static PyDict.Key	toKey(Object to return or wrap key) Turn an object into a `Key` suitable for lookup in `map`.
public String	toString() Overrides java.util.AbstractMap.toString. Returns a string representation of this map.
pack-priv void	update(Object to merge into this dictionary o) Update the dictionary with the contents of another mapping object, allowing replacement of matching keys.

Inherited from java.util.AbstractMap:: clear clone containsKey containsValue equals hashCode isEmpty keySet putAll remove size values

Field Detail

CANNOT_CONVERT_SEQ	back to summary
private static final String CANNOT_CONVERT_SEQ

ELEMENT_N	back to summary
private static final String ELEMENT_N

KV_TUPLE_LENGTH	back to summary
private static final String KV_TUPLE_LENGTH

map	back to summary
private final LinkedHashMap<PyDict.Key, Object> map The dictionary as a hash map preserving insertion order.

TYPE	back to summary
public static final PyType TYPE The type of Python object this class implements.

type	back to summary
protected final PyType type The Python type of this instance.

Constructor Detail

PyDict back to summary

PyDict	back to summary
protected PyDict(PyType type) Construct an empty dictionary of a specified Python sub-class of `dict`. Parameters type:PyType sub-type for which this is being created

protected PyDict(PyType type)

Construct an empty dictionary of a specified Python sub-class of dict.

Parameters

type:PyType: sub-type for which this is being created

PyDict back to summary

PyDict	back to summary
protected <K, V> PyDict(PyType type, Map<K, V> map) Construct a dictionary of a specified Python sub-class of `dict`, filled by copying from a given Java map. Parameters <K> key type of incoming map <V> value type of incoming map type:PyType sub-type for which this is being created map:Map<K, V> Java map from which to copy

protected <K, V> PyDict(PyType type, Map<K, V> map)

Construct a dictionary of a specified Python sub-class of dict, filled by copying from a given Java map.

Parameters

<K>: key type of incoming map
<V>: value type of incoming map
type:PyType: sub-type for which this is being created
map:Map<K, V>: Java map from which to copy

PyDict	back to summary
public PyDict() Construct an empty `dict`.

Method Detail

__delitem__	back to summary
private void __delitem__(Object key) Annotations @SuppressWarnings:unused

__eq__	back to summary
private Object __eq__(Object o) Annotations @SuppressWarnings:unused

__getitem__	back to summary
private Object __getitem__(Object key) Annotations @SuppressWarnings:unused

__ne__	back to summary
private Object __ne__(Object o) Annotations @SuppressWarnings:unused

__repr__	back to summary
private Object __repr__() throws Throwable Annotations @SuppressWarnings:unused

__setitem__	back to summary
private void __setitem__(Object key, Object value) Annotations @SuppressWarnings:unused

compareEQ back to summary

compareEQ	back to summary
private boolean compareEQ(PyDict other) Compare this dictionary with the other `dict` for equality. Parameters other:PyDict `dict` Returns:boolean `true` if equal, `false` if not.

private boolean compareEQ(PyDict other)

Compare this dictionary with the other dict for equality.

Parameters

other:PyDict: dict

Returns:boolean

true if equal, false if not.

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<Object, Object>> entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<Map.Entry<Object, Object>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<Object, Object>> entrySet()

Implements abstract java.util.AbstractMap.entrySet.

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<Object, Object>>

a set view of the mappings contained in this map

Annotations

@Override

fromKeyValuePairs back to summary

fromKeyValuePairs	back to summary
pack-priv static PyDict fromKeyValuePairs(Object[] stack, int start, int count) Create a `dict` and add entries from key-value pairs that are supplied as successive values in an array slice. (This method supports the CPython byte code interpreter.) Parameters stack:Object[] array containing key-value pairs start:int index of first key count:int number of pairs Returns:PyDict a new `dict`

pack-priv static PyDict fromKeyValuePairs(Object[] stack, int start, int count)

Create a dict and add entries from key-value pairs that are supplied as successive values in an array slice. (This method supports the CPython byte code interpreter.)

Parameters

stack:Object[]: array containing key-value pairs
start:int: index of first key
count:int: number of pairs

Returns:PyDict

a new dict

fromKeyValuePairs back to summary

fromKeyValuePairs	back to summary
public static PyDict fromKeyValuePairs(PyTuple... tuples) Create a `dict` and add entries from key-value pairs. Parameters tuples:PyTuple[] specifying key-value pairs to enter Returns:PyDict new `dict`

public static PyDict fromKeyValuePairs(PyTuple... tuples)

Create a dict and add entries from key-value pairs.

Parameters

tuples:PyTuple[]: specifying key-value pairs to enter

Returns:PyDict

new dict

get back to summary

get	back to summary
public Object get(Object key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Override `Map.get` to give keys Python semantics. Parameters key:Object whose associated value is to be returned Returns:Object value at `key` or `null` if not found Annotations @Override

public Object get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Override Map.get to give keys Python semantics.

Parameters

key:Object: whose associated value is to be returned

Returns:Object

value at key or null if not found

Annotations

@Override

getType back to summary

getType	back to summary
public PyType getType() Implements org.python.core.CraftedPyObject.getType. Doc from org.python.core.CraftedPyObject.getType. The Python `type` of this object. Returns:PyType `type` of this object Annotations @Override

public PyType getType()

Implements org.python.core.CraftedPyObject.getType.

Doc from org.python.core.CraftedPyObject.getType.

The Python type of this object.

Returns:PyType

type of this object

Annotations

@Override

loadGlobal back to summary

loadGlobal	back to summary
pack-priv final Object loadGlobal(Map<Object, Object> builtins, String key) Optimised get on this `PyDict` and some other `Map`, specifically to support the `LOAD_GLOBAL` opcode. We avoid the cost of a second key holder if the second mapping is also a `PyDict`, which it commonly is. Parameters builtins:Map<Object, Object> final mapping to search key:String to find Returns:Object found object or `null`

pack-priv final Object loadGlobal(Map<Object, Object> builtins, String key)

Optimised get on this PyDict and some other Map, specifically to support the LOAD_GLOBAL opcode. We avoid the cost of a second key holder if the second mapping is also a PyDict, which it commonly is.

Parameters

builtins:Map<Object, Object>: final mapping to search
key:String: to find

Returns:Object

found object or null

merge	back to summary
pack-priv void merge(Object o, PyDict.MergeMode mode) Merge the contents of another mapping into this dictionary allowing replacement of matching keys only as specified. Parameters o:Object to merge into this dictionary mode:PyDict.MergeMode policy on replacement

merge

back to summary

pack-priv void merge(Object o, PyDict.MergeMode mode)

Merge the contents of another mapping into this dictionary allowing replacement of matching keys only as specified.

Parameters

o:Object: to merge into this dictionary
mode:PyDict.MergeMode: policy on replacement

mergeFromSeq back to summary

mergeFromSeq	back to summary
pack-priv void mergeFromSeq(Object seq, PyDict.MergeMode mode) throws TypeError, KeyError, Throwable Update this dictionary from a sequence of key-value pairs, in the chosen mode. The sequence is any iterable object producing iterable objects of length 2, typically a `list` of `tuple`s. Parameters seq:Object sequence of KV pairs to merge mode:PyDict.MergeMode merge policy

pack-priv void mergeFromSeq(Object seq, PyDict.MergeMode mode) throws TypeError, KeyError, Throwable

Update this dictionary from a sequence of key-value pairs, in the chosen mode. The sequence is any iterable object producing iterable objects of length 2, typically a list of tuples.

Parameters

seq:Object: sequence of KV pairs to merge
mode:PyDict.MergeMode: merge policy

mergeObject back to summary

mergeObject	back to summary
private void mergeObject(Object src, PyDict.MergeMode mode) throws KeyError, AttributeError Merge the mapping `src` into this `dict`. Parameters src:Object a mapping to merge in mode:PyDict.MergeMode what to do about duplicates Exceptions KeyError: on duplicate key (if `mode ==` `MergeMode#UNIQUE`)

private void mergeObject(Object src, PyDict.MergeMode mode) throws KeyError, AttributeError

Merge the mapping src into this dict.

Parameters

src:Object: a mapping to merge in
mode:PyDict.MergeMode: what to do about duplicates

Exceptions

KeyError:: on duplicate key (if mode == MergeMode#UNIQUE)

mergeSingle back to summary

mergeSingle	back to summary
private void mergeSingle(Object k, Object v, PyDict.MergeMode mode) throws KeyError Merge a key-value pair into this `dict`. Parameters k:Object key v:Object value mode:PyDict.MergeMode what to do about duplicates Exceptions KeyError: on duplicate key (if `mode ==` `MergeMode#UNIQUE`)

private void mergeSingle(Object k, Object v, PyDict.MergeMode mode) throws KeyError

Merge a key-value pair into this dict.

Parameters

k:Object: key
v:Object: value
mode:PyDict.MergeMode: what to do about duplicates

Exceptions

KeyError:: on duplicate key (if mode == MergeMode#UNIQUE)

put back to summary

put	back to summary
public Object put(Object key, Object value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Override `Map.put` to give keys Python semantics. Parameters key:Object with which the specified value is to be associated value:Object to be associated Returns:Object previous value associated Annotations @Override

public Object put(Object key, Object value)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Override Map.put to give keys Python semantics.

Parameters

key:Object: with which the specified value is to be associated
value:Object: to be associated

Returns:Object

previous value associated

Annotations

@Override

putIfAbsent back to summary

putIfAbsent	back to summary
public Object putIfAbsent(Object key, Object value) Overrides default java.util.Map.putIfAbsent. Override `Map.putIfAbsent` to give keys Python semantics. Parameters key:Object with which the specified value is to be associated value:Object to be associated Returns:Object previous value associated Annotations @Override

public Object putIfAbsent(Object key, Object value)

Overrides default java.util.Map.putIfAbsent.

Override Map.putIfAbsent to give keys Python semantics.

Parameters

key:Object: with which the specified value is to be associated
value:Object: to be associated

Returns:Object

previous value associated

Annotations

@Override

pythonEquals back to summary

pythonEquals	back to summary
public static boolean pythonEquals(PyDict.Key key, Object other) throws PyException Convenience function for Python objects that implement `PyDict.Key`, to impose Python semantics for `==` on `Object.equals`. See `Key#equals(Object)`. Parameters key:PyDict.Key to test equal other:Object to test equal Returns:boolean whether equal Exceptions PyException: from `__eq__` implementations

public static boolean pythonEquals(PyDict.Key key, Object other) throws PyException

Convenience function for Python objects that implement PyDict.Key, to impose Python semantics for == on Object.equals. See Key#equals(Object).

Parameters

key:PyDict.Key: to test equal
other:Object: to test equal

Returns:boolean

whether equal

Exceptions

PyException:: from __eq__ implementations

pythonHash back to summary

pythonHash	back to summary
public static int pythonHash(PyDict.Key key) throws PyException Convenience function for Python objects that implement `PyDict.Key`, to impose Python semantics for `hash()` on `Object.hashCode`. See `PyDict.Key#hashCode()`. Parameters key:PyDict.Key to hash Returns:int the hash Exceptions PyException: from `__hash__` implementations

public static int pythonHash(PyDict.Key key) throws PyException

Convenience function for Python objects that implement PyDict.Key, to impose Python semantics for hash() on Object.hashCode. See PyDict.Key#hashCode().

Parameters

key:PyDict.Key: to hash

Returns:int

the hash

Exceptions

PyException:: from __hash__ implementations

toKey back to summary

toKey	back to summary
private static PyDict.Key toKey(Object key) Turn an object into a `Key` suitable for lookup in `map`. Parameters key:Object to return or wrap

private static PyDict.Key toKey(Object key)

Turn an object into a Key suitable for lookup in map.

Parameters

key:Object: to return or wrap

toString back to summary

toString	back to summary
public String toString() Overrides java.util.AbstractMap.toString. Doc from java.util.AbstractMap.toString. Returns a string representation of this map. The string representation consists of a list of key-value mappings in the order returned by the map's `entrySet` view's iterator, enclosed in braces (`"{}"`). Adjacent mappings are separated by the characters `", "` (comma and space). Each key-value mapping is rendered as the key followed by an equals sign (`"="`) followed by the associated value. Keys and values are converted to strings as by `String#valueOf(Object)`. Returns:String a string representation of this map Annotations @Override

public String toString()

Overrides java.util.AbstractMap.toString.

Doc from java.util.AbstractMap.toString.

Returns a string representation of this map. The string representation consists of a list of key-value mappings in the order returned by the map's entrySet view's iterator, enclosed in braces ("{}"). Adjacent mappings are separated by the characters ", " (comma and space). Each key-value mapping is rendered as the key followed by an equals sign ("=") followed by the associated value. Keys and values are converted to strings as by String#valueOf(Object).

Returns:String

a string representation of this map

Annotations

@Override

update back to summary

update	back to summary
pack-priv void update(Object o) Update the dictionary with the contents of another mapping object, allowing replacement of matching keys. This supports the `UPDATE_DICT` opcode. Parameters o:Object to merge into this dictionary

pack-priv void update(Object o)

Update the dictionary with the contents of another mapping object, allowing replacement of matching keys. This supports the UPDATE_DICT opcode.

Parameters

o:Object: to merge into this dictionary

org.python.core back to summary

private Class PyDict.EntrySetImpl

Class Inheritance

extends AbstractSet<Map.Entry<Object, Object>>

An instance of this class is returned by PyDict#entrySet(), and provides the view of the entries in the PyDict mentioned there.

It is probably also the backing for a dict_keys.

Constructor Summary

Access	Constructor and Description
private	EntrySetImpl()

Method Summary

Modifier and Type	Method and Description
public Iterator<Map.Entry<Object, Object>>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).

Inherited from java.util.AbstractSet:: equals hashCode removeAll

Constructor Detail

EntrySetImpl	back to summary
private EntrySetImpl()

Method Detail

iterator	back to summary
public Iterator<Map.Entry<Object, Object>> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Returns:Iterator<Map.Entry<Object, Object>> an iterator over the elements in this set Annotations @Override

iterator

back to summary

public Iterator<Map.Entry<Object, Object>> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<Map.Entry<Object, Object>>

an iterator over the elements in this set

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this set (its cardinality) Annotations @Override

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

Annotations

@Override

org.python.core back to summary

private Class PyDict.EntrySetIteratorImpl

Class Inheritance

extends Object
implements Iterator<Map.Entry<Object, Object>>

java.lang.Object
org.python.core.PyDict.EntrySetIteratorImpl

All Implemented Interfaces

java.util.Iterator

An instance of this class is returned by EntrySetImpl#iterator(). It is backed by an iterator on the underlying map, and its job is to return an entry in which the PyDict#Key has been replaced with its contained object, the true key at the Python level.

Field Summary

Modifier and Type	Field and Description
private final Iterator<Map.Entry<PyDict.Key, Object>>	mapIterator Backing iterator on the "real" implementation.

Constructor Summary

Access	Constructor and Description
private	EntrySetIteratorImpl()

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Map.Entry<Object, Object>	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

mapIterator	back to summary
private final Iterator<Map.Entry<PyDict.Key, Object>> mapIterator Backing iterator on the "real" implementation.

Constructor Detail

EntrySetIteratorImpl	back to summary
private EntrySetIteratorImpl()

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next back to summary

next	back to summary
public Map.Entry<Object, Object> next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. The difference from the underlying `mapIterator` is that the key in the entry returned by this method is the object embedded in the `KeyHolder`, which is the key as far as Python is concerned. Returns:Map.Entry<Object, Object> the next element in the iteration Annotations @Override

public Map.Entry<Object, Object> next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration. The difference from the underlying mapIterator is that the key in the entry returned by this method is the object embedded in the KeyHolder, which is the key as far as Python is concerned.

Returns:Map.Entry<Object, Object>

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

org.python.core back to summary

pack-priv Interface PyDict.Key

Known Direct Implementers: org.python.core.PyDict.KeyHolder, org.python.core.PyLong, org.python.core.PyUnicode

A PyDict is a Map<Object, Object>, but contains a private implementation of java.utilMap<Key, Object>. We use this class Key so that when Java needs key hashes or comparisons, it receives the hash or comparison that Python would produce. An object with the Key interface defines the standard Java hashCode() and equals() to return the answers Python would give for __hash__ and __eq__.

Some implementations of Python objects (e.g. the PyUnicode implementation of str) implement PyDict.Key, and can give Python semantics to hash and comparison directly. Other implementations (e.g. a Java String implementation of str) have to be wrapped in a KeyHolder that implements PyDict.Key. Conversely, when any method requires the keys of a Python dict, the Key must yield up the original Python object it contains.

An implementation of a Python type that allows Python sub-classes must respect re-definition of the corresponding special methods. This is best done by by calling abstract API Abstract#hash(Object), etc..

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object other) Python objects that implement the interface `Key`, define this method so that calls from Java libraries to `Object.equals(Object)` are answered with Python semantics.
public default Object	Returns: the underlying key object (by default `this`) get() If this object is a holder for the actual key, return the actual key.
public int	hashCode() Python objects that implement the interface `Key`, define this method so that calls from Java libraries to `Object.hashCode()` receive the hash defined by Python.

Method Detail

equals back to summary

public boolean equals(Object other) throws PyException

Python objects that implement the interface Key, define this method so that calls from Java libraries to Object.equals(Object) are answered with Python semantics. A sufficient implementation is:

@Override
public int equals(Object obj) throws PyException {
    return PyDict.pythonEquals(this, obj);
}

Objects that provide their own specialised implementation of equals, receiving a Key a object as the other argument, must dereference it with get() and work on those contents. An idiom like this may be used:

@Override
public boolean equals(Object other) {
    if (other instanceof PyDict.Key)
        other = ((PyDict.Key) other).get();
    // ... rest of implementation
}

Annotations

@Override

Exceptions

PyException:: from __eq__ implementations

get back to summary

public default Object get()

If this object is a holder for the actual key, return the actual key. By default, return this. Python object implementations that implement Key#hashCode() and Key#equals(Object), do not usually override this method.

Returns:Object: the underlying key object (by default this)

hashCode back to summary

public int hashCode() throws PyException

Python objects that implement the interface Key, define this method so that calls from Java libraries to Object.hashCode() receive the hash defined by Python. A sufficient implementation is:

@Override
public int hashCode() throws PyException {
    return PyDict.pythonHash(this);
}

Where it is known __hash__ cannot have been redefined, object implementations may have a shorter option.

Annotations

@Override

Exceptions

PyException:: from __hash__ implementations

org.python.core back to summary

pack-priv Class PyDict.KeyHolder

Class Inheritance

extends Object
implements Key

java.lang.Object
org.python.core.PyDict.KeyHolder

All Implemented Interfaces

org.python.core.PyDict.Key

This is a wrapper that gives Python semantics to objects used as keys. When using a Java collection, it is necessary to intercept the calls Java will make to Object.hashCode and Object.equals, and direct them to Python __hash__ and __eq__.

Field Summary

Modifier and Type	Field and Description
private final Object	key The actual key this object is holding.

Constructor Summary

Access	Constructor and Description
pack-priv	KeyHolder(Object to wrap key) Create a key on the given object Python `__eq__` definitions on objects offered as keys.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Implements org.python.core.PyDict.Key.equals. Impose Python `__eq__` definitions on objects offered as keys.
public Object	get() Overrides default org.python.core.PyDict.Key.get. Return the actual object held by this `Key` object.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements org.python.core.PyDict.Key.hashCode. Python objects that implement the interface `Key`, define this method so that calls from Java libraries to `Object.hashCode()` receive the hash defined by Python.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

key	back to summary
private final Object key The actual key this object is holding.

Constructor Detail

KeyHolder back to summary

pack-priv KeyHolder(Object key)

Create a key on the given object Python __eq__ definitions on objects offered as keys.

Parameters

key:Object: to wrap

Exceptions

PyException:: from __eq__

Method Detail

equals back to summary

public boolean equals(Object other) throws PyException

Overrides java.lang.Object.equals.

Implements org.python.core.PyDict.Key.equals.

Impose Python __eq__ definitions on objects offered as keys.

Parameters

other:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Exceptions

PyException:: from __eq__

get back to summary

public Object get()

Overrides default org.python.core.PyDict.Key.get.

Return the actual object held by this Key object.

Returns:Object

Doc from org.python.core.PyDict.Key.get.

the underlying key object (by default this)

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements org.python.core.PyDict.Key.hashCode.

Doc from org.python.core.PyDict.Key.hashCode.

Python objects that implement the interface Key, define this method so that calls from Java libraries to Object.hashCode() receive the hash defined by Python. A sufficient implementation is:

@Override
public int hashCode() throws PyException {
    return PyDict.pythonHash(this);
}

Where it is known __hash__ cannot have been redefined, object implementations may have a shorter option.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

Modifier and Type	Field and Description
public static final PyDict.MergeMode	IF_ABSENT Ignore the operation if the key is already in the map.
public static final PyDict.MergeMode	PUT Overwrite any existing entry with the same key.
public static final PyDict.MergeMode	UNIQUE Raise a `KeyError` if the key is already in the map.

Modifier and Type	Method and Description
public static PyDict.MergeMode	valueOf(String name)
public static PyDict.MergeMode[]	values()

public Class PyDict

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PyDict.EntrySetImpl

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class PyDict.EntrySetIteratorImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface PyDict.Key

Method Summary

Method Detail

pack-priv Class PyDict.KeyHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum PyDict.MergeMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail