Python convenciones de nomenclatura para Diccionarios/Mapas/hashes

Question

Mientras que otras preguntas han abordado la categoría más amplia de sequences y modules, hago esta pregunta muy específica:

"¿Qué convención de nomenclatura Cómo se utiliza para los diccionarios y por qué?"

Algunas muestras convención de nombres que he estado considerando:

# 'value' is the data type stored in the map, while 'key' is the type of key 
value_for_key={key1:value1, key2,value2} 
value_key={key1:value1, key2,value2} 
v_value_k_key={key1:value1, key2,value2} 

no se molestan en contestar el 'por qué' con "porque mi trabajo me dice que", no es muy útil. El motivo por el que se impulsa la elección es más importante. ¿Existen otras consideraciones útiles para una convención de nombres de diccionarios además de la legibilidad?

EDIT:

respuesta elegida: value_key_map

Motivo de la respuesta elegida: Permite que un revisor de código para calcular rápida y fácilmente la clave y el valor de un mapa, y el hecho de que es un mapa sin mirar a ningún otro lado.

Answer 1

Nunca parezco nombrarles nada como lo que propones (es decir, manteniendo un camino). Simplemente parece ser mucho más claro cuando puedo encontrar un "nombre propio" para el hash. Puede ser "detalles_de_personas" o "tamaños de archivos" o "pistas de álbumes", etc. (aunque los últimos 2 parecen tener nombres de valores_claves, primero un poco menos). En casos excepcionales, será key_value_map o value_key_map si es importante que se trate de un mapa.

Nunca asumiría ningún esquema de nombres para eso. A veces los valores son lo que buscas, a veces las claves. Mi preferencia es "un nombre natural".

Answer 2

Normalmente uso < algo>map ya que generalmente es un mapa como cadenas de funciones, o números para clases, o lo que sea. Los dictados sin nombre por lo general terminan en una estructura más grande, por lo que no me preocupo por ellos.

Answer 3

Creo que tiene sentido nombrar el dict después de los valores en el diccionario, y omitir cualquier mención de la clave. Después de todo, vas a utilizar el dict en situaciones como values[key] que deja perfectamente claro cuáles son las claves, suponiendo que hayas llamado key.

Answer 4

key_to_value, por ejemplo surname_to_salary puede ser útil cuando hay mapas estrechamente interrelacionados en código: A a B, B a A, C a B, etc.

Answer 5

En nuestros proyectos, hemos adoptado siguiente convención:

• key_to_value_map cuando es un mapa
• aname_dict para mayor estructura más compleja.