← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/api.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/api.py
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Library API versioning support.
18
18
 
70
70
        version. See get_minimum_api_version and get_current_api_version for
71
71
        details.
72
72
    :param wanted_api: The API version for which support is required.
73
 
    :return: None
 
73
    :return None:
74
74
    :raises IncompatibleAPI: When the wanted_api is not supported by
75
75
        object_with_api.
76
76
 
80
80
    minimum = get_minimum_api_version(object_with_api)
81
81
    if wanted_api < minimum or wanted_api > current:
82
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])