diff --git a/lib/iris/__init__.py b/lib/iris/__init__.py index b944f9b22f..70dcaa60de 100644 --- a/lib/iris/__init__.py +++ b/lib/iris/__init__.py @@ -140,7 +140,7 @@ def callback(cube, field, filename): class Future(threading.local): """Run-time configuration controller.""" - def __init__(self, datum_support=False): + def __init__(self, datum_support=False, pandas_ndim=False): """ A container for run-time options controls. @@ -157,6 +157,12 @@ def __init__(self, datum_support=False): iris.FUTURE.example_future_flag does not exist. It is provided as an example. + .. todo:: + + Document the ``pandas_ndim`` flag once iris#4669 is merged - can + add cross-referencing documentation both here and in + iris.pandas.as_dataframe(). + """ # The flag 'example_future_flag' is provided as a reference for the # structure of this class. @@ -166,13 +172,14 @@ def __init__(self, datum_support=False): # # self.__dict__['example_future_flag'] = example_future_flag self.__dict__["datum_support"] = datum_support + self.__dict__["pandas_ndim"] = pandas_ndim def __repr__(self): # msg = ('Future(example_future_flag={})') # return msg.format(self.example_future_flag) - msg = "Future(datum_support={})" - return msg.format(self.datum_support) + msg = "Future(datum_support={}, pandas_ndim={})" + return msg.format(self.datum_support, self.pandas_ndim) # deprecated_options = {'example_future_flag': 'warning',} deprecated_options = {}