REF: rename option key "print" to "display"

print is a python keyword, bad choice.

Author: y-p

doc/source/basics.rst

@@ -1058,25 +1058,28 @@ and they are:
 
 **Note:** developers can check out pandas/core/config.py for more info.
 
-Options have a full "dotted-style", case-insensitive name (e.g. ``print.max_rows``),
+Options have a full "dotted-style", case-insensitive name (e.g. ``display.max_rows``),
 but all of the functions above accept a regexp pattern (``re.search`` style) as argument,
 so passing in a substring will work - as long as it is unambiguous :
 
 .. ipython:: python
 
-   get_option("print.max_rows")
-   set_option("print.max_rows",101)
-   get_option("print.max_rows")
+   get_option("display.max_rows")
+   set_option("display.max_rows",101)
+   get_option("display.max_rows")
    set_option("max_r",102)
-   get_option("print.max_rows")
+   get_option("display.max_rows")
 
 
-However, the following will **not work** because it matches multiple option names, e.g.``print.max_colwidth``, ``print.max_rows``, ``print.max_columns``:
+However, the following will **not work** because it matches multiple option names, e.g.``display.max_colwidth``, ``display.max_rows``, ``display.max_columns``:
 
 .. ipython:: python
    :okexcept:
 
-   get_option("print.max_")
+   try:
+       get_option("display.max_")
+   except KeyError as e:
+       print(e)
 
 
 **Note:** Using this form of convenient shorthand may make your code break if new options with similar names are added in future versions.
@@ -1103,23 +1106,23 @@ All options also have a default value, and you can use the ``reset_option`` to d
 .. ipython:: python
    :suppress:
 
-   reset_option("print.max_rows")
+   reset_option("display.max_rows")
 
 
 .. ipython:: python
 
-   get_option("print.max_rows")
-   set_option("print.max_rows",999)
-   get_option("print.max_rows")
-   reset_option("print.max_rows")
-   get_option("print.max_rows")
+   get_option("display.max_rows")
+   set_option("display.max_rows",999)
+   get_option("display.max_rows")
+   reset_option("display.max_rows")
+   get_option("display.max_rows")
 
 
 and you also set multiple options at once:
 
 .. ipython:: python
 
-   reset_option("^print\.")
+   reset_option("^display\.")
 
 
 

doc/source/v0.10.0.txt

@@ -160,11 +160,11 @@ Convenience methods ``ffill`` and  ``bfill`` have been added:
     arguments. print all registered options.
 
   Note: ``set_printoptions``/ ``reset_printoptions`` are now deprecated (but
-  functioning), the print options now live under "print.XYZ". For example:
+  functioning), the print options now live under "display.XYZ". For example:
 
   .. ipython:: python
 
-     get_option("print.max_rows")
+     get_option("display.max_rows")
 
 - to_string() methods now always return unicode strings  (GH2224_).
 
@@ -284,7 +284,7 @@ Updated PyTables Support
       df['string'] = 'string'
       df['int']    = 1
       store.append('df',df)
-      df1 = store.select('df') 
+      df1 = store.select('df')
       df1
       df1.get_dtype_counts()
 

pandas/core/common.py

@@ -1213,7 +1213,7 @@ def in_qtconsole():
 # 2) If you need to send something to the console, use console_encode().
 #
 #    console_encode() should (hopefully) choose the right encoding for you
-#    based on the encoding set in option "print.encoding"
+#    based on the encoding set in option "display.encoding"
 #
 # 3) if you need to write something out to file, use
 #    pprint_thing_encoded(encoding).
@@ -1272,10 +1272,10 @@ def pprint_thing(thing, _nest_lvl=0, escape_chars=None):
          hasattr(thing,'next'):
         return unicode(thing)
     elif (isinstance(thing, dict) and
-          _nest_lvl < get_option("print.pprint_nest_depth")):
+          _nest_lvl < get_option("display.pprint_nest_depth")):
         result = _pprint_dict(thing, _nest_lvl)
     elif _is_sequence(thing) and _nest_lvl < \
