1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
# Copyright (C) 2008, 2009, 2011 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Directory service registration and usage.
Directory services are utilities that provide a mapping from URL-like strings
to true URLs. Examples include lp:urls and per-user location aliases.
"""
from __future__ import absolute_import
from bzrlib import (
errors,
registry,
)
from bzrlib.lazy_import import lazy_import
lazy_import(globals(), """
from bzrlib import (
branch as _mod_branch,
urlutils,
)
""")
class DirectoryServiceRegistry(registry.Registry):
"""This object maintains and uses a list of directory services.
Directory services may be registered via the standard Registry methods.
They will be invoked if their key is a prefix of the supplied URL.
Each item registered should be a factory of objects that provide a look_up
method, as invoked by dereference. Specifically, look_up should accept a
name and URL, and return a URL.
"""
def dereference(self, url):
"""Dereference a supplied URL if possible.
URLs that match a registered directory service prefix are looked up in
it. Non-matching urls are returned verbatim.
This is applied only once; the resulting URL must not be one that
requires further dereferencing.
:param url: The URL to dereference
:return: The dereferenced URL if applicable, the input URL otherwise.
"""
match = self.get_prefix(url)
if match is None:
return url
service, name = match
return service().look_up(name, url)
directories = DirectoryServiceRegistry()
class AliasDirectory(object):
"""Directory lookup for locations associated with a branch.
:parent, :submit, :public, :push, :this, and :bound are currently
supported. On error, a subclass of DirectoryLookupFailure will be raised.
"""
branch_aliases = registry.Registry()
branch_aliases.register('parent', lambda b: b.get_parent(),
help="The parent of this branch.")
branch_aliases.register('submit', lambda b: b.get_submit_branch(),
help="The submit branch for this branch.")
branch_aliases.register('public', lambda b: b.get_public_branch(),
help="The public location of this branch.")
branch_aliases.register('bound', lambda b: b.get_bound_location(),
help="The branch this branch is bound to, for bound branches.")
branch_aliases.register('push', lambda b: b.get_push_location(),
help="The saved location used for `bzr push` with no arguments.")
branch_aliases.register('this', lambda b: b.base,
help="This branch.")
def look_up(self, name, url):
branch = _mod_branch.Branch.open_containing('.')[0]
parts = url.split('/', 1)
if len(parts) == 2:
name, extra = parts
else:
(name,) = parts
extra = None
try:
method = self.branch_aliases.get(name[1:])
except KeyError:
raise errors.InvalidLocationAlias(url)
else:
result = method(branch)
if result is None:
raise errors.UnsetLocationAlias(url)
if extra is not None:
result = urlutils.join(result, extra)
return result
@classmethod
def help_text(cls, topic):
alias_lines = []
for key in cls.branch_aliases.keys():
help = cls.branch_aliases.get_help(key)
alias_lines.append(" :%-10s%s\n" % (key, help))
return """\
Location aliases
================
Bazaar defines several aliases for locations associated with a branch. These
can be used with most commands that expect a location, such as `bzr push`.
The aliases are::
%s
For example, to push to the parent location::
bzr push :parent
""" % "".join(alias_lines)
directories.register(':', AliasDirectory,
'Easy access to remembered branch locations')
|