o h&@s dZddlZddlZddlmZddlmZddlmZddl m Z e dZ eGdd d ej ZGd d d ejZd d ZddZddZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZgd ZdS)!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_-]*$cs2eZdZdZddZddZd fdd ZZS) MagicHelpFormatterz@A HelpFormatter with a couple of changes to meet our needs. cCstj|t|||SN)argparseRawDescriptionHelpFormatter _fill_textr)selftextwidthindentrRc:\Users\shubh\Videos\agent\nova\Lib\site-packages\IPython/core/magic_arguments.pyr eszMagicHelpFormatter._fill_textcCs|js|||jd\}|Sg}|jdkr||jn#|j}|||}t|s1d|}|jD] }| d||fq4d |S)Nrz<%s>z%s %sz, ) option_stringsZ_metavar_formatterdestnargsextendupperZ _format_argsNAME_REmatchappendjoin)r actionmetavarpartsdefaultZ args_stringZ option_stringrrr_format_action_invocationis      z,MagicHelpFormatter._format_action_invocation:: %cstt|||||dSr)superr add_usage)r usageactionsgroupsprefix __class__rrr#szMagicHelpFormatter.add_usage)r!)__name__ __module__ __qualname____doc__r r r# __classcell__rrr(rr`s rc sFeZdZdZdddddeddddf fdd Zdd Zd d ZZS) MagicArgumentParserz: An ArgumentParser tweaked for use by IPython magics. N-errorFc s4|durg}tt|j||||||||| | d dS)N) progr$ descriptionepilogparentsformatter_class prefix_charsargument_defaultconflict_handleradd_help)r"r/__init__) r r2r$r3r4r5r6r7r8r9r:r(rrr;s  zMagicArgumentParser.__init__cCst|)z5 Raise a catchable error instead of exiting. r)r messagerrrr1szMagicArgumentParser.errorcCst|}||S)zL Split a string into an argument list and parse that argument list. )r parse_args)r argstringargvrrrparse_argstrings z#MagicArgumentParser.parse_argstring) r*r+r,r-rr;r1r@r.rrr(rr/sr/cCs|t|di}d|vrt|dd|d<t|}t|fi|}d}|jdddD]}|||}|dur6|}q(||_|S)zB Construct an argument parser using the function decorations. argcmd_kwdsr3r-N)getattr real_namer/ decorators add_to_parser format_helpr-) magic_funckwdsZarg_nameparsergroupdecoresultrrrconstruct_parsers   rNcCs |j|S)zA Parse the string of arguments for the given magic function. )rJr@)rHr>rrrr@s r@cCs,|j}|dr|tdd}t|d|S)z& Find the real name of the magic. Zmagic_N argcmd_name)r* startswithlenrC)rHZ magic_namerrrrDs  rDc@s eZdZdZddZddZdS) ArgDecoratorzN Base class for decorators to add ArgumentParser information to a method. cCs(t|dds d|_g|_|j||SN has_argumentsFT)rCrTrErr funcrrr__call__s  zArgDecorator.__call__cCsdS)zD Add this object's information to the parser, if necessary. Nrr rJrKrrrrFszArgDecorator.add_to_parserN)r*r+r,r-rWrFrrrrrRs rRc@s"eZdZdZdddZddZdS)magic_argumentszS Mark the magic as having argparse arguments and possibly adjust the name. NcC ||_dSr)name)r r[rrrr; zmagic_arguments.__init__cCs8t|dds d|_g|_|jdur|j|_t||_|SrS)rCrTrEr[rOrNrJrUrrrrWs   zmagic_arguments.__call__r)r*r+r,r-r;rWrrrrrYs  rYc@s*eZdZUdZeed<ddZddZdS)ArgMethodWrapperz Base class to define a wrapper for ArgumentParser method. Child class must define either `_method_name` or `add_to_parser`. _method_namecOs||_||_dSr)argsrI)r r_rIrrrr;s zArgMethodWrapper.__init__cCs*|dur|}t||j|ji|jdS)6 Add this object's information to the parser. N)rCr^r_rIrXrrrrFszArgMethodWrapper.add_to_parserN)r*r+r,r-str__annotations__r;rFrrrrr]s  r]c@eZdZdZdZdS)argumentzt Store arguments and keywords to pass to add_argument(). Instances also serve to decorate command methods. add_argumentNr*r+r,r-r^rrrrrd rdc@rc)defaultszt Store arguments and keywords to pass to set_defaults(). Instances also serve to decorate command methods. set_defaultsNrfrrrrrhrgrhc@seZdZdZddZdS)argument_groupzz Store arguments and keywords to pass to add_argument_group(). Instances also serve to decorate command methods. cCs|j|ji|jS)r`)add_argument_groupr_rIrXrrrrF#szargument_group.add_to_parserN)r*r+r,r-rFrrrrrjs rjcs(eZdZdZddZfddZZS)rIz; Provide other keywords to the sub-parser constructor. cKrZr)rI)r rIrrrr;,r\z kwds.__init__cstt||}|j|_|Sr)r"rIrWrArUr(rrrW/sz kwds.__call__)r*r+r,r-r;rWr.rrr(rrI)srI)rYrdrjrIr@)r-r reZIPython.core.errorrZIPython.utils.decoratorsrZIPython.utils.processrZIPython.utils.textrcompilerr rArgumentParserr/rNr@rDobjectrRrYr]rdrhrjrI__all__rrrrs,T     ("