forked from ipython/ipython
-
Notifications
You must be signed in to change notification settings - Fork 1
/
genutils.py
2170 lines (1722 loc) · 72.6 KB
/
genutils.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""General purpose utilities.
This is a grab-bag of stuff I find useful in most programs I write. Some of
these things are also convenient when working at the command line.
"""
#*****************************************************************************
# Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#*****************************************************************************
#****************************************************************************
# required modules from the Python standard library
import __main__
import commands
try:
import doctest
except ImportError:
pass
import os
import platform
import re
import shlex
import shutil
import subprocess
import sys
import tempfile
import time
import types
import warnings
# Curses and termios are Unix-only modules
try:
import curses
# We need termios as well, so if its import happens to raise, we bail on
# using curses altogether.
import termios
except ImportError:
USE_CURSES = False
else:
# Curses on Solaris may not be complete, so we can't use it there
USE_CURSES = hasattr(curses,'initscr')
# Other IPython utilities
import IPython
from IPython.Itpl import Itpl,itpl,printpl
from IPython import DPyGetOpt, platutils
from IPython.generics import result_display
import IPython.ipapi
from IPython.external.path import path
if os.name == "nt":
from IPython.winconsole import get_console_size
try:
set
except:
from sets import Set as set
#****************************************************************************
# Exceptions
class Error(Exception):
"""Base class for exceptions in this module."""
pass
#----------------------------------------------------------------------------
class IOStream:
def __init__(self,stream,fallback):
if not hasattr(stream,'write') or not hasattr(stream,'flush'):
stream = fallback
self.stream = stream
self._swrite = stream.write
self.flush = stream.flush
def write(self,data):
try:
self._swrite(data)
except:
try:
# print handles some unicode issues which may trip a plain
# write() call. Attempt to emulate write() by using a
# trailing comma
print >> self.stream, data,
except:
# if we get here, something is seriously broken.
print >> sys.stderr, \
'ERROR - failed to write data to stream:', self.stream
def close(self):
pass
class IOTerm:
""" Term holds the file or file-like objects for handling I/O operations.
These are normally just sys.stdin, sys.stdout and sys.stderr but for
Windows they can can replaced to allow editing the strings before they are
displayed."""
# In the future, having IPython channel all its I/O operations through
# this class will make it easier to embed it into other environments which
# are not a normal terminal (such as a GUI-based shell)
def __init__(self,cin=None,cout=None,cerr=None):
self.cin = IOStream(cin,sys.stdin)
self.cout = IOStream(cout,sys.stdout)
self.cerr = IOStream(cerr,sys.stderr)
# Global variable to be used for all I/O
Term = IOTerm()
import IPython.rlineimpl as readline
# Remake Term to use the readline i/o facilities
if sys.platform == 'win32' and readline.have_readline:
Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile)
#****************************************************************************
# Generic warning/error printer, used by everything else
def warn(msg,level=2,exit_val=1):
"""Standard warning printer. Gives formatting consistency.
Output is sent to Term.cerr (sys.stderr by default).
Options:
-level(2): allows finer control:
0 -> Do nothing, dummy function.
1 -> Print message.
2 -> Print 'WARNING:' + message. (Default level).
3 -> Print 'ERROR:' + message.
4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val).
-exit_val (1): exit value returned by sys.exit() for a level 4
warning. Ignored for all other levels."""
if level>0:
header = ['','','WARNING: ','ERROR: ','FATAL ERROR: ']
print >> Term.cerr, '%s%s' % (header[level],msg)
if level == 4:
print >> Term.cerr,'Exiting.\n'
sys.exit(exit_val)
def info(msg):
"""Equivalent to warn(msg,level=1)."""
warn(msg,level=1)
def error(msg):
"""Equivalent to warn(msg,level=3)."""
warn(msg,level=3)
def fatal(msg,exit_val=1):
"""Equivalent to warn(msg,exit_val=exit_val,level=4)."""
warn(msg,exit_val=exit_val,level=4)
#---------------------------------------------------------------------------
# Debugging routines
#
def debugx(expr,pre_msg=''):
"""Print the value of an expression from the caller's frame.
Takes an expression, evaluates it in the caller's frame and prints both
the given expression and the resulting value (as well as a debug mark
indicating the name of the calling function. The input must be of a form
suitable for eval().
An optional message can be passed, which will be prepended to the printed
expr->value pair."""
cf = sys._getframe(1)
print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr,
eval(expr,cf.f_globals,cf.f_locals))
# deactivate it by uncommenting the following line, which makes it a no-op
#def debugx(expr,pre_msg=''): pass
#----------------------------------------------------------------------------
StringTypes = types.StringTypes
# Basic timing functionality
# If possible (Unix), use the resource module instead of time.clock()
try:
import resource
def clocku():
"""clocku() -> floating point number
Return the *USER* CPU time in seconds since the start of the process.
This is done via a call to resource.getrusage, so it avoids the
wraparound problems in time.clock()."""
return resource.getrusage(resource.RUSAGE_SELF)[0]
def clocks():
"""clocks() -> floating point number
Return the *SYSTEM* CPU time in seconds since the start of the process.
This is done via a call to resource.getrusage, so it avoids the
wraparound problems in time.clock()."""
return resource.getrusage(resource.RUSAGE_SELF)[1]
def clock():
"""clock() -> floating point number
Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of
the process. This is done via a call to resource.getrusage, so it
avoids the wraparound problems in time.clock()."""
u,s = resource.getrusage(resource.RUSAGE_SELF)[:2]
return u+s
def clock2():
"""clock2() -> (t_user,t_system)
Similar to clock(), but return a tuple of user/system times."""
return resource.getrusage(resource.RUSAGE_SELF)[:2]
except ImportError:
# There is no distinction of user/system time under windows, so we just use
# time.clock() for everything...
clocku = clocks = clock = time.clock
def clock2():
"""Under windows, system CPU time can't be measured.
This just returns clock() and zero."""
return time.clock(),0.0
def timings_out(reps,func,*args,**kw):
"""timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output)
Execute a function reps times, return a tuple with the elapsed total
CPU time in seconds, the time per call and the function's output.
Under Unix, the return value is the sum of user+system time consumed by
the process, computed via the resource module. This prevents problems
related to the wraparound effect which the time.clock() function has.
Under Windows the return value is in wall clock seconds. See the
documentation for the time module for more details."""
reps = int(reps)
assert reps >=1, 'reps must be >= 1'
if reps==1:
start = clock()
out = func(*args,**kw)
tot_time = clock()-start
else:
rng = xrange(reps-1) # the last time is executed separately to store output
start = clock()
for dummy in rng: func(*args,**kw)
out = func(*args,**kw) # one last time
tot_time = clock()-start
av_time = tot_time / reps
return tot_time,av_time,out
def timings(reps,func,*args,**kw):
"""timings(reps,func,*args,**kw) -> (t_total,t_per_call)
Execute a function reps times, return a tuple with the elapsed total CPU
time in seconds and the time per call. These are just the first two values
in timings_out()."""
return timings_out(reps,func,*args,**kw)[0:2]
def timing(func,*args,**kw):
"""timing(func,*args,**kw) -> t_total
Execute a function once, return the elapsed total CPU time in
seconds. This is just the first value in timings_out()."""
return timings_out(1,func,*args,**kw)[0]
#****************************************************************************
# file and system
def arg_split(s,posix=False):
"""Split a command line's arguments in a shell-like manner.
This is a modified version of the standard library's shlex.split()
function, but with a default of posix=False for splitting, so that quotes
in inputs are respected."""
# Unfortunately, python's shlex module is buggy with unicode input:
# http://bugs.python.org/issue1170
# At least encoding the input when it's unicode seems to help, but there
# may be more problems lurking. Apparently this is fixed in python3.
if isinstance(s, unicode):
s = s.encode(sys.stdin.encoding)
lex = shlex.shlex(s, posix=posix)
lex.whitespace_split = True
return list(lex)
def system(cmd,verbose=0,debug=0,header=''):
"""Execute a system command, return its exit status.
Options:
- verbose (0): print the command to be executed.
- debug (0): only print, do not actually execute.
- header (''): Header to print on screen prior to the executed command (it
is only prepended to the command, no newlines are added).
Note: a stateful version of this function is available through the
SystemExec class."""
stat = 0
if verbose or debug: print header+cmd
sys.stdout.flush()
if not debug: stat = os.system(cmd)
return stat
def abbrev_cwd():
""" Return abbreviated version of cwd, e.g. d:mydir """
cwd = os.getcwd().replace('\\','/')
drivepart = ''
tail = cwd
if sys.platform == 'win32':
if len(cwd) < 4:
return cwd
drivepart,tail = os.path.splitdrive(cwd)
parts = tail.split('/')
if len(parts) > 2:
tail = '/'.join(parts[-2:])
return (drivepart + (
cwd == '/' and '/' or tail))
# This function is used by ipython in a lot of places to make system calls.
# We need it to be slightly different under win32, due to the vagaries of
# 'network shares'. A win32 override is below.
def shell(cmd,verbose=0,debug=0,header=''):
"""Execute a command in the system shell, always return None.
Options:
- verbose (0): print the command to be executed.
- debug (0): only print, do not actually execute.
- header (''): Header to print on screen prior to the executed command (it
is only prepended to the command, no newlines are added).
Note: this is similar to genutils.system(), but it returns None so it can
be conveniently used in interactive loops without getting the return value
(typically 0) printed many times."""
stat = 0
if verbose or debug: print header+cmd
# flush stdout so we don't mangle python's buffering
sys.stdout.flush()
if not debug:
platutils.set_term_title("IPy " + cmd)
os.system(cmd)
platutils.set_term_title("IPy " + abbrev_cwd())
# override shell() for win32 to deal with network shares
if os.name in ('nt','dos'):
shell_ori = shell
def shell(cmd,verbose=0,debug=0,header=''):
if os.getcwd().startswith(r"\\"):
path = os.getcwd()
# change to c drive (cannot be on UNC-share when issuing os.system,
# as cmd.exe cannot handle UNC addresses)
os.chdir("c:")
# issue pushd to the UNC-share and then run the command
try:
shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header)
finally:
os.chdir(path)
else:
shell_ori(cmd,verbose,debug,header)
shell.__doc__ = shell_ori.__doc__
def getoutput(cmd,verbose=0,debug=0,header='',split=0):
"""Dummy substitute for perl's backquotes.
Executes a command and returns the output.
Accepts the same arguments as system(), plus:
- split(0): if true, the output is returned as a list split on newlines.
Note: a stateful version of this function is available through the
SystemExec class.
This is pretty much deprecated and rarely used,
genutils.getoutputerror may be what you need.
"""
if verbose or debug: print header+cmd
if not debug:
output = os.popen(cmd).read()
# stipping last \n is here for backwards compat.
if output.endswith('\n'):
output = output[:-1]
if split:
return output.split('\n')
else:
return output
def getoutputerror(cmd,verbose=0,debug=0,header='',split=0):
"""Return (standard output,standard error) of executing cmd in a shell.
Accepts the same arguments as system(), plus:
- split(0): if true, each of stdout/err is returned as a list split on
newlines.
Note: a stateful version of this function is available through the
SystemExec class."""
if verbose or debug: print header+cmd
if not cmd:
if split:
return [],[]
else:
return '',''
if not debug:
pin,pout,perr = os.popen3(cmd)
tout = pout.read().rstrip()
terr = perr.read().rstrip()
pin.close()
pout.close()
perr.close()
if split:
return tout.split('\n'),terr.split('\n')
else:
return tout,terr
# for compatibility with older naming conventions
xsys = system
bq = getoutput
class SystemExec:
"""Access the system and getoutput functions through a stateful interface.
Note: here we refer to the system and getoutput functions from this
library, not the ones from the standard python library.
This class offers the system and getoutput functions as methods, but the
verbose, debug and header parameters can be set for the instance (at
creation time or later) so that they don't need to be specified on each
call.
For efficiency reasons, there's no way to override the parameters on a
per-call basis other than by setting instance attributes. If you need
local overrides, it's best to directly call system() or getoutput().
The following names are provided as alternate options:
- xsys: alias to system
- bq: alias to getoutput
An instance can then be created as:
>>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ')
"""
def __init__(self,verbose=0,debug=0,header='',split=0):
"""Specify the instance's values for verbose, debug and header."""
setattr_list(self,'verbose debug header split')
def system(self,cmd):
"""Stateful interface to system(), with the same keyword parameters."""
system(cmd,self.verbose,self.debug,self.header)
def shell(self,cmd):
"""Stateful interface to shell(), with the same keyword parameters."""
shell(cmd,self.verbose,self.debug,self.header)
xsys = system # alias
def getoutput(self,cmd):
"""Stateful interface to getoutput()."""
return getoutput(cmd,self.verbose,self.debug,self.header,self.split)
def getoutputerror(self,cmd):
"""Stateful interface to getoutputerror()."""
return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split)
bq = getoutput # alias
#-----------------------------------------------------------------------------
def mutex_opts(dict,ex_op):
"""Check for presence of mutually exclusive keys in a dict.
Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]"""
for op1,op2 in ex_op:
if op1 in dict and op2 in dict:
raise ValueError,'\n*** ERROR in Arguments *** '\
'Options '+op1+' and '+op2+' are mutually exclusive.'
#-----------------------------------------------------------------------------
def get_py_filename(name):
"""Return a valid python filename in the current directory.
If the given name is not a file, it adds '.py' and searches again.
Raises IOError with an informative message if the file isn't found."""
name = os.path.expanduser(name)
if not os.path.isfile(name) and not name.endswith('.py'):
name += '.py'
if os.path.isfile(name):
return name
else:
raise IOError,'File `%s` not found.' % name
#-----------------------------------------------------------------------------
def filefind(fname,alt_dirs = None):
"""Return the given filename either in the current directory, if it
exists, or in a specified list of directories.
~ expansion is done on all file and directory names.
Upon an unsuccessful search, raise an IOError exception."""
if alt_dirs is None:
try:
alt_dirs = get_home_dir()
except HomeDirError:
alt_dirs = os.getcwd()
search = [fname] + list_strings(alt_dirs)
search = map(os.path.expanduser,search)
#print 'search list for',fname,'list:',search # dbg
fname = search[0]
if os.path.isfile(fname):
return fname
for direc in search[1:]:
testname = os.path.join(direc,fname)
#print 'testname',testname # dbg
if os.path.isfile(testname):
return testname
raise IOError,'File' + `fname` + \
' not found in current or supplied directories:' + `alt_dirs`
#----------------------------------------------------------------------------
def file_read(filename):
"""Read a file and close it. Returns the file source."""
fobj = open(filename,'r');
source = fobj.read();
fobj.close()
return source
def file_readlines(filename):
"""Read a file and close it. Returns the file source using readlines()."""
fobj = open(filename,'r');
lines = fobj.readlines();
fobj.close()
return lines
#----------------------------------------------------------------------------
def target_outdated(target,deps):
"""Determine whether a target is out of date.
target_outdated(target,deps) -> 1/0
deps: list of filenames which MUST exist.
target: single filename which may or may not exist.
If target doesn't exist or is older than any file listed in deps, return
true, otherwise return false.
"""
try:
target_time = os.path.getmtime(target)
except os.error:
return 1
for dep in deps:
dep_time = os.path.getmtime(dep)
if dep_time > target_time:
#print "For target",target,"Dep failed:",dep # dbg
#print "times (dep,tar):",dep_time,target_time # dbg
return 1
return 0
#-----------------------------------------------------------------------------
def target_update(target,deps,cmd):
"""Update a target with a given command given a list of dependencies.
target_update(target,deps,cmd) -> runs cmd if target is outdated.
This is just a wrapper around target_outdated() which calls the given
command if target is outdated."""
if target_outdated(target,deps):
xsys(cmd)
#----------------------------------------------------------------------------
def unquote_ends(istr):
"""Remove a single pair of quotes from the endpoints of a string."""
if not istr:
return istr
if (istr[0]=="'" and istr[-1]=="'") or \
(istr[0]=='"' and istr[-1]=='"'):
return istr[1:-1]
else:
return istr
#----------------------------------------------------------------------------
def process_cmdline(argv,names=[],defaults={},usage=''):
""" Process command-line options and arguments.
Arguments:
- argv: list of arguments, typically sys.argv.
- names: list of option names. See DPyGetOpt docs for details on options
syntax.
- defaults: dict of default values.
- usage: optional usage notice to print if a wrong argument is passed.
Return a dict of options and a list of free arguments."""
getopt = DPyGetOpt.DPyGetOpt()
getopt.setIgnoreCase(0)
getopt.parseConfiguration(names)
try:
getopt.processArguments(argv)
except DPyGetOpt.ArgumentError, exc:
print usage
warn('"%s"' % exc,level=4)
defaults.update(getopt.optionValues)
args = getopt.freeValues
return defaults,args
#----------------------------------------------------------------------------
def optstr2types(ostr):
"""Convert a string of option names to a dict of type mappings.
optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'}
This is used to get the types of all the options in a string formatted
with the conventions of DPyGetOpt. The 'type' None is used for options
which are strings (they need no further conversion). This function's main
use is to get a typemap for use with read_dict().
"""
typeconv = {None:'',int:'',float:''}
typemap = {'s':None,'i':int,'f':float}
opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)')
for w in ostr.split():
oname,alias,otype = opt_re.match(w).groups()
if otype == '' or alias == '!': # simple switches are integers too
otype = 'i'
typeconv[typemap[otype]] += oname + ' '
return typeconv
#----------------------------------------------------------------------------
def read_dict(filename,type_conv=None,**opt):
r"""Read a dictionary of key=value pairs from an input file, optionally
performing conversions on the resulting values.
read_dict(filename,type_conv,**opt) -> dict
Only one value per line is accepted, the format should be
# optional comments are ignored
key value\n
Args:
- type_conv: A dictionary specifying which keys need to be converted to
which types. By default all keys are read as strings. This dictionary
should have as its keys valid conversion functions for strings
(int,long,float,complex, or your own). The value for each key
(converter) should be a whitespace separated string containing the names
of all the entries in the file to be converted using that function. For
keys to be left alone, use None as the conversion function (only needed
with purge=1, see below).
- opt: dictionary with extra options as below (default in parens)
purge(0): if set to 1, all keys *not* listed in type_conv are purged out
of the dictionary to be returned. If purge is going to be used, the
set of keys to be left as strings also has to be explicitly specified
using the (non-existent) conversion function None.
fs(None): field separator. This is the key/value separator to be used
when parsing the file. The None default means any whitespace [behavior
of string.split()].
strip(0): if 1, strip string values of leading/trailinig whitespace.
warn(1): warning level if requested keys are not found in file.
- 0: silently ignore.
- 1: inform but proceed.
- 2: raise KeyError exception.
no_empty(0): if 1, remove keys with whitespace strings as a value.
unique([]): list of keys (or space separated string) which can't be
repeated. If one such key is found in the file, each new instance
overwrites the previous one. For keys not listed here, the behavior is
to make a list of all appearances.
Example:
If the input file test.ini contains (we put it in a string to keep the test
self-contained):
>>> test_ini = '''\
... i 3
... x 4.5
... y 5.5
... s hi ho'''
Then we can use it as follows:
>>> type_conv={int:'i',float:'x',None:'s'}
>>> d = read_dict(test_ini)
>>> sorted(d.items())
[('i', '3'), ('s', 'hi ho'), ('x', '4.5'), ('y', '5.5')]
>>> d = read_dict(test_ini,type_conv)
>>> sorted(d.items())
[('i', 3), ('s', 'hi ho'), ('x', 4.5), ('y', '5.5')]
>>> d = read_dict(test_ini,type_conv,purge=True)
>>> sorted(d.items())
[('i', 3), ('s', 'hi ho'), ('x', 4.5)]
"""
# starting config
opt.setdefault('purge',0)
opt.setdefault('fs',None) # field sep defaults to any whitespace
opt.setdefault('strip',0)
opt.setdefault('warn',1)
opt.setdefault('no_empty',0)
opt.setdefault('unique','')
if type(opt['unique']) in StringTypes:
unique_keys = qw(opt['unique'])
elif type(opt['unique']) in (types.TupleType,types.ListType):
unique_keys = opt['unique']
else:
raise ValueError, 'Unique keys must be given as a string, List or Tuple'
dict = {}
# first read in table of values as strings
if '\n' in filename:
lines = filename.splitlines()
file = None
else:
file = open(filename,'r')
lines = file.readlines()
for line in lines:
line = line.strip()
if len(line) and line[0]=='#': continue
if len(line)>0:
lsplit = line.split(opt['fs'],1)
try:
key,val = lsplit
except ValueError:
key,val = lsplit[0],''
key = key.strip()
if opt['strip']: val = val.strip()
if val == "''" or val == '""': val = ''
if opt['no_empty'] and (val=='' or val.isspace()):
continue
# if a key is found more than once in the file, build a list
# unless it's in the 'unique' list. In that case, last found in file
# takes precedence. User beware.
try:
if dict[key] and key in unique_keys:
dict[key] = val
elif type(dict[key]) is types.ListType:
dict[key].append(val)
else:
dict[key] = [dict[key],val]
except KeyError:
dict[key] = val
# purge if requested
if opt['purge']:
accepted_keys = qwflat(type_conv.values())
for key in dict.keys():
if key in accepted_keys: continue
del(dict[key])
# now convert if requested
if type_conv==None: return dict
conversions = type_conv.keys()
try: conversions.remove(None)
except: pass
for convert in conversions:
for val in qw(type_conv[convert]):
try:
dict[val] = convert(dict[val])
except KeyError,e:
if opt['warn'] == 0:
pass
elif opt['warn'] == 1:
print >>sys.stderr, 'Warning: key',val,\
'not found in file',filename
elif opt['warn'] == 2:
raise KeyError,e
else:
raise ValueError,'Warning level must be 0,1 or 2'
return dict
#----------------------------------------------------------------------------
def flag_calls(func):
"""Wrap a function to detect and flag when it gets called.
This is a decorator which takes a function and wraps it in a function with
a 'called' attribute. wrapper.called is initialized to False.
The wrapper.called attribute is set to False right before each call to the
wrapped function, so if the call fails it remains False. After the call
completes, wrapper.called is set to True and the output is returned.
Testing for truth in wrapper.called allows you to determine if a call to
func() was attempted and succeeded."""
def wrapper(*args,**kw):
wrapper.called = False
out = func(*args,**kw)
wrapper.called = True
return out
wrapper.called = False
wrapper.__doc__ = func.__doc__
return wrapper
#----------------------------------------------------------------------------
def dhook_wrap(func,*a,**k):
"""Wrap a function call in a sys.displayhook controller.
Returns a wrapper around func which calls func, with all its arguments and
keywords unmodified, using the default sys.displayhook. Since IPython
modifies sys.displayhook, it breaks the behavior of certain systems that
rely on the default behavior, notably doctest.
"""
def f(*a,**k):
dhook_s = sys.displayhook
sys.displayhook = sys.__displayhook__
try:
out = func(*a,**k)
finally:
sys.displayhook = dhook_s
return out
f.__doc__ = func.__doc__
return f
#----------------------------------------------------------------------------
def doctest_reload():
"""Properly reload doctest to reuse it interactively.
This routine:
- imports doctest but does NOT reload it (see below).
- resets its global 'master' attribute to None, so that multiple uses of
the module interactively don't produce cumulative reports.
- Monkeypatches its core test runner method to protect it from IPython's
modified displayhook. Doctest expects the default displayhook behavior
deep down, so our modification breaks it completely. For this reason, a
hard monkeypatch seems like a reasonable solution rather than asking
users to manually use a different doctest runner when under IPython.
Notes
-----
This function *used to* reload doctest, but this has been disabled because
reloading doctest unconditionally can cause massive breakage of other
doctest-dependent modules already in memory, such as those for IPython's
own testing system. The name wasn't changed to avoid breaking people's
code, but the reload call isn't actually made anymore."""
import doctest
doctest.master = None
doctest.DocTestRunner.run = dhook_wrap(doctest.DocTestRunner.run)
#----------------------------------------------------------------------------
class HomeDirError(Error):
pass
def get_home_dir():
"""Return the closest possible equivalent to a 'home' directory.
We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH.
Currently only Posix and NT are implemented, a HomeDirError exception is
raised for all other OSes. """
isdir = os.path.isdir
env = os.environ
# first, check py2exe distribution root directory for _ipython.
# This overrides all. Normally does not exist.
if hasattr(sys, "frozen"): #Is frozen by py2exe
if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file
root, rest = IPython.__file__.lower().split('library.zip')
else:
root=os.path.join(os.path.split(IPython.__file__)[0],"../../")
root=os.path.abspath(root).rstrip('\\')
if isdir(os.path.join(root, '_ipython')):
os.environ["IPYKITROOT"] = root
return root
try:
homedir = env['HOME']
if not isdir(homedir):
# in case a user stuck some string which does NOT resolve to a
# valid path, it's as good as if we hadn't foud it
raise KeyError
return homedir
except KeyError:
if os.name == 'posix':
raise HomeDirError,'undefined $HOME, IPython can not proceed.'
elif os.name == 'nt':
# For some strange reason, win9x returns 'nt' for os.name.
try:
homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH'])
if not isdir(homedir):
homedir = os.path.join(env['USERPROFILE'])
if not isdir(homedir):
raise HomeDirError
return homedir
except KeyError:
try:
# Use the registry to get the 'My Documents' folder.
import _winreg as wreg
key = wreg.OpenKey(wreg.HKEY_CURRENT_USER,
"Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders")
homedir = wreg.QueryValueEx(key,'Personal')[0]
key.Close()
if not isdir(homedir):
e = ('Invalid "Personal" folder registry key '
'typically "My Documents".\n'
'Value: %s\n'
'This is not a valid directory on your system.' %
homedir)
raise HomeDirError(e)
return homedir
except HomeDirError:
raise
except:
return 'C:\\'
elif os.name == 'dos':
# Desperate, may do absurd things in classic MacOS. May work under DOS.
return 'C:\\'
else:
raise HomeDirError,'support for your operating system not implemented.'
def get_ipython_dir():
"""Get the IPython directory for this platform and user.
This uses the logic in `get_home_dir` to find the home directory
and the adds either .ipython or _ipython to the end of the path.
"""
if os.name == 'posix':
ipdir_def = '.ipython'
else:
ipdir_def = '_ipython'
home_dir = get_home_dir()
ipdir = os.path.abspath(os.environ.get('IPYTHONDIR',
os.path.join(home_dir, ipdir_def)))
return ipdir.decode(sys.getfilesystemencoding())
def get_security_dir():
"""Get the IPython security directory.
This directory is the default location for all security related files,
including SSL/TLS certificates and FURL files.
If the directory does not exist, it is created with 0700 permissions.