Краткий обзор стандартной библиотеки

10.1. Интерфейс операционной системы

Модуль os предоставляет десятки функций для взаимодействия с операционной системой:

>>> import os
>>> os.getcwd()      # Return the current working directory
'C:\\Python313'
>>> os.chdir('/server/accesslogs')   # Change current working directory
>>> os.system('mkdir today')   # Run the command mkdir in the system shell
0

Обязательно используйте стиль import os вместо from os import *. Это предотвратит затенение встроенной функции open() функцией os.open(), которая работает совершенно иначе.

Встроенные функции dir() и help() полезны как интерактивные помощники при работе с большими модулями, такими как os:

>>> import os
>>> dir(os)
<returns a list of all module functions>
>>> help(os)
<returns an extensive manual page created from the module's docstrings>

Для повседневных задач по управлению файлами и каталогами модуль shutil предоставляет более удобный высокоуровневый интерфейс:

>>> import shutil
>>> shutil.copyfile('data.db', 'archive.db')
'archive.db'
>>> shutil.move('/build/executables', 'installdir')
'installdir'

10.2. Шаблоны подстановки для файлов

Модуль glob предоставляет функцию для создания списков файлов с помощью поиска по шаблонам в каталогах:

>>> import glob
>>> glob.glob('*.py')
['primes.py', 'random.py', 'quote.py']

10.3. Аргументы командной строки

Обычным служебным скриптам часто требуется обрабатывать аргументы командной строки. Эти аргументы хранятся в модуле sys в виде списка в атрибуте argv. Например, рассмотрим следующий файл demo.py:

# File demo.py
import sys
print(sys.argv)

Вот результат запуска python demo.py one two three из командной строки:

['demo.py', 'one', 'two', 'three']

Модуль argparse предоставляет более сложный механизм обработки аргументов командной строки. Следующий скрипт извлекает одно или несколько имён файлов и необязательное количество строк для отображения:

import argparse

parser = argparse.ArgumentParser(
    prog='top',
    description='Show top lines from each file')
parser.add_argument('filenames', nargs='+')
parser.add_argument('-l', '--lines', type=int, default=10)
args = parser.parse_args()
print(args)

При запуске из командной строки с python top.py --lines=5 alpha.txt beta.txt скрипт присваивает args.lines значение 5, а args.filenames — значение ['alpha.txt', 'beta.txt'].

10.4. Перенаправление вывода ошибок и завершение программы

Модуль sys также содержит атрибуты stdin, stdout и stderr. Последний полезен для вывода предупреждений и сообщений об ошибках, чтобы они оставались видимыми даже при перенаправлении stdout:

>>> sys.stderr.write('Warning, log file not found starting a new one\n')
Warning, log file not found starting a new one

Самый простой способ завершить скрипт — использовать sys.exit().

10.5. Сопоставление строк с шаблонами

Модуль re предоставляет инструменты регулярных выражений для расширенной обработки строк. Для сложного сопоставления и манипулирования регулярные выражения позволяют создавать лаконичные и оптимизированные решения:

>>> import re
>>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
['foot', 'fell', 'fastest']
>>> re.sub(r'(\b[a-z]+) \1', r'\1', 'cat in the the hat')
'cat in the hat'

Если нужны только простые возможности, предпочтительнее использовать строковые методы, поскольку их легче читать и отлаживать:

>>> 'tea for too'.replace('too', 'two')
'tea for two'

10.6. Математика

Модуль math предоставляет доступ к функциям базовой библиотеки C для вычислений с числами с плавающей точкой:

>>> import math
>>> math.cos(math.pi / 4)
0.70710678118654757
>>> math.log(1024, 2)
10.0

Модуль random предоставляет инструменты для случайного выбора:

