Version 2.2.0 (cdgriffith#12)

cdgriffith · web-flow · commit 52515efd41dd · 2017-04-02T13:37:22.000-05:00
* Adding update, set_default and dir support * Adding tests, fixing up readme * Python2.x compatibility * Support for ruamel.yaml (cdgriffith#8) * [ci skip] adding Authors and Contributing files. * [ci skip] Updating Authors * [ci skip] Updating Changes * Fixing tests when using ruamel.yaml instead of pyyaml * [ci skip] Update changes.rst * Fixing PEP8 issues
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -0,0 +1,17 @@
+Box is written and maintained by Chris Griffith chris@cdgriffith.com.
+
+A big thank you to everyone that has helped! From PRs to suggestions and bug
+reporting, all input is greatly appreciated!
+
+Code contributions:
+
+- Alexandre Decan (AlexandreDecan)
+
+Suggestions and bug reporting:
+
+- JiuLi Gao (gaojiuli)
+- Jürgen Hermann (jhermann)
+- /u/tilkau
+- /u/Jumpy89
+- /u/can_dry
+- /u/spidyfan21
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,3 +1,9 @@
+Version 2.2.0
+=============
+
+* Adding support for `ruamel.yaml` (Thanks to Alexandre Decan)
+* Adding Contributing and Authors files
+
 Version 2.1.0
 =============
 
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,39 @@
+Contributing to Box
+===================
+
+Thank you for looking into supporting Box. Any constructive input
+is greatly appreciated!
+
+Questions and Ideas
+-------------------
+
+Even if you don't have code contributions, but just an idea, or a question about
+Box, please feel free to open an issue!
+
+Reporting Bugs
+--------------
+
+- Please include sample code and traceback (or unexpected behavior)
+  of the error you are experiencing.
+
+- Python version and Operating System.
+
+Pull Requests
+-------------
+
+- Follow PEP8
+
+- New features should have
+    - Reasoning for addition in pull request
+    - Docstring with code block example and parameters
+    - Tests with as much coverage as reasonable
+    - Tests should go through both sad and happy paths
+
+- Bug fixes should include
+    - Explain under which circumstances the bug occurs in the pull request
+    - Tests for new happy and sad paths
+    - Test proving error without new code
+
+- Update CHANGES.rst to include new feature or fix
+
+- Add yourself to AUTHORS.rst!
diff --git a/README.rst b/README.rst
@@ -185,7 +185,7 @@ Available on all systems that support the default `json` library.::
 
 **to_yaml**
 
-Only available if `PyYAML` is installed (not automatically installed via pip or `setup.py`)::
+Only available if `PyYAML` or `ruamel.yaml` is installed (not automatically installed via pip or `setup.py`)::
 
    to_yaml(filename=None, default_flow_style=False, **yaml_kwargs)
        Transform the Box object into a YAML string.
diff --git a/box.py b/box.py
@@ -22,14 +22,18 @@
     import yaml
     yaml_support = True
 except ImportError:
-    yaml = None
+    try:
+        import ruamel.yaml as yaml
+        yaml_support = True
+    except ImportError:
+        yaml = None
 
 if sys.version_info >= (3, 0):
     basestring = str
 
 __all__ = ['Box', 'ConfigBox', 'LightBox', 'BoxList']
 __author__ = "Chris Griffith"
-__version__ = "2.1.0"
+__version__ = "2.2.0"
 
 
 class LightBox(dict):
@@ -163,8 +167,8 @@ def to_dict(self, in_dict=None):
 
     def to_json(self, filename=None, indent=4, **json_kwargs):
         """
-        Transform the Box object into a JSON string. 
-        
+        Transform the Box object into a JSON string.
+
         :param filename: If provided will save to file
         :param indent: Automatic formatting by indent size in spaces
         :param json_kwargs: additional arguments to pass to json.dump(s)
@@ -181,8 +185,8 @@ def to_json(self, filename=None, indent=4, **json_kwargs):
         def to_yaml(self, filename=None, default_flow_style=False,
                     **yaml_kwargs):
             """
-            Transform the Box object into a YAML string. 
-            
+            Transform the Box object into a YAML string.
+
             :param filename:  If provided will save to file
             :param default_flow_style: False will recursively dump dicts
             :param yaml_kwargs: additional arguments to pass to yaml.dump
@@ -210,13 +214,12 @@ def _recursive_create(self, iterable, include_lists=False, box_class=LightBox):
 
 class Box(LightBox):
     """
-    Same as LightBox, 
+    Same as LightBox,
     but also goes into lists and makes dicts within into Boxes.
 
     The lists are turned into BoxLists
     so that they can also intercept incoming items and turn
     them into Boxes.
-
     """
 
     def __init__(self, *args, **kwargs):
@@ -295,7 +298,7 @@ def update(self, item=None, **kwargs):
     def setdefault(self, item, default=None):
         if item in self:
             return self[item]
-        
+
         if isinstance(default, dict):
             default = Box(default)
         elif isinstance(default, list):
@@ -307,7 +310,7 @@ def setdefault(self, item, default=None):
 class BoxList(list):
     """
     Drop in replacement of list, that converts added objects to Box or BoxList
-    objects as necessary. 
+    objects as necessary.
     """
     __box_class__ = Box
 
@@ -363,7 +366,6 @@ class ConfigBox(LightBox):
     cns.bool('my_bool') # True
     cns.int('my_int') # 5
     cns.list('my_list', mod=lambda x: int(x)) # [5, 4, 3, 3, 2]
-
     """
 
     _protected_keys = dir({}) + ['to_dict', 'bool', 'int', 'float',
diff --git a/test/test_box.py b/test/test_box.py
@@ -3,7 +3,10 @@
 import unittest
 import json
 
-import yaml
+try:
+    import yaml
+except ImportError:
+    import ruamel.yaml as yaml
 
 from box import Box, ConfigBox, LightBox, BoxList
 
@@ -72,8 +75,7 @@ def test_box_from_dict(self):
 
     def test_box_from_bad_dict(self):
         try:
-            ns = Box('{"k1": "v1", '
-                                               '"k2": {"k3": "v2"}}')
+            Box('{"k1": "v1", "k2": {"k3": "v2"}}')
         except ValueError:
             assert True
         else:
diff --git a/tox.ini b/tox.ini
@@ -7,4 +7,4 @@ deps=
     rarfile
     scandir
     pytest-cov
-commands=py.test --cov=box test/
+commands=py.test --cov=box test/
