ó æNXc@ssdZddlZddlZddlmZddlmZddlmZddl m Z ej dƒZ edej fd „ƒYƒZd ejfd „ƒYZd „Zd „Zd„Zdefd„ƒYZdefd„ƒYZdefd„ƒYZdefd„ƒYZdefd„ƒYZdefd„ƒYZdefd„ƒYZdddddgZdS(sM A decorator-based method of constructing IPython magics with `argparse` option handling. New magic functions can be defined like so:: from IPython.core.magic_arguments import (argument, magic_arguments, parse_argstring) @magic_arguments() @argument('-o', '--option', help='An optional argument.') @argument('arg', type=int, help='An integer positional argument.') def magic_cool(self, arg): """ A really cool magic command. """ args = parse_argstring(magic_cool, arg) ... The `@magic_arguments` decorator marks the function as having argparse arguments. The `@argument` decorator adds an argument using the same syntax as argparse's `add_argument()` method. More sophisticated uses may also require the `@argument_group` or `@kwds` decorator to customize the formatting and the parsing. Help text for the magic is automatically generated from the docstring and the arguments:: In[1]: %cool? %cool [-o OPTION] arg A really cool magic command. positional arguments: arg An integer positional argument. optional arguments: -o OPTION, --option OPTION An optional argument. Inheritance diagram: .. inheritance-diagram:: IPython.core.magic_arguments :parts: 3 iÿÿÿÿN(t UsageError(tundoc(t arg_split(tdedents[a-zA-Z][a-zA-Z0-9_-]*$tMagicHelpFormattercBs,eZdZd„Zd„Zdd„ZRS(s@A HelpFormatter with a couple of changes to meet our needs. cCstjj|t|ƒ||ƒS(N(targparsetRawDescriptionHelpFormattert _fill_textR(tselfttexttwidthtindent((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyREscCsÌ|js+|j||jƒdƒ\}|Sg}|jdkrS|j|jƒnh|jjƒ}|j||ƒ}tj|ƒsd|}nx(|jD]}|j d||fƒqšWdj |ƒSdS(Niis<%s>s%s %ss, ( toption_stringst_metavar_formattertdesttnargstextendtuppert _format_argstNAME_REtmatchtappendtjoin(Rtactiontmetavartpartstdefaultt args_stringt option_string((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyt_format_action_invocationIs  s:: %cCs#tt|ƒj||||ƒdS(N(tsuperRt add_usage(Rtusagetactionstgroupstprefix((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRfs(t__name__t __module__t__doc__RRR(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR@s  tMagicArgumentParserc BsGeZdZdddddeddded„ Zd„Zd„ZRS(s: An ArgumentParser tweaked for use by IPython magics. t-terrorc Csh|dkrg}ntt|ƒjd|d|d|d|d|d|d|d|d | d | ƒ dS( NtprogR t descriptiontepilogtparentstformatter_classt prefix_charstargument_defaulttconflict_handlertadd_help(tNoneRR't__init__( RR*R R+R,R-R.R/R0R1R2((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR4ls     cCst|ƒ‚dS(s5 Raise a catchable error instead of exiting. N(R(Rtmessage((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR)scCst|ƒ}|j|ƒS(sL Split a string into an argument list and parse that argument list. (Rt parse_args(Rt argstringtargv((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pytparse_argstring„s N( R$R%R&R3RtFalseR4R)R9(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR'is cCs³t|diƒ}d|kr7t|ddƒ|dR(Rtfunc((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyt__call__´s   cCsdS(sD Add this object's information to the parser, if necessary. N((RRDRE((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR?»s(R$R%R&RRR?(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRN°s tmagic_argumentscBs#eZdZdd„Zd„ZRS(sS Mark the magic as having argparse arguments and possibly adjust the name. cCs ||_dS(N(tname(RRT((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR4ÆscCsXt|dtƒs't|_g|_n|jdk rE|j|_nt|ƒ|_ |S(NRO( R<R:RPROR>RTR3RJRHRD(RRQ((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRRÉs  N(R$R%R&R3R4RR(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRSÁs tArgMethodWrappercBs&eZdZdZd„Zd„ZRS(s‹ Base class to define a wrapper for ArgumentParser method. Child class must define either `_method_name` or `add_to_parser`. cOs||_||_dS(N(targsRB(RRVRB((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR4às cCs8|dk r|}nt||jƒ|j|jŽdS(s6 Add this object's information to the parser. N(R3R<t _method_nameRVRB(RRDRE((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR?äs  N(R$R%R&R3RWR4R?(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRUÕs targumentcBseZdZdZRS(st Store arguments and keywords to pass to add_argument(). Instances also serve to decorate command methods. t add_argument(R$R%R&RW(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRXístdefaultscBseZdZdZRS(st Store arguments and keywords to pass to set_defaults(). Instances also serve to decorate command methods. t set_defaults(R$R%R&RW(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRZõstargument_groupcBseZdZd„ZRS(sz Store arguments and keywords to pass to add_argument_group(). Instances also serve to decorate command methods. cCs|j|j|jŽS(s6 Add this object's information to the parser. (tadd_argument_groupRVRB(RRDRE((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR?s(R$R%R&R?(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR\ýsRBcBs eZdZd„Zd„ZRS(s; Provide other keywords to the sub-parser constructor. cKs ||_dS(N(RB(RRB((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyR4 scCs(tt|ƒj|ƒ}|j|_|S(N(RRBRRR;(RRQ((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRRs (R$R%R&R4RR(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyRB s R9(R&RtretIPython.core.errorRtIPython.utils.decoratorsRtIPython.utils.processRtIPython.utils.textRtcompileRRRtArgumentParserR'RHR9R=tobjectRNRSRURXRZR\RBt__all__(((sT/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magic_arguments.pyt-s,  ("