fwdZddlZddlZddlZddlZddlZddlmZddlm Z ddlm Z ddlm Z ddl m Z mZddlmZdd lmZmZmZmZmZmZdd lmZdd lmZdd lmZdd lmZddl m!Z!ddl"m#Z#eGddeZ$y)zImplementation of magic functions for interaction with the OS. Note: this module is named 'osm' instead of 'os' to avoid a collision with the builtin. N)pformat)magic_arguments)oinspect)page) AliasErrorAlias) UsageError)Magicscompress_dhist magics_class line_magic cell_magicline_cell_magic) skip_doctest)source_to_unicode) abbrev_cwd)set_term_title)Bool)warncreZdZdZeddj dZd%fd ZdZd Z d Z e e d&d Z e d&d Ze d&d Ze e d&dZe e d&dZe d&dZe dZe d&dZe d&dZe d&dZe d&dZe e d&dZed'dZedeZedeZe d&dZe d&dZe j@e jBddddd e jBd!e"d"#ed$Z#xZ$S)(OSMagicszJMagics to interact with the underlying OS (shell-type functionality). Fz5Force %cd magic to be quiet even if -q is not passed.)helpT)configc d|_d|_tjdk(rd|_na tjdj ddj dd} tjd |ztj|_t|4d d |i|y#t $rd }YLwxYw#tj$r<td d }tjd |ztj|_YqwxYw)NFposixTpathext;|.zexe|com|bat|pyz (.*)\.(%s)$zSeems like your pathext environmental variable is malformed. Please check it to enable a proper handle of file extensions managed for your systemshell)is_posixexecreosnameenvironreplaceKeyErrorrecompile IGNORECASEerrorrsuper__init__)selfr!kwargswinext __class__s R/var/www/cvtools/html/venv/lib/python3.12/site-packages/IPython/core/magics/osm.pyr/zOSMagics.__init__)s  77g  DM *I.66s3?GGBO P jj&)@O  /u// *) *88 P/0* jj&)@O  Ps$3B ,B/ B,+B,/A C>=C>ctj|jtjr|j Sy)z7 Test for executable on a POSIX system F)r%accesspathX_OKis_filer0files r4 _isexec_POSIXzOSMagics._isexec_POSIXCs) 99TYY (<<> !ct|jxr'|jj|jduS)> Test for executable file on non POSIX system N)r9r$matchr&r:s r4 _isexec_WINzOSMagics._isexec_WINNs-||~J$++"3"3DII">d"JJr=c^|jr|j|S|j|S)r?)r#r<rAr:s r4isexeczOSMagics.isexecTs- ==%%d+ +##D) )r=c|j}|s^t|jjj}t dt |tjj|S |jdd\}} |jjj||y#t$r+t tj|jYywxYw#t $r}t |Yd}~yd}~wwxYw)a/ Define an alias for a system command. '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' Then, typing 'alias_name params' will execute the system command 'cmd params' (from your underlying operating system). Aliases have lower precedence than magic functions and Python normal variables, so if 'foo' is both a Python variable and an alias, the alias can not be executed until 'del foo' removes the Python variable. You can use the %l specifier in an alias definition to represent the whole line when the alias is called. For example:: In [2]: alias bracket echo "Input in brackets: <%l>" In [3]: bracket hello world Input in brackets: You can also define aliases with parameters using %s specifiers (one per parameter):: In [1]: alias parts echo first %s second %s In [2]: %parts A B first A second B In [3]: %parts A Incorrect number of arguments: 2 expected. parts is an alias to: 'echo first %s second %s' Note that %l and %s are mutually exclusive. You can only use one or the other in your aliases. Aliases expand Python variables just like system calls using ! or !! do: all expressions prefixed with '$' get expanded. For details of the semantic rules, see PEP-215: https://peps.python.org/pep-0215/. This is the library used by IPython for variable expansion. If you want to access a true shell variable, an extra $ is necessary to prevent its expansion by IPython:: In [6]: alias show echo In [7]: PATH='A Python string' In [8]: show $PATH A Python string In [9]: show $$PATH /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... You can use the alias facility to access all of $PATH. See the %rehashx function, which automatically creates aliases for the contents of your $PATH. If called with no parameters, %alias prints the current alias table for your system. For posix systems, the default aliases are 'cat', 'cp', 'mv', 'rm', 'rmdir', and 'mkdir', and other platform-specific aliases are added. For windows-based systems, the default aliases are 'copy', 'ddir', 'echo', 'ls', 'ldir', 'mkdir', 'ren', and 'rmdir'. You can see the definition of alias by adding a question mark in the end:: In [1]: cat? Repr: zTotal number of aliases:N)stripsortedr! alias_manageraliasesprintlensysstdoutflushsplit TypeErrorrgetdocalias define_aliasr)r0 parameter_sparrIrRcmdes r4rRzOSMagics.alias^sB!TZZ55==>G ,c'l ; JJ   N  $*IE#   JJ $ $ 1 1% =   (//$**- .     !HH s*2B/&C&/1C#"C#& D/ C??DcX|j} |jjj||jj jdi}||vr)t d|||=||jj d<yy#t$r}t |Yd}~yd}~wwxYw)zRemove an aliasNstored_aliaseszRemoving %stored alias)rFr!rHundefine_alias ValueErrorrJdbget)r0rTanamerWstoreds r4unaliaszOSMagics.unaliass!!#  JJ $ $ 3 3E : ""#3R9 F? *5 1u .4DJJMM* +    !H  s%B B) B$$B)c2ddlm}|jjd=tj j ddjtjDcgc]>}tjjtjj|@}}g}t j} |jr|D]} t j|t j |}|D]} |j#| s| j$} |jj&j)| s6|jj&j+| j-dd| |j/| nt0j2} |D]} t j|t j |}|D]} | j$} tjj5| \} } |j#| sC| j7| vsV| j7dk(sj| } |jj&j+| j7j-dd| |j/| ||jjd <t j|y cc}w#t$rY wxYw#|$rYwxYw#t$rYRwxYw#|$rY|wxYw#t j|wxYw) aUpdate the alias table with all executable files in $PATH. rehashx explicitly checks that every entry in $PATH is a file with execute access (os.X_OK). Under Windows, it checks executability as a match against a '|'-separated string of extensions, stored in the IPython config variable win_exec_ext. This defaults to 'exe|com|bat'. This function also resets the root module cache of module completer, used on slow filesystems. r)InvalidAliasErrorrootmodules_cachePATHr )r7rz.exe syscmdlistN)IPython.core.aliasrbr!r\r%r'r]rOpathsepr7abspath expandusergetcwdr#chdirOSErrorscandirrCr&rHis_aliasrSr(appendr blacklistsplitextlower)r0rTrbpr7resavedirpdirdirlistfffnameno_aliasbaseexts r4rehashxzOSMagics.rehashxs 9 JJMM- . JJNN6" % + +BJJ 791 2 21 5699 ))+4 }} 9D! !jjd3G% 9;;r?$&GGE 9(,zz'?'?'H'H'O$(JJ$<$<$I$I(- c"(=u%F !+ 1 1% 8 99,!?? 9D! !jj.G% 9 "$&GG$4$4U$; c;;r?tzz|8/K"yy{f4(,!)%)JJ$<$<$I$I(, (<(`` to see directory history conveniently. Usage: - ``cd 'dir'``: changes to directory 'dir'. - ``cd -``: changes to the last visited directory. - ``cd -``: changes to the n-th directory in the directory history. - ``cd --foo``: change to directory that matches 'foo' in history - ``cd -b ``: jump to a bookmark set by %bookmark - Hitting a tab key after ``cd -b`` allows you to tab-complete bookmark names. .. note:: ``cd `` is enough if there is no directory ````, but a bookmark with the name exists. Options: -q Be quiet. Do not print the working directory after the cd command is executed. By default IPython's cd command does print this directory, since the default prompts do not display path information. .. note:: Note that ``!cd`` doesn't work for this purpose because the shell where ``!command`` runs is immediately discarded after executing 'command'. Examples -------- :: In [10]: cd parent/child /home/tsuser/parent/child Nz (-)(\d+)$_dhz2The requested directory does not exist in history.z--z&No matching entry in directory historyqbstringmode-z*%cd -: No previous directory to change to.b bookmarksz (bookmark:z) -> zDBookmark '%s' not found. Use '%%bookmark -l' to see your bookmarks. term_title)cwdidhistrE~q)&r%rjr~r*r@intgroupr!user_ns IndexErrorrJ startswithreversedr7basenameisdir parse_optionsr r\r]rkrihasattrrrterm_title_formatformatrpathlibPathrror rlrLexc_infohome_dircd_force_quiet)r0rToldcwdnumcdnnpsoptsfallbackpatdhentrWbkmstargetrrs r4cdz OSMagics.cd)sV YY[F k2 U[[^$B ZZ''.r2   # #D )BHab/C##E*B| #"''**3//BGGMM#4FB#s rww}}S7I"H  #zz>?))+t()KHD" 9 VZZ''.r2 77==$t zz}}((b9:!"XF2v>?Bd{(*KMO*PQQ  J++B/04::|49N9N"4::#?#?#F#F:<#F#XYll&&( **51S=LL%-;E-B45-IDJJMM'* HHTZZ(( )tzz<0TZZ5J5Jtzz;;BBsBKL,,""$CJJ&&u-E} S!)7)>tu)E g&d{4#6#64::;M;Me;T $**$$U+B/ 05 QQQQ! Q;* Q66Q;>)R*)R*c|jrd|vrdnd}|j|}t|dk(rQ|jtjvrtjSdj }t |t|dkDr|j|Sttj}t|D]tfddDsd|<|S)a\Get, set, or list environment variables. Usage:\ :``%env``: lists all environment variables/values :``%env var``: get value for var :``%env var val``: set value for var :``%env var=val``: set value for var :``%env var=$val``: set value for var, using python expansion if possible = rEz"Environment does not have key: {0}c3BK|]}|jvywN)rr).0skeys r4 zOSMagics.env..sH1 #Hs)rtokensecretz) rFrOrKr%r'rr set_envdictlistany)r0rTrObitserrenvrs @r4rz OSMagics.envs    +-C3E$$U+D4yA~!'')"**$::c?*>EEcJC$S/)4y1}||K002::9 &CH-GHH%C & r=cd|vrdnd}|j|d}|jrt|dkr td|dj}|dj}t j d|rd}|j |}t||tj|<td j ||y ) avSet environment variables. Assumptions are that either "val" is a name in the user namespace, or val is something that evaluates to a string. Usage:\ :``%set_env var val``: set value for var :``%set_env var=val``: set value for var :``%set_env var=$val``: set value for var, using python expansion if possible rrrErzusage is 'set_env var=val'rz.*\s.*z.refusing to set env var with whitespace: '{0}'z env: {0}={1}N) rOrFrKr r*r@rr%r'rJ)r0rTrOrvarvalrs r4rzOSMagics.set_envsk)s  *  "c$ik9: :1gmmo1gmmo 88Is #CC**S/CS/ ! 3 n##C,-r=c^|jj}tjj |}tj j |jjd}|r|j||jd||jjddS)zkPlace the current dir on stack and change directory. Usage:\ %pushd ['dirname'] rrdirsr ) r! dir_stackr%r7rirjr(rrinsertrun_line_magic)r0rTdir_stgtrs r4pushdzOSMagics.pushds} $$gg  -iik!!$**"5"5c:  GGK  Qszz((44r=c|jjs td|jjjd}|j |t d|y)z=Change to directory popped off the top of the stack. z%popd on empty stackrzpopd ->N)r!rr poprrJ)r0rTtops r4popdz OSMagics.popdsLzz##34 4jj""&&q)   ir=c.|jjS)z#Return the current directory stack.)r!r)r0rTs r4rz OSMagics.dirsszz###r=c(|jjd}|r tt|j }t|dk(r'tt||dz dt|}}nRt|dk(r|\}}t|t|}n)|j |j ydt|}}tdt||D]}td|||fzy#|j |j YyxYw)aPrint your history of visited directories. %dhist -> print full history\ %dhist n -> print last n entries only\ %dhist n1 n2 -> print entries between n1 and n2 (n2 not included)\ This history is automatically maintained by the %cd command, and always available as the global list variable _dh. You can use %cd - to go to directory number . Note that most of time, you should view directory history by entering cd -. rNrErrzDirectory history (kept in _dh)z%d: %s) r!rmaprrOarg_errrrKmaxminrJrange)r0rTrargsinifinis r4rzOSMagics.dhists"ZZ   &  3{00234yA~c"gtAw/23r7CTaC#s2w' TZZ(BC /0sC )A (aAZ' ( )  TZZ(s C22Dc|j|d\}} |jdd\}}|j}|jdd\}}d|v}|jj ||}d|vrt |dt||r(|jjj||iy |S#t$rd\}}YzwxYw) a Shell capture - run shell command and capture output (DEPRECATED use !). DEPRECATED. Suboptimal, retained for backwards compatibility. You should use the form 'var = !command' instead. Example: "%sc -l myfiles = ls ~" should now be written as "myfiles = !ls ~" myfiles.s, myfiles.l and myfiles.n still apply as documented below. -- %sc [options] varname=command IPython will run the given command using commands.getoutput(), and will then update the user's interactive namespace with a variable called varname, containing the value of the call. Your command can contain shell wildcards, pipes, etc. The '=' sign in the syntax is mandatory, and the variable name you supply must follow Python's standard conventions for valid names. (A special format without variable name exists for internal use) Options: -l: list output. Split the output on newlines into a list before assigning it to the given variable. By default the output is stored as a single string. -v: verbose. Print the contents of the variable. In most cases you should not need to split as a list, because the returned value is a special type of string which can automatically provide its contents either as a list (split on newlines) or as a space-separated string. These are convenient, respectively, either for sequential processing or to be passed to a shell command. For example:: # Capture into variable a In [1]: sc a=ls *py # a is a string with embedded newlines In [2]: a Out[2]: 'setup.py\nwin32_manual_post_install.py' # which can be seen as a list: In [3]: a.l Out[3]: ['setup.py', 'win32_manual_post_install.py'] # or as a whitespace-separated string: In [4]: a.s Out[4]: 'setup.py win32_manual_post_install.py' # a.s is useful to pass as a single command line: In [5]: !wc -l $a.s 146 setup.py 130 win32_manual_post_install.py 276 total # while the list form is useful to loop over: In [6]: for f in a.l: ...: !wc -l $f ...: 146 setup.py 130 win32_manual_post_install.py Similarly, the lists returned by the -l option are also special, in the sense that you can equally invoke the .s attribute on them to automatically get a whitespace-separated string from their contents:: In [7]: sc -l b=ls *py In [8]: b Out[8]: ['setup.py', 'win32_manual_post_install.py'] In [9]: b.s Out[9]: 'setup.py win32_manual_post_install.py' In summary, both the lists and strings used for output capture have the following special attributes:: .l (or .list) : value as list. .n (or .nlstr): value as newline-separated string. .s (or .spstr): value as space-separated string. lvrrE)r r l)rOvz == N) rrOrFr[r! getoutputrJrrupdate) r0rTrrr_rVrOouts r4scz OSMagics.sc4sz&&{D9 T JJsA&EC))+C %%c1-EAct jj""3e"4 $; gcl3 4  JJ   % %s3i 0J GC s:B;;C  C c||jj|S|j|dd\}}|jj|}|jd|jd}|r||jj|<y|S)a'Shell execute - run shell command and capture output (!! is short-hand). %sx command IPython will run the given command using commands.getoutput(), and return the result formatted as a list (split on '\n'). Since the output is _returned_, it will be stored in ipython's regular output cache Out[N] and in the '_N' automatic variables. Notes: 1) If an input line begins with '!!', then %sx is automatically invoked. That is, while:: !ls causes ipython to simply issue system('ls'), typing:: !!ls is a shorthand equivalent to:: %sx ls 2) %sx differs from %sc in that %sx automatically splits into a list, like '%sc -l'. The reason for this is to make it as easy as possible to process line-oriented shell output via further python commands. %sc is meant to provide much finer control, but requires more typing. 3) Just like %sc -l, this is a list with special attributes: :: .l (or .list) : value as list. .n (or .nlstr): value as newline-separated string. .s (or .spstr): value as whitespace-separated string. This is very useful when trying to use such lists as arguments to system commands.Nr zout=ro)r!rrr]r)r0linecellrroutputout_names r4sxz OSMagics.sxsT <::''- -**4V - set bookmark to current dir %bookmark - set bookmark to %bookmark -l - list all bookmarks %bookmark -d - remove bookmark %bookmark -r - remove all bookmarks You can later on access a bookmarked folder with:: %cd -b or simply '%cd ' if there is no directory called AND there is such a bookmark defined. Your bookmarks persist through IPython sessions, but they are associated with each profile.drlrrrz%bookmark: too many argumentsrdrz)%%bookmark -d: Can't delete bookmark '%s'Nz/%bookmark -d: must provide a bookmark to deleterrz%-zs -> %szCurrent bookmarks:z-%bookmark: You must specify the bookmark namerE)rrKr r!r\r]r)rrGrrstrrJr%rj) r0rTrrrtodelrWbkssizefmtbks r4bookmarkzOSMagics.bookmarks(&&{5f&E T t9q=<= =zz}}  R0 $; TQ TU D[D D[,C3sC=)s4y.*C & ' ,cRbN*+ , !PQQTA " T!W TA $QT!W %) k"/ T$CeKMRSTT  N EGLMN Ns0E"D:: EEE E4# E//E4c |jj|d}t j |jj t|y#ttf$rt dYywxYw)a3Show a syntax-highlighted file through a pager. This magic is similar to the cat utility, but it will assume the file to be Python source and will show it with syntax highlighting. This magic command can either take a local filename, an url, an history range (see %history) or a macro as argument. If no parameter is given, prints out history of current session up to this point. :: %pycat myscript.py %pycat 7-27 %pycat myMacro %pycat http://www.example.com/myscript.py F)skip_encoding_cookiez:Error: no such file, variable, URL, history range or macroN)r!find_user_coder[IOErrorrJr pycolorizer)r0rTconts r4pycatzOSMagics.pycatse$ ::,,[u,UD $**''(9$(?@A G$  N O  sAA43A4z-az--append store_truez_Append contents of the cell to an existing file. The file will be created if it does not exist.)actiondefaultrfilenamez file to write)typercztj|j|}tjd|j r-t jj|j dd}n)t jj|j }t jj|r*|jrtd|zntd|zntd|z|jrdnd}tj||d 5}|j|d d d y #1swYy xYw) zWrite the contents of the cell to a file. The file will be overwritten unless the -a (--append) flag is specified. z^(\'.*\')|(".*")$rErzAppending to %szOverwriting %sz Writing %sawzutf-8)encodingN)rparse_argstring writefiler*r@rr%r7riexistsrorJioopenwrite)r0rrrrrfs r4rzOSMagics.writefile7s ..t~~tD 88($-- 8ww))$--"*=>Hww))$--8H 77>>( #{{'(23&12 ,) *kkss WWXtg 6 ! GGDM   s D11D:r)r )r N)%__name__ __module__ __qualname____doc__rtagrr/r<rArCrr rRr`r|rrrrrrrrrrrrrbangrrrargumentrr __classcell__)r3s@r4rr s(% D cc04K *TTn55 MM^ b bC1C1J>..: 5 5$$ #)#)Jppd33j'_X &r *F :c?2 D9*9*vBB2%_$$&_ ju> _   'r=r)%rr r%rr*rLpprintr IPython.corerrrrfrrIPython.core.errorr IPython.core.magicr r r r rrIPython.testing.skipdoctestrIPython.utils.openpyrIPython.utils.processrIPython.utils.terminalr traitletsrwarningsrrr"r=r4r si  (!0)52,1v vv v r=