>>> import random
>>> random.choice(['apple', 'pear', 'banana'])
'apple'
>>> random.sample(range(100), 10)   # sampling without replacement
[30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
>>> random.random()    # random float from the interval [0.0, 1.0)
0.17970987693706186
>>> random.randrange(6)    # random integer chosen from range(6)
4

Модуль statistics вычисляет основные статистические характеристики числовых данных (среднее значение, медиану, дисперсию и т. д.):

>>> import statistics
>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> statistics.mean(data)
1.6071428571428572
>>> statistics.median(data)
1.25
>>> statistics.variance(data)
1.3720238095238095

В проекте SciPy <https://scipy.org> есть множество других модулей для численных вычислений.

10.7. Доступ к Интернету

Существует ряд модулей для доступа к Интернету и обработки интернет-протоколов. Два самых простых — urllib.request для получения данных по URL-адресам и smtplib для отправки почты:

>>> from urllib.request import urlopen
>>> with urlopen('http://worldtimeapi.org/api/timezone/etc/UTC.txt') as response:
...     for line in response:
...         line = line.decode()             # Convert bytes to a str
...         if line.startswith('datetime'):
...             print(line.rstrip())         # Remove trailing newline
...
datetime: 2022-01-01T01:36:47.689215+00:00

>>> import smtplib
>>> server = smtplib.SMTP('localhost')
>>> server.sendmail('soothsayer@example.org', 'jcaesar@example.org',
... """To: jcaesar@example.org
... From: soothsayer@example.org
...
... Beware the Ides of March.
... """)
>>> server.quit()

(Обратите внимание, что для второго примера требуется работающий почтовый сервер на localhost.)

10.8. Даты и время

Модуль datetime предоставляет классы для работы с датами и временем как простыми, так и сложными способами. Поддерживаются арифметические операции с датами и временем, однако реализация ориентирована прежде всего на эффективное извлечение компонентов для форматирования и обработки вывода. Модуль также поддерживает объекты с информацией о часовом поясе.

>>> # dates are easily constructed and formatted
>>> from datetime import date
>>> now = date.today()
>>> now
datetime.date(2003, 12, 2)
>>> now.strftime("%m-%d-%y. %d %b %Y is a %A on the %d day of %B.")
'12-02-03. 02 Dec 2003 is a Tuesday on the 02 day of December.'

>>> # dates support calendar arithmetic
>>> birthday = date(1964, 7, 31)
>>> age = now - birthday
>>> age.days
14368

10.9. Сжатие данных

Распространённые форматы архивирования и сжатия данных напрямую поддерживаются такими модулями, как: zlib, gzip, bz2, lzma, zipfile и tarfile.

>>> import zlib
>>> s = b'witch which has which witches wrist watch'
>>> len(s)
41
>>> t = zlib.compress(s)
>>> len(t)
37
>>> zlib.decompress(t)
b'witch which has which witches wrist watch'
>>> zlib.crc32(s)
226805979

10.10. Измерение производительности

Некоторым пользователям Python очень интересно сравнивать производительность различных подходов к решению одной и той же задачи. В Python есть инструмент измерения, который позволяет быстро получить ответы на такие вопросы.

Например, может показаться заманчивым использовать упаковку и распаковку кортежей вместо традиционного способа обмена значениями аргументов. Модуль timeit быстро показывает небольшое преимущество в производительности:

>>> from timeit import Timer
>>> Timer('t=a; a=b; b=t', 'a=1; b=2').timeit()
0.57535828626024577
>>> Timer('a,b = b,a', 'a=1; b=2').timeit()
0.54962537085770791

В отличие от высокой точности измерений модуля timeit, модули profile и pstats предоставляют инструменты для выявления критичных по времени участков в больших блоках кода.

10.11. Контроль качества

Один из способов разрабатывать высококачественное программное обеспечение — писать тесты для каждой функции по мере её создания и часто запускать эти тесты в процессе разработки.

Модуль doctest предоставляет инструмент для сканирования модуля и проверки тестов, встроенных в строки документации программы. Создать тест так же просто, как скопировать типичный вызов вместе с результатом в строку документации. Это улучшает документацию, предоставляя пользователю пример, а также позволяет модулю doctest проверять, что код соответствует документации:

def average(values):
    """Computes the arithmetic mean of a list of numbers.

    >>> print(average([20, 30, 70]))
    40.0
    """
    return sum(values) / len(values)

import doctest
doctest.testmod()   # automatically validate the embedded tests

Модуль unittest не так прост в использовании, как модуль doctest, но он позволяет поддерживать более полный набор тестов в отдельном файле:

import unittest

class TestStatisticalFunctions(unittest.TestCase):

    def test_average(self):
        self.assertEqual(average([20, 30, 70]), 40.0)
        self.assertEqual(round(average([1, 5, 7]), 1), 4.3)
        with self.assertRaises(ZeroDivisionError):
            average([])
        with self.assertRaises(TypeError):
            average(20, 30, 70)

unittest.main()  # Calling from the command line invokes all tests

10.12. Батарейки в комплекте

В Python придерживаются философии «батарейки в комплекте». Лучше всего она проявляется в широких и надёжных возможностях крупных пакетов. Например:

• Модули xmlrpc.client и xmlrpc.server превращают реализацию удалённых вызовов процедур в почти тривиальную задачу. Несмотря на названия модулей, знать XML или непосредственно работать с ним не нужно.
• Пакет email — это библиотека для управления сообщениями электронной почты, включая MIME и другие документы сообщений на основе RFC 2822. В отличие от smtplib и poplib, которые непосредственно отправляют и принимают сообщения, пакет email предоставляет полный набор инструментов для создания и декодирования сложных структур сообщений (включая вложения), а также для реализации интернет-кодировок и протоколов заголовков.
• Пакет json обеспечивает надёжную поддержку разбора этого популярного формата обмена данными. Модуль csv поддерживает непосредственное чтение и запись файлов в формате CSV, который широко используется в базах данных и электронных таблицах. Обработку XML обеспечивают пакеты xml.etree.ElementTree, xml.dom и xml.sax. Вместе эти модули и пакеты значительно упрощают обмен данными между приложениями Python и другими инструментами.
• Модуль sqlite3 — это обёртка для библиотеки баз данных SQLite, предоставляющая постоянное хранилище данных, которое можно обновлять и использовать с помощью немного нестандартного синтаксиса SQL.
• Интернационализацию поддерживает ряд модулей, включая gettext, locale и пакет codecs.