src/KERNEL_PY/kernel/diclookup.py

   1 # -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 ## \defgroup diclookup diclookup
  25 #  \{
  26 #  \details Smart dictionnary with key/value lookup
  27 #  \}
  28
  29 __author__="gboulant"
  30 __date__ ="$21 mai 2010 18:00:23$"
  31
  32
  33 # search a dictionary for key or value
  34 # using named functions or a class
  35 # tested with Python25   by Ene Uran    01/19/2008
  36
  37 ## return the key of dictionary dic given the value
  38 #  \ingroup diclookup
  39 def find_key(dic, val):
  40     """return the key of dictionary dic given the value"""
  41     return [k for k, v in dic.iteritems() if v == val][0]
  42
  43 ## return the value of dictionary dic given the key
  44 #  \ingroup diclookup
  45 def find_value(dic, key):
  46     """return the value of dictionary dic given the key"""
  47     return dic[key]
  48
  49 ## a dictionary which can lookup value by key, or keys by value
  50 #  \ingroup diclookup
  51 class Lookup(dict):
  52     """
  53     a dictionary which can lookup value by key, or keys by value
  54     """
  55     ## items can be a list of pair_lists or a dictionary
  56     def __init__(self, items=[]):
  57         """items can be a list of pair_lists or a dictionary"""
  58         dict.__init__(self, items)
  59
  60     ## find the key(s) as a list given a value
  61     def get_keys(self, value):
  62         """find the key(s) as a list given a value"""
  63         return [item[0] for item in self.items() if item[1] == value]
  64
  65     ## find the key associated to the given a value. If several keys exist,
  66     #  only the first is given. To get the whole list, use get_keys instead.
  67     def get_key(self, value):
  68         """
  69         find the key associated to the given a value. If several keys exist,
  70         only the first is given. To get the whole list, use get_keys instead.
  71         """
  72         list = self.get_keys(value)
  73         if len(list) == 0:
  74             return None
  75         return list[0]
  76
  77     ## find the value given a key
  78     def get_value(self, key):
  79         """find the value given a key"""
  80         return self[key]
  81
  82 #
  83 # ==============================================================================
  84 # Use cases and unit tests
  85 # ==============================================================================
  86 #
  87 def TEST_getTestDictionnary():
  88     # dictionary of chemical symbols
  89     symbol_dic = {
  90     'C': 'carbon',
  91     'H': 'hydrogen',
  92     'N': 'nitrogen',
  93     'Li': 'lithium',
  94     'Be': 'beryllium',
  95     'B': 'boron'
  96     }
  97     return symbol_dic
  98
  99 def TEST_find_value():
 100     symbol_dic = TEST_getTestDictionnary()
 101     print find_key(symbol_dic, 'boron')  # B
 102     print find_value(symbol_dic, 'B')    # boron
 103     print find_value(symbol_dic, 'H')    # hydrogen
 104     if find_key(symbol_dic, 'nitrogen') != 'N':
 105         return False
 106     return True
 107
 108 def TEST_lookup():
 109     symbol_dic = TEST_getTestDictionnary()
 110
 111     name = 'lithium'
 112     symbol = 'Li'
 113     # use a dictionary as initialization argument
 114     look = Lookup(symbol_dic)
 115     print look.get_key(name)      # [Li']
 116     if look.get_key(name) != symbol:
 117         print "get "+str(look.get_key(name))+" while "+str(symbol)+" was expected"
 118         return False
 119     print look.get_value(symbol)  # lithium
 120
 121     # use a list of pairs instead of a dictionary as initialization argument
 122     # (will be converted to a dictionary by the class internally)
 123     age_list = [['Fred', 23], ['Larry', 28], ['Ene', 23]]
 124     look2 = Lookup(age_list)
 125     print look2.get_keys(23)        # ['Ene', 'Fred']
 126     if look2.get_keys(23)[0] != 'Ene' or look2.get_keys(23)[1] != 'Fred':
 127         print "get "+str(look2.get_keys(23))+" while ['Ene', 'Fred'] was expected"
 128         return False
 129     print look2.get_value('Fred')  # 23
 130     return True
 131
 132 if __name__ == '__main__':
 133     import unittester
 134     unittester.run("diclookup", "TEST_find_value")
 135     unittester.run("diclookup", "TEST_lookup")