Найти в Дзене
Ты в АйТи

О строках и комментариях в Python. Часть вторая.

Если вам еще не известно как специальные символы в строках, такие как: символ новой строки, табуляция, возврат каретки и пр., то спешу вас обрадовать Python, разумеется, обладает возможностями довольно удобно с ними работать. Специальные символы. и Экранированные последовательности. Специальные символы могут быть представлены как последовательность заранее определенных в языке символов начинающихся с косой черты. Такие последовательности называются экранированными последовательностями.
Если задаваемые таким образом символы не являются печатаемыми, то Python отображает их с помощью шестнадцатеричной системы отображения. Вот примеры экранированных последовательностей: Кавычки, кавычки и снова кавычки... Наверное, вы знаете, что строки в Python можно заключать как в двойные, так и в одиночные кавычки, но последний способ используется большинством программистов чаще.
Но возможно, вы не знаете про тройные кавычки, то есть идущие подряд 3 двойные или три одинарные кавычки затем текст с перен
Оглавление

Если вам еще не известно как специальные символы в строках, такие как: символ новой строки, табуляция, возврат каретки и пр., то спешу вас обрадовать Python, разумеется, обладает возможностями довольно удобно с ними работать.

Специальные символы. и Экранированные последовательности.

Специальные символы могут быть представлены как последовательность заранее определенных в языке символов начинающихся с косой черты. Такие последовательности называются экранированными последовательностями.
Если задаваемые таким образом символы не являются печатаемыми, то Python отображает их с помощью шестнадцатеричной системы отображения.

Вот примеры экранированных последовательностей:

Рис. 1. Примеры экранированных последовательностей.
Рис. 1. Примеры экранированных последовательностей.

Кавычки, кавычки и снова кавычки...

Наверное, вы знаете, что строки в Python можно заключать как в двойные, так и в одиночные кавычки, но последний способ используется большинством программистов чаще.
Но возможно, вы не знаете про тройные кавычки, то есть идущие подряд 3 двойные или три одинарные кавычки затем текст с переносом строк и снова три двойные или одиночные кавычки. Когда применяется такая форма, то все строки объединяются в одну с добавлением символа конца строки в тех местах, где встречался разрыв строки. Пример использования показан на рисунке 2.

Рис.2 Пример использования длинной строки с тройными кавычками
Рис.2 Пример использования длинной строки с тройными кавычками

Правильный способ документирования.

В Python есть концепция «строки документации», это отличный способ связать написанную вами документацию с модулями, функциями, классами и методами Python.

Строка документа добавляется в качестве комментария прямо под заголовком функции, модуля или объекта и описывает действия функции, модуля или объекта.

Строка документа - однострочный или многострочный комментарий. В последнем случае первая строка является кратким описанием, а после первой строки следует пустая строка.

Строка документа начинается с заглавной буквы и завершается точкой.

Использование:

  • Удобны при встраивании в код Python многострочного кода. Например, HTML, XML, JSON;
  • Удобны при отладке. Можно закомментировать многострочную часть кода, не удаляя и не вырезая его. При этом не придётся комментировать каждую строку, как если бы мы использовали стандартный однострочный комментарий;
  • Можно использовать для многострочных комментариев;
  • Создание документации модулей, функций.

А что такое неформатированные строки?

Неформатированные строки это удобный способ для отключения экранированных последовательностей. Чтобы отключить экранирование достаточно перед открывающей кавычкой строки поставить символ r (регистр значения не имеет).
Кстати r тут от слова raw. Raw это значит "сырая". Сырая строка. то есть строка как есть.
Важная особенность: Даже при использовании неформатированной строки последний "\" всё равно нужно экранировать.

Рис.3 Пример использования неформатированной строки.
Рис.3 Пример использования неформатированной строки.

Использование:

  1. Удобны для представления строк подобных путям к каталогам Windows (рисунок 4)
Рис.4 Пример использования при обработке адреса в Windows
Рис.4 Пример использования при обработке адреса в Windows

В этой статье мы продолжили раскрывать интереснейшую тему о работе со строками. но это еще не всё. Далее мы поговорим о различных способах форматирования строк и особенно о новом быстром и удобном доступном в Python с версии 3,6 - об f-строках.

Если статья была вам хоть сколько-нибудь интересна ставим лайк и подписываемся на канал, чтобы не пропустить новые материалы. Спасибо за прочтение.
Помогите автору канала одним из этих способов :) :
Донаты (переводы) с любых карт и yoomoney -
https://yoomoney.ru/fundraise/QnZacAJpY9g.230208
Донаты на карту Сбера - 2202 2007 6729 1543
Донаты на Тинькофф - 5536 9137 9511 4657
Донаты на Открытие - 5586 2000 6614 6835
Криптокошельки:
1. Ethereum - 0x73670880Af17F42E6a641f5936E2f3Bc5a4db257
2. Bitcoin - bc1qywt6l80metclksvdzjt370r28zg9gxg5262aum
3. LiteCoin - ltc1qrwedpjt4evqhl42w2z32kks6xwysqvk3g27uqj
4. Zcash - t1YfZNFJ5Q1BQLCbC6Qo3bcueLJ53QLo4Mx