← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml8.py

  • Committer: Martin Albisetti
  • Date: 2008-05-04 18:15:17 UTC
  • mto: (3431.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3432.
  • Revision ID: argentina@gmail.com-20080504181517-3kxwgf01sprjzje3
 * Added directory structure for docs en spanish
 * Added index file for docs in spanish

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml8.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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., 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
import cStringIO
18
18
import re
22
22
    errors,
23
23
    inventory,
24
24
    revision as _mod_revision,
25
 
    trace,
26
 
    )
27
 
from bzrlib.xml_serializer import (
28
 
    Element,
29
 
    SubElement,
30
 
    XMLSerializer,
31
 
    escape_invalid_chars,
32
 
    )
33
 
from bzrlib.inventory import InventoryEntry
 
25
    )
 
26
from bzrlib.xml_serializer import SubElement, Element, Serializer
 
27
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
34
28
from bzrlib.revision import Revision
35
29
from bzrlib.errors import BzrError
36
30
 
97
91
    # to check if None, rather than try/KeyError
98
92
    text = _map.get(unicode_or_utf8_str)
99
93
    if text is None:
100
 
        if unicode_or_utf8_str.__class__ is unicode:
 
94
        if unicode_or_utf8_str.__class__ == unicode:
101
95
            # The alternative policy is to do a regular UTF8 encoding
102
96
            # and then escape only XML meta characters.
103
97
            # Performance is equivalent once you use cache_utf8. *However*
133
127
    # This is fairly optimized because we know what cElementTree does, this is
134
128
    # not meant as a generic function for all cases. Because it is possible for
135
129
    # an 8-bit string to not be ascii or valid utf8.
136
 
    if a_str.__class__ is unicode:
 
130
    if a_str.__class__ == unicode:
137
131
        return _encode_utf8(a_str)
138
132
    else:
139
 
        return intern(a_str)
 
133
        return _get_cached_ascii(a_str)
140
134
 
141
135
 
142
136
def _clear_cache():
144
138
    _to_escaped_map.clear()
145
139
 
146
140
 
147
 
class Serializer_v8(XMLSerializer):
 
141
class Serializer_v8(Serializer):
148
142
    """This serialiser adds rich roots.
149
143
 
150
144
    Its revision format number matches its inventory number.
165
159
        """Extension point for subclasses to check during serialisation.
166
160
 
167
161
        :param inv: An inventory about to be serialised, to be checked.
168
 
        :raises: AssertionError if an error has occurred.
169
 
        """
170
 
        if inv.revision_id is None:
171
 
            raise AssertionError("inv.revision_id is None")
172
 
        if inv.root.revision is None:
173
 
            raise AssertionError("inv.root.revision is None")
174
 
 
175
 
    def _check_cache_size(self, inv_size, entry_cache):
176
 
        """Check that the entry_cache is large enough.
177
 
 
178
 
        We want the cache to be ~2x the size of an inventory. The reason is
179
 
        because we use a FIFO cache, and how Inventory records are likely to
180
 
        change. In general, you have a small number of records which change
181
 
        often, and a lot of records which do not change at all. So when the
182
 
        cache gets full, you actually flush out a lot of the records you are
183
 
        interested in, which means you need to recreate all of those records.
184
 
        An LRU Cache would be better, but the overhead negates the cache
185
 
        coherency benefit.
186
 
 
187
 
        One way to look at it, only the size of the cache > len(inv) is your
188
 
        'working' set. And in general, it shouldn't be a problem to hold 2
189
 
        inventories in memory anyway.
190
 
 
191
 
        :param inv_size: The number of entries in an inventory.
192
 
        """
193
 
        if entry_cache is None:
194
 
            return
195
 
        # 1.5 times might also be reasonable.
196
 
        recommended_min_cache_size = inv_size * 1.5
197
 
        if entry_cache.cache_size() < recommended_min_cache_size:
198
 
            recommended_cache_size = inv_size * 2
199
 
            trace.mutter('Resizing the inventory entry cache from %d to %d',
200
 
                         entry_cache.cache_size(), recommended_cache_size)
201
 
            entry_cache.resize(recommended_cache_size)
 
162
        :raises: AssertionError if an error has occured.
 
163
        """
 
164
        assert inv.revision_id is not None
 
165
        assert inv.root.revision is not None
202
166
 
203
167
    def write_inventory_to_lines(self, inv):
204
168
        """Return a list of lines with the encoded inventory."""
216
180
 
217
181
    def write_inventory(self, inv, f, working=False):
