### Navigation

- index
- modules
- next
- previous
- Home »
- Contents »
- InaSAFE’s API documentation »
- Package::safe_qgis »

# Module: safe_qgis.odict

A dict that keeps keys in insertion order

class `safe_qgis.odict.``OrderedDict`(init_val=(), strict=False)

  A class of dictionary that keeps the insertion order of keys.

  All appropriate methods return keys, items, or values in an ordered way.

  All normal dictionary methods are available. Update and comparison is restricted to other OrderedDict objects.

  Various sequence methods are available, including the ability to explicitly mutate the key ordering.

  __contains__ tests:

      >>> d = OrderedDict(((1, 3),))
      >>> 1 in d
      1
      >>> 4 in d
      0

  __getitem__ tests:

      >>> OrderedDict(((1, 3), (3, 2), (2, 1)))[2]
      1
      >>> OrderedDict(((1, 3), (3, 2), (2, 1)))[4]
      Traceback (most recent call last):
      KeyError: 4

  __len__ tests:

      >>> len(OrderedDict())
      0
      >>> len(OrderedDict(((1, 3), (3, 2), (2, 1))))
      3

  get tests:

      >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
      >>> d.get(1)
      3
      >>> d.get(4) is None
      1
      >>> d.get(4, 5)
      5
      >>> d
      OrderedDict([(1, 3), (3, 2), (2, 1)])

  has_key tests:

      >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
      >>> d.has_key(1)
      1
      >>> d.has_key(4)
      0

  `clear`()

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.clear()
        >>> d
        OrderedDict([])

  `copy`()

        >>> OrderedDict(((1, 3), (3, 2), (2, 1))).copy()
        OrderedDict([(1, 3), (3, 2), (2, 1)])

  `index`(key)

    Return the position of the specified key in the OrderedDict.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.index(3)
        1
        >>> d.index(4)
        Traceback (most recent call last):
        ValueError: list.index(x): x not in list

  `insert`(index, key, value)

    Takes `index`, `key`, and `value` as arguments.

    Sets `key` to `value`, so that `key` is at position `index` in the OrderedDict.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.insert(0, 4, 0)
        >>> d
        OrderedDict([(4, 0), (1, 3), (3, 2), (2, 1)])
        >>> d.insert(0, 2, 1)
        >>> d
        OrderedDict([(2, 1), (4, 0), (1, 3), (3, 2)])
        >>> d.insert(8, 8, 1)
        >>> d
        OrderedDict([(2, 1), (4, 0), (1, 3), (3, 2), (8, 1)])

  `items`()

    `items` returns a list of tuples representing all the `(key, value)` pairs in the dictionary.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.items()
        [(1, 3), (3, 2), (2, 1)]
        >>> d.clear()
        >>> d.items()
        []

  `iteritems`()

        >>> ii = OrderedDict(((1, 3), (3, 2), (2, 1))).iteritems()
        >>> ii.next()
        (1, 3)
        >>> ii.next()
        (3, 2)
        >>> ii.next()
        (2, 1)
        >>> ii.next()
        Traceback (most recent call last):
        StopIteration

  `iterkeys`()

        >>> ii = OrderedDict(((1, 3), (3, 2), (2, 1))).iterkeys()
        >>> ii.next()
        1
        >>> ii.next()
        3
        >>> ii.next()
        2
        >>> ii.next()
        Traceback (most recent call last):
        StopIteration

  `itervalues`()

        >>> iv = OrderedDict(((1, 3), (3, 2), (2, 1))).itervalues()
        >>> iv.next()
        3
        >>> iv.next()
        2
        >>> iv.next()
        1
        >>> iv.next()
        Traceback (most recent call last):
        StopIteration

  `keys`()

    Return a list of keys in the `OrderedDict`.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.keys()
        [1, 3, 2]

  `pop`(key, *args)

    No dict.pop in Python 2.2, gotta reimplement it

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.pop(3)
        2
        >>> d
        OrderedDict([(1, 3), (2, 1)])
        >>> d.pop(4)
        Traceback (most recent call last):
        KeyError: 4
        >>> d.pop(4, 0)
        0
        >>> d.pop(4, 0, 1)
        Traceback (most recent call last):
        TypeError: pop expected at most 2 arguments, got 3

  `popitem`(i=-1)

    Delete and return an item specified by index, not a random one as in dict. The index is -1 by default (the last item).

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.popitem()
        (2, 1)
        >>> d
        OrderedDict([(1, 3), (3, 2)])
        >>> d.popitem(0)
        (1, 3)
        >>> OrderedDict().popitem()
        Traceback (most recent call last):
        KeyError: 'popitem(): dictionary is empty'
        >>> d.popitem(2)
        Traceback (most recent call last):
        IndexError: popitem(): index 2 not valid

  `rename`(old_key, new_key)

    Rename the key for a given value, without modifying sequence order.

    For the case where new_key already exists this raise an exception, since if new_key exists, it is ambiguous as to what happens to the associated values, and the position of new_key in the sequence.

        >>> od = OrderedDict()
        >>> od['a'] = 1
        >>> od['b'] = 2
        >>> od.items()
        [('a', 1), ('b', 2)]
        >>> od.rename('b', 'c')
        >>> od.items()
        [('a', 1), ('c', 2)]
        >>> od.rename('c', 'a')
        Traceback (most recent call last):
        ValueError: New key already exists: 'a'
        >>> od.rename('d', 'b')
        Traceback (most recent call last):
        KeyError: 'd'

  `reverse`()

    Reverse the order of the OrderedDict.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.reverse()
        >>> d
        OrderedDict([(2, 1), (3, 2), (1, 3)])

  `setdefault`(key, defval=None)

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.setdefault(1)
        3
        >>> d.setdefault(4) is None
        True
        >>> d
        OrderedDict([(1, 3), (3, 2), (2, 1), (4, None)])
        >>> d.setdefault(5, 0)
        0
        >>> d
        OrderedDict([(1, 3), (3, 2), (2, 1), (4, None), (5, 0)])

  `setitems`(items)

    This method allows you to set the items in the dict.

    It takes a list of tuples - of the same sort returned by the `items` method.

        >>> d = OrderedDict()
        >>> d.setitems(((3, 1), (2, 3), (1, 2)))
        >>> d
        OrderedDict([(3, 1), (2, 3), (1, 2)])

  `setkeys`(keys)

    `setkeys` all ows you to pass in a new list of keys which will replace the current set. This must contain the same set of keys, but need not be in the same order.

    If you pass in new keys that don’t match, a `KeyError` will be raised.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.keys()
        [1, 3, 2]
        >>> d.setkeys((1, 2, 3))
        >>> d
        OrderedDict([(1, 3), (2, 1), (3, 2)])
        >>> d.setkeys(['a', 'b', 'c'])
        Traceback (most recent call last):
        KeyError: 'Keylist is not the same as current keylist.'

  `setvalues`(values)

    You can pass in a list of values, which will replace the current list. The value list must be the same len as the OrderedDict.

    (Or a `ValueError` is raised.)

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.setvalues((1, 2, 3))
        >>> d
        OrderedDict([(1, 1), (3, 2), (2, 3)])
        >>> d.setvalues([6])
        Traceback (most recent call last):
        ValueError: Value list is not the same length as the OrderedDict.

  `sort`(*args, **kwargs)

    Sort the key order in the OrderedDict.

    This method takes the same arguments as the `list.sort` method on your version of Python.

        >>> d = OrderedDict(((4, 1), (2, 2), (3, 3), (1, 4)))
        >>> d.sort()
        >>> d
        OrderedDict([(1, 4), (2, 2), (3, 3), (4, 1)])

  `update`(from_od)

    Update from another OrderedDict or sequence of (key, value) pairs

        >>> d = OrderedDict(((1, 0), (0, 1)))
        >>> d.update(OrderedDict(((1, 3), (3, 2), (2, 1))))
        >>> d
        OrderedDict([(1, 3), (0, 1), (3, 2), (2, 1)])
        >>> d.update({4: 4})
        Traceback (most recent call last):
        TypeError: undefined order, cannot get items from dict
        >>> d.update((4, 4))
        Traceback (most recent call last):
        TypeError: cannot convert dictionary update sequence element "4" to a 2-item sequence

  `values`(values=None)

    Return a list of all the values in the OrderedDict.

    Optionally you can pass in a list of values, which will replace the current list. The value list must be the same len as the OrderedDict.

        >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
        >>> d.values()
        [3, 2, 1]

