77

I have a text file which contains a time stamp on each line. My goal is to find the time range. All the times are in order so the first line will be the earliest time and the last line will be the latest time. I only need the very first and very last line. What would be the most efficient way to get these lines in python?

Note: These files are relatively large in length, about 1-2 million lines each and I have to do this for several hundred files.

mik01aj
  • 11,150
  • 14
  • 71
  • 113
pasbino
  • 773
  • 1
  • 5
  • 4

12 Answers12

91

To read both the first and final line of a file you could...

  • open the file, ...
  • ... read the first line using built-in readline(), ...
  • ... seek (move the cursor) to the end of the file, ...
  • ... step backwards until you encounter EOL (line break) and ...
  • ... read the last line from there.
def readlastline(f):
    f.seek(-2, 2)              # Jump to the second last byte.
    while f.read(1) != b"\n":  # Until EOL is found ...
        f.seek(-2, 1)          # ... jump back, over the read byte plus one more.
    return f.read()            # Read all data from this point on.
    
with open(file, "rb") as f:
    first = f.readline()
    last = readlastline(f)

Jump to the second last byte directly to prevent trailing newline characters to cause empty lines to be returned*.

The current offset is pushed ahead by one every time a byte is read so the stepping backwards is done two bytes at a time, past the recently read byte and the byte to read next.

The whence parameter passed to fseek(offset, whence=0) indicates that fseek should seek to a position offset bytes relative to...

* As would be expected as the default behavior of most applications, including print and echo, is to append one to every line written and has no effect on lines missing trailing newline character.


Efficiency

1-2 million lines each and I have to do this for several hundred files.

I timed this method and compared it against against the top answer.

10k iterations processing a file of 6k lines totalling 200kB: 1.62s vs 6.92s.
100 iterations processing a file of 6k lines totalling 1.3GB: 8.93s vs 86.95.

Millions of lines would increase the difference a lot more.

Exakt code used for timing:

with open(file, "rb") as f:
    first = f.readline()     # Read and store the first line.
    for last in f: pass      # Read all lines, keep final value.

Amendment

A more complex, and harder to read, variation to address comments and issues raised since.

  • Return empty string when parsing empty file, raised by comment.
  • Return all content when no delimiter is found, raised by comment.
  • Avoid relative offsets to support text mode, raised by comment.
  • UTF16/UTF32 hack, noted by comment.

Also adds support for multibyte delimiters, readlast(b'X<br>Y', b'<br>', fixed=False).

Please note that this variation is really slow for large files because of the non-relative offsets needed in text mode. Modify to your need, or do not use it at all as you're probably better off using f.readlines()[-1] with files opened in text mode.

#!/bin/python3

from os import SEEK_END

def readlast(f, sep, fixed=True):
    r"""Read the last segment from a file-like object.

    :param f: File to read last line from.
    :type  f: file-like object
    :param sep: Segment separator (delimiter).
    :type  sep: bytes, str
    :param fixed: Treat data in ``f`` as a chain of fixed size blocks.
    :type  fixed: bool
    :returns: Last line of file.
    :rtype: bytes, str
    """
    bs   = len(sep)
    step = bs if fixed else 1
    if not bs:
        raise ValueError("Zero-length separator.")
    try:
        o = f.seek(0, SEEK_END)
        o = f.seek(o-bs-step)    # - Ignore trailing delimiter 'sep'.
        while f.read(bs) != sep: # - Until reaching 'sep': Read sep-sized block
            o = f.seek(o-step)   #  and then seek to the block to read next.
    except (OSError,ValueError): # - Beginning of file reached.
        f.seek(0)
    return f.read()

