7. Вхід і вихід

Є кілька способів представити вихідні дані програми; дані можна роздрукувати у формі, зрозумілій людині, або записати у файл для подальшого використання. У цьому розділі будуть розглянуті деякі з можливостей.

7.1. Вишуканіше форматування виводу

So far we’ve encountered two ways of writing values: expression statements and the print() function. (A third way is using the write() method of file objects; the standard output file can be referenced as sys.stdout. See the Library Reference for more information on this.)

Часто вам знадобиться більше контролювати форматування вихідних даних, ніж просто друкувати значення, розділені пробілами. Існує кілька способів форматування виводу.

• Щоб використовувати відформатовані рядкові літерали, починайте рядок з f або F перед лапками, що відкривають або потрійними лапками. Усередині цього рядка можна написати вираз Python між символами { і }, які можуть посилатися на змінні або літеральні значення.

  >>> year = 2016
  >>> event = 'Referendum'
  >>> f'Results of the {year} {event}'
  'Results of the 2016 Referendum'
  

• Метод рядків str.format() вимагає більше ручних зусиль. Ви все одно використовуватимете { і }, щоб позначити місце заміни змінної, і можете надати детальні директиви форматування, але вам також потрібно буде надати інформацію для форматування.

  >>> yes_votes = 42_572_654
  >>> no_votes = 43_132_495
  >>> percentage = yes_votes / (yes_votes + no_votes)
  >>> '{:-9} YES votes  {:2.2%}'.format(yes_votes, percentage)
  ' 42572654 YES votes  49.67%'
  

• Нарешті, ви можете виконувати всю обробку рядків самостійно, використовуючи операції зрізання рядків і конкатенації для створення будь-якого макета, який тільки можете собі уявити. Рядковий тип має деякі методи, які виконують корисні операції для доповнення рядків до заданої ширини стовпця.

Якщо вам не потрібен вигадливий вихід, а просто потрібно швидко відобразити деякі змінні для цілей налагодження, ви можете перетворити будь-яке значення на рядок за допомогою функцій repr() або str().

Функція str() призначена для повернення представлень значень, які досить зрозумілі людині, тоді як repr() призначена для створення представлень, які може читати інтерпретатор (або примусово SyntaxError, якщо немає еквівалентного синтаксису). Для об’єктів, які не мають спеціального представлення для споживання людиною, str() поверне те саме значення, що й repr(). Багато значень, наприклад чисел або структур, таких як списки та словники, мають однакове представлення за допомогою будь-якої функції. Рядки, зокрема, мають два різних представлення.

Деякі приклади:

>>> s = 'Hello, world.'
>>> str(s)
'Hello, world.'
>>> repr(s)
"'Hello, world.'"
>>> str(1/7)
'0.14285714285714285'
>>> x = 10 * 3.25
>>> y = 200 * 200
>>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...'
>>> print(s)
The value of x is 32.5, and y is 40000...
>>> # The repr() of a string adds string quotes and backslashes:
... hello = 'hello, world\n'
>>> hellos = repr(hello)
>>> print(hellos)
'hello, world\n'
>>> # The argument to repr() may be any Python object:
... repr((x, y, ('spam', 'eggs')))
"(32.5, 40000, ('spam', 'eggs'))"

Модуль string містить клас Template, який пропонує ще один спосіб заміни значень у рядки, використовуючи заповнювачі, такі як $x, і замінюючи їх значеннями зі словника, але пропонує набагато менше контролю над форматуванням.

7.1.1. Відформатовані рядкові літерали

Форматовані рядкові літерали (які також скорочено називаються f-рядками) дозволяють включити значення виразів Python у рядок, додавши до рядка префікс f або F і записавши вирази як` {expression}`.

За виразом може слідувати необов’язковий специфікатор формату. Це дозволяє краще контролювати форматування значення. У наступному прикладі число pi округлюється до трьох знаків після коми:

>>> import math
>>> print(f'The value of pi is approximately {math.pi:.3f}.')
The value of pi is approximately 3.142.

Передача цілого числа після ':'' призведе до того, що це поле матиме мінімальну кількість символів. Це корисно для того, щоб вирівняти колони.

>>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678}
>>> for name, phone in table.items():
...     print(f'{name:10} ==> {phone:10d}')
...
Sjoerd     ==>       4127
Jack       ==>       4098
Dcab       ==>       7678

Для перетворення значення перед його форматуванням можна використовувати інші модифікатори. '!a'' застосовується ascii(), '!s'' застосовується str(), а '!r'' застосовується repr():

