Skip to content

POC: make core.config self-contained #25176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
50 changes: 36 additions & 14 deletions pandas/core/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,10 @@
import re
import warnings

import pandas.compat as compat
from pandas.compat import lmap, map, u
try:
unicode
except NameError:
unicode = str

DeprecatedOption = namedtuple('DeprecatedOption', 'key msg rkey removal_ver')
RegisteredOption = namedtuple('RegisteredOption',
Expand Down Expand Up @@ -140,7 +142,7 @@ def _describe_option(pat='', _print_desc=True):
if len(keys) == 0:
raise OptionError('No such keys(s)')

s = u('')
s = u''
for k in keys: # filter by pat
s += _build_option_description(k)

Expand Down Expand Up @@ -634,22 +636,22 @@ def _build_option_description(k):
o = _get_registered_option(k)
d = _get_deprecated_option(k)

s = u('{k} ').format(k=k)
s = u'{k} '.format(k=k)

if o.doc:
s += '\n'.join(o.doc.strip().split('\n'))
else:
s += 'No description available.'

if o:
s += (u('\n [default: {default}] [currently: {current}]')
s += (u'\n [default: {default}] [currently: {current}]'
.format(default=o.defval, current=_get_option(k, True)))

if d:
s += u('\n (Deprecated')
s += (u(', use `{rkey}` instead.')
s += u'\n (Deprecated'
s += (u', use `{rkey}` instead.'
.format(rkey=d.rkey if d.rkey else ''))
s += u(')')
s += u')'

s += '\n\n'
return s
Expand Down Expand Up @@ -736,10 +738,11 @@ def inner(key, *args, **kwds):
get_option = _get_option
register_option = _register_option


# -----------------------------------------------------------------------
# These factories and methods are handy for use as the validator
# arg in register_option


def is_type_factory(_type):
"""

Expand Down Expand Up @@ -777,8 +780,7 @@ def is_instance_factory(_type):
"""
if isinstance(_type, (tuple, list)):
_type = tuple(_type)
from pandas.io.formats.printing import pprint_thing
type_repr = "|".join(map(pprint_thing, _type))
type_repr = "|".join(map(str, _type))
else:
type_repr = "'{typ}'".format(typ=_type)

Expand All @@ -796,11 +798,11 @@ def is_one_of_factory(legal_values):
legal_values = [c for c in legal_values if not callable(c)]

def inner(x):
from pandas.io.formats.printing import pprint_thing as pp
if x not in legal_values:

if not any(c(x) for c in callables):
pp_values = pp("|".join(lmap(pp, legal_values)))
uvals = [str(lval) for lval in legal_values]
pp_values = "|".join(uvals)
msg = "Value must be one of {pp_values}"
if len(callables):
msg += " or a callable"
Expand All @@ -815,7 +817,7 @@ def inner(x):
is_bool = is_type_factory(bool)
is_float = is_type_factory(float)
is_str = is_type_factory(str)
is_unicode = is_type_factory(compat.text_type)
is_unicode = is_type_factory(unicode)
is_text = is_instance_factory((str, bytes))


Expand All @@ -835,3 +837,23 @@ def is_callable(obj):
if not callable(obj):
raise ValueError("Value must be a callable")
return True

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are you moving this? this defeats the entire purpose of config_init

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The goal is to move config out of core (either to another dependency-free directory in pandas or something external like @topper-123's repo) and make it explicitly "upstream" from _libs. That way we get a much cleaner dependency structure by avoiding runtime imports inside _libs.


# -----------------------------------------------------------------------
# Options needed in _libs

pc_date_dayfirst_doc = """
: boolean
When True, prints and parses dates with the day first, eg 20/01/2005
"""

pc_date_yearfirst_doc = """
: boolean
When True, prints and parses dates with the year first, eg 2005/01/20
"""

with config_prefix('display'):
register_option('date_dayfirst', False, pc_date_dayfirst_doc,
validator=is_bool)
register_option('date_yearfirst', False, pc_date_yearfirst_doc,
validator=is_bool)
14 changes: 0 additions & 14 deletions pandas/core/config_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,16 +110,6 @@ def use_numexpr_cb(key):
pandas objects (if it is available).
"""

pc_date_dayfirst_doc = """
: boolean
When True, prints and parses dates with the day first, eg 20/01/2005
"""

pc_date_yearfirst_doc = """
: boolean
When True, prints and parses dates with the year first, eg 2005/01/20
"""

pc_pprint_nest_depth = """
: int
Controls the number of nested levels to process when pretty-printing
Expand Down Expand Up @@ -331,10 +321,6 @@ def table_schema_cb(key):
validator=is_text)
cf.register_option('notebook_repr_html', True, pc_nb_repr_h_doc,
validator=is_bool)
cf.register_option('date_dayfirst', False, pc_date_dayfirst_doc,
validator=is_bool)
cf.register_option('date_yearfirst', False, pc_date_yearfirst_doc,
validator=is_bool)
cf.register_option('pprint_nest_depth', 3, pc_pprint_nest_depth,
validator=is_int)
cf.register_option('multi_sparse', True, pc_multi_sparse_doc,
Expand Down