+ ^|iq&Rt^RIt^RIt^RIHt^RIHt^RIHt^RI H t ]P!R4t ]!RR]P44t!R R ]P4tR tR R /RltRt!RR4t!RR]4t!RR]4t!RR]4t!RR]4t!RR]4t!RR]4t.ROtR#)aA 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. Here is an elaborated example that uses default parameters in `argument` and calls the `args` in the cell magic:: from IPython.core.magic import register_cell_magic from IPython.core.magic_arguments import (argument, magic_arguments, parse_argstring) @magic_arguments() @argument( "--option", "-o", help=("Add an option here"), ) @argument( "--style", "-s", default="foo", help=("Add some style arguments"), ) @register_cell_magic def my_cell_magic(line, cell): args = parse_argstring(my_cell_magic, line) print(f"{args.option=}") print(f"{args.style=}") print(f"{cell=}") In a jupyter notebook, this cell magic can be executed like this:: %%my_cell_magic -o Hello print("bar") i = 42 Inheritance diagram: .. inheritance-diagram:: IPython.core.magic_arguments :parts: 3 N UsageError)undoc) arg_split)dedentz[a-zA-Z][a-zA-Z0-9_-]*$cFaa]tRt^`toRtRtRtRV3RlltRtVt V;t #)MagicHelpFormatterz@A HelpFormatter with a couple of changes to meet our needs. cV\PPV\V4W#4#N)argparseRawDescriptionHelpFormatter _fill_textr)selftextwidthindents&&&&>/usr/lib/python3/dist-packages/IPython/core/magic_arguments.pyr MagicHelpFormatter._fill_textes"33>>tVD\SXaacVP'g&VPWP4!^4wpV#.pVP^8XdVP VP4MzVPP 4pVP W4p\PV4'g RV,pVPFpVPV: RV: 24K RPV4#)z<%s> z, ) option_strings_metavar_formatterdestnargsextendupper _format_argsNAME_REmatchappendjoin)ractionmetavarpartsdefault args_string option_strings&& r_format_action_invocation,MagicHelpFormatter._format_action_invocationis$$$..v{{CAFHGNE||q  V223 !++++-"//@ }}[11"(;"6K%+%:%:MLLM;!GH&;99U# #rc0<\\V` WW44R#r )superr add_usage)rusageactionsgroupsprefix __class__s&&&&&rr-MagicHelpFormatter.add_usages  $1%&Qr)z:: %) __name__ __module__ __qualname____firstlineno____doc__r r)r-__static_attributes____classdictcell__ __classcell__r2 __classdict__s@@rrr`s!b$:RRrrc baa]tRt^toRtRRRRR]RRRR3 V3RlltRtRR/R ltR t Vt V;t #) MagicArgumentParserz9An ArgumentParser tweaked for use by IPython magics. N-errorFc D<Vf.p\\V` WW4WVWxWR7 R#)N) progr. descriptionepilogparentsformatter_class prefix_charsargument_defaultconflict_handleradd_help)r,r@__init__) rrDr.rErFrGrHrIrJrKrLr2s &&&&&&&&&&&rrMMagicArgumentParser.__init__s3 ?G !41t#%- 2 Brc \V4h)z4Raise a catchable error instead of exiting. r)rmessages&&rrBMagicArgumentParser.errors!!rpartialc x\W'*R7pV'dVPV4#VPV4#)zKSplit a string into an argument list and parse that argument list. )strict)rparse_known_args parse_args)r argstringrRargvs&&$ rparse_argstring#MagicArgumentParser.parse_argstrings3;7 ((. .t$$rr4) r5r6r7r8r9rrMrBrYr:r;r<r=s@@rr@r@sF!!3!"&")B&" %E%%rr@c\VR/4pRV9d\VRR4VR&\V4p\V3/VBpRpVPRRR1,FpVP W44pVfKTpK VP 4VnV#)zAConstruct an argument parser using the function decorations. argcmd_kwdsrEr9N)getattr real_namer@ decorators add_to_parser format_helpr9) magic_funckwdsarg_nameparsergroupdecoresults& rconstruct_parserrjs :}b 1DD %j)TB]$H  2T 2F E%%dd++##F2  E,  ++-J MrrRFc:VPPWR7#)z@Parse the string of arguments for the given magic function. )rR)rfrY)rcrWrRs&&$rrYrYs    , ,Y , HHrc~VPpVPR4'dV\R4Rp\VRV4#)z%Find the real name of the magic. magic_N argcmd_name)r5 startswithlenr^)rc magic_names& rr_r_s?$$JX&&H / :}j 99rc0a]tRt^toRtRtRtRtVtR#) ArgDecoratorzMBase class for decorators to add ArgumentParser information to a method. c~\VRR4'gRVn.VnVPPV4V# has_argumentsFT)r^rvr`r!rfuncs&&r__call__ArgDecorator.__call__s7t_e44!%D  DO t$ rc R#)zCAdd this object's information to the parser, if necessary. Nr4rrfrgs&&&rraArgDecorator.add_to_parsers rr4N) r5r6r7r8r9ryrar:r;r>s@rrsrss  rrsc4a]tRt^toRtRRltRtRtVtR#)magic_argumentszJMark the magic as having argparse arguments and possibly adjust the name. NcWnR#r name)rrs&&rrMmagic_arguments.__init__ rc\VRR4'gRVn.VnVPeVPVn\ V4VnV#ru)r^rvr`rrnrjrfrws&&rrymagic_arguments.__call__sIt_e44!%D  DO 99 #yyD 't,  rrr ) r5r6r7r8r9rMryr:r;r~s@rrrs  rrc<a]tRt^toRtRtRtV3RltRtVt R#)ArgMethodWrapperz Base class to define a wrapper for ArgumentParser method. Child class must define either `_method_name` or `add_to_parser`. cWnW nR#r argsrd)rrrds&*,rrMArgMethodWrapper.__init__s   rc pVeTp\WP4!VP/VPBR#)5Add this object's information to the parser. N)r^ _method_namerrdr|s&&&rraArgMethodWrapper.add_to_parsers2  F))*DIICCrc&<V^8dQh/S[;R&#)r)str)formatr>s"r __annotate__ArgMethodWrapper.__annotate__srrN) r5r6r7r8r9rMra__annotate_func__r:r;r~s@rrrsrrc]tRtRtRtRtRtR#)argumentizkStore arguments and keywords to pass to add_argument(). Instances also serve to decorate command methods. add_argumentr4Nr5r6r7r8r9rr:r4rrrr"Lrrc]tRtRtRtRtRtR#)defaultsizkStore arguments and keywords to pass to set_defaults(). Instances also serve to decorate command methods. set_defaultsr4Nrr4rrrrrrrc*a]tRtRtoRtRtRtVtR#)argument_groupizqStore arguments and keywords to pass to add_argument_group(). Instances also serve to decorate command methods. c NVP!VP/VPB#)r)add_argument_grouprrdr|s&&&rraargument_group.add_to_parser%s"(($))AtyyAArr4N)r5r6r7r8r9rar:r;r~s@rrrs BBrrc<aa]tRtRtoRtRtV3RltRtVtV;t #)rdi+z:Provide other keywords to the sub-parser constructor. c WnR#r rd)rrds&,rrM kwds.__init__.rrcP<\\V` V4pVPVnV#r )r,rdryr\)rrxr2s&&rry kwds.__call__1s%T4)$/99 rr) r5r6r7r8r9rMryr:r;r<r=s@@rrdrd+srrd)rrrrdrY)r9r reIPython.core.errorrIPython.utils.decoratorsrIPython.utils.processrIPython.utils.textrcompilerr rArgumentParserr@rjrYr_rsrrrrrrd__all__r4rrrsLh **+% **/ 0&R==&R&RP!%(11!%H,IeI :  "l(|0"""" B% B <  r