added get_options function

Author: alixdamman

larray/core/array.py

@@ -65,7 +65,7 @@
 from larray.util.misc import (table2str, size2str, basestring, izip, rproduct, ReprString, duplicates,
                               float_error_handler_factory, _isnoneslice, light_product, unique_list, common_type,
                               renamed_to, deprecate_kwarg, LHDFStore, lazy_attribute)
-from larray.util.options import OPTIONS, DISPLAY_MAXLINES, DISPLAY_EDGEITEMS, DISPLAY_WIDTH, DISPLAY_PRECISION
+from larray.util.options import _OPTIONS, DISPLAY_MAXLINES, DISPLAY_EDGEITEMS, DISPLAY_WIDTH, DISPLAY_PRECISION
 
 
 def all(values, axis=None):
@@ -2278,9 +2278,9 @@ def __str__(self):
         elif not len(self):
             return 'LArray([])'
         else:
-            table = list(self.as_table(OPTIONS[DISPLAY_MAXLINES], OPTIONS[DISPLAY_EDGEITEMS]))
-            return table2str(table, 'nan', maxwidth=OPTIONS[DISPLAY_WIDTH], keepcols=self.ndim - 1,
-                             precision=OPTIONS[DISPLAY_PRECISION])
+            table = list(self.as_table(_OPTIONS[DISPLAY_MAXLINES], _OPTIONS[DISPLAY_EDGEITEMS]))
+            return table2str(table, 'nan', maxwidth=_OPTIONS[DISPLAY_WIDTH], keepcols=self.ndim - 1,
+                             precision=_OPTIONS[DISPLAY_PRECISION])
     __repr__ = __str__
 
     def __iter__(self):

larray/tests/test_options.py

@@ -1,7 +1,6 @@
 from __future__ import absolute_import, division, print_function
 import pytest
 import larray
-from larray.util.options import OPTIONS
 
 
 def test_invalid_option_raises():
@@ -10,7 +9,7 @@ def test_invalid_option_raises():
 
 
 def test_set_options_as_global():
-    original_ops = OPTIONS.copy()
+    original_ops = larray.get_options()
     arr = larray.ndtest((500, 100))
     larray.set_options(display_width=40, display_maxlines=10)
     expected = """\

larray/util/options.py

@@ -3,7 +3,7 @@
 from larray.util.misc import basestring
 
 
-__all__ = ['set_options']
+__all__ = ['set_options', 'get_options']
 
 
 DISPLAY_PRECISION = 'display_precision'
@@ -12,7 +12,7 @@
 DISPLAY_EDGEITEMS = 'display_edgeitems'
 
 
-OPTIONS = {
+_OPTIONS = {
     DISPLAY_PRECISION: None,
     DISPLAY_WIDTH: 80,
     DISPLAY_MAXLINES: 200,
@@ -96,15 +96,42 @@ class set_options(object):
     def __init__(self, **kwargs):
         self.old = {}
         for k, v in kwargs.items():
-            if k not in OPTIONS:
-                raise ValueError('Argument {} is not in the set of valid options {}'.format(k, set(OPTIONS)))
+            if k not in _OPTIONS:
+                raise ValueError('Argument {} is not in the set of valid options {}'.format(k, set(_OPTIONS)))
             if k in _VALIDATORS:
                 _VALIDATORS[k](v)
-            self.old[k] = OPTIONS[k]
-        OPTIONS.update(kwargs)
+            self.old[k] = _OPTIONS[k]
+        _OPTIONS.update(kwargs)
 
     def __enter__(self):
         return
 
     def __exit__(self, type, value, traceback):
-        OPTIONS.update(self.old)
+        _OPTIONS.update(self.old)
+
+
+def get_options():
+    """
+    Return the current options.
+
+    Returns
+    -------
+    Dictionary of current print options with keys
+
+        - display_precision: int
+        - display_width: int
+        - display_maxlines: int
+        - display_edgeitems : int
+
+    For a full description of these options, see :py:obj:`set_options`.
+
+    See Also
+    --------
+    set_options
+
+    Examples
+    --------
+    >>> get_options()
+    {'display_precision': None, 'display_width': 80, 'display_maxlines': 200, 'display_edgeitems': 5}
+    """
+    return _OPTIONS.copy()