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

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

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

>>> import os
>>> os.getcwd()      # Return the current working directory
'C:\\Python311'
>>> 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 *. Это предотвратит конфликт os.open() с встроенной функцией 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. Аргументы командной строки

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

>>> import sys
>>> print(sys.argv)
['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
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

END_OF_DOCUMENT_MARKER

10.12. Встроенные возможности

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

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