9 f&dZddlZddlZddlmZddlmZddlmZddl m Z ej dZ eGdd ej ZGd d ejZd Zd ZdZGddeZGddeZGddeZGddeZGddeZGddeZGddeZgdZdS)a 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. 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_-]*$c0eZdZdZdZdZdfd ZxZS)MagicHelpFormatterz@A HelpFormatter with a couple of changes to meet our needs. c`tj|t|||SN)argparseRawDescriptionHelpFormatter _fill_textr)selftextwidthindents R/var/www/equiseq/venv/lib/python3.11/site-packages/IPython/core/magic_arguments.pyrzMagicHelpFormatter._fill_textes'3>>tVD\\SXZ`aaac|js(|||jd\}|Sg}|jdkr||jnr|j}|||}t|sd|z}|jD]}| |d|d |S)Nrz<%s> z, ) option_strings_metavar_formatterdestnargsextendupper _format_argsNAME_REmatchappendjoin)ractionmetavarpartsdefault args_string option_strings r_format_action_invocationz,MagicHelpFormatter._format_action_invocationis$ $Ct..vv{CCAFFHGNE|q   V23333 !+++--"//@@ }}[117"(;"6K%+%:IIMLLMMM;;!GHHHH99U## #r:: %c^tt|||||dSr )superr add_usage)rusageactionsgroupsprefix __class__s rr-zMagicHelpFormatter.add_usages.  $''11%&&QQQQQr)r*)__name__ __module__ __qualname____doc__rr)r- __classcell__r2s@rr r `srbbb$$$:RRRRRRRRRRrr c DeZdZdZdddddeddddf fd ZdZdZxZS) MagicArgumentParserz: An ArgumentParser tweaked for use by IPython magics. N-errorFc t|g}tt|||||||||| |  dS)N) progr. descriptionepilogparentsformatter_class prefix_charsargument_defaultconflict_handleradd_help)r,r:__init__) rr>r.r?r@rArBrCrDrErFr2s rrGzMagicArgumentParser.__init__s_ ?G !4((11t5#F_%8H- 2 B B B B Brc t|)z5 Raise a catchable error instead of exiting. r)rmessages rr<zMagicArgumentParser.errors!!!rcJt|}||S)zL Split a string into an argument list and parse that argument list. )r parse_args)r argstringargvs rparse_argstringz#MagicArgumentParser.parse_argstrings###t$$$r) r3r4r5r6r rGr<rNr7r8s@rr:r:s!!3!"&")BBBBBB&""" %%%%%%%rr:c t|di}d|vrt|dd|d<t|}t|fi|}d}|jdddD]}|||}||}||_|S)zB Construct an argument parser using the function decorations. argcmd_kwdsr?r6N)getattr real_namer: decorators add_to_parser format_helpr6) magic_funckwdsarg_nameparsergroupdecoresults rconstruct_parserr^s :}b 1 1DD  %j)TBB]$$H  2 2T 2 2F E%ddd+##FE22  E ++--J Mrc6|j|S)zA Parse the string of arguments for the given magic function. )rZrN)rWrLs rrNrNs   , ,Y 7 77rc|j}|dr|tdd}t|d|S)z& Find the real name of the magic. magic_N argcmd_name)r3 startswithlenrR)rW magic_names rrSrSsH$JX&&0H / :}j 9 99rceZdZdZdZdZdS) ArgDecoratorzN Base class for decorators to add ArgumentParser information to a method. cxt|ddsd|_g|_|j||SN has_argumentsFT)rRrjrTr!rfuncs r__call__zArgDecorator.__call__s@t_e44 !!%D  DO t$$$ rcdS)zD Add this object's information to the parser, if necessary. NrrZr[s rrUzArgDecorator.add_to_parsers  rN)r3r4r5r6rmrUrorrrgrgs<     rrgc eZdZdZddZdZdS)magic_argumentszS Mark the magic as having argparse arguments and possibly adjust the name. Nc||_dSr )name)rrts rrGzmagic_arguments.__init__  rct|ddsd|_g|_|j |j|_t ||_|Sri)rRrjrTrtrbr^rZrks rrmzmagic_arguments.__call__sMt_e44 !!%D  DO 9 #yD 't,,  rr )r3r4r5r6rGrmrorrrrrrsA     rrrc*eZdZUdZeed<dZdZdS)ArgMethodWrapperz Base class to define a wrapper for ArgumentParser method. Child class must define either `_method_name` or `add_to_parser`. _method_namec"||_||_dSr )argsrX)rr{rXs rrGzArgMethodWrapper.__init__s  rcX||}t||j|ji|jdS)6 Add this object's information to the parser. N)rRryr{rXrps rrUzArgMethodWrapper.add_to_parsers:  F*)**DICCCCtrN)r3r4r5r6str__annotations__rGrUrorrrxrxsLrrxceZdZdZdZdS)argumentzt Store arguments and keywords to pass to add_argument(). Instances also serve to decorate command methods. add_argumentNr3r4r5r6ryrorrrr "LLLrrceZdZdZdZdS)defaultszt Store arguments and keywords to pass to set_defaults(). Instances also serve to decorate command methods. set_defaultsNrrorrrrrrrceZdZdZdZdS)argument_groupzz Store arguments and keywords to pass to add_argument_group(). Instances also serve to decorate command methods. c0|j|ji|jS)r})add_argument_groupr{rXrps rrUzargument_group.add_to_parser#s )v($)AtyAAArN)r3r4r5r6rUrorrrrs2 BBBBBrrc(eZdZdZdZfdZxZS)rXz; Provide other keywords to the sub-parser constructor. c ||_dSr )rX)rrXs rrGz kwds.__init__,rurcptt||}|j|_|Sr )r,rXrmrP)rrlr2s rrmz kwds.__call__/s/T4  ))$//9 r)r3r4r5r6rGrmr7r8s@rrXrX)sQrrX)rrrrrXrN)r6r reIPython.core.errorrIPython.utils.decoratorsrIPython.utils.processrIPython.utils.textrcompilerr r ArgumentParserr:r^rNrSobjectrgrrrxrrrrX__all__rorrrscLLh *)))))******++++++%%%%%% "*/ 0 0&R&R&R&R&R=&R&R&RP%%%%%(1%%%D,888 :::     6   "l(|0"""""""""""""""" B B B B B% B B B     <      r