Python locale.getpreferredencoding() Function

The Python locale.getpreferredencoding() function is used to retrieve the preferred encoding for the system. This encoding is typically used for file operations and other locale-dependent encoding settings.

This function is useful when handling text encoding dynamically without explicitly specifying an encoding format.

Syntax

Following is the syntax of the Python locale.getpreferredencoding() function −

locale.getpreferredencoding(do_setlocale=True)

Parameters

This function accepts a boolean value indicating whether to set the locale before retrieving the preferred encoding. Defaults to True.

Return Value

This function returns a string representing the preferred encoding of the system (e.g., 'UTF-8').

Example 1

Following is an example of the Python locale.getpreferredencoding() function. Here, we retrieve the system's preferred encoding −

import locale

preferred_encoding = locale.getpreferredencoding()
print("Preferred Encoding:", preferred_encoding)

Following is the output of the above code (output may vary depending on the system) −

Preferred Encoding: UTF-8

Example 2

Here, we check the preferred encoding without modifying the locale settings by setting the do_setlocale parameter to False −

import locale

preferred_encoding = locale.getpreferredencoding(False)
print("Preferred Encoding (without setting locale):", preferred_encoding)

Output of the above code is as follows (output may vary based on system settings) −

Preferred Encoding (without setting locale): UTF-8

Example 3

Now, we use the locale.getpreferredencoding() function to determine the encoding before reading a file dynamically −

import locale

def read_file(filename):
   encoding = locale.getpreferredencoding()
   with open(filename, encoding=encoding) as file:
      print(file.read())

read_file("example.txt")

The result obtained depends on the file contents but ensures that the correct encoding is used.

Example 4

We can use the locale.getpreferredencoding() function to check if the system defaults to UTF-8 encoding before performing operations that require UTF-8 −

import locale

def is_utf8_default():
   return locale.getpreferredencoding() == "UTF-8"

print("Is UTF-8 Default Encoding?:", is_utf8_default())

The result produced is as follows (output may vary) −

Is UTF-8 Default Encoding?: False