def test_readlast():
    from io import BytesIO, StringIO
    
    # Text mode.
    f = StringIO("first\nlast\n")
    assert readlast(f, "\n") == "last\n"
    
    # Bytes.
    f = BytesIO(b'first|last')
    assert readlast(f, b'|') == b'last'
    
    # Bytes, UTF-8.
    f = BytesIO("X\nY\n".encode("utf-8"))
    assert readlast(f, b'\n').decode() == "Y\n"
    
    # Bytes, UTF-16.
    f = BytesIO("X\nY\n".encode("utf-16"))
    assert readlast(f, b'\n\x00').decode('utf-16') == "Y\n"
  
    # Bytes, UTF-32.
    f = BytesIO("X\nY\n".encode("utf-32"))
    assert readlast(f, b'\n\x00\x00\x00').decode('utf-32') == "Y\n"
    
    # Multichar delimiter.
    f = StringIO("X<br>Y")
    assert readlast(f, "<br>", fixed=False) == "Y"
    
    # Make sure you use the correct delimiters.
    seps = { 'utf8': b'\n', 'utf16': b'\n\x00', 'utf32': b'\n\x00\x00\x00' }
    assert "\n".encode('utf8' )     == seps['utf8']
    assert "\n".encode('utf16')[2:] == seps['utf16']
    assert "\n".encode('utf32')[4:] == seps['utf32']
    
    # Edge cases.
    edges = (
        # Text , Match
        (""    , ""  ), # Empty file, empty string.
        ("X"   , "X" ), # No delimiter, full content.
        ("\n"  , "\n"),
        ("\n\n", "\n"),
        # UTF16/32 encoded U+270A (b"\n\x00\n'\n\x00"/utf16)
        (b'\n\xe2\x9c\x8a\n'.decode(), b'\xe2\x9c\x8a\n'.decode()),
    )
    for txt, match in edges:
        for enc,sep in seps.items():
            assert readlast(BytesIO(txt.encode(enc)), sep).decode(enc) == match

if __name__ == "__main__":
    import sys
    for path in sys.argv[1:]:
        with open(path) as f:
            print(f.readline()    , end="")
            print(readlast(f,"\n"), end="")
