Range as dictionary key in Python
It is possible on Python 3 — and on Python 2 if you use xrange
instead of range
:
stealth_check = {
xrange(1, 6) : 'You are about as stealthy as thunderstorm.', #...
}
However, the way you're trying to use it it won't work. You could iterate over the keys, like this:
for key in stealth_check:
if stealth_roll in key:
print stealth_check[key]
break
Performance of this isn't nice (O(n)) but if it's a small dictionary like you showed it's okay. If you actually want to do that, I'd subclass dict
to work like that automatically:
class RangeDict(dict):
def __getitem__(self, item):
if not isinstance(item, range): # or xrange in Python 2
for key in self:
if item in key:
return self[key]
raise KeyError(item)
else:
return super().__getitem__(item) # or super(RangeDict, self) for Python 2
stealth_check = RangeDict({range(1,6): 'thunderstorm', range(6,11): 'tip-toe'})
stealth_roll = 8
print(stealth_check[stealth_roll]) # prints 'tip-toe'
dict
is the wrong tool for this job. dict
is for mapping specific keys to specific values. That isn't what you're doing; you're trying to map ranges. Here are some more straightforward options.
Use if
blocks
For a small list of values, use the obvious and straightforward if
blocks:
def get_stealthiness(roll):
if 1 <= roll < 6:
return 'You are about as stealthy as thunderstorm.'
elif 6 <= roll < 11:
return 'You tip-toe through the crowd of walkers, while loudly calling them names.'
elif 11 <= roll < 16:
return 'You are quiet, and deliberate, but still you smell.'
elif 16 <= roll <= 20:
return 'You move like a ninja, but attracting a handful of walkers was inevitable.'
else:
raise ValueError('Unsupported roll: {}'.format(roll))
stealth_roll = randint(1, 20)
print(get_stealthiness(stealth_roll))
There is absolutely nothing wrong with this approach. It really doesn't need to be any more complex. This is much more intuitive, much easier to figure out, and much more efficient than trying to use a dict
here.
Doing it this way also makes the boundary handling more visible. In the code I present above, you can quickly spot whether the range uses <
or <=
in each place. The code above also throws a meaningful error message for values outside of 1 to 20. It also supports non-integer input for free, although you may not care about that.
Map every value to an outcome
Instead of trying to use the ranges for the keys, you could reformulate your problem into one that does map specific keys to specific values. You do so by looping through the ranges and generating a full dict
containing all the possible values:
OUTCOMES = {}
for i in range(1, 6):
OUTCOMES[i] = 'You are about as stealthy as thunderstorm.'
for i in range(6, 11):
OUTCOMES[i] = 'You tip-toe through the crowd of walkers, while loudly calling them names.'
for i in range(11, 16):
OUTCOMES[i] = 'You are quiet, and deliberate, but still you smell.'
for i in range(16, 21):
OUTCOMES[i] = 'You move like a ninja, but attracting a handful of walkers was inevitable.'
def get_stealthiness(roll):
if roll not in OUTCOMES.keys():
raise ValueError('Unsupported roll: {}'.format(roll))
return OUTCOMES[roll]
stealth_roll = randint(1, 20)
print(get_stealthiness(stealth_roll))
In this case, we use the ranges to generate a dict
that we can look up a result in. We map each roll to an outcome, reusing the same outcomes multiple times. This is less straightforward; it's not quite as easy to discern the probability of each outcome from it. But at least it uses dict
properly: it maps a key to a value.
Compute according to probabilities
You could choose the result based on a probabilities calculation. The basic idea is to compute a "cumulative" probability (which you already have with the top end of the roll values) and then loop through until the cumulative probability exceeds the random value. There's plenty of ideas of how to go about it here.
Some simple options are:
-
numpy.random.choice
-
A loop:
# Must be in order of cummulative weight OUTCOME_WITH_CUM_WEIGHT = [ ('You are about as stealthy as thunderstorm.', 5), ('You tip-toe through the crowd of walkers, while loudly calling them names.', 10), ('You are quiet, and deliberate, but still you smell.', 15), ('You move like a ninja, but attracting a handful of walkers was inevitable.', 20), ] def get_stealthiness(roll): if 1 > roll or 20 < roll: raise ValueError('Unsupported roll: {}'.format(roll)) for stealthiness, cumweight in OUTCOME_WITH_CUM_WEIGHT: if roll <= cumweight: return stealthiness raise Exception('Reached end of get_stealthiness without returning. This is a bug. roll was ' + str(roll)) stealth_roll = randint(1, 20) print(get_stealthiness(stealth_roll))
-
random.choices
(requires Python 3.6 or higher)OUTCOMES_SENTENCES = [ 'You are about as stealthy as thunderstorm.', 'You tip-toe through the crowd of walkers, while loudly calling them names.', 'You are quiet, and deliberate, but still you smell.', 'You move like a ninja, but attracting a handful of walkers was inevitable.', ] OUTCOME_CUMULATIVE_WEIGHTS = [5, 10, 15, 20] def make_stealth_roll(): return random.choices( population=OUTCOMES_SENTENCES, cum_weights=OUTCOME_CUMULATIVE_WEIGHTS, ) print(make_stealth_roll())
Some have the downside of taking the actual numeric roll out of your hands, but they're a lot simpler to implement and maintain.
Pythonic
"Pythonic" means keeping your code straightforward and approachable. It means using structures for the purposes they were designed for. dict
was not designed for what you're doing.
Speed
All of these options are comparatively fast. According to raratiru's comment, the RangeDict
was the fastest answer at the time. However, my testing script shows that except for numpy.random.choice
, all the options I've suggested are about 40% to 50% faster:
get_stealthiness_rangedict(randint(1, 20)): 3.4458323369617574 µs per loop
get_stealthiness_ifs(randint(1, 20)): 1.8013543629786 µs per loop
get_stealthiness_dict(randint(1, 20)): 1.9512669100076891 µs per loop
get_stealthiness_cumweight(randint(1, 20)): 1.9908560069743544 µs per loop
make_stealth_roll_randomchoice(): 2.037966169009451 µs per loop
make_stealth_roll_numpychoice(): 38.046008297998924 µs per loop
numpy.choice all at once: 0.5016623589908704 µs per loop
numpy is an order of magnitude slower if you get one result at a time from it; however, it's an order of magnitude faster if you generate your results in bulk.
Yes, you can, only if you convert your range
lists as immutable tuple
, so they are hashable and accepted as keys of your dictionary:
stealth_check = {
tuple(range(1, 6)) : 'You are about as stealthy as thunderstorm.',
EDIT: actually it works in Python 3 as range
is an immutable sequence type and generate an immutable tuple
instead of a list
as L3viathan stated.
but you cannot access them with a single integer as key though. Your last line won't work.
I took some time to create a solution which would work whatever the values may be (picking one entry in the dictionary works as long as the lines are not "weighted" by bigger ranges.
It calls bisect
on the sorted keys to find the insertion point, hacks it a bit, and finds the best value in the dictionary, with O(log(N))
complexity, which means it can handle a really big list (maybe a little too much here :) but the dictionary is also too much in that case)
from random import randint
import bisect
stealth_roll = randint(1, 20)
# select from a dictionary of 4 responses using one of four thresholds.
stealth_check = {
1 : 'You are about as stealthy as thunderstorm.',
6 : 'You tip-toe through the crowd of walkers, while loudly calling them names.',
11 : 'You are quiet, and deliberate, but still you smell.',
16 : 'You move like a ninja, but attracting a handful of walkers was inevitable.'
}
sorted_keys = sorted(stealth_check.keys())
insertion_point = bisect.bisect_left(sorted_keys,stealth_roll)
# adjust, as bisect returns not exactly what we want
if insertion_point==len(sorted_keys) or sorted_keys[insertion_point]!=stealth_roll:
insertion_point-=1
print(insertion_point,stealth_roll,stealth_check[sorted_keys[insertion_point]])