forked from ipython/ipython
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mglob.py
203 lines (164 loc) · 6.54 KB
/
mglob.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
#!/usr/bin/env python
r""" mglob - enhanced file list expansion module
Use as stand-alone utility (for xargs, `backticks` etc.),
or a globbing library for own python programs. Globbing the sys.argv is something
that almost every Windows script has to perform manually, and this module is here
to help with that task. Also Unix users will benefit from enhanced modes
such as recursion, exclusion, directory omission...
Unlike glob.glob, directories are not included in the glob unless specified
with 'dir:'
'expand' is the function to use in python programs. Typical use
to expand argv (esp. in windows)::
try:
import mglob
files = mglob.expand(sys.argv[1:])
except ImportError:
print "mglob not found; try 'easy_install mglob' for extra features"
files = sys.argv[1:]
Note that for unix, shell expands *normal* wildcards (*.cpp, etc.) in argv.
Therefore, you might want to use quotes with normal wildcards to prevent this
expansion, in order for mglob to see the wildcards and get the wanted behaviour.
Not quoting the wildcards is harmless and typically has equivalent results, though.
Author: Ville Vainio <vivainio@gmail.com>
License: MIT Open Source license
"""
#Assigned in variable for "usage" printing convenience"
globsyntax = """\
This program allows specifying filenames with "mglob" mechanism.
Supported syntax in globs (wilcard matching patterns)::
*.cpp ?ellowo*
- obvious. Differs from normal glob in that dirs are not included.
Unix users might want to write this as: "*.cpp" "?ellowo*"
rec:/usr/share=*.txt,*.doc
- get all *.txt and *.doc under /usr/share,
recursively
rec:/usr/share
- All files under /usr/share, recursively
rec:*.py
- All .py files under current working dir, recursively
foo
- File or dir foo
!*.bak readme*
- readme*, exclude files ending with .bak
!.svn/ !.hg/ !*_Data/ rec:.
- Skip .svn, .hg, foo_Data dirs (and their subdirs) in recurse.
Trailing / is the key, \ does not work!
dir:foo
- the directory foo if it exists (not files in foo)
dir:*
- all directories in current folder
foo.py bar.* !h* rec:*.py
- Obvious. !h* exclusion only applies for rec:*.py.
foo.py is *not* included twice.
@filelist.txt
- All files listed in 'filelist.txt' file, on separate lines.
"""
__version__ = "0.2"
import os,glob,fnmatch,sys
from sets import Set as set
def expand(flist,exp_dirs = False):
""" Expand the glob(s) in flist.
flist may be either a whitespace-separated list of globs/files
or an array of globs/files.
if exp_dirs is true, directory names in glob are expanded to the files
contained in them - otherwise, directory names are returned as is.
"""
if isinstance(flist, basestring):
flist = flist.split()
done_set = set()
denied_set = set()
def recfind(p, pats = ["*"]):
denied_dirs = ["*" + d+"*" for d in denied_set if d.endswith("/")]
#print "de", denied_dirs
for (dp,dnames,fnames) in os.walk(p):
# see if we should ignore the whole directory
dp_norm = dp.replace("\\","/") + "/"
deny = False
#print "dp",dp
for deny_pat in denied_dirs:
if fnmatch.fnmatch( dp_norm, deny_pat):
deny = True
break
if deny:
continue
for f in fnames:
matched = False
for p in pats:
if fnmatch.fnmatch(f,p):
matched = True
break
if matched:
yield os.path.join(dp,f)
def once_filter(seq):
for it in seq:
p = os.path.abspath(it)
if p in done_set:
continue
done_set.add(p)
deny = False
for deny_pat in denied_set:
if fnmatch.fnmatch(os.path.basename(p), deny_pat):
deny = True
break
if not deny:
yield it
return
res = []
for ent in flist:
ent = os.path.expanduser(os.path.expandvars(ent))
if ent.lower().startswith('rec:'):
fields = ent[4:].split('=')
if len(fields) == 2:
pth, patlist = fields
elif len(fields) == 1:
if os.path.isdir(fields[0]):
# single arg is dir
pth, patlist = fields[0], '*'
else:
# single arg is pattern
pth, patlist = '.', fields[0]
elif len(fields) == 0:
pth, pathlist = '.','*'
pats = patlist.split(',')
res.extend(once_filter(recfind(pth, pats)))
# filelist
elif ent.startswith('@') and os.path.isfile(ent[1:]):
res.extend(once_filter(open(ent[1:]).read().splitlines()))
# exclusion
elif ent.startswith('!'):
denied_set.add(ent[1:])
# glob only dirs
elif ent.lower().startswith('dir:'):
res.extend(once_filter(filter(os.path.isdir,glob.glob(ent[4:]))))
# get all files in the specified dir
elif os.path.isdir(ent) and exp_dirs:
res.extend(once_filter(filter(os.path.isfile,glob.glob(ent + os.sep+"*"))))
# glob only files
elif '*' in ent or '?' in ent:
res.extend(once_filter(filter(os.path.isfile,glob.glob(ent))))
else:
res.extend(once_filter([ent]))
return res
def test():
assert (
expand("*.py ~/.ipython/*.py rec:/usr/share/doc-base") ==
expand( ['*.py', '~/.ipython/*.py', 'rec:/usr/share/doc-base'] )
)
def main():
if len(sys.argv) < 2:
print globsyntax
return
print "\n".join(expand(sys.argv[1:])),
def mglob_f(self, arg):
from IPython.genutils import SList
if arg.strip():
return SList(expand(arg))
print "Please specify pattern!"
print globsyntax
def init_ipython(ip):
""" register %mglob for IPython """
mglob_f.__doc__ = globsyntax
ip.expose_magic("mglob",mglob_f)
# test()
if __name__ == "__main__":
main()