ó šxŠ\c@s¢dZddlmZddlmZddlZddlZddljZddlm Z m Z m Z eddƒZ edd ƒZ iZiZiZd gZd eefd „ƒYZd „Zed„Zd„Zded„Zed„Zd„Zdefd„ƒYZdefd„ƒYZdZ dZ!dZ"dZ#eee ƒa$eee!ƒa%eee#ƒa&eee"ƒZ'eeƒZ(defd„ƒYZ)dddd„a+dddd„Z,d „Z-d!„Z.d"„Z/d#„Z0d$„Z1d%„Z2d&„Z3d'„Z4d(ed)„Z5ed*„ƒZ6d+„Z7d,„Z8d-„Z9e7e:ƒZ;e7e<ƒZ=e7e>ƒZ?e7e@ƒZAe7ejBƒZCe8e@eDfƒZEd.„ZFdS(/sò The config module holds package-wide configurables and provides a uniform API for working with them. Overview ======== This module supports the following requirements: - options are referenced using keys in dot.notation, e.g. "x.y.option - z". - keys are case-insensitive. - functions should accept partial/regex keys, when unambiguous. - options can be registered by modules at import time. - options can be registered at init-time (via core.config_init) - options have a default value, and (optionally) a description and validation function associated with them. - options can be deprecated, in which case referencing them should produce a warning. - deprecated options can optionally be rerouted to a replacement so that accessing a deprecated option reroutes to a differently named option. - options can be reset to their default value. - all option can be reset to their default value at once. - all options in a certain sub - namespace can be reset at once. - the user can set / get / reset or ask for the description of an option. - a developer can register and mark an option as deprecated. - you can register a callback to be invoked when the option value is set or reset. Changing the stored value is considered misuse, but is not verboten. Implementation ============== - Data is stored using nested dictionaries, and should be accessed through the provided API. - "Registered options" and "Deprecated options" have metadata associated with them, which are stored in auxiliary dictionaries keyed on the fully-qualified key, e.g. "x.y.z.option". - the config_init module is imported by the package's __init__.py file. placing any register_option() calls there will ensure those options are available as soon as pandas is loaded. If you use register_option in a module, it will only be available after that module is imported, which you should be aware of. - `config_prefix` is a context_manager (for use with the `with` keyword) which can save developers some typing, see the docstring. iÿÿÿÿ(t namedtuple(tcontextmanagerN(tlmaptmaptutDeprecatedOptionskey msg rkey removal_vertRegisteredOptionskey defval doc validator cbtallt OptionErrorcBseZdZRS(sPException for pandas.options, backwards compatible with KeyError checks (t__name__t __module__t__doc__(((s1lib/python2.7/site-packages/pandas/core/config.pyREscCsšt|ƒ}t|ƒdkrL|s1t|ƒntdjd|ƒƒ‚nt|ƒdkrmtdƒ‚n|d}|sŠt|ƒnt|ƒ}|S(NisNo such keys(s): {pat!r}tpatisPattern matched multiple keys(t_select_optionstlent_warn_if_deprecatedRtformatt_translate_key(R tsilenttkeystkey((s1lib/python2.7/site-packages/pandas/core/config.pyt_get_single_keyNs     cCs)t||ƒ}t|ƒ\}}||S(N(Rt _get_root(R RRtroottk((s1lib/python2.7/site-packages/pandas/core/config.pyt _get_option`sc OsTt|ƒ}| s#|ddkr2tdƒ‚n|jdtƒ}|rxd}t|jt|jƒƒdƒƒ‚nxÕt|ddd…|ddd…ƒD]ª\}}t ||ƒ}t |ƒ}|rè|j rè|j |ƒnt |ƒ\} }|| |<|j r¢|r<tjdtƒ|j |ƒWdQXqL|j |ƒq¢q¢WdS(Niis4Must provide an even number of non-keyword argumentsRs:_set_option() got an unexpected keyword argument "{kwarg}"itrecord(Rt ValueErrortpoptFalset TypeErrorRtlistRtzipRt_get_registered_optiont validatorRtcbtwarningstcatch_warningstTrue( targstkwargstnargsRtmsgRtvRtoR((s1lib/python2.7/site-packages/pandas/core/config.pyt _set_optionhs& (6   tcCspt|ƒ}t|ƒdkr-tdƒ‚ntdƒ}x|D]}|t|ƒ7}q@W|rh|GHn|SdS(NisNo such keys(s)R.(R RRRt_build_option_description(R t _print_descRtsR((s1lib/python2.7/site-packages/pandas/core/config.pyt_describe_option‰s   cCs›t|ƒ}t|ƒdkr-tdƒ‚nt|ƒdkrlt|ƒdkrl|dkrltdƒ‚nx(|D] }t|t|jd|ƒqsWdS(NisNo such keys(s)iiRs’You must specify at least 4 characters when resetting multiple keys, use the special keyword "all" to reset all the options to their default valueR(R RRRR-t_registered_optionstdefval(R RRR((s1lib/python2.7/site-packages/pandas/core/config.pyt _reset_option™s 0 cCst|dtƒ}t|ƒjS(NR(RR&R!R4(R R((s1lib/python2.7/site-packages/pandas/core/config.pytget_default_valªst DictWrappercBs5eZdZdd„Zd„Zd„Zd„ZRS(s0 provide attribute-style access to a nested dictR.cCs*tj|d|ƒtj|d|ƒdS(Ntdtprefix(tobjectt __setattr__(tselfR8R9((s1lib/python2.7/site-packages/pandas/core/config.pyt__init__²scCsutj|dƒ}|r%|d7}n||7}||jkret|j|tƒ ret||ƒn tdƒ‚dS(NR9t.s.You can only set the value of existing options(R:t__getattribute__R8t isinstancetdictR-R(R<RtvalR9((s1lib/python2.7/site-packages/pandas/core/config.pyR;¶s  &cCs“tj|dƒ}|r%|d7}n||7}ytj|dƒ|}Wntk rhtdƒ‚nXt|tƒr…t||ƒSt|ƒSdS(NR9R>R8sNo such option(R:R?tKeyErrorRR@RAR7R(R<RR9R+((s1lib/python2.7/site-packages/pandas/core/config.pyt __getattr__Âs    cCst|jjƒƒS(N(RR8R(R<((s1lib/python2.7/site-packages/pandas/core/config.pyt__dir__Ðs(R R R R=R;RDRE(((s1lib/python2.7/site-packages/pandas/core/config.pyR7¯s   tCallableDynamicDoccBs)eZd„Zd„Zed„ƒZRS(cCs||_||_dS(N(t __doc_tmpl__t__func__(R<tfunctdoc_tmpl((s1lib/python2.7/site-packages/pandas/core/config.pyR=Þs cOs|j||ŽS(N(RH(R<R'tkwds((s1lib/python2.7/site-packages/pandas/core/config.pyt__call__âscCsCtddtƒ}tttjƒƒƒ}|jjd|d|ƒS(NRR0t opts_desct opts_list(R2Rtpp_options_listRR3RRGR(R<RMRN((s1lib/python2.7/site-packages/pandas/core/config.pyR ås(R R R=RLtpropertyR (((s1lib/python2.7/site-packages/pandas/core/config.pyRFÜs  s; get_option(pat) Retrieves the value of the specified option. Available options: {opts_list} Parameters ---------- pat : str Regexp which should match a single option. Note: partial matches are supported for convenience, but unless you use the full option name (e.g. x.y.z.option_name), your code may break in future versions if new options with similar names are introduced. Returns ------- result : the value of the option Raises ------ OptionError : if no such option exists Notes ----- The available options with its descriptions: {opts_desc} s@ set_option(pat, value) Sets the value of the specified option. Available options: {opts_list} Parameters ---------- pat : str Regexp which should match a single option. Note: partial matches are supported for convenience, but unless you use the full option name (e.g. x.y.z.option_name), your code may break in future versions if new options with similar names are introduced. value : new value of option. Returns ------- None Raises ------ OptionError if no such option exists Notes ----- The available options with its descriptions: {opts_desc} s¡ describe_option(pat, _print_desc=False) Prints the description for one or more registered options. Call with not arguments to get a listing for all registered options. Available options: {opts_list} Parameters ---------- pat : str Regexp pattern. All matching keys will have their description displayed. _print_desc : bool, default True If True (default) the description(s) will be printed to stdout. Otherwise, the description(s) will be returned as a unicode string (for testing). Returns ------- None by default, the description(s) as a unicode string if _print_desc is False Notes ----- The available options with its descriptions: {opts_desc} s5 reset_option(pat) Reset one or more options to their default value. Pass "all" as argument to reset all options. Available options: {opts_list} Parameters ---------- pat : str/regex If specified only options matching `prefix*` will be reset. Note: partial matches are supported for convenience, but unless you use the full option name (e.g. x.y.z.option_name), your code may break in future versions if new options with similar names are introduced. Returns ------- None Notes ----- The available options with its descriptions: {opts_desc} toption_contextcBs)eZdZd„Zd„Zd„ZRS(s Context manager to temporarily set options in the `with` statement context. You need to invoke as ``option_context(pat, val, [(pat, val), ...])``. Examples -------- >>> with option_context('display.max_rows', 10, 'display.max_columns', 5): ... ... cGsmt|ƒddko%t|ƒdks7tdƒ‚ntt|ddd…|ddd…ƒƒ|_dS(Niis>Need to invoke as option_context(pat, val, [(pat, val), ...]).i(RRRR tops(R<R'((s1lib/python2.7/site-packages/pandas/core/config.pyR=†s(cCshg|jD]$\}}|t|dtƒf^q |_x*|jD]\}}t||dtƒqAWdS(NR(RRRR&tundoR-(R<R RB((s1lib/python2.7/site-packages/pandas/core/config.pyt __enter__s4cGs=|jr9x-|jD]\}}t||dtƒqWndS(NR(RSR-R&(R<R'R RB((s1lib/python2.7/site-packages/pandas/core/config.pyt__exit__”s (R R R R=RTRU(((s1lib/python2.7/site-packages/pandas/core/config.pyRQys   c Csddl}ddl}|jƒ}|tkrQd}t|jd|ƒƒ‚n|tkr~d}t|jd|ƒƒ‚n|r‘||ƒn|jdƒ}xv|D]n} tt j d|j d| ƒƒsët d jd | ƒƒ‚n|j | ƒr§t d jd | ƒƒ‚q§q§Wt} d }xxt|d ƒD]f\} } t| tƒsyt|jd dj|| ƒƒƒ‚n| | kr’i| | t^t$s{k} is not a valid identifierRs{k} is a python keywords5Path prefix to option '{option}' is already an optiontoptionR4tdocR"R#(ttokenizetkeywordtlowerR3RRt_reserved_keystsplittbooltretmatchtNameRt iskeywordt_global_configt enumerateR@RAtjoinR( RR4RYR"R#RZR[R*tpathRtcursortitp((s1lib/python2.7/site-packages/pandas/core/config.pytregister_optionšs>       #(  ( cCsV|jƒ}|tkr9d}t|jd|ƒƒ‚nt||||ƒt|iÿÿÿÿ(R^Rd(RRgRhRj((s1lib/python2.7/site-packages/pandas/core/config.pyR"s cCs|jƒ}|tkS(s6 Returns True if the given option has been deprecated (R\Rl(R((s1lib/python2.7/site-packages/pandas/core/config.pyt_is_deprecated*s cCs+yt|}Wntk r"dSX|SdS(s± Retrieves the metadata for a deprecated option, if `key` is deprecated. Returns ------- DeprecatedOption (namedtuple) if key is deprecated, None otherwise N(RlRCtNone(RR8((s1lib/python2.7/site-packages/pandas/core/config.pyt_get_deprecated_option1s  cCs tj|ƒS(s¨ Retrieves the option metadata if `key` is a registered option. Returns ------- RegisteredOption (namedtuple) if key is deprecated, None otherwise (R3tget(R((s1lib/python2.7/site-packages/pandas/core/config.pyR!BscCs't|ƒ}|r|jp|S|SdS(s‚ if key id deprecated and a replacement key defined, will return the replacement key, otherwise returns `key` as - is N(RuRm(RR8((s1lib/python2.7/site-packages/pandas/core/config.pyRMs  cCs·t|ƒ}|r³|jr9|jGHtj|jtƒnvdjd|ƒ}|jrp|djd|jƒ7}n|jr•|djd|jƒ7}n |d7}tj|tƒtSt S(sŸ Checks if `key` is a deprecated option and if so, prints a warning. Returns ------- bool - True if `key` is deprecated, False otherwise. s'{key}' is deprecatedRs! and will be removed in {version}tversions, please use '{rkey}' instead.Rms, please refrain from using it.( RuR*R$twarnt FutureWarningRRnRmR&R(RR8R*((s1lib/python2.7/site-packages/pandas/core/config.pyRZs      cCst|ƒ}t|ƒ}tdƒjd|ƒ}|jra|dj|jjƒjdƒƒ7}n |d7}|r¢|tdƒjd|jdt |t ƒƒ7}n|rù|tdƒ7}|td ƒjd |j rÜ|j nd ƒ7}|td ƒ7}n|d 7}|S(sE Builds a formatted description of a registered option and prints it s{k} Rs sNo description available.s0 [default: {default}] [currently: {current}]tdefaulttcurrents (Deprecateds, use `{rkey}` instead.RmR.t)s ( R!RuRRRYRftstripR^R4RR&Rm(RR,R8R1((s1lib/python2.7/site-packages/pandas/core/config.pyR/ws    (  iPc sDddlm‰ddlm}‡‡fd†}g}gt|ƒD]!}|jdƒdkrE|^qE}|rˆ||d|ƒ7}ng|D]!}|jdƒdkr|^q}xf|t|ƒd„ƒD]L\}} gt| ƒD]}|t|ƒd ^qè} |||| ƒ7}qÏWd j|ƒ} |r<| GHn| Sd S( sB Builds a concise listing of available options, grouped by prefix iÿÿÿÿ(twrap(tgroupbyc ss|rd|dnd}ˆdj|ƒˆd|dddtƒ}|ro|d ro|ro|d d |d iR.cSs||jdƒ S(NR>(trfind(tx((s1lib/python2.7/site-packages/pandas/core/config.pyt¦sis N( ttextwrapR~t itertoolsRRptfindRRRf( RRˆt_printRR‰R‡R‹tsinglesRtgR…R1((RˆR~s1lib/python2.7/site-packages/pandas/core/config.pyRO’s4.%-c#s`‡fd†}t}t}t}|tƒa|tƒa|tƒadV|a|a|adS(s°contextmanager for multiple invocations of API with a common prefix supported API functions: (register / get / set )__option Warning: This is not thread - safe, and won't work properly if you import the API functions into your module using the "from x import y" construct. Example: import pandas.core.config as cf with cf.config_prefix("display.font"): cf.register_option("color", "red") cf.register_option("size", " 5 pt") cf.set_option(size, " 6 pt") cf.get_option(size) ... etc' will register options "display.font.color", "display.font.size", set the value of "display.font.size"... and so on. cs‡‡fd†}|S(Ncs(djdˆd|ƒ}ˆ|||ŽS(Ns{prefix}.{key}R9R(R(RR'RKtpkey(RIR9(s1lib/python2.7/site-packages/pandas/core/config.pytinnerÒs((RIR”(R9(RIs1lib/python2.7/site-packages/pandas/core/config.pyR~ÑsN(Rkt get_optiont set_optionRt(R9R~t_register_optionRR-((R9s1lib/python2.7/site-packages/pandas/core/config.pyt config_prefix³s   cs‡fd†}|S(s Parameters ---------- `_type` - a type to be compared against (e.g. type(x) == `_type`) Returns ------- validator - a function of a single argument x , which raises ValueError if type(x) is not equal to `_type` cs7t|ƒˆkr3d}t|jdˆƒƒ‚ndS(NsValue must have type '{typ!s}'ttyp(ttypeRR(R‹R*(t_type(s1lib/python2.7/site-packages/pandas/core/config.pyR”õs((R›R”((R›s1lib/python2.7/site-packages/pandas/core/config.pytis_type_factoryçscsttˆttfƒrLtˆƒ‰ddlm}djt|ˆƒƒ‰ndjdˆƒ‰‡‡fd†}|S(sê Parameters ---------- `_type` - the type to be checked against Returns ------- validator - a function of a single argument x , which raises ValueError if x is not an instance of `_type` iÿÿÿÿ(t pprint_thingt|s'{typ}'R™cs4t|ˆƒs0d}t|jdˆƒƒ‚ndS(Ns(Value must be an instance of {type_repr}t type_repr(R@RR(R‹R*(R›RŸ(s1lib/python2.7/site-packages/pandas/core/config.pyR”s(R@ttupleRtpandas.io.formats.printingRRfRR(R›RR”((R›RŸs1lib/python2.7/site-packages/pandas/core/config.pytis_instance_factoryýs  cs`gˆD]}t|ƒr|^q‰gˆD]}t|ƒs,|^q,‰‡‡fd†}|S(Ncs—ddlm}ˆˆkr“t‡fd†ˆDƒƒs“|djt|ˆƒƒƒ}d}tˆƒru|d7}nt|jd|ƒƒ‚q“ndS(Niÿÿÿÿ(Rc3s|]}|ˆƒVqdS(N((t.0tc(R‹(s1lib/python2.7/site-packages/pandas/core/config.pys "sRžs Value must be one of {pp_values}s or a callablet pp_values(R¡RtanyRfRRRR(R‹R‰R¥R*(t callablest legal_values(R‹s1lib/python2.7/site-packages/pandas/core/config.pyR”s   (tcallable(R¨R¤R”((R§R¨s1lib/python2.7/site-packages/pandas/core/config.pytis_one_of_factorys%% cCst|ƒstdƒ‚ntS(s» Parameters ---------- `obj` - the object to be checked Returns ------- validator - returns True if object is callable raises ValueError otherwise. sValue must be a callable(R©RR&(tobj((s1lib/python2.7/site-packages/pandas/core/config.pyt is_callable6s (GR t collectionsRt contextlibRR`R$t pandas.compattcompatRRRRRRlR3RdR]tAttributeErrorRCRRRRR-R&R2R5R6R:R7RFt_get_option_tmplt_set_option_tmplt_describe_option_tmplt_reset_option_tmplR•R–t reset_optiontdescribe_optiontoptionsRQRtRkRoR RRsRuR!RRR/ROR˜RœR¢Rªtinttis_intR_tis_booltfloattis_floattstrtis_strt text_typet is_unicodetbytestis_textR¬(((s1lib/python2.7/site-packages/pandas/core/config.pyt1sl       !  -/"  !C3      !4