← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/util.py

  • Committer: William Grant
  • Date: 2009-05-11 04:51:08 UTC
  • mto: (1165.3.65 submissions-admin)
  • mto: This revision was merged to the branch mainline in revision 1247.
  • Revision ID: grantw@unimelb.edu.au-20090511045108-z70ij6oti5cazyo4
Add an ivle-refreshfilesystem script, which currently just rewrites svn(-group).conf.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/util.py
22
22
# Contains common utility functions.
23
23
 
24
24
import os
25
 
import sys
26
 
import stat
27
25
 
28
26
class IVLEError(Exception):
29
27
    """Legacy general IVLE exception.
31
29
    This is the old "standard" exception class for IVLE errors. It is only
32
30
    used in fileservice, and should not be used in any new code.
33
31
    """
34
 
 
35
 
    message = None
36
 
 
37
32
    def __init__(self, httpcode, message=None):
38
33
        self.httpcode = httpcode
39
34
        self.message = message
99
94
    else:
100
95
        return tuple(splitpath)
101
96
 
102
 
def relpath(path, start=os.path.curdir):
103
 
    """Return a relative version of a path.
104
 
    XXX Backported from Python 2.6 posixpath.py.
105
 
    """
106
 
 
107
 
    if not path:
108
 
        raise ValueError("no path specified")
109
 
 
110
 
    start_list = os.path.abspath(start).split(os.path.sep)
111
 
    path_list = os.path.abspath(path).split(os.path.sep)
112
 
 
113
 
    # Work out how much of the filepath is shared by start and path.
114
 
    i = len(os.path.commonprefix([start_list, path_list]))
115
 
 
116
 
    rel_list = [os.path.pardir] * (len(start_list)-i) + path_list[i:]
117
 
    if not rel_list:
118
 
        return os.path.curdir
119
 
    return os.path.join(*rel_list)
120
 
 
121
97
def incomplete_utf8_sequence(byteseq):
122
98
    """Calculate the completeness of a UTF-8 encoded string.
123
99
 
197
173
        # Incomplete
198
174
        return count
199
175
 
200
 
def safe_rmtree(path, ignore_errors=False, onerror=None):
201
 
    """Recursively delete a directory tree.
202
 
 
203
 
    Copied from shutil.rmtree from Python 2.6, which does not follow symbolic
204
 
    links (it is otherwise unsafe to call as root on untrusted directories; do
205
 
    not use shutil.rmtree in this case, as you may be running Python 2.5).
206
 
 
207
 
    If ignore_errors is set, errors are ignored; otherwise, if onerror
208
 
    is set, it is called to handle the error with arguments (func,
209
 
    path, exc_info) where func is os.listdir, os.remove, or os.rmdir;
210
 
    path is the argument to that function that caused it to fail; and
211
 
    exc_info is a tuple returned by sys.exc_info().  If ignore_errors
212
 
    is false and onerror is None, an exception is raised.
213
 
 
214
 
    """
215
 
    if ignore_errors:
216
 
        def onerror(*args):
217
 
            pass
218
 
    elif onerror is None:
219
 
        def onerror(*args):
220
 
            raise
221
 
    try:
222
 
        if os.path.islink(path):
223
 
            # symlinks to directories are forbidden, see bug #1669
224
 
            raise OSError("Cannot call safe_rmtree on a symbolic link")
225
 
    except OSError:
226
 
        onerror(os.path.islink, path, sys.exc_info())
227
 
        # can't continue even if onerror hook returns
228
 
        return
229
 
    names = []
230
 
    try:
231
 
        names = os.listdir(path)
232
 
    except os.error, err:
233
 
        onerror(os.listdir, path, sys.exc_info())
234
 
    for name in names:
235
 
        fullname = os.path.join(path, name)
236
 
        try:
237
 
            mode = os.lstat(fullname).st_mode
238
 
        except os.error:
239
 
            mode = 0
240
 
        if stat.S_ISDIR(mode):
241
 
            safe_rmtree(fullname, ignore_errors, onerror)
242
 
        else:
243
 
            try:
244
 
                os.remove(fullname)
245
 
            except os.error, err:
246
 
                onerror(os.remove, fullname, sys.exc_info())
247
 
    try:
248
 
        os.rmdir(path)
249
 
    except os.error:
250
 
        onerror(os.rmdir, path, sys.exc_info())
251
 
 
252
 
def format_submission_principal(user, principal):
253
 
    """Render a list of users to fit in the offering project listing.
254
 
 
255
 
    Given a user and a list of submitters, returns 'solo' if the
256
 
    only submitter is the user, or a string of the form
257
 
    'with A, B and C' if there are any other submitters.
258
 
 
259
 
    If submitters is None, we assume that the list of members could
260
 
    not be determined, so we just return 'group'.
261
 
    """
262
 
    if principal is None:
263
 
        return 'group'
264
 
 
265
 
    if principal is user:
266
 
        return 'solo'
267
 
 
268
 
    display_names = sorted(
269
 
        member.display_name for member in principal.members
270
 
        if member is not user)
271
 
 
272
 
    if len(display_names) == 0:
273
 
        return 'solo (%s)' % principal.name
274
 
    elif len(display_names) == 1:
275
 
        return 'with %s (%s)' % (display_names[0], principal.name)
276
 
    elif len(display_names) > 5:
277
 
        return 'with %d others (%s)' % (len(display_names), principal.name)
278
 
    else:
279
 
        return 'with %s and %s (%s)' % (', '.join(display_names[:-1]),
280
 
                                        display_names[-1], principal.name)
 
176
def object_to_dict(attrnames, obj):
 
177
    """Convert an object into a dictionary.
 
178
 
 
179
    This takes a shallow copy of the object.
 
180
 
 
181
    @param attrnames: Set (or iterable) of names of attributes to be copied
 
182
                      into the dictionary. (We don't auto-lookup, because this
 
183
                      function needs to be used on magical objects).
 
184
    """
 
185
    return dict((k, getattr(obj, k))
 
186
        for k in attrnames if not k.startswith('_'))