← Back to branch summary

~mbp/bzr/integration

« back to all changes in this revision

Viewing changes to bzrlib/directory_service.py

(jelmer) Allow registering new location aliases. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/directory_service.py
64
64
 
65
65
directories = DirectoryServiceRegistry()
66
66
 
67
 
 
68
67
class AliasDirectory(object):
69
68
    """Directory lookup for locations associated with a branch.
70
69
 
72
71
    supported.  On error, a subclass of DirectoryLookupFailure will be raised.
73
72
    """
74
73
 
 
74
    branch_aliases = registry.Registry()
 
75
    branch_aliases.register('parent', lambda b: b.get_parent(),
 
76
        help="The parent of this branch.")
 
77
    branch_aliases.register('submit', lambda b: b.get_submit_branch(),
 
78
        help="The submit branch for this branch.")
 
79
    branch_aliases.register('public', lambda b: b.get_public_branch(),
 
80
        help="The public location of this branch.")
 
81
    branch_aliases.register('bound', lambda b: b.get_bound_location(),
 
82
        help="The branch this branch is bound to, for bound branches.")
 
83
    branch_aliases.register('push', lambda b: b.get_push_location(),
 
84
        help="The saved location used for `bzr push` with no arguments.")
 
85
    branch_aliases.register('this', lambda b: b.base,
 
86
        help="This branch.")
 
87
 
75
88
    def look_up(self, name, url):
76
89
        branch = _mod_branch.Branch.open_containing('.')[0]
77
 
        lookups = {
78
 
            'parent': branch.get_parent,
79
 
            'submit': branch.get_submit_branch,
80
 
            'public': branch.get_public_branch,
81
 
            'bound': branch.get_bound_location,
82
 
            'push': branch.get_push_location,
83
 
            'this': lambda: branch.base
84
 
        }
85
90
        parts = url.split('/', 1)
86
91
        if len(parts) == 2:
87
92
            name, extra = parts
89
94
            (name,) = parts
90
95
            extra = None
91
96
        try:
92
 
            method = lookups[name[1:]]
 
97
            method = self.branch_aliases.get(name[1:])
93
98
        except KeyError:
94
99
            raise errors.InvalidLocationAlias(url)
95
100
        else:
96
 
            result = method()
 
101
            result = method(branch)
97
102
        if result is None:
98
103
            raise errors.UnsetLocationAlias(url)
99
104
        if extra is not None:
100
105
            result = urlutils.join(result, extra)
101
106
        return result
102
107
 
 
108
    @classmethod
 
109
    def help_text(cls, topic):
 
110
        alias_lines = []
 
111
        for key in cls.branch_aliases.keys():
 
112
            help = cls.branch_aliases.get_help(key)
 
113
            alias_lines.append("  :%-10s%s\n" % (key, help))
 
114
        return """\
 
115
Location aliases
 
116
================
 
117
 
 
118
Bazaar defines several aliases for locations associated with a branch.  These
 
119
can be used with most commands that expect a location, such as `bzr push`.
 
120
 
 
121
The aliases are::
 
122
 
 
123
%s
 
124
For example, to push to the parent location::
 
125
 
 
126
    bzr push :parent
 
127
""" % "".join(alias_lines)
 
128
 
 
129
 
103
130
directories.register(':', AliasDirectory,
104
131
                     'Easy access to remembered branch locations')