218
182
        """Write inventory to a file.
219
 
 
 
183
        
220
184
        :param inv: the inventory to write.
221
185
        :param f: the file to write. (May be None if the lines are the desired
222
186
            output).
346
310
            root.set('timezone', str(rev.timezone))
347
311
        root.text = '\n'
348
312
        msg = SubElement(root, 'message')
349
 
        msg.text = escape_invalid_chars(rev.message)[0]
 
313
        msg.text = rev.message
350
314
        msg.tail = '\n'
351
315
        if rev.parent_ids:
352
316
            pelts = SubElement(root, 'parents')
353
317
            pelts.tail = pelts.text = '\n'
354
318
            for parent_id in rev.parent_ids:
 
319
                assert isinstance(parent_id, basestring)
355
320
                _mod_revision.check_not_reserved_id(parent_id)
356
321
                p = SubElement(pelts, 'revision_ref')
357
322
                p.tail = '\n'
365
330
    def _pack_revision_properties(self, rev, under_element):
366
331
        top_elt = SubElement(under_element, 'properties')
367
332
        for prop_name, prop_value in sorted(rev.properties.items()):
 
333
            assert isinstance(prop_name, basestring) 
 
334
            assert isinstance(prop_value, basestring) 
368
335
            prop_elt = SubElement(top_elt, 'property')
369
336
            prop_elt.set('name', prop_name)
370
337
            prop_elt.text = prop_value
371
338
            prop_elt.tail = '\n'
372
339
        top_elt.tail = '\n'
373
340
 
374
 
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
375
 
                          return_from_cache=False):
 
341
    def _unpack_inventory(self, elt, revision_id=None):
376
342
        """Construct from XML Element"""
377
343
        if elt.tag != 'inventory':
378
344
            raise errors.UnexpectedInventoryFormat('Root tag is %r' % elt.tag)
385
351
            revision_id = cache_utf8.encode(revision_id)
386
352
        inv = inventory.Inventory(root_id=None, revision_id=revision_id)
387
353
        for e in elt:
388
 
            ie = self._unpack_entry(e, entry_cache=entry_cache,
389
 
                                    return_from_cache=return_from_cache)
 
354
            ie = self._unpack_entry(e)
390
355
            inv.add(ie)
391
 
        self._check_cache_size(len(inv), entry_cache)
 
356
        assert inv.root.revision is not None
392
357
        return inv
393
358
 
394
 
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
395
 
        elt_get = elt.get
396
 
        file_id = elt_get('file_id')
397
 
        revision = elt_get('revision')
398
 
        # Check and see if we have already unpacked this exact entry
399
 
        # Some timings for "repo.revision_trees(last_100_revs)"
400
 
        #               bzr     mysql
401
 
        #   unmodified  4.1s    40.8s
402
 
        #   using lru   3.5s
403
 
        #   using fifo  2.83s   29.1s
404
 
        #   lru._cache  2.8s
405
 
        #   dict        2.75s   26.8s
406
 
        #   inv.add     2.5s    26.0s
407
 
        #   no_copy     2.00s   20.5s
408
 
        #   no_c,dict   1.95s   18.0s
409
 
        # Note that a cache of 10k nodes is more than sufficient to hold all of
410
 
        # the inventory for the last 100 revs for bzr, but not for mysql (20k
411
 
        # is enough for mysql, which saves the same 2s as using a dict)
412
 
 
413
 
        # Breakdown of mysql using time.clock()
414
 
        #   4.1s    2 calls to element.get for file_id, revision_id
415
 
        #   4.5s    cache_hit lookup
416
 
        #   7.1s    InventoryFile.copy()
417
 
        #   2.4s    InventoryDirectory.copy()
418
 
        #   0.4s    decoding unique entries
419
 
        #   1.6s    decoding entries after FIFO fills up
420
 
        #   0.8s    Adding nodes to FIFO (including flushes)
421
 
        #   0.1s    cache miss lookups
422
 
        # Using an LRU cache
423
 
        #   4.1s    2 calls to element.get for file_id, revision_id
424
 
        #   9.9s    cache_hit lookup
425
 
        #   10.8s   InventoryEntry.copy()
426
 
        #   0.3s    cache miss lookus
427
 
        #   1.2s    decoding entries
428
 
        #   1.0s    adding nodes to LRU
429
 
        if entry_cache is not None and revision is not None:
430
 
            key = (file_id, revision)
431
 
            try:
432
 
                # We copy it, because some operations may mutate it
433
 
                cached_ie = entry_cache[key]
434
 
            except KeyError:
435
 
                pass
436
 
            else:
437
 
                # Only copying directory entries drops us 2.85s => 2.35s
438
 
                if return_from_cache:
439
 
                    if cached_ie.kind == 'directory':
440
 
                        return cached_ie.copy()
441
 
                    return cached_ie
442
 
                return cached_ie.copy()
443
 
 
 
359
    def _unpack_entry(self, elt):
444
360
        kind = elt.tag
445
361
        if not InventoryEntry.versionable_kind(kind):
446
362
            raise AssertionError('unsupported entry kind %s' % kind)
447
363
 
448
364
        get_cached = _get_utf8_or_ascii
449
365
 
450
 
        file_id = get_cached(file_id)
451
 
        if revision is not None:
452
 
            revision = get_cached(revision)
453
 
        parent_id = elt_get('parent_id')
 
366
        parent_id = elt.get('parent_id')
454
367
        if parent_id is not None:
455
368
            parent_id = get_cached(parent_id)
 
369
        file_id = get_cached(elt.get('file_id'))
456
370
 
457
371
        if kind == 'directory':
458
372
            ie = inventory.InventoryDirectory(file_id,
459
 
                                              elt_get('name'),
 
373
                                              elt.get('name'),
460
374
                                              parent_id)
461
375
        elif kind == 'file':
462
376
            ie = inventory.InventoryFile(file_id,
463
 
                                         elt_get('name'),
 
377
                                         elt.get('name'),
464
378
                                         parent_id)
465
 
            ie.text_sha1 = elt_get('text_sha1')
466
 
            if elt_get('executable') == 'yes':
 
379
            ie.text_sha1 = elt.get('text_sha1')
 
380
            if elt.get('executable') == 'yes':
467
381
                ie.executable = True
468
 
            v = elt_get('text_size')
 
382
            v = elt.get('text_size')
469
383
            ie.text_size = v and int(v)
470
384
        elif kind == 'symlink':
471
385
            ie = inventory.InventoryLink(file_id,
472
 
                                         elt_get('name'),
 
386
                                         elt.get('name'),
473
387
                                         parent_id)
474
 
            ie.symlink_target = elt_get('symlink_target')
 
388
            ie.symlink_target = elt.get('symlink_target')
475
389
        else:
476
390
            raise errors.UnsupportedInventoryKind(kind)
 
391
        revision = elt.get('revision')
 
392
        if revision is not None:
 
393
            revision = get_cached(revision)
477
394
        ie.revision = revision
478
 
        if revision is not None and entry_cache is not None:
479
 
            # We cache a copy() because callers like to mutate objects, and
480
 
            # that would cause the item in cache to mutate as well.
481
 
            # This has a small effect on many-inventory performance, because
482
 
            # the majority fraction is spent in cache hits, not misses.
483
 
            entry_cache[key] = ie.copy()
484
395
 
485
396
        return ie
486
397
 
487
398
    def _unpack_revision(self, elt):
488
399
        """XML Element -> Revision object"""
 
400
        assert elt.tag == 'revision'
489
401
        format = elt.get('format')
490
402
        format_num = self.format_num
491
403
        if self.revision_format_num is not None:
502
414
                       )
503
415
        parents = elt.find('parents') or []
504
416
        for p in parents:
 
417
            assert p.tag == 'revision_ref', \
 
418
                   "bad parent node tag %r" % p.tag
505
419
            rev.parent_ids.append(get_cached(p.get('revision_id')))
506
420
        self._unpack_revision_properties(elt, rev)
507
421
        v = elt.get('timezone')
515
429
    def _unpack_revision_properties(self, elt, rev):
516
430
        """Unpack properties onto a revision."""
517
431
        props_elt = elt.find('properties')
 
432
        assert len(rev.properties) == 0
518
433
        if not props_elt:
519
434
            return
520
435
        for prop_elt in props_elt:
521
 
            if prop_elt.tag != 'property':
522
 
                raise AssertionError(
523
 
                    "bad tag under properties list: %r" % prop_elt.tag)
 
436
            assert prop_elt.tag == 'property', \
 
437
                "bad tag under properties list: %r" % prop_elt.tag
524
438
            name = prop_elt.get('name')
525
439
            value = prop_elt.text
526
440
            # If a property had an empty value ('') cElementTree reads
528
442
            # properties have string values
529
443
            if value is None:
530
444
                value = ''
531
 
            if name in rev.properties:
532
 
                raise AssertionError("repeated property %r" % name)
 
445
            assert name not in rev.properties, \
 
446
                "repeated property %r" % name
533
447
            rev.properties[name] = value
534
448
 
535
449