/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome

« back to all changes in this revision

Viewing changes to lib/stdhome/walker/walker.py

  • Committer: Tim Marston
  • Date: 2016-04-10 20:29:46 UTC
  • Revision ID: tim@ed.am-20160410202946-9eoh5i3et9443aq6
fixed greps in tools/dev to detect home-dir lines in stdhomerc

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# walker.py
 
2
#
 
3
# Copyright (C) 2013 to 2014 Tim Marston <tim@edm.am>
 
4
#
 
5
# This file is part of stdhome (hereafter referred to as "this program").
 
6
# See http://ed.am/dev/stdhome for more information.
 
7
#
 
8
# This program is free software: you can redistribute it and/or modify
 
9
# it under the terms of the GNU General Public License as published by
 
10
# the Free Software Foundation, either version 3 of the License, or
 
11
# (at your option) any later version.
 
12
#
 
13
# This program is distributed in the hope that it will be useful,
 
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
16
# GNU General Public License for more details.
 
17
#
 
18
# You should have received a copy of the GNU General Public License
 
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
20
 
 
21
 
 
22
import os
 
23
import stdhome.the as the
 
24
 
 
25
 
 
26
class Walker:
 
27
        """Classes which derive from the Walker class are intended to walk through
 
28
        (traverse) a single list of filenames in two locations.  They must provide
 
29
        the two locations (src_dir and dst_dir) and a list of relative filenames
 
30
        (walk_list).  For each files in the walk list, the process() method is
 
31
        called, allowing the deriving class to perform some kind of processing.  See
 
32
        process() for more information.
 
33
        """
 
34
 
 
35
        def walk( self ):
 
36
                """Iterates over self.walk_list, calling process() for each entry in turn.  For
 
37
                directory entries, where process() returns False, subsequent entries in
 
38
                walk_list that fall under the directory are skipped.
 
39
                """
 
40
 
 
41
                skip = ''
 
42
 
 
43
                for rel_file in self.walk_list:
 
44
 
 
45
                        # if we're skipping, skip entries in subdirectories, or turn off
 
46
                        # skipping if it no longer matches
 
47
                        if skip:
 
48
                                if skip == rel_file[ : len( skip ) ]:
 
49
                                        continue
 
50
                                else:
 
51
                                        skip = ''
 
52
 
 
53
                        src = Walker.File( os.path.join( self.src_dir, rel_file ) )
 
54
                        dst = Walker.File( os.path.join( self.dst_dir, rel_file ) )
 
55
 
 
56
                        # process ths entry
 
57
                        recurse = self.process( rel_file, src, dst )
 
58
 
 
59
                        # Set up skipping, as required.  Note that we don't check to see if
 
60
                        # we're dealing with a directory here.  We can't, because we've no
 
61
                        # way of knowing what to check.  It could be src_type or dst_type
 
62
                        # (if src_dir or dst_dir was used to generate the walk list) or it
 
63
                        # could be neither (if the walk list came from somewhere else).  But
 
64
                        # it shouldn't matter.  We adding an os.pathset to the end of the
 
65
                        # filename, so it wuill only match files that are descendents of a
 
66
                        # directory with the name of this file.
 
67
                        if not recurse: skip = rel_file + os.sep
 
68
 
 
69
 
 
70
        class File:
 
71
 
 
72
                def __init__( self, full_file ):
 
73
                        self.file = full_file
 
74
                        if not os.path.exists( self.file ):
 
75
                                self.type = '_'
 
76
                        elif os.path.isfile( self.file ):
 
77
                                self.type = 'f'
 
78
                        elif os.path.isdir( self.file ):
 
79
                                self.type = 'd'
 
80
                        else:
 
81
                                self.type = '?'
 
82
                        if os.path.islink( self.file ):
 
83
                                self.link_type = self.type
 
84
                                self.type = 'l'
 
85
                        else:
 
86
                                self.link_type = False
 
87
 
 
88
                def get_type_name( self ):
 
89
                        if self.type == 'l': return 'symlink'
 
90
                        elif self.type == 'f': return 'file'
 
91
                        elif self.type == 'd': return 'directory'
 
92
                        elif self.type == '_': return 'missing'
 
93
                        else: return 'unknown'
 
94
 
 
95
                def __str__( self ):
 
96
                        type = self.type
 
97
                        if( self.link_type ): type += '/' + self.link_type
 
98
                        return 'File( %s (%s) )' % ( self.file, type )
 
99
 
 
100
 
 
101
        @staticmethod
 
102
        def generate_walk_list( rel_file = '', full_dir = None ):
 
103
                """Returns a list of files and directories in full_dir, specified as relative
 
104
                files (relative to full_dir), breadth first.
 
105
                """
 
106
 
 
107
                # default place to walk
 
108
                if full_dir is None: full_dir = the.repo.full_dir
 
109
 
 
110
                # ignore some files
 
111
                if rel_file in [ '.bzr', '.bzrignore', '.stdhome', '.stdhomerc' ]:
 
112
                        return list()
 
113
 
 
114
                full_file = os.path.join( full_dir, rel_file )
 
115
 
 
116
                # files and links are returned
 
117
                if os.path.isfile( full_file ) or os.path.islink( full_file ):
 
118
                        return [ rel_file ]
 
119
 
 
120
                # directories are returned and recursed in to
 
121
                elif os.path.isdir( full_file ):
 
122
                        ret = [ rel_file ] if rel_file != '' else []
 
123
                        for file in os.listdir( full_file ):
 
124
                                ret.extend( Walker.generate_walk_list(
 
125
                                        os.path.join( rel_file, file ), full_dir ) )
 
126
                        return sorted( ret )
 
127
 
 
128
                # other kinds are invalid
 
129
                else:
 
130
                        raise RuntimeError(
 
131
                                'unknown/exotic file: %s' % full_file )