Mercurial > hg > config
annotate python/tree.py @ 558:db2d7026b531
bin/vpn-moz.sh
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Tue, 26 Nov 2013 13:46:07 -0800 |
parents | fbb5b143349a |
children | 93dc0507ab3b |
rev | line source |
---|---|
382 | 1 #!/usr/bin/env python |
2 # -*- coding: utf-8 -*- | |
3 | |
4 """ | |
5 tree in python | |
6 """ | |
7 | |
425 | 8 # TODO: script2package |
9 | |
382 | 10 import optparse |
11 import os | |
12 import sys | |
13 | |
387 | 14 # ASCII delimeters |
388 | 15 ascii_delimeters = { |
389 | 16 'vertical_line' : '|', |
17 'item_marker' : '+', | |
18 'last_child' : '\\' | |
388 | 19 } |
387 | 20 |
21 # unicode delimiters | |
389 | 22 unicode_delimeters = { |
23 'vertical_line' : '│', | |
24 'item_marker' : '├', | |
25 'last_child' : '└' | |
26 } | |
382 | 27 |
425 | 28 |
382 | 29 def depth(directory): |
387 | 30 """returns the integer depth of a directory or path relative to '/' """ |
31 | |
382 | 32 directory = os.path.abspath(directory) |
33 level = 0 | |
34 while True: | |
35 directory, remainder = os.path.split(directory) | |
36 level += 1 | |
37 if not remainder: | |
38 break | |
39 return level | |
40 | |
425 | 41 |
42 ### stuff for tree generalization | |
43 | |
44 class Tree(object): | |
45 """tree structure in python""" | |
46 | |
47 def __init__(self, parent=None): | |
48 self.parent = parent | |
426 | 49 self._children = [] |
425 | 50 |
51 def children(self): | |
52 """returns children of the tree""" | |
426 | 53 return self._children # base implementation |
425 | 54 |
55 def add(self, item): | |
56 """add a child to the tree root""" | |
57 | |
58 def update(self, tree): | |
59 """add a subtree to the tree""" | |
60 self.add(tree) | |
61 tree.parent = self # XXX .add should probably do this for scary reasons | |
62 | |
63 def output(self, serializer): | |
64 """output the tree via the given serializer""" | |
65 # XXX or should this method exist at all and instead the | |
66 # __call__ method of serializers take a Tree object? | |
67 | |
68 class DirectoryTree(Tree): | |
69 """directory structure as a tree""" | |
70 | |
429 | 71 def __init__(self, directory): |
72 self.directory = directory | |
73 self._return_type = os.path.abspath | |
74 | |
75 def children(self): | |
76 return os.listdir(self.directory) # -> self._return_type | |
77 | |
78 ## Serializers | |
79 | |
443 | 80 def tree2html(tree): |
81 """ | |
82 . | |
83 ├── a8e.py | |
84 ├── abstract.py | |
85 ├── accentuate.py | |
86 | |
87 -> | |
88 | |
89 <ul> | |
90 <li>a8e.py</li> | |
91 ... | |
92 """ | |
93 | |
94 | |
429 | 95 # How to serialize a tree -> JSON? |
96 | |
425 | 97 ### |
98 | |
388 | 99 def tree(directory, |
389 | 100 item_marker=unicode_delimeters['item_marker'], |
101 vertical_line=unicode_delimeters['vertical_line'], | |
102 last_child=unicode_delimeters['last_child'], | |
388 | 103 sort_key=lambda x: x.lower()): |
104 """ | |
105 display tree directory structure for `directory` | |
106 """ | |
383
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
107 |
385 | 108 retval = [] |
383
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
109 indent = [] |
384 | 110 last = {} |
386 | 111 top = depth(directory) |
112 | |
382 | 113 for dirpath, dirnames, filenames in os.walk(directory, topdown=True): |
383
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
114 |
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
115 abspath = os.path.abspath(dirpath) |
384 | 116 basename = os.path.basename(abspath) |
117 parent = os.path.dirname(abspath) | |
383
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
118 level = depth(abspath) - top |
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
119 |
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
120 # sort articles of interest |
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
121 for resource in (dirnames, filenames): |
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
122 resource[:] = sorted(resource, key=sort_key) |
382 | 123 |
389 | 124 files_end = item_marker |
125 dirpath_marker = item_marker | |
385 | 126 |
127 if level > len(indent): | |
389 | 128 indent.append(vertical_line) |
385 | 129 indent = indent[:level] |
130 | |
383
8d1ad56761b0
this still, somehow, eludes my tired brain
Jeff Hammel <jhammel@mozilla.com>
parents:
382
diff
changeset
|
131 if dirnames: |
389 | 132 files_end = item_marker |
385 | 133 last[abspath] = dirnames[-1] |
134 else: | |
389 | 135 files_end = last_child |
384 | 136 |
385 | 137 if last.get(parent) == os.path.basename(abspath): |
138 # last directory of parent | |
389 | 139 dirpath_mark = last_child |
385 | 140 indent[-1] = ' ' |
141 elif not indent: | |
142 dirpath_mark = '' | |
143 else: | |
389 | 144 dirpath_mark = item_marker |
385 | 145 |
388 | 146 # append the directory and piece of tree structure |
147 # if the top-level entry directory, print as passed | |
148 retval.append('%s%s%s'% (''.join(indent[:-1]), | |
149 dirpath_mark, | |
150 basename if retval else directory)) | |
151 # add the files | |
385 | 152 if filenames: |
153 last_file = filenames[-1] | |
387 | 154 retval.extend([('%s%s%s' % (''.join(indent), |
389 | 155 files_end if filename == last_file else item_marker, |
385 | 156 filename)) |
157 for index, filename in enumerate(filenames)]) | |
158 | |
382 | 159 return '\n'.join(retval) |
160 | |
161 def main(args=sys.argv[1:]): | |
162 | |
390
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
163 # parse command line options |
382 | 164 usage = '%prog [options]' |
165 parser = optparse.OptionParser(usage=usage, description=__doc__) | |
390
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
166 parser.add_option('-a', '--ascii', dest='use_ascii', |
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
167 action='store_true', default=False, |
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
168 help="use ascii delimeters (%s)" % ascii_delimeters) |
382 | 169 options, args = parser.parse_args(args) |
170 if not args: | |
171 args = ['.'] | |
172 | |
390
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
173 # sanity check |
382 | 174 not_directory = [arg for arg in args |
175 if not os.path.isdir(arg)] | |
176 if not_directory: | |
177 parser.error("Not a directory: %s" % (', '.join(not_directory))) | |
178 | |
390
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
179 delimeters = unicode_delimeters |
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
180 if options.use_ascii: |
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
181 delimeters = ascii_delimeters |
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
182 |
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
183 # print the tree |
382 | 184 for arg in args: |
390
9d02187611ae
make delimeters CLI switchable
Jeff Hammel <jhammel@mozilla.com>
parents:
389
diff
changeset
|
185 print (tree(arg, **delimeters)) |
382 | 186 |
187 if __name__ == '__main__': | |
188 main() |