Numpy char.splitlines() Function

The Numpy char.splitlines() function is used to splitlines each string element of an array into a list of lines, based on line breaks. It is useful for processing text data where lines are separated by newline characters.

By default this function splitliness on any newline character such as \n, \r, \r\n but we can specify the keepends parameter to include or exclude newline characters in the output. This function processes each string in the input array individually and returns an array of the same shape with each string replaced by a list of lines.

Syntax

Following is the syntax of Numpy char.splitlines() function −

numpy.char.splitlines(a, keepends = None)

Parameters

Following are the parameters of Numpy char.splitlines() function −

• a(array-like of str or unicode): The input array containing strings to be split using the splitlines.

• keepends(bool, optional): This parameter is used whether to include newline characters in the resulting lines.

Return Value

This function returns an array with the same shape as the input array which contains lists of lines.

Example 1

Following is the basic example of Numpy char.splitlines() function. Here in this example we split each string in the array into lines based on newline characters. By default this function removes the newline characters from the resulting lines −

import numpy as np

arr = np.array(['line1\nline2\nline3', 'lineA\nlineB'])
splitlines_arr = np.char.splitlines(arr)
print(splitlines_arr)

Below is the output of the basic example of numpy.char.splitlines() function −

[list(['line1', 'line2', 'line3']) list(['lineA', 'lineB'])]

Example 2

We can use the keepends parameter to include newline characters in the resulting lines. Here is the example we are passing the keepend parameter as True to the char.splitlines() function −

import numpy as np
arr = np.array(['line1\nline2\nline3', 'lineA\nlineB'])
splitlines_arr = np.char.splitlines(arr, keepends=True)
print(splitlines_arr)

Here is the output of including newline characters −

[list(['line1\n', 'line2\n', 'line3']) list(['lineA\n', 'lineB'])]

Example 3

This example shows how to handle different types of newline characters with the help of char.splitlines() function −

import numpy as np
arr = np.array(['line1\rline2\rline3', 'lineA\nlineB\r\nlineC'])
splitlines_arr = np.char.splitlines(arr)
print(splitlines_arr)

Here is the output of limiting the number of splitliness −

[list(['line1', 'line2', 'line3']) list(['lineA', 'lineB', 'lineC'])]