← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/api.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/api.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007, 2008, 2009, 2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Library API versioning support.
18
18
 
21
21
examples.
22
22
"""
23
23
 
 
24
from __future__ import absolute_import
 
25
 
24
26
import bzrlib
25
 
from bzrlib.lazy_import import lazy_import
26
 
lazy_import(globals(), """
27
27
from bzrlib.errors import IncompatibleAPI
28
 
""")
29
28
 
30
29
 
31
30
def get_current_api_version(object_with_api):
70
69
        version. See get_minimum_api_version and get_current_api_version for
71
70
        details.
72
71
    :param wanted_api: The API version for which support is required.
73
 
    :return None:
 
72
    :return: None
74
73
    :raises IncompatibleAPI: When the wanted_api is not supported by
75
74
        object_with_api.
76
75
 
80
79
    minimum = get_minimum_api_version(object_with_api)
81
80
    if wanted_api < minimum or wanted_api > current:
82
81
        raise IncompatibleAPI(object_with_api, wanted_api, minimum, current)
 
82
 
 
83
 
 
84
def require_any_api(object_with_api, wanted_api_list):
 
85
    """Check if object_with_api supports the api version wanted_api.
 
86
 
 
87
    :param object_with_api: An object which exports an API minimum and current
 
88
        version. See get_minimum_api_version and get_current_api_version for
 
89
        details.
 
90
    :param wanted_api: A list of API versions, any of which being available is
 
91
        sufficent.
 
92
    :return: None
 
93
    :raises IncompatibleAPI: When the wanted_api is not supported by
 
94
        object_with_api.
 
95
 
 
96
    Added in bzrlib 1.9.
 
97
    """
 
98
    for api in wanted_api_list[:-1]:
 
99
        try:
 
100
            return require_api(object_with_api, api)
 
101
        except IncompatibleAPI:
 
102
            pass
 
103
    require_api(object_with_api, wanted_api_list[-1])