/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/api.py

  • Committer: Andrew Bennetts
  • Date: 2009-10-21 11:13:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4762.
  • Revision ID: andrew.bennetts@canonical.com-20091021111340-w7x4d5yf83qwjncc
Add test that WSGI glue allows request handlers to access paths above that request's. backing transport, so long as it is within the WSGI app's backing transport.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/api.py
 
1
# Copyright (C) 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Library API versioning support.
 
18
 
 
19
Added in bzrlib 0.18 this allows export of compatibility information about
 
20
bzrlib. Please see doc/developers/api-versioning.txt for design details and
 
21
examples.
 
22
"""
 
23
 
 
24
import bzrlib
 
25
from bzrlib.lazy_import import lazy_import
 
26
lazy_import(globals(), """
 
27
from bzrlib.errors import IncompatibleAPI
 
28
""")
 
29
 
 
30
 
 
31
def get_current_api_version(object_with_api):
 
32
    """Return the API version tuple for object_with_api.
 
33
 
 
34
    :param object_with_api: An object to look for an API version on. If the
 
35
        object has a api_current_version attribute, that is used. Otherwise if
 
36
        there is a version_info attribute, its first three elements are used.
 
37
        Finally if there was no version_info attribute, the current api version
 
38
        of bzrlib itself is used.
 
39
 
 
40
    Added in bzrlib 0.18.
 
41
    """
 
42
    try:
 
43
        return object_with_api.api_current_version
 
44
    except AttributeError:
 
45
        try:
 
46
            return object_with_api.version_info[0:3]
 
47
        except AttributeError:
 
48
            return get_current_api_version(bzrlib)
 
49
 
 
50
 
 
51
def get_minimum_api_version(object_with_api):
 
52
    """Return the minimum API version supported by object_with_api.
 
53
 
 
54
    :param object_with_api: An object to look for an API version on. If the
 
55
        object has a api_minimum_version attribute, that is used. Otherwise the
 
56
        minimum api version of bzrlib itself is used.
 
57
 
 
58
    Added in bzrlib 0.18.
 
59
    """
 
60
    try:
 
61
        return object_with_api.api_minimum_version
 
62
    except AttributeError:
 
63
        return get_minimum_api_version(bzrlib)
 
64
 
 
65
 
 
66
def require_api(object_with_api, wanted_api):
 
67
    """Check if object_with_api supports the api version wanted_api.
 
68
 
 
69
    :param object_with_api: An object which exports an API minimum and current
 
70
        version. See get_minimum_api_version and get_current_api_version for
 
71
        details.
 
72
    :param wanted_api: The API version for which support is required.
 
73
    :return: None
 
74
    :raises IncompatibleAPI: When the wanted_api is not supported by
 
75
        object_with_api.
 
76
 
 
77
    Added in bzrlib 0.18.
 
78
    """
 
79
    current = get_current_api_version(object_with_api)
 
80
    minimum = get_minimum_api_version(object_with_api)
 
81
    if wanted_api < minimum or wanted_api > current:
 
82
        raise IncompatibleAPI(object_with_api, wanted_api, minimum, current)
 
83
 
 
84
 
 
85
def require_any_api(object_with_api, wanted_api_list):
 
86
    """Check if object_with_api supports the api version wanted_api.
 
87
 
 
88
    :param object_with_api: An object which exports an API minimum and current
 
89
        version. See get_minimum_api_version and get_current_api_version for
 
90
        details.
 
91
    :param wanted_api: A list of API versions, any of which being available is
 
92
        sufficent.
 
93
    :return: None
 
94
    :raises IncompatibleAPI: When the wanted_api is not supported by
 
95
        object_with_api.
 
96
 
 
97
    Added in bzrlib 1.9.
 
98
    """
 
99
    for api in wanted_api_list[:-1]:
 
100
        try:
 
101
            return require_api(object_with_api, api)
 
102
        except IncompatibleAPI:
 
103
            pass
 
104
    require_api(object_with_api, wanted_api_list[-1])