/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/util.py

  • Committer: Tim Marston
  • Date: 2016-04-10 20:30:10 UTC
  • Revision ID: tim@ed.am-20160410203010-xt9rvf6mf74xh5g1
updated todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# util.py
 
2
#
 
3
# Copyright (C) 2013 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, stat, errno
 
23
 
 
24
 
 
25
def canonicalise_path( path ):
 
26
        """Return the canonicalised form of a path.  That is, the fully-qualified
 
27
        version of the supplied path, with ~ expanded to the user's home directory.
 
28
        The returned path is guaranteed to always begin and end with a '/'.
 
29
        """
 
30
        path = '/' + os.path.expanduser( path ).strip( '/' )
 
31
        return path if path == '/' else path + '/'
 
32
 
 
33
 
 
34
# Class to provide the switch functionality that C/C++ programmers are so used
 
35
# to but which is missing in python.  For more information, see
 
36
# http://code.activestate.com/recipes/410692-readable-switch-construction-without-lambdas-or-di/
 
37
class switch( object ):
 
38
 
 
39
        def __init__( self, value ):
 
40
                self.value = value
 
41
                self.fall = False
 
42
 
 
43
        def __iter__( self ):
 
44
                """Return the match method once, then stop
 
45
                """
 
46
                yield self.match
 
47
                raise StopIteration
 
48
 
 
49
        def match( self, *args ):
 
50
                """Indicate whether or not to enter a case suite
 
51
                """
 
52
                if self.fall or not args:
 
53
                        return True
 
54
                elif self.value in args:
 
55
                        self.fall = True
 
56
                        return True
 
57
                else:
 
58
                        return False
 
59
 
 
60
# enums
 
61
# see http://stackoverflow.com/a/1695250
 
62
def enum( **enums ):
 
63
    return type( 'Enum', (), enums )