Python Problem Overview
"What naming convention do you use for dictionaries and why?"
Some naming convention samples I have been considering:
# 'value' is the data type stored in the map, while 'key' is the type of key
Don't bother answering the 'why' with "because my work tells me to", not very helpful. The reason driving the choice is more important. Are there any other good considerations for a dictionary naming convention aside from readability?
Chosen answer: value_key_map
Reason for chosen answer: Allows a code reviewer to quickly and easily figure out the key and value for a map, and the fact that it is a map without looking anywhere else.
Solution 1 - Python
key_to_value, for example
surname_to_salary may be useful when there are closely interrelated maps in code: a to b, b to a, c to b etc.
Solution 2 - Python
I never seem to name them anything like what you proposed (i.e. keeping one way). It just seems to be much more clear when I can find a "proper name" for the hash. It might be "person_details" or "file_sizes" or "album_tracks" etc. (although the last 2 seem to have key_value names, first one a bit less). In rare cases, it will be
value_key_map if it's important that it's a map.
I would never assume any naming scheme for that. Sometimes the values are what you're after, sometimes the keys. My preference is "a natural name".
Solution 3 - Python
- it is not so confusing as
value_key_map: you can't confuse what is value name and what is key name
- it doesn't name the type directly -- python style naming
Solution 4 - Python
I think it makes sense to name the dict after the values in the dict, and drop any mention of the key. After all, you are going to be using the dict in situations like
values[key] which makes it perfectly clear what the keys are, assuming you named
Solution 5 - Python
I will contrast with many answers so far (including the chosen answer) and say:
I avoid adding type references like
map to the variable name. It feels too much like Hungarian notation to me, which feels very anti-pythonic.
To answer the question of what I DO use:
I use names of the form
values_for_key, whichever reads most naturally.
Solution 6 - Python
I usually use <something>
map since it's usually a map such as strings to functions, or numbers to classes, or whatnot. Unnamed dicts usually end up in a larger structure, so I don't worry about them.
Solution 7 - Python
In our projects, we adopted following convention:
key_to_value_mapwhen it is a map
aname_dictfor larger more complex structure.