class `safe_qgis.odict.``SequenceOrderedDict`(init_val=(), strict=True)

  Experimental version of OrderedDict that has a custom object for `keys`, `values`, and `items`.

  These are callable sequence objects that work as methods, or can be manipulated directly as sequences.

  Test for `keys`, `items` and `values`.

      >>> d = SequenceOrderedDict(((1, 2), (2, 3), (3, 4)))
      >>> d
      SequenceOrderedDict([(1, 2), (2, 3), (3, 4)])
      >>> d.keys
      [1, 2, 3]
      >>> d.keys()
      [1, 2, 3]
      >>> d.setkeys((3, 2, 1))
      >>> d
      SequenceOrderedDict([(3, 4), (2, 3), (1, 2)])
      >>> d.setkeys((1, 2, 3))
      >>> d.keys[0]
      1
      >>> d.keys[:]
      [1, 2, 3]
      >>> d.keys[-1]
      3
      >>> d.keys[-2]
      2
      >>> d.keys[0:2] = [2, 1]
      >>> d
      SequenceOrderedDict([(2, 3), (1, 2), (3, 4)])
      >>> d.keys.reverse()
      >>> d.keys
      [3, 1, 2]
      >>> d.keys = [1, 2, 3]
      >>> d
      SequenceOrderedDict([(1, 2), (2, 3), (3, 4)])
      >>> d.keys = [3, 1, 2]
      >>> d
      SequenceOrderedDict([(3, 4), (1, 2), (2, 3)])
      >>> a = SequenceOrderedDict()
      >>> b = SequenceOrderedDict()
      >>> a.keys == b.keys
      1
      >>> a['a'] = 3
      >>> a.keys == b.keys
      0
      >>> b['a'] = 3
      >>> a.keys == b.keys
      1
      >>> b['b'] = 3
      >>> a.keys == b.keys
      0
      >>> a.keys > b.keys
      0
      >>> a.keys < b.keys
      1
      >>> 'a' in a.keys
      1
      >>> len(b.keys)
      2
      >>> 'c' in d.keys
      0
      >>> 1 in d.keys
      1
      >>> [v for v in d.keys]
      [3, 1, 2]
      >>> d.keys.sort()
      >>> d.keys
      [1, 2, 3]
      >>> d = SequenceOrderedDict(((1, 2), (2, 3), (3, 4)), strict=True)
      >>> d.keys[::-1] = [1, 2, 3]
      >>> d
      SequenceOrderedDict([(3, 4), (2, 3), (1, 2)])
      >>> d.keys[:2]
      [3, 2]
      >>> d.keys[:2] = [1, 3]
      Traceback (most recent call last):
      KeyError: 'Keylist is not the same as current keylist.'

      >>> d = SequenceOrderedDict(((1, 2), (2, 3), (3, 4)))
      >>> d
      SequenceOrderedDict([(1, 2), (2, 3), (3, 4)])
      >>> d.values
      [2, 3, 4]
      >>> d.values()
      [2, 3, 4]
      >>> d.setvalues((4, 3, 2))
      >>> d
      SequenceOrderedDict([(1, 4), (2, 3), (3, 2)])
      >>> d.values[::-1]
      [2, 3, 4]
      >>> d.values[0]
      4
      >>> d.values[-2]
      3
      >>> del d.values[0]
      Traceback (most recent call last):
      TypeError: Can't delete items from values
      >>> d.values[::2] = [2, 4]
      >>> d
      SequenceOrderedDict([(1, 2), (2, 3), (3, 4)])
      >>> 7 in d.values
      0
      >>> len(d.values)
      3
      >>> [val for val in d.values]
      [2, 3, 4]
      >>> d.values[-1] = 2
      >>> d.values.count(2)
      2
      >>> d.values.index(2)
      0
      >>> d.values[-1] = 7
      >>> d.values
      [2, 3, 7]
      >>> d.values.reverse()
      >>> d.values
      [7, 3, 2]
      >>> d.values.sort()
      >>> d.values
      [2, 3, 7]
      >>> d.values.append('anything')
      Traceback (most recent call last):
      TypeError: Can't append items to values
      >>> d.values = (1, 2, 3)
      >>> d
      SequenceOrderedDict([(1, 1), (2, 2), (3, 3)])

      >>> d = SequenceOrderedDict(((1, 2), (2, 3), (3, 4)))
      >>> d
      SequenceOrderedDict([(1, 2), (2, 3), (3, 4)])
      >>> d.items()
      [(1, 2), (2, 3), (3, 4)]
      >>> d.setitems([(3, 4), (2 ,3), (1, 2)])
      >>> d
      SequenceOrderedDict([(3, 4), (2, 3), (1, 2)])
      >>> d.items[0]
      (3, 4)
      >>> d.items[:-1]
      [(3, 4), (2, 3)]
      >>> d.items[1] = (6, 3)
      >>> d.items
      [(3, 4), (6, 3), (1, 2)]
      >>> d.items[1:2] = [(9, 9)]
      >>> d
      SequenceOrderedDict([(3, 4), (9, 9), (1, 2)])
      >>> del d.items[1:2]
      >>> d
      SequenceOrderedDict([(3, 4), (1, 2)])
      >>> (3, 4) in d.items
      1
      >>> (4, 3) in d.items
      0
      >>> len(d.items)
      2
      >>> [v for v in d.items]
      [(3, 4), (1, 2)]
      >>> d.items.count((3, 4))
      1
      >>> d.items.index((1, 2))
      1
      >>> d.items.index((2, 1))
      Traceback (most recent call last):
      ValueError: list.index(x): x not in list
      >>> d.items.reverse()
      >>> d.items
      [(1, 2), (3, 4)]
      >>> d.items.reverse()
      >>> d.items.sort()
      >>> d.items
      [(1, 2), (3, 4)]
      >>> d.items.append((5, 6))
      >>> d.items
      [(1, 2), (3, 4), (5, 6)]
      >>> d.items.insert(0, (0, 0))
      >>> d.items
      [(0, 0), (1, 2), (3, 4), (5, 6)]
      >>> d.items.insert(-1, (7, 8))
      >>> d.items
      [(0, 0), (1, 2), (3, 4), (7, 8), (5, 6)]
      >>> d.items.pop()
      (5, 6)
      >>> d.items
      [(0, 0), (1, 2), (3, 4), (7, 8)]
      >>> d.items.remove((1, 2))
      >>> d.items
      [(0, 0), (3, 4), (7, 8)]
      >>> d.items.extend([(1, 2), (5, 6)])
      >>> d.items
      [(0, 0), (3, 4), (7, 8), (1, 2), (5, 6)]

This module forms part of the InaSAFE tool.

### Navigation

- index
- modules
- next
- previous
- Home »
- Contents »
- InaSAFE’s API documentation »
- Package::safe_qgis »