/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/cache_utf8.py

  • Committer: Vincent Ladeuil
  • Date: 2010-01-25 15:55:48 UTC
  • mto: (4985.1.4 add-attr-cleanup)
  • mto: This revision was merged to the branch mainline in revision 4988.
  • Revision ID: v.ladeuil+lp@free.fr-20100125155548-0l352pujvt5bzl5e
Deploy addAttrCleanup on the whole test suite.

Several use case worth mentioning:

- setting a module or any other object attribute is the majority
by far. In some cases the setting itself is deferred but most of
the time we want to set at the same time we add the cleanup.

- there multiple occurrences of protecting hooks or ui factory
which are now useless (the test framework takes care of that now),

- there was some lambda uses that can now be avoided.

That first cleanup already simplifies things a lot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cache_utf8.py
 
1
# Copyright (C) 2006 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
# TODO: Some kind of command-line display of revision properties:
 
18
# perhaps show them in log -v and allow them as options to the commit command.
 
19
 
 
20
"""Some functions to enable caching the conversion between unicode to utf8"""
 
21
 
 
22
import codecs
 
23
 
 
24
 
 
25
_utf8_encode = codecs.utf_8_encode
 
26
_utf8_decode = codecs.utf_8_decode
 
27
def _utf8_decode_with_None(bytestring, _utf8_decode=_utf8_decode):
 
28
    """wrap _utf8_decode to support None->None for optional strings.
 
29
 
 
30
    Also, only return the Unicode portion, since we don't care about the second
 
31
    return value.
 
32
    """
 
33
    if bytestring is None:
 
34
        return None
 
35
    else:
 
36
        return _utf8_decode(bytestring)[0]
 
37
 
 
38
# Map revisions from and to utf8 encoding
 
39
# Whenever we do an encode/decode operation, we save the result, so that
 
40
# we don't have to do it again.
 
41
_unicode_to_utf8_map = {}
 
42
_utf8_to_unicode_map = {}
 
43
 
 
44
 
 
45
def encode(unicode_str,
 
46
           _uni_to_utf8=_unicode_to_utf8_map,
 
47
           _utf8_to_uni=_utf8_to_unicode_map,
 
48
           _utf8_encode=_utf8_encode):
 
49
    """Take this unicode revision id, and get a unicode version"""
 
50
    # If the key is in the cache try/KeyError is 50% faster than
 
51
    # val = dict.get(key), if val is None:
 
52
    # On jam's machine the difference is
 
53
    # try/KeyError:  900ms
 
54
    #      if None: 1250ms
 
55
    # Since these are primarily used when iterating over a knit entry
 
56
    # *most* of the time the key will already be in the cache, so use the
 
57
    # fast path
 
58
    try:
 
59
        return _uni_to_utf8[unicode_str]
 
60
    except KeyError:
 
61
        _uni_to_utf8[unicode_str] = utf8_str = _utf8_encode(unicode_str)[0]
 
62
        _utf8_to_uni[utf8_str] = unicode_str
 
63
        return utf8_str
 
64
 
 
65
 
 
66
def decode(utf8_str,
 
67
           _uni_to_utf8=_unicode_to_utf8_map,
 
68
           _utf8_to_uni=_utf8_to_unicode_map,
 
69
           _utf8_decode=_utf8_decode):
 
70
    """Take a utf8 revision id, and decode it, but cache the result"""
 
71
    try:
 
72
        return _utf8_to_uni[utf8_str]
 
73
    except KeyError:
 
74
        unicode_str = _utf8_decode(utf8_str)[0]
 
75
        _utf8_to_uni[utf8_str] = unicode_str
 
76
        _uni_to_utf8[unicode_str] = utf8_str
 
77
        return unicode_str
 
78
 
 
79
 
 
80
def get_cached_unicode(unicode_str):
 
81
    """Return a cached version of the unicode string.
 
82
 
 
83
    This has a similar idea to that of intern() in that it tries
 
84
    to return a singleton string. Only it works for unicode strings.
 
85
    """
 
86
    # This might return the same object, or it might return the cached one
 
87
    # the decode() should just be a hash lookup, because the encode() side
 
88
    # should add the entry to the maps
 
89
    return decode(encode(unicode_str))
 
90
 
 
91
 
 
92
def get_cached_utf8(utf8_str):
 
93
    """Return a cached version of the utf-8 string.
 
94
 
 
95
    Get a cached version of this string (similar to intern()).
 
96
    At present, this will be decoded to ensure it is a utf-8 string. In the
 
97
    future this might change to simply caching the string.
 
98
    """
 
99
    return encode(decode(utf8_str))
 
100
 
 
101
 
 
102
def get_cached_ascii(ascii_str,
 
103
                     _uni_to_utf8=_unicode_to_utf8_map,
 
104
                     _utf8_to_uni=_utf8_to_unicode_map):
 
105
    """This is a string which is identical in utf-8 and unicode."""
 
106
    # We don't need to do any encoding, but we want _utf8_to_uni to return a
 
107
    # real Unicode string. Unicode and plain strings of this type will have the
 
108
    # same hash, so we can just use it as the key in _uni_to_utf8, but we need
 
109
    # the return value to be different in _utf8_to_uni
 
110
    ascii_str = _uni_to_utf8.setdefault(ascii_str, ascii_str)
 
111
    _utf8_to_uni.setdefault(ascii_str, unicode(ascii_str))
 
112
    return ascii_str
 
113
 
 
114
 
 
115
def clear_encoding_cache():
 
116
    """Clear the encoding and decoding caches"""
 
117
    _unicode_to_utf8_map.clear()
 
118
    _utf8_to_unicode_map.clear()