ENH: Validation to only allow positive integers for options

doc/source/whatsnew/v0.26.0.rst

@@ -0,0 +1,201 @@
+.. _whatsnew_0260:
+
+What's new in 0.26.0 (??)
+------------------------
+
+.. warning::
+
+   Starting with the 0.25.x series of releases, pandas only supports Python 3.5.3 and higher.
+   See :ref:`install.dropping-27` for more details.
+
+.. warning::
+
+   The minimum supported Python version will be bumped to 3.6 in a future release.
+
+{{ header }}
+
+These are the changes in pandas 0.26.0. See :ref:`release` for a full changelog
+including other versions of pandas.
+
+
+Enhancements
+~~~~~~~~~~~~
+
+.. _whatsnew_0260.enhancements.other:
+
+-
+-
+
+Other enhancements
+^^^^^^^^^^^^^^^^^^
+
+.. _whatsnew_0260.api_breaking:
+
+-
+-
+
+Backwards incompatible API changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _whatsnew_0260.api.other:
+
+-
+-
+
+Other API changes
+^^^^^^^^^^^^^^^^^
+
+-
+-
+
+.. _whatsnew_0260.deprecations:
+
+Deprecations
+~~~~~~~~~~~~
+
+-
+-
+
+.. _whatsnew_0260.prior_deprecations:
+
+Removal of prior version deprecations/changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-
+-
+
+.. _whatsnew_0260.performance:
+
+Performance improvements
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+-
+-
+
+.. _whatsnew_0260.bug_fixes:
+
+Bug fixes
+~~~~~~~~~
+
+
+Categorical
+^^^^^^^^^^^
+
+-
+-
+
+
+Datetimelike
+^^^^^^^^^^^^
+
+-
+-
+
+
+Timedelta
+^^^^^^^^^
+
+-
+-
+
+Timezones
+^^^^^^^^^
+
+-
+-
+
+
+Numeric
+^^^^^^^
+
+-
+-
+
+Conversion
+^^^^^^^^^^
+
+-
+-
+
+Strings
+^^^^^^^
+
+-
+-
+
+
+Interval
+^^^^^^^^
+
+-
+-
+
+Indexing
+^^^^^^^^
+
+-
+-
+
+Missing
+^^^^^^^
+
+-
+-
+
+MultiIndex
+^^^^^^^^^^
+
+-
+-
+
+I/O
+^^^
+
+-
+-
+
+Plotting
+^^^^^^^^
+
+-
+-
+
+Groupby/resample/rolling
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+-
+-
+
+Reshaping
+^^^^^^^^^
+
+-
+-
+
+Sparse
+^^^^^^
+
+-
+-
+
+
+Build Changes
+^^^^^^^^^^^^^
+
+
+ExtensionArray
+^^^^^^^^^^^^^^
+
+-
+-
+
+
+Other
+^^^^^
+- Trying to set the display.precision, display.max_rows or display.max_columns using set_option to anything but a None or a positive int will raise a ``ValueError`` (:issue:`23348`)
+
+
+.. _whatsnew_0260.contributors:
+
+Contributors
+~~~~~~~~~~~~

pandas/_config/config.py

@@ -787,6 +787,7 @@ def is_instance_factory(_type):
                 ValueError if x is not an instance of `_type`
 
     """
+
     if isinstance(_type, (tuple, list)):
         _type = tuple(_type)
         type_repr = "|".join(map(str, _type))
@@ -820,6 +821,31 @@ def inner(x):
     return inner
 
 
+def is_pos_int(value):
+    """
+    Verifies that value is None or a positive int
+
+    Parameters
+    ----------
+    value - the value to be checked
+
+    Raises
+    ------
+    ValueError if value is not equal to None or int, or if value is not
+    positive in the case of a int type.
+
+    """
+
+    if not (value is None or isinstance(value, int)):
+        msg = "Value must be an instance of <class 'NoneType'>|<class 'int'>"
+        raise ValueError(msg)
+
+    elif isinstance(value, int):
+        if value < 0:
+            msg = "int values must be positive for this option"
+            raise ValueError(msg)
+
+
 # common type validators, for convenience
 # usage: register_option(... , validator = is_int)
 is_int = is_type_factory(int)

pandas/core/config_init.py

@@ -18,6 +18,7 @@
     is_instance_factory,
     is_int,
     is_one_of_factory,
+    is_pos_int,
     is_text,
 )
 
@@ -319,7 +320,7 @@ def is_terminal():
 
 
 with cf.config_prefix("display"):
-    cf.register_option("precision", 6, pc_precision_doc, validator=is_int)
+    cf.register_option("precision", 6, pc_precision_doc, validator=is_pos_int)
     cf.register_option(
         "float_format",
         None,
@@ -333,12 +334,7 @@ def is_terminal():
         pc_max_info_rows_doc,
         validator=is_instance_factory((int, type(None))),
     )
-    cf.register_option(
-        "max_rows",
-        60,
-        pc_max_rows_doc,
-        validator=is_instance_factory([type(None), int]),
-    )
+    cf.register_option("max_rows", 60, pc_max_rows_doc, validator=is_pos_int)
     cf.register_option(
         "min_rows",
         10,
@@ -351,12 +347,7 @@ def is_terminal():
         max_cols = 0  # automatically determine optimal number of columns
     else:
         max_cols = 20  # cannot determine optimal number of columns
-    cf.register_option(
-        "max_columns",
-        max_cols,
-        pc_max_cols_doc,
-        validator=is_instance_factory([type(None), int]),
-    )
+    cf.register_option("max_columns", max_cols, pc_max_cols_doc, validator=is_pos_int)
     cf.register_option(
         "large_repr",
         "truncate",

pandas/tests/config/test_config.py

@@ -208,20 +208,33 @@ def test_set_option_multiple(self):
 
     def test_validation(self):
         self.cf.register_option("a", 1, "doc", validator=self.cf.is_int)
+        self.cf.register_option("d", 1, "doc", validator=self.cf.is_pos_int)
         self.cf.register_option("b.c", "hullo", "doc2", validator=self.cf.is_text)
+
         msg = "Value must have type '<class 'int'>'"
         with pytest.raises(ValueError, match=msg):
             self.cf.register_option("a.b.c.d2", "NO", "doc", validator=self.cf.is_int)
 
         self.cf.set_option("a", 2)  # int is_int
         self.cf.set_option("b.c", "wurld")  # str is_str
+        self.cf.set_option("d", 2)
 
         # None not is_int
         with pytest.raises(ValueError, match=msg):
             self.cf.set_option("a", None)
         with pytest.raises(ValueError, match=msg):
             self.cf.set_option("a", "ab")
 
+        msg = r"Value must be an instance of <class 'NoneType'>\|<class 'int'>"
+        with pytest.raises(ValueError, match=msg):
+            self.cf.register_option(
+                "a.b.c.d3", "NO", "doc", validator=self.cf.is_pos_int
+            )
+
+        msg = "int values must be positive for this option"
+        with pytest.raises(ValueError, match=msg):
+            self.cf.register_option("a.b.c.d3", -2, "doc", validator=self.cf.is_pos_int)
+
         msg = r"Value must be an instance of <class 'str'>\|<class 'bytes'>"
         with pytest.raises(ValueError, match=msg):
             self.cf.set_option("b.c", 1)