← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/_static_tuple_py.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.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
"""The pure-python implementation of the StaticTuple type.
 
18
 
 
19
Note that it is generally just implemented as using tuples of tuples of
 
20
strings.
 
21
"""
 
22
 
 
23
from __future__ import absolute_import
 
24
 
 
25
 
 
26
class StaticTuple(tuple):
 
27
    """A static type, similar to a tuple of strings."""
 
28
 
 
29
    __slots__ = ()
 
30
 
 
31
    def __new__(cls, *args):
 
32
        # Make the empty StaticTuple a singleton
 
33
        if not args and _empty_tuple is not None:
 
34
            return _empty_tuple
 
35
        return tuple.__new__(cls, args)
 
36
 
 
37
    def __init__(self, *args):
 
38
        """Create a new 'StaticTuple'"""
 
39
        num_keys = len(args)
 
40
        if num_keys < 0 or num_keys > 255:
 
41
            raise TypeError('StaticTuple(...) takes from 0 to 255 items')
 
42
        for bit in args:
 
43
            if type(bit) not in (str, StaticTuple, unicode, int, long, float,
 
44
                                 None.__class__, bool):
 
45
                raise TypeError('StaticTuple can only point to'
 
46
                    ' StaticTuple, str, unicode, int, long, float, bool, or'
 
47
                    ' None not %s' % (type(bit),))
 
48
        # We don't need to pass args to tuple.__init__, because that was
 
49
        # already handled in __new__.
 
50
        tuple.__init__(self)
 
51
 
 
52
    def __repr__(self):
 
53
        return '%s%s' % (self.__class__.__name__, tuple.__repr__(self))
 
54
 
 
55
    def __reduce__(self):
 
56
        return (StaticTuple, tuple(self))
 
57
 
 
58
    def __add__(self, other):
 
59
        """Concatenate self with other"""
 
60
        return StaticTuple.from_sequence(tuple.__add__(self,other))
 
61
 
 
62
    def as_tuple(self):
 
63
        return tuple(self)
 
64
 
 
65
    def intern(self):
 
66
        return _interned_tuples.setdefault(self, self)
 
67
 
 
68
    @staticmethod
 
69
    def from_sequence(seq):
 
70
        """Convert a sequence object into a StaticTuple instance."""
 
71
        if isinstance(seq, StaticTuple):
 
72
            # it already is
 
73
            return seq
 
74
        return StaticTuple(*seq)
 
75
 
 
76
 
 
77
 
 
78
# Have to set it to None first, so that __new__ can determine whether
 
79
# the _empty_tuple singleton has been created yet or not.
 
80
_empty_tuple = None
 
81
_empty_tuple = StaticTuple()
 
82
_interned_tuples = {}