Trasp
  • 1,058
  • 7
  • 7
  • 4
    This is the most concise solution, and I like it. The nice part about not guessing a blocksize is that it works well with small test files. I added a few lines and wrapped it in a function I fondly call `tail_n`. – MarkHu Jun 27 '14 at 03:56
  • 1
    I love it on the paper but can't have it to work. `File "mapper1.2.2.py", line 17, in get_last_line f.seek(-2, 2) IOError: [Errno 22] Invalid argument` – Loïc Sep 29 '14 at 14:12
  • 2
    Nevermind, file was empty, derp. Best answer anyway. +1 – Loïc Sep 29 '14 at 14:22
  • 2
    As per [this comment](http://stackoverflow.com/a/31460631) as an answer, this `while f.read(1) != "\n":` should be `while f.read(1) != b"\n":` – Artjom B. Jul 17 '15 at 16:49
  • That is true for python 3, and it doesn't matter for python 2, so I've updated the answer accordingly. Thank you. – Trasp Dec 14 '15 at 21:29
  • 1
    For the records: if the file is UTF-16 encoded, replace ``f.seek(-2, 2)`` with ``f.seek(-4, 2)``, ``f.seek(-2, 1)`` with ``f.seek(-3, 1)`` and each ``f.readline()`` with ``f.readline() + '\x00'`` – Pietro Battiston Jan 14 '16 at 15:39
  • 5
    Also for the record: If you get the exception `io.UnsupportedOperation: can't do nonzero end-relative seeks`, you have to do it in two steps: first find the length of the file, then add the offset, then pass that to `f.seek(size+offset,os.SEEK_SET)` – AnotherParker Feb 08 '16 at 22:14
  • 1
    Such a simple solution! However if there is no b"\n" in the file. an IOError is thrown when a start of file is reached while seeking backwards. – LazyLeopard May 09 '18 at 11:34
  • why `f.seek(-2, os.SEEK_END)`? Do you assume there is always a '\n' at the end of the file and you want to avoid that? – Ruggero Turra Jul 12 '18 at 14:06
  • The above code returns error if there is only one line in the file and there is no \n at the end of the first line `with open(filename, "r") as f: first = f.readline() if f.read(1) == '': return first f.seek(-2, 2) # Jump to the second last byte. while f.read(1) != b"\n": # Until EOL is found... f.seek(-2, 1) # ...jump back the read byte plus one more. last = f.readline() # Read last line. return last` Modified the above code to return first line if there is only one line in file – user37940 Jul 29 '18 at 08:48
  • 1
    @PietroBattiston Great comment! But, if you still read one byte to compare against `b'\n'` like that it would break lines on any two byte UTF16 character that begins with `b'\n'`, like ✊. – Trasp Apr 08 '20 at 08:59
  • @RuggeroTurra No, I wouldn't say that. No extra line or character is read if the last byte of the file(s last line) is not a newline character (_\n_). – Trasp Apr 09 '20 at 11:26
  • For the record though, assuming good and common practice is to terminate lines written to files/buffers (with `b'\n'`) I also assumed that the expected behavior when a file/line ends with `b'\n'` would be to read the full line of text including the terminating `b'\n'`. For example, the expected result of a file created by running `{ echo "x"; echo "y";} > f` would most likely be `b'x', b'y'`, not `b'x', b''`. – Trasp Apr 09 '20 at 11:26
66

docs for io module

with open(fname, 'rb') as fh:
    first = next(fh).decode()

    fh.seek(-1024, 2)
    last = fh.readlines()[-1].decode()

The variable value here is 1024: it represents the average string length. I choose 1024 only for example. If you have an estimate of average line length you could just use that value times 2.

Since you have no idea whatsoever about the possible upper bound for the line length, the obvious solution would be to loop over the file:

for line in fh:
    pass
last = line

You don't need to bother with the binary flag you could just use open(fname).

ETA: Since you have many files to work on, you could create a sample of couple of dozens of files using random.sample and run this code on them to determine length of last line. With an a priori large value of the position shift (let say 1 MB). This will help you to estimate the value for the full run.

John Y
  • 13,437
  • 1
  • 45
  • 71
SilentGhost
  • 287,765
  • 61
  • 300
  • 288
  • As long as the lines aren't longer than 1024 characters. – FogleBird Jul 27 '10 at 18:08
  • There is no guarantee that the lines aren't longer than 1024 characters, there may be some other junk besides the timestamps on the line. – pasbino Jul 27 '10 at 18:10
  • @pasbino: do you have *some* upper bound? – SilentGhost Jul 27 '10 at 18:11
  • @pasbino: You can still use a similar approach in a loop until you find a full line. – FogleBird Jul 27 '10 at 18:12
  • Unfortunately, I have not seen every line of these files. From a quick glance some of these lines seem extremely long. I don't think I can estimate an upper bound safely. – pasbino Jul 27 '10 at 18:14
  • @pasbino: 1 MB? there is always possibility to check for EOL character in the cut off chunk and cut more. – SilentGhost Jul 27 '10 at 18:16
  • Hmmmmm thats what I feared. Currently I loop over the whole file and it takes a while. But I guess without a line length upper bound there is no faster way. – pasbino Jul 27 '10 at 18:18
  • The files are about 150 MB's in size – pasbino Jul 27 '10 at 18:20
  • @pasbino: 1 MB was an example of the length of last string. – SilentGhost Jul 27 '10 at 18:21
  • Uhmmm so depending on the file its different. I just checked on a few and it seems like they're only a few kilobytes – pasbino Jul 27 '10 at 18:26
  • Sorry for so many questions but how does the seek work in your first example? It means set the file's current position to 1024 bytes from the end of the file? – pasbino Jul 27 '10 at 18:37
  • @pasbino: yes. [docs](http://docs.python.org/library/io.html?highlight=seek#io.IOBase.seek) has more information. – SilentGhost Jul 27 '10 at 18:43
  • 20
    Using `fh.seek(-1024, os.SEEK_END)` instead of `fh.seek(-1024, 2)` increases readability. – marsl May 12 '14 at 16:31
  • 3
    The following is not true: *You don't need to bother with the binary flag you could just use `open(fname)`.* Opening with `b` flag is crucial. If you use `open(fname)` instead of `open(fname, 'rb')` you [will get](https://stackoverflow.com/questions/21533391/seeking-from-end-of-file-throwing-unsupported-exception) *io.UnsupportedOperation: can't do nonzero end-relative seeks*. – patryk.beza Jul 13 '17 at 07:08
25

Here's a modified version of SilentGhost's answer that will do what you want.

with open(fname, 'rb') as fh:
    first = next(fh)
    offs = -100
    while True:
        fh.seek(offs, 2)
        lines = fh.readlines()
        if len(lines)>1:
            last = lines[-1]
            break
        offs *= 2
    print first
    print last

No need for an upper bound for line length here.

mik01aj
  • 11,150
  • 14
  • 71
  • 113
10

Can you use unix commands? I think using head -1 and tail -n 1 are probably the most efficient methods. Alternatively, you could use a simple fid.readline() to get the first line and fid.readlines()[-1], but that may take too much memory.

beitar
  • 156
  • 4
6

This is my solution, compatible also with Python3. It does also manage border cases, but it misses utf-16 support:

def tail(filepath):
    """
    @author Marco Sulla (marcosullaroma@gmail.com)
    @date May 31, 2016
    """

    try:
        filepath.is_file
        fp = str(filepath)
    except AttributeError:
        fp = filepath

    with open(fp, "rb") as f:
        size = os.stat(fp).st_size
        start_pos = 0 if size - 1 < 0 else size - 1

        if start_pos != 0:
            f.seek(start_pos)
            char = f.read(1)

            if char == b"\n":
                start_pos -= 1
                f.seek(start_pos)

            if start_pos == 0:
                f.seek(start_pos)
            else:
                char = ""

                for pos in range(start_pos, -1, -1):
                    f.seek(pos)

                    char = f.read(1)

                    if char == b"\n":
                        break

        return f.readline()

It's ispired by Trasp's answer and AnotherParker's comment.

Community
  • 1
  • 1
Marco Sulla
  • 14,337
  • 13
  • 54
  • 92
4

First open the file in read mode.Then use readlines() method to read line by line.All the lines stored in a list.Now you can use list slices to get first and last lines of the file.

    a=open('file.txt','rb')
    lines = a.readlines()
    if lines:
        first_line = lines[:1]
        last_line = lines[-1]
4
w=open(file.txt, 'r')
print ('first line is : ',w.readline())
for line in w:  
    x= line
print ('last line is : ',x)
w.close()

The for loop runs through the lines and x gets the last line on the final iteration.

Mr. Llama
  • 19,374
  • 2
  • 54
  • 107
VipeR
  • 49
  • 1
  • This should be the accepted answer. I don't know why there's all this messing around with low level io in the other answers? – GreenAsJade Jun 21 '16 at 14:19
  • 3
    @GreenAsJade My understanding is that the "messing around" is to avoid reading the whole file from start to end. This might be inefficient on a large file. – bli Sep 14 '17 at 14:40
3
with open("myfile.txt") as f:
    lines = f.readlines()
    first_row = lines[0]
    print first_row
    last_row = lines[-1]
    print last_row
Riccardo Volpe
  • 1,303
  • 1
  • 14
  • 27
  • Can you explain why your solution will be better ? – Zulu Jan 31 '15 at 02:26
  • Hi, I found myself in the same need, to remove the last comma at level of the last line in a text file, and in this way I solved to locate it easily; I thought then to share it. This solution has been simple, practical and immediate, but I don't know if it is the fastest in terms of efficiency. What can you tell me about it? – Riccardo Volpe Feb 03 '15 at 02:26
  • Well, it has to read and process the entire file so it seems like the least efficient way. – rakslice May 01 '15 at 23:24
  • Ok...so, if you don't know the string length, which would be the best one method? I need to try the other one (http://stackoverflow.com/a/3346492/2149425). Thank you! – Riccardo Volpe May 04 '15 at 18:43
  • 1
    use `f.readlines()[-1]` insead of new variable. **0** = *First Line*, **1** = *Second Line*, **-1** = *Last Line*, **-2** = *Line Before Last Line*... – BladeMight Aug 05 '16 at 02:17
2

Here is an extension of @Trasp's answer that has additional logic for handling the corner case of a file that has only one line. It may be useful to handle this case if you repeatedly want to read the last line of a file that is continuously being updated. Without this, if you try to grab the last line of a file that has just been created and has only one line, IOError: [Errno 22] Invalid argument will be raised.

def tail(filepath):
    with open(filepath, "rb") as f:
        first = f.readline()      # Read the first line.
        f.seek(-2, 2)             # Jump to the second last byte.
        while f.read(1) != b"\n": # Until EOL is found...
            try:
                f.seek(-2, 1)     # ...jump back the read byte plus one more.
            except IOError:
                f.seek(-1, 1)
                if f.tell() == 0:
                    break
        last = f.readline()       # Read last line.
    return last
tony_tiger
  • 769
  • 1
  • 10
  • 23
2

Nobody mentioned using reversed:

f=open(file,"r")
r=reversed(f.readlines())
last_line_of_file = r.next()
1

Getting the first line is trivially easy. For the last line, presuming you know an approximate upper bound on the line length, os.lseek some amount from SEEK_END find the second to last line ending and then readline() the last line.

msw
  • 41,609
  • 8
  • 82
  • 107
1
with open(filename, "rb") as f:#Needs to be in binary mode for the seek from the end to work
    first = f.readline()
    if f.read(1) == '':
        return first
    f.seek(-2, 2)  # Jump to the second last byte.
    while f.read(1) != b"\n":  # Until EOL is found...
        f.seek(-2, 1)  # ...jump back the read byte plus one more.
    last = f.readline()  # Read last line.
    return last

The above answer is a modified version of the above answers which handles the case that there is only one line in the file

Okapi575
  • 569
  • 8
  • 22
user37940
  • 478
  • 1
  • 4
  • 15