>>> animals = 'eels'
>>> print(f'My hovercraft is full of {animals}.')
My hovercraft is full of eels.
>>> print(f'My hovercraft is full of {animals!r}.')
My hovercraft is full of 'eels'.

The = specifier can be used to expand an expression to the text of the expression, an equal sign, then the representation of the evaluated expression:

>>> bugs = 'roaches'
>>> count = 13
>>> area = 'living room'
>>> print(f'Debugging {bugs=} {count=} {area=}')
Debugging bugs='roaches' count=13 area='living room'

See self-documenting expressions for more information on the = specifier. For a reference on these format specifications, see the reference guide for the Міні-мова специфікації формату.

7.1.2. Метод String format().

Основне використання методу str.format() виглядає так:

>>> print('We are the {} who say "{}!"'.format('knights', 'Ni'))
We are the knights who say "Ni!"

Дужки та символи в них (так звані поля форматування) замінюються об’єктами, переданими в метод str.format(). Число в дужках можна використовувати для позначення позиції об’єкта, переданого в метод str.format().

>>> print('{0} and {1}'.format('spam', 'eggs'))
spam and eggs
>>> print('{1} and {0}'.format('spam', 'eggs'))
eggs and spam

Якщо ключові аргументи використовуються в методі str.format(), їх значення посилаються за допомогою назви аргументу.

>>> print('This {food} is {adjective}.'.format(
...       food='spam', adjective='absolutely horrible'))
This spam is absolutely horrible.

Позиційні та ключові аргументи можна довільно комбінувати:

>>> print('The story of {0}, {1}, and {other}.'.format('Bill', 'Manfred',
...                                                    other='Georg'))
The story of Bill, Manfred, and Georg.

Якщо у вас є дуже довгий рядок формату, який ви не хочете розділяти, було б непогано, якби ви могли посилатися на змінні, які потрібно відформатувати за назвою, а не за позицією. Це можна зробити, просто передавши dict і використовуючи квадратні дужки ''[]' для доступу до ключів.

>>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
>>> print('Jack: {0[Jack]:d}; Sjoerd: {0[Sjoerd]:d}; '
...       'Dcab: {0[Dcab]:d}'.format(table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678

This could also be done by passing the table dictionary as keyword arguments with the ** notation.

>>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
>>> print('Jack: {Jack:d}; Sjoerd: {Sjoerd:d}; Dcab: {Dcab:d}'.format(**table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678

Це особливо корисно в поєднанні з вбудованою функцією vars(), яка повертає словник, що містить усі локальні змінні.

As an example, the following lines produce a tidily aligned set of columns giving integers and their squares and cubes:

>>> for x in range(1, 11):
...     print('{0:2d} {1:3d} {2:4d}'.format(x, x*x, x*x*x))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000

Щоб отримати повний огляд форматування рядка за допомогою str.format(), перегляньте Синтаксис рядка формату.

7.1.3. Ручне форматування рядка

Ось та сама таблиця квадратів і кубів, відформатована вручну:

>>> for x in range(1, 11):
...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
...     # Note use of 'end' on previous line
...     print(repr(x*x*x).rjust(4))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000

(Зверніть увагу, що один пробіл між кожним стовпцем було додано так, як працює print(): він завжди додає пробіли між своїми аргументами.)

Метод str.rjust() рядкових об’єктів вирівнює рядок по правому краю в полі заданої ширини, доповнюючи його пробілами зліва. Існують схожі методи str.ljust() і str.center(). Ці методи нічого не записують, вони просто повертають новий рядок. Якщо вхідний рядок надто довгий, вони не скорочують його, а повертають без змін; це зіпсує ваш макет стовпців, але це зазвичай краще, ніж альтернатива, яка б брехала про значення. (Якщо вам дійсно потрібно скорочення, ви завжди можете додати операцію зрізу, як у x.ljust(n)[:n].)

Є інший метод, str.zfill(), який доповнює числовий рядок зліва нулями. Він розуміє знаки плюс і мінус:

>>> '12'.zfill(5)
'00012'
>>> '-3.14'.zfill(7)
'-003.14'
>>> '3.14159265359'.zfill(5)
'3.14159265359'

7.1.4. Старе форматування рядка

Оператор % (по модулю) також можна використовувати для форматування рядків. З урахуванням % значень 'string' екземпляри % в string замінюються нулем або більше елементами values. Ця операція широко відома як інтерполяція рядків. Наприклад:

>>> import math
>>> print('The value of pi is approximately %5.3f.' % math.pi)
The value of pi is approximately 3.142.

Більше інформації можна знайти в розділі Форматування рядків у стилі printf.

7.2. Читання та запис файлів

open() повертає об’єкт file object і найчастіше використовується з двома позиційними аргументами та одним ключовим аргументом: open(filename, mode, encoding=None)

>>> f = open('workfile', 'w', encoding="utf-8")

Перший аргумент - це рядок, що містить назву файлу. Другий аргумент — це інший рядок, що містить декілька символів, що описують спосіб використання файлу. режим може бути 'r', коли файл буде лише читатися, 'w'' лише для запису (існуючий файл із такою ж назвою буде стерто) і 'a' відкриває файл для додавання; будь-які дані, записані у файл, автоматично додаються в кінець. 'r+' відкриває файл як для читання, так і для запису. Аргумент mode необов’язковий; 'r' передбачається, якщо його опустити.

Зазвичай файли відкриваються в text mode, це означає, що ви читаєте та записуєте рядки з і до файлу, які закодовані в певному кодуванні. Якщо кодування не вказано, типове значення залежить від платформи (див. open()). Оскільки UTF-8 є сучасним стандартом де-факто, рекомендується encoding="utf-8", якщо ви не знаєте, що вам потрібно використовувати інше кодування. Додавання 'b' до режиму відкриває файл у binary mode. Дані у двійковому режимі читаються та записуються як об’єкти bytes. Ви не можете вказати кодування під час відкриття файлу в двійковому режимі.

У текстовому режимі під час читання за замовчуванням закінчення рядків для певної платформи (\n в Unix, \r\n у Windows) перетворюються лише на \n. Під час написання в текстовому режимі за замовчуванням символи \n перетворюються на закінчення рядків, що залежать від платформи. Ця закулісна модифікація даних файлу підходить для текстових файлів, але пошкодить двійкові дані, як у файлах JPEG або EXE. Будьте дуже обережні, використовуйте двійковий режим під час читання та запису таких файлів.

Під час роботи з файловими об’єктами корисно використовувати ключове слово with. Перевагою є те, що файл закривається належним чином після завершення його набору, навіть якщо в якийсь момент виникає виняток. Використання with також набагато коротше, ніж написання еквівалента try-finally блоків:

>>> with open('workfile', encoding="utf-8") as f:
...     read_data = f.read()

>>> # We can check that the file has been automatically closed.
>>> f.closed
True

Якщо ви не використовуєте ключове слово with, вам слід викликати f.close(), щоб закрити файл і негайно звільнити всі системні ресурси, які він використовує.

Попередження

Виклик f.write() без використання ключового слова with або виклик f.close() може привести до аргументів f.write() не повністю записується на диск, навіть якщо програма успішно завершує роботу.

Після того, як файловий об’єкт закрито за допомогою оператора with або виклику f.close(), спроби використати файловий об’єкт автоматично зазнають невдачі.

>>> f.close()
>>> f.read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: I/O operation on closed file.

7.2.1. Методи файлових об’єктів

У решті прикладів у цьому розділі буде припущено, що файловий об’єкт під назвою f уже створено.

Щоб прочитати вміст файлу, викличте f.read(size), який зчитує певну кількість даних і повертає їх як рядок (у текстовому режимі) або об’єкт байтів (у двійковому режимі). розмір є необов’язковим числовим аргументом. Якщо size пропущений або негативний, весь вміст файлу буде прочитано та повернено; це ваша проблема, якщо розмір файлу вдвічі перевищує пам’ять вашої машини. В іншому випадку зчитуються та повертаються щонайбільше size символів (у текстовому режимі) або size байтів (у двійковому режимі). Якщо досягнуто кінця файлу, f.read() поверне порожній рядок ('').

>>> f.read()
'This is the entire file.\n'
>>> f.read()
''

f.readline() читає один рядок із файлу; символ нового рядка (\n) залишається в кінці рядка та пропускається лише в останньому рядку файлу, якщо файл не закінчується символом нового рядка. Це робить значення, що повертається, однозначним; якщо f.readline() повертає порожній рядок, це означає, що кінець файлу досягнуто, тоді як порожній рядок представлений '\n', рядок, що містить лише один новий рядок.

>>> f.readline()
'This is the first line of the file.\n'
>>> f.readline()
'Second line of the file\n'
>>> f.readline()
''

Щоб прочитати рядки з файлу, ви можете виконати цикл по об’єкту файлу. Це ефективне використання пам’яті, швидке та веде до простого коду:

>>> for line in f:
...     print(line, end='')
...
This is the first line of the file.
Second line of the file

Якщо ви хочете прочитати всі рядки файлу у списку, ви також можете скористатися list(f) або f.readlines().

f.write(string) записує вміст string у файл, повертаючи кількість записаних символів.

>>> f.write('This is a test\n')
15

Інші типи об’єктів потрібно перетворити — або на рядок (у текстовому режимі), або на об’єкт bytes (у двійковому режимі) — перед їх записом:

>>> value = ('the answer', 42)
>>> s = str(value)  # convert the tuple to string
>>> f.write(s)
18

f.tell() повертає ціле число, що вказує поточну позицію файлового об’єкта у файлі, представлену як кількість байтів від початку файлу в двійковому режимі та непрозоре число в текстовому режимі.

Щоб змінити позицію об’єкта файлу, використовуйте f.seek(offset, wherece). Положення обчислюється шляхом додавання зміщення до опорної точки; опорна точка вибирається аргументом whence. Значення whence 0 вимірюється від початку файлу, 1 використовує поточну позицію файлу, а 2 використовує кінець файлу як контрольну точку. whence можна опустити і за умовчанням дорівнює 0, використовуючи початок файлу як контрольну точку.

>>> f = open('workfile', 'rb+')
>>> f.write(b'0123456789abcdef')
16
>>> f.seek(5)      # Go to the 6th byte in the file
5
>>> f.read(1)
b'5'
>>> f.seek(-3, 2)  # Go to the 3rd byte before the end
13
>>> f.read(1)
b'd'

У текстових файлах (відкритих без b у рядку режиму) дозволений лише пошук відносно початку файлу (виняток полягає в пошуку до самого кінця файлу за допомогою seek(0, 2)), і єдиними дійсними значеннями offset є ті, які повертає f.tell() або нуль. Будь-яке інше значення offset призводить до невизначеної поведінки.

File objects have some additional methods, such as isatty() and truncate() which are less frequently used; consult the Library Reference for a complete guide to file objects.

7.2.2. Збереження структурованих даних за допомогою json

Strings can easily be written to and read from a file. Numbers take a bit more effort, since the read() method only returns strings, which will have to be passed to a function like int(), which takes a string like '123' and returns its numeric value 123. When you want to save more complex data types like nested lists and dictionaries, parsing and serializing by hand becomes complicated.

Rather than having users constantly writing and debugging code to save complicated data types to files, Python allows you to use the popular data interchange format called JSON (JavaScript Object Notation). The standard module called json can take Python data hierarchies, and convert them to string representations; this process is called serializing. Reconstructing the data from the string representation is called deserializing. Between serializing and deserializing, the string representing the object may have been stored in a file or data, or sent over a network connection to some distant machine.

Примітка

Формат JSON зазвичай використовується сучасними програмами для обміну даними. Багато програмістів уже знайомі з ним, що робить його хорошим вибором для сумісності.

Якщо у вас є об’єкт x, ви можете переглянути його представлення рядка JSON за допомогою простого рядка коду:

>>> import json
>>> x = [1, 'simple', 'list']
>>> json.dumps(x)
'[1, "simple", "list"]'

Інший варіант функції dumps(), який називається dump(), просто серіалізує об’єкт у text file. Отже, якщо f є об’єктом text file, відкритим для запису, ми можемо зробити це:

json.dump(x, f)

Щоб знову декодувати об’єкт, якщо f є об’єктом binary file або text file, який було відкрито для читання:

x = json.load(f)

Примітка

Файли JSON мають бути закодовані в UTF-8. Використовуйте encoding="utf-8", коли відкриваєте файл JSON як text file як для читання, так і для запису.

Ця проста техніка серіалізації може працювати зі списками та словниками, але серіалізація довільних екземплярів класу в JSON потребує додаткових зусиль. Посилання на модуль json містить пояснення цього.

Дивись також

pickle - модуль pickle

На відміну від JSON, pickle — це протокол, який дозволяє серіалізувати довільно складні об’єкти Python. Як такий, він специфічний для Python і не може використовуватися для зв’язку з програмами, написаними іншими мовами. Це також небезпечно за замовчуванням: десеріалізація даних pickle, що надходять із ненадійного джерела, може виконувати довільний код, якщо дані були створені кваліфікованим зловмисником.