When splitting an empty string in Python, why does split() return an empty list while split('\n') returns ['']?

I am using split('\n') to get lines in one string, and found that ''.split() returns an empty list, [], while ''.split('\n') returns ['']. Is there any specific reason for such a difference?

And is there any more convenient way to count lines in a string?

Question: I am using split('\n') to get lines in one string, and found that ''.split() returns empty list [], while ''.split('\n') returns [''].

The str.split() method has two algorithms. If no arguments are given, it splits on repeated runs of whitespace. However, if an argument is given, it is treated as a single delimiter with no repeated runs.

In the case of splitting an empty string, the first mode (no argument) will return an empty list because the whitespace is eaten and there are no values to put in the result list.

In contrast, the second mode (with an argument such as \n) will produce the first empty field. Consider if you had written '\n'.split('\n'), you would get two fields (one split, gives you two halves).

Question: Is there any specific reason for such a difference?

This first mode is useful when data is aligned in columns with variable amounts of whitespace. For example:

    >>> data = '''\
    Shasta      California     14,200
    McKinley    Alaska         20,300
    Fuji        Japan          12,400
    '''
    >>> for line in data.splitlines():
            print line.split()

    ['Shasta', 'California', '14,200']
    ['McKinley', 'Alaska', '20,300']
    ['Fuji', 'Japan', '12,400']

The second mode is useful for delimited data such as CSV where repeated commas denote empty fields. For example:

    >>> data = '''\
    Guido,BDFL,,Amsterdam
    Barry,FLUFL,,USA
    Tim,,,USA
    '''
    >>> for line in data.splitlines():
            print line.split(',')

    ['Guido', 'BDFL', '', 'Amsterdam']
    ['Barry', 'FLUFL', '', 'USA']
    ['Tim', '', '', 'USA']

Note, the number of result fields is one greater than the number of delimiters. Think of cutting a rope. If you make no cuts, you have one piece. Making one cut, gives two pieces. Making two cuts, gives three pieces. And so it is with Python's str.split(delimiter) method:

    >>> ''.split(',')       # No cuts
    ['']
    >>> ','.split(',')      # One cut
    ['', '']
    >>> ',,'.split(',')     # Two cuts
    ['', '', '']

Question: And is there any more convenient way to count lines in a string?

Yes, there are a couple of easy ways. One uses str.count() and the other uses str.splitlines(). Both ways will give the same answer unless the final line is missing the \n. If the final newline is missing, the str.splitlines approach will give the accurate answer. A faster technique that is also accurate uses the count method but then corrects it for the final newline:

    >>> data = '''\
    Line 1
    Line 2
    Line 3
    Line 4'''

    >>> data.count('\n')                               # Inaccurate
    3
    >>> len(data.splitlines())                         # Accurate, but slow
    4
    >>> data.count('\n') + (not data.endswith('\n'))   # Accurate and fast
    4

Question from @Kaz: Why the heck are two very different algorithms shoe-horned into a single function?

The signature for str.split is about 20 years old, and a number of the APIs from that era are strictly pragmatic. While not perfect, the method signature isn't "terrible" either. For the most part, Guido's API design choices have stood the test of time.

The current API is not without advantages. Consider strings such as:

    ps_aux_header  = "USER               PID  %CPU %MEM      VSZ"
    patient_header = "name,age,height,weight"

When asked to break these strings into fields, people tend to describe both using the same English word, "split". When asked to read code such as fields = line.split() or fields = line.split(','), people tend to correctly interpret the statements as "splits a line into fields".

Microsoft Excel's text-to-columns tool made a similar API choice and incorporates both splitting algorithms in the same tool. People seem to mentally model field-splitting as a single concept even though more than one algorithm is involved.

From: stackoverflow.com/q/16645083

Back to homepage or read more recommendations: