← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/directory_service.py

  • Committer: Martin Pool
  • Date: 2005-07-05 09:04:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050705090423-e41ae78e4986e5a1
- handle chunks which differ from the base but agree

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/directory_service.py
1
 
# Copyright (C) 2008 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
"""Directory service registration and usage.
18
 
 
19
 
Directory services are utilities that provide a mapping from URL-like strings
20
 
to true URLs.  Examples include lp:urls and per-user location aliases.
21
 
"""
22
 
 
23
 
from bzrlib import registry
24
 
 
25
 
class DirectoryServiceRegistry(registry.Registry):
26
 
    """This object maintains and uses a list of directory services.
27
 
 
28
 
    Directory services may be registered via the standard Registry methods.
29
 
    They will be invoked if their key is a prefix of the supplied URL.
30
 
 
31
 
    Each item registered should be a factory of objects that provide a look_up
32
 
    method, as invoked by dereference.  Specifically, look_up should accept a
33
 
    name and URL, and return a URL.
34
 
    """
35
 
 
36
 
    def dereference(self, url):
37
 
        """Dereference a supplied URL if possible.
38
 
 
39
 
        URLs that match a registered directory service prefix are looked up in
40
 
        it.  Non-matching urls are returned verbatim.
41
 
 
42
 
        This is applied only once; the resulting URL must not be one that
43
 
        requires further dereferencing.
44
 
 
45
 
        :param url: The URL to dereference
46
 
        :return: The dereferenced URL if applicable, the input URL otherwise.
47
 
        """
48
 
        match = self.get_prefix(url)
49
 
        if match is None:
50
 
            return url
51
 
        service, name = match
52
 
        return service().look_up(name, url)
53
 
 
54
 
directories = DirectoryServiceRegistry()