-		get_option("print.pprint_nest_depth"):
+		get_option("display.pprint_nest_depth"):
         result = _pprint_seq(thing, _nest_lvl, escape_chars=escape_chars)
     else:
         # when used internally in the package, everything
@@ -1313,8 +1313,8 @@ def console_encode(object, **kwds):
     this is the sanctioned way to prepare something for
     sending *to the console*, it delegates to pprint_thing() to get
     a unicode representation of the object relies on the global encoding
-    set in print.encoding. Use this everywhere
+    set in display.encoding. Use this everywhere
     where you output to the console.
     """
     return pprint_thing_encoded(object,
-             get_option("print.encoding"))
+             get_option("display.encoding"))

pandas/core/config_init.py

@@ -16,7 +16,7 @@
 
 
 ###########################################
-# options from the "print" namespace
+# options from the "display" namespace
 
 pc_precision_doc="""
 : int
@@ -121,7 +121,7 @@
     When printing wide DataFrames, this is the width of each line.
 """
 
-with cf.config_prefix('print'):
+with cf.config_prefix('display'):
     cf.register_option('precision', 7, pc_precision_doc, validator=is_int)
     cf.register_option('float_format', None, float_format_doc)
     cf.register_option('column_space', 12, validator=is_int)

pandas/core/format.py

@@ -74,7 +74,7 @@ def __init__(self, series, buf=None, header=True, length=True,
         self.header = header
 
         if float_format is None:
-            float_format = get_option("print.float_format")
+            float_format = get_option("display.float_format")
         self.float_format = float_format
 
     def _get_footer(self):
@@ -151,7 +151,7 @@ def _encode_diff_func():
     if py3compat.PY3:  # pragma: no cover
         _encode_diff = lambda x: 0
     else:
-        encoding = get_option("print.encoding")
+        encoding = get_option("display.encoding")
         def _encode_diff(x):
             return len(x) - len(x.decode(encoding))
 
@@ -162,7 +162,7 @@ def _strlen_func():
     if py3compat.PY3:  # pragma: no cover
         _strlen = len
     else:
-        encoding = get_option("print.encoding")
+        encoding = get_option("display.encoding")
         def _strlen(x):
             try:
                 return len(x.decode(encoding))
@@ -208,7 +208,7 @@ def __init__(self, frame, buf=None, columns=None, col_space=None,
         self.show_index_names = index_names
 
         if sparsify is None:
-            sparsify = get_option("print.multi_sparse")
+            sparsify = get_option("display.multi_sparse")
 
         self.sparsify = sparsify
 
@@ -221,7 +221,7 @@ def __init__(self, frame, buf=None, columns=None, col_space=None,
         self.line_width = line_width
 
         if justify is None:
-            self.justify = get_option("print.colheader_justify")
+            self.justify = get_option("display.colheader_justify")
         else:
             self.justify = justify
 
@@ -1005,13 +1005,13 @@ def format_array(values, formatter, float_format=None, na_rep='NaN',
         fmt_klass = GenericArrayFormatter
 
     if space is None:
-        space = get_option("print.column_space")
+        space = get_option("display.column_space")
 
     if float_format is None:
-        float_format = get_option("print.float_format")
+        float_format = get_option("display.float_format")
 
     if digits is None:
-        digits = get_option("print.precision")
+        digits = get_option("display.precision")
 
     fmt_obj = fmt_klass(values, digits, na_rep=na_rep,
                         float_format=float_format,
@@ -1039,9 +1039,9 @@ def get_result(self):
 
     def _format_strings(self):
         if self.float_format is None:
-            float_format = get_option("print.float_format")
+            float_format = get_option("display.float_format")
             if float_format is None:
-                fmt_str = '%% .%dg' % get_option("print.precision")
+                fmt_str = '%% .%dg' % get_option("display.precision")
                 float_format = lambda x: fmt_str % x
         else:
             float_format = self.float_format
@@ -1167,7 +1167,7 @@ def _make_fixed_width(strings, justify='right', minimum=None):
     if minimum is not None:
         max_len = max(minimum, max_len)
 
-    conf_max = get_option("print.max_colwidth")
+    conf_max = get_option("display.max_colwidth")
     if conf_max is not None and max_len > conf_max:
         max_len = conf_max
 
@@ -1281,35 +1281,35 @@ def set_printoptions(precision=None, column_space=None, max_rows=None,
     warnings.warn("set_printoptions is deprecated, use set_option instead",
                           FutureWarning)
     if precision is not None:
-        set_option("print.precision", precision)
+        set_option("display.precision", precision)
     if column_space is not None:
-        set_option("print.column_space", column_space)
+        set_option("display.column_space", column_space)
     if max_rows is not None:
-        set_option("print.max_rows", max_rows)
+        set_option("display.max_rows", max_rows)
     if max_colwidth is not None:
-        set_option("print.max_colwidth", max_colwidth)
+        set_option("display.max_colwidth", max_colwidth)
     if max_columns is not None:
-        set_option("print.max_columns", max_columns)
+        set_option("display.max_columns", max_columns)
     if colheader_justify is not None:
-        set_option("print.colheader_justify", colheader_justify)
+        set_option("display.colheader_justify", colheader_justify)
     if notebook_repr_html is not None:
-        set_option("print.notebook_repr_html", notebook_repr_html)
+        set_option("display.notebook_repr_html", notebook_repr_html)
     if date_dayfirst is not None:
-        set_option("print.date_dayfirst", date_dayfirst)
+        set_option("display.date_dayfirst", date_dayfirst)
     if date_yearfirst is not None:
-        set_option("print.date_yearfirst", date_yearfirst)
+        set_option("display.date_yearfirst", date_yearfirst)
     if pprint_nest_depth is not None:
-        set_option("print.pprint_nest_depth", pprint_nest_depth)
+        set_option("display.pprint_nest_depth", pprint_nest_depth)
     if multi_sparse is not None:
-        set_option("print.multi_sparse", multi_sparse)
+        set_option("display.multi_sparse", multi_sparse)
     if encoding is not None:
-        set_option("print.encoding", encoding)
+        set_option("display.encoding", encoding)
 
 def reset_printoptions():
     import warnings
     warnings.warn("reset_printoptions is deprecated, use reset_option instead",
                           FutureWarning)
-    reset_option("^print\.")
+    reset_option("^display\.")
 
 def detect_console_encoding():
     """
