← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/static_tuple.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/static_tuple.py
 
1
# Copyright (C) 2009, 2010 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
"""Interface thunk for a StaticTuple implementation."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
from bzrlib import debug
 
22
 
 
23
try:
 
24
    from bzrlib._static_tuple_c import StaticTuple
 
25
except ImportError, e:
 
26
    from bzrlib import osutils
 
27
    osutils.failed_to_load_extension(e)
 
28
    from bzrlib._static_tuple_py import StaticTuple
 
29
 
 
30
 
 
31
def expect_static_tuple(obj):
 
32
    """Check if the passed object is a StaticTuple.
 
33
 
 
34
    Cast it if necessary, but if the 'static_tuple' debug flag is set, raise an
 
35
    error instead.
 
36
 
 
37
    As apis are improved, we will probably eventually stop calling this as it
 
38
    adds overhead we shouldn't need.
 
39
    """
 
40
    if 'static_tuple' not in debug.debug_flags:
 
41
        return StaticTuple.from_sequence(obj)
 
42
    if type(obj) is not StaticTuple:
 
43
        raise TypeError('We expected a StaticTuple not a %s' % (type(obj),))
 
44
    return obj
 
45
 
 
46
 
 
47
def as_tuples(obj):
 
48
    """Ensure that the object and any referenced objects are plain tuples.
 
49
 
 
50
    :param obj: a list, tuple or StaticTuple
 
51
    :return: a plain tuple instance, with all children also being tuples.
 
52
    """
 
53
    result = []
 
54
    for item in obj:
 
55
        if isinstance(item, (tuple, list, StaticTuple)):
 
56
            item = as_tuples(item)
 
57
        result.append(item)
 
58
    return tuple(result)