Функция smart_str

Функция smart_str применяется для преобразования различных объектов (строк, байтовых строк, чисел) в строковый тип с корректной обработкой кодировки. Она возвращает объект типа str, выполняя декодирование байтовых строк с использованием указанной или автоматически определенной кодировки. Функция особенно полезна при работе с данными, полученными из внешних источников, где может потребоваться явное преобразование кодировки.

Синтаксис

smart_str(s, encoding='utf-8', strings_only=False, errors='strict')

Параметры функции:

⁅b⁆s⁅/b⁆ - объект, который необходимо преобразовать в строку. Может быть строкой, байтовой строкой, числом или любым другим объектом, поддерживающим строковое представление.

⁅b⁆encoding⁅/b⁆ - кодировка, используемая для декодирования байтовых строк. По умолчанию используется 'utf-8'.

⁅b⁆strings_only⁅/b⁆ - если установлено в True, функция применяется только к строкам и байтовым строкам, остальные объекты возвращаются без изменений. По умолчанию False.

⁅b⁆errors⁅/b⁆ - определяет поведение при ошибках декодирования. По умолчанию 'strict', что вызывает исключение.

Пример

Давайте преобразуем байтовую строку в строку с помощью smart_str:

from django.utils.encoding import smart_str

byte_string = b'Hello, World!'
res = smart_str(byte_string)
print(res)

Результат выполнения кода:

"Hello, World!"

Пример

Давайте преобразуем число в строку с помощью smart_str:

from django.utils.encoding import smart_str

number = 12345
res = smart_str(number)
print(res)

Результат выполнения кода:

"12345"

Пример

Давайте преобразуем байтовую строку с русским текстом с помощью smart_str:

from django.utils.encoding import smart_str

byte_string = b'\xd0\x9f\xd1\x80\xd0\xb8\xd0\xb2\xd0\xb5\xd1\x82'
res = smart_str(byte_string, encoding='utf-8')
print(res)

Результат выполнения кода:

"Привет"

Пример

Давайте используем параметр ⁅b⁆strings_only⁅/b⁆ для преобразования только строк и байтовых строк:

from django.utils.encoding import smart_str

res1 = smart_str(b'bytes', strings_only=True)
res2 = smart_str(100, strings_only=True)
print(res1, type(res1))
print(res2, type(res2))

Результат выполнения кода:

"bytes <class 'str'>"
"100 <class 'int'>"

Обратите внимание, что число осталось целым числом, так как параметр ⁅b⁆strings_only⁅/b⁆ был установлен в True.

Пример

Давайте используем smart_str для преобразования данных модели Django:

from django.utils.encoding import smart_str
from myapp.models import Article

article = Article.objects.get(id=1)
res = smart_str(article.title)
print(res)

Результат выполнения кода:

"article"

Смотрите также

функция force_str,
которая принудительно преобразует объект в строку
функция slugify,
которая преобразует строку в URL-совместимый слаг
функция iri_to_uri,
которая преобразует IRI в URI
функция uri_to_iri,
которая преобразует URI в IRI