PYTHON
Preserve Dictionary Key Order with `collections.OrderedDict`
Guarantee the insertion order of dictionary keys in Python using `collections.OrderedDict`, vital for configurations or API responses where element sequence is critical.
from collections import OrderedDict
# Create an OrderedDict
config_settings = OrderedDict()
config_settings['host'] = 'localhost'
config_settings['port'] = 8080
config_settings['debug'] = True
config_settings['environment'] = 'development'
print("Ordered Dictionary:")
for key, value in config_settings.items():
print(f"{key}: {value}")
# Demonstrate order preservation
new_config = OrderedDict([
('name', 'MyWebApp'),
('version', '1.0'),
('path', '/app')
])
new_config['owner'] = 'Admin'
print("
Another Ordered Dictionary:")
print(list(new_config.keys()))
# Comparison with standard dict (pre-Python 3.7 behavior)
# Note: For Python 3.7+, standard dicts *also* preserve insertion order.
# OrderedDict ensures this behavior across versions and makes intent explicit.
How it works: `collections.OrderedDict` is a dictionary subclass that remembers the order in which its contents were added. While standard Python dictionaries (from Python 3.7 onwards) also preserve insertion order, `OrderedDict` explicitly documents this behavior and provides compatibility for older Python versions. It's particularly useful when the order of items is semantically important, such as in API parameter definitions or configuration files.