← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/textfile.py

Merge from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/textfile.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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Utilities for distinguishing binary files from text files"""
 
18
 
 
19
from itertools import chain 
 
20
 
 
21
from bzrlib.errors import BinaryFile
 
22
from bzrlib.iterablefile import IterableFile
 
23
from bzrlib.osutils import file_iterator
 
24
 
 
25
 
 
26
def text_file(input):
 
27
    """Produce a file iterator that is guaranteed to be text, without seeking.
 
28
    BinaryFile is raised if the file contains a NUL in the first 1024 bytes.
 
29
    """
 
30
    first_chunk = input.read(1024)
 
31
    if '\x00' in first_chunk:
 
32
        raise BinaryFile()
 
33
    return IterableFile(chain((first_chunk,), file_iterator(input)))
 
34
 
 
35
 
 
36
def check_text_lines(lines):
 
37
    """Raise BinaryFile if the supplied lines contain NULs.
 
38
    Only the first 1024 characters are checked.
 
39
    """
 
40
    f = IterableFile(lines)
 
41
    if '\x00' in f.read(1024):
 
42
        raise BinaryFile()
 
43
 
 
44
 
 
45
def check_text_path(path):
 
46
    """Check whether the supplied path is a text, not binary file.
 
47
    Raise BinaryFile if a NUL occurs in the first 1024 bytes.
 
48
    """
 
49
    f = open(path, 'rb')
 
50
    try:
 
51
        text_file(f)
 
52
    finally:
 
53
        f.close()