NXc@sjdZddlmZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl m Z ddl mZmZdd lmZdd lmZmZmZmZmZmZdd lmZdd lmZdd lmZddlm Z ddl!m"Z"ddl#m$Z$ddl%m&Z&edefdYZ'dS(sImplementation of magic functions for interaction with the OS. Note: this module is named 'osm' instead of 'os' to avoid a collision with the builtin. i(tprint_functionN(tpformat(tmagic_arguments(toinspect(tpage(t AliasErrortAlias(t UsageError(tMagicstcompress_dhistt magics_classt line_magict cell_magictline_cell_magic(t skip_doctest(tsource_to_unicode(tunquote_filename(t abbrev_cwd(t py3compat(t unicode_type(tset_term_titletOSMagicsc BseZdZeeddZeddZeddZeeddZeeddZ eddZ edZ edd Z edd Z edd Zedd Zeedd ZedddZedeZedeZeddZeddZejejdddddeddejddeddedZRS(sJMagics to interact with the underlying OS (shell-type functionality). tcCs|j}|sKt|jjj}tdt|tjj |Sy|j dd\}}Wn(t k rtt j|jdSXy|jjj||Wntk r}t|nXdS(svDefine 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: http://www.python.org/peps/pep-0215.html. 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 acess all of $PATH. See the %rehash and %rehashx functions, which automatically create aliases for the contents of your $PATH. If called with no parameters, %alias prints the current alias table.sTotal number of aliases:iN(tstriptsortedtshellt alias_managertaliasestprinttlentsyststdouttflushtsplittNonet TypeErrorRtgetdoctaliast define_aliasR(tselft parameter_stparRR%tcmdte((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyR%3s7   cCs|j}y|jjj|Wntk rC}t|dSX|jjjdi}||krtd|||=||jjd|jjj| s|jjj| j d d| nWn|k rqX|j| qwqwWq3Wntj} x|D]} y tj| tj| } Wntk rBqnXx| D]} tj j| \} }|| rJ| j| krJ|jdkr| } y,|jjj| jj d d| Wn|k rnX|j| qqJqJWqW||jjdstpathextt;t|t.sexe|com|bat|pytpys|pys (.*)\.(%s)$cstjj|oj|S(N(R8R9R:tmatch(R=(texecre(sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyR>ss.exet syscmdlistN(tIPython.core.aliasR4RR/R8tenvironR0R!tpathsepR9tabspatht expandusertnametreplacetKeyErrortretcompilet IGNORECASERtgetcwdtchdirtlistdirtOSErrorRtis_aliasR&tappendRt blacklisttsplitexttlower(R'R(R4tpR9RFtisexectwinexttsavedirtpdirtdirlisttfftno_aliastbasetext((REsO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytrehashxsj I )                    cCs tjS(sReturn the current working directory path. Examples -------- :: In [9]: pwd Out[9]: '/home/tsuser/sprint/ipython' (RRR(R'R(((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytpwds cCstj}tjd|}|ryt|jd}y|jjd|}Wntk rot ddSXi}n|j drdd}d}|d}|jjd} x{t | D]m} |t jj| krt jj| r| }Pn|dkr|| krt jj| r| }qqW|dkrA|}n|dkr[t ddSi}n3tjdd |}|j|d d d \}}|d kry|jjdd}Wqjtk rtdqjXnt jj| sd|krj|jjjdi} || krH| |} t d|| f| }qjd|krjtd|qjnt|}|rHyOt jt jj|t|jdr|jjrtdtnWn%tk rt tjdqXtj} |jjd}|| kr|j | t!|d|jjd' 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 (note: cd is enough if there is no directory , but a bookmark with the name exists.) 'cd -b ' allows you to tab-complete bookmark names. Options: -q: 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 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 s (-)(\d+)$it_dhs2The requested directory does not exist in history.Ns--s&No matching entry in directory historys\\(?! )t/tqbtmodetstringt-is*%cd -: No previous directory to change to.tbt bookmarkss(bookmark:%s) -> %ssDBookmark '%s' not found. Use '%%bookmark -l' to see your bookmarks.t term_titles IPython: iitdhistt~tqis IPython: ~(#RRRRORDtinttgroupRtuser_nst IndexErrorRt startswithR"treversedR8R9tbasenametisdirtsubt parse_optionsRR/R0RRSRKthasattrRoRRRURtexc_infoRWR thome_dir(R'R(toldcwdtnumcdtnntpstoptstfallbacktpattdhtenttbkmsttargettcwdRp((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytcds*     **                      cCs|jrd|krdnd}|j|}t|dkr|j}|tjkrktj|Sdj|}t|nt|dkr|j|SnttjS(sCGet, 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 t=t is"Environment does not have key: {0}( RR!RR8RHtformatRtset_envtdict(R'R(R!tbitstkeyterr((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytenv}s   cCsd|krdnd}|j|d}|j sIt|dkrXtdn|dj}|dj}tjd|rd}|j|}t|ntj|t j tj|N(RRRtpopRR(R'R(ttop((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytpopds   cCs |jjS(s#Return the current directory stack.(RR(R'R(((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyRscCs)|jjd}|rytt|j}Wn|j|jdSXt|dkrtt||ddt|}}qt|dkr|\}}t |t|}q|j|jdSndt|}}t dx/t ||D]}t d|||fqWdS(sPrint 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 -. RgNiiisDirectory history (kept in _dh)s%d: %s( RRutmapRsR!targ_errRpRtmaxtminRtrange(R'R(Rtargstinitfinti((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyRps$-  c Cs|j|d\}}y@|jdd\}}|j}|jdd\}}Wntk rwd \}}nXd|k}|jj|d|}d|krtd|t|fn|r|jjj i||6n|Sd S( s 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. tlvRiRtlR!tvs%s == %sN(RR( R|R!RR.Rt getoutputRRRutupdate( R'R(RRRt_R*R!tout((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytscs]    cCs|dkr|jj|S|j|dd\}}|jj|}|jd|jd}|r}||jj| - 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.tdrlRjtlistis%bookmark: too many argumentsRntdis/%bookmark -d: must provide a bookmark to deletes)%%bookmark -d: Can't delete bookmark '%s'trRs%-ss -> %ssCurrent bookmarks:s-%bookmark: You must specify the bookmark nameiN(R|RRRR/R0RvRNRRRtstrRRRR( R'R(RRRttodeltbkstsizetfmttbk((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytbookmarksB           cCsy|stdny|jj|dt}Wn"ttfk rUtddSXtj|jjt |dS(sShow 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 :: %pycat myscript.py %pycat 7-27 %pycat myMacro %pycat http://www.example.com/myscript.py s5Missing filename, URL, input history range, or macro.tskip_encoding_cookies:Error: no such file, variable, URL, history range or macroN( RRtfind_user_codetFalseR.tIOErrorRRt pycolorizeR(R'R(tcont((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pytpycats s-as--appendtactiont store_truetdefaultthelps_Append contents of the cell to an existing file. The file will be created if it does not exist.tfilenamettypes file to writecCstj|j|}tjjt|j}tjj|rm|j r\t d|q{t d|nt d||j rdnd}t j ||dd}|j |WdQXdS( sWrite the contents of the cell to a file. The file will be overwritten unless the -a (--append) flag is specified. sAppending to %ssOverwriting %ss Writing %statwtencodingsutf-8N(Rtparse_argstringt writefileR8R9RKRRtexistsRWRtiotopentwrite(R'RRRRRjtf((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyRs N(t__name__t __module__t__doc__RR R%R3ReRfRRRRRRRpRR R"RRR tbangRRRtargumentRRR(((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyR.sXMU  %r5;  ((Rt __future__RRR8RORtpprintRt IPython.coreRRRRGRRtIPython.core.errorRtIPython.core.magicRR R R R R tIPython.testing.skipdoctestRtIPython.utils.openpyRtIPython.utils.pathRtIPython.utils.processRt IPython.utilsRtIPython.utils.py3compatRtIPython.utils.terminalRR(((sO/data/av2000/mvv/env_mvv/lib/python2.7/site-packages/IPython/core/magics/osm.pyts*    .