DESCRIPTION.rst 785 B

123456789101112131415161718192021222324252627282930313233
  1. # optionaldict
  2. [![Build Status](https://travis-ci.org/messense/optionaldict.svg)](https://travis-ci.org/messense/optionaldict)
  3. [![Coverage Status](https://coveralls.io/repos/messense/optionaldict/badge.svg)](https://coveralls.io/r/messense/optionaldict)
  4. ``optionaldict`` is a dict-like object that ignore NoneType values for Python which is pickable and JSON serializable.
  5. # Installation
  6. You can install ``optionaldict`` simply using ``pip``:
  7. ```bash
  8. pip install optionaldict
  9. ```
  10. # Usage
  11. ``optionaldict``'s usage is very simple, you will import it:
  12. ```python
  13. from optionaldict import optionaldict
  14. ```
  15. then use it just like the built-in ``dict``:
  16. ```python
  17. d1 = optionaldict(a=1, b=None)
  18. d1['c'] = 2
  19. d1.setdefault('d', None)
  20. d2 = optionaldict()
  21. d2['a'] = 1
  22. d2['b'] = None
  23. ```