@@ -1441,8 +1441,8 @@ def set_eng_float_format(precision=None, accuracy=3, use_eng_prefix=False):
                       "being renamed to 'accuracy'", FutureWarning)
         accuracy = precision
 
-    set_option("print.float_format", EngFormatter(accuracy, use_eng_prefix))
-    set_option("print.column_space", max(12, accuracy + 9))
+    set_option("display.float_format", EngFormatter(accuracy, use_eng_prefix))
+    set_option("display.column_space", max(12, accuracy + 9))
 
 def _put_lines(buf, lines):
     if any(isinstance(x, unicode) for x in lines):

pandas/core/frame.py

@@ -594,10 +594,10 @@ def _need_info_repr_(self):
             terminal_width, terminal_height = 100, 100
         else:
             terminal_width, terminal_height = get_terminal_size()
-        max_rows = (terminal_height if get_option("print.max_rows") == 0
-                    else get_option("print.max_rows"))
-        max_columns = get_option("print.max_columns")
-        expand_repr = get_option("print.expand_frame_repr")
+        max_rows = (terminal_height if get_option("display.max_rows") == 0
+                    else get_option("display.max_rows"))
+        max_columns = get_option("display.max_columns")
+        expand_repr = get_option("display.expand_frame_repr")
 
         if max_columns > 0:
             if (len(self.index) <= max_rows and
@@ -642,7 +642,7 @@ def __bytes__(self):
         Invoked by bytes(df) in py3 only.
         Yields a bytestring in both py2/py3.
         """
-        encoding = com.get_option("print.encoding")
+        encoding = com.get_option("display.encoding")
         return self.__unicode__().encode(encoding , 'replace')
 
     def __unicode__(self):
@@ -659,7 +659,7 @@ def __unicode__(self):
             is_wide = self._need_wide_repr()
             line_width = None
             if is_wide:
-                line_width = get_option('print.line_width')
+                line_width = get_option('display.line_width')
             self.to_string(buf=buf, line_width=line_width)
 
         value = buf.getvalue()
@@ -668,7 +668,7 @@ def __unicode__(self):
         return value
 
     def _need_wide_repr(self):
-        return (get_option("print.expand_frame_repr")
+        return (get_option("display.expand_frame_repr")
                 and com.in_interactive_session())
 
     def __repr__(self):
@@ -687,7 +687,7 @@ def _repr_html_(self):
         if com.in_qtconsole():
             raise ValueError('Disable HTML output in QtConsole')
 
-        if get_option("print.notebook_repr_html"):
+        if get_option("display.notebook_repr_html"):
             if self._need_info_repr_():
                 return None
             else:
@@ -1597,7 +1597,7 @@ def info(self, verbose=True, buf=None, max_cols=None):
 
         # hack
         if max_cols is None:
-            max_cols = get_option('print.max_info_columns')
+            max_cols = get_option('display.max_info_columns')
 
         if verbose and len(self.columns) <= max_cols:
             lines.append('Data columns:')

pandas/core/index.py

@@ -159,7 +159,7 @@ def __bytes__(self):
         Invoked by bytes(df) in py3 only.
         Yields a bytestring in both py2/py3.
         """
-        encoding = com.get_option("print.encoding")
+        encoding = com.get_option("display.encoding")
         return self.__unicode__().encode(encoding , 'replace')
 
     def __unicode__(self):
@@ -1380,7 +1380,7 @@ def __bytes__(self):
         Invoked by bytes(df) in py3 only.
         Yields a bytestring in both py2/py3.
         """
-        encoding = com.get_option("print.encoding")
+        encoding = com.get_option("display.encoding")
         return self.__unicode__().encode(encoding , 'replace')
 
     def __unicode__(self):
@@ -1586,7 +1586,7 @@ def format(self, space=2, sparsify=None, adjoin=True, names=False,
             result_levels.append(level)
 
         if sparsify is None:
-            sparsify = get_option("print.multi_sparse")
+            sparsify = get_option("display.multi_sparse")
 
         if sparsify:
             # little bit of a kludge job for #1217

pandas/core/panel.py

@@ -473,7 +473,7 @@ def __bytes__(self):
         Invoked by bytes(df) in py3 only.
         Yields a bytestring in both py2/py3.
         """
-        encoding = com.get_option("print.encoding")
+        encoding = com.get_option("display.encoding")
         return self.__unicode__().encode(encoding , 'replace')
 
     def __unicode__(self):
@@ -1556,7 +1556,7 @@ def _add_aggregate_operations(cls):
         # doc strings substitors
         _agg_doc = """
 Wrapper method for %s
-                
+
 Parameters
 ----------
 other : """ + "%s or %s" % (cls._constructor_sliced.__name__,cls.__name__) + """
@@ -1634,7 +1634,7 @@ def std(self, axis='major', skipna=True):
         def skew(self, axis='major', skipna=True):
             return self._reduce(nanops.nanskew, axis=axis, skipna=skipna)
         cls.skew = skew
-        
+
         @Substitution(desc='product', outname='prod')
         @Appender(_agg_doc)
         def prod(self, axis='major', skipna=True):