biconfigs 0.0.14

High frequency update

Normally, Biconfigs will write the changes to file immediately. But sometime you may want to update values frequently, which will result in a IO bottleneck. So you can use ``with`` statement to prevent auto saving for a while.

with configs:
  for i in range(1000):
    configs['some_key'] = i
# This statement will execute saving process only one time when exiting "with" scope

When to save

• Saving when: Item create, item delete, list reorder, value change, ``get_set``, etc.

  # All the following single statement will cause saving
  configs['item'] = 'value'
  configs['options'] = {}
  configs.options['list'] = []
  configs.options.list.append('example')
  configs.options['list'] = []
  configs.options.clear()
  value2 = configs.get_set('item2', 45)

• Not saving when: Item access, assignment but not changed, etc.

  # All the following single statement will NOT cause saving
  value = configs.item
  configs['item'] = 'value' # The value of 'item' is not changed
  value3 = configs.get('item_not_exists', 'default_value')

Get or set

Biconfigs provides a special function get_set for dict. The get_set acts just like dict.get(key, default), but it will save the default value to dict if the key is not exists.

For example:

# get_set will return the default value if the key is not exists
>>> self.config.get_set('item', 'value')
'value'
# get_set also set the default value to dict
>>> self.config.item
'value'
# get_set will just return the value of existing key
>>> self.config.get_set('item', 'new-value')
'value'