[ Россум, Дрейк, Откидач ] Язык программирования Python

Если задан и является истиной аргумент inplace, файл переименовывается в резервную копию с именем, полученным добавлением суффикса backup (по умолчанию используется ’.bak’) к исходному имени файла, стандартный поток вывода перенаправляется в исходный файл, и перебираются строки резервной копии. Таким образом, одновременно с чтением строк Вы можете безопасно изменять исходный файл, выводя в него информацию, например, инструкцией print. Резервная копия удаляется при закрытии выходного файла. Такое редактирование файла (“in-place filtering”) невозможно при чтении из стандартного потока ввода.

Текущая реализация не позволяет работать с файловой системой MS-DOS, которая налагает сильные ограничения на имена файлов.

Экземпляры класса FileInput ведут себя аналогично последовательностям, но предоставляют доступ к элементам в определенном порядке (этого достаточно для использования в инструкции for), а также имеют следующие методы:

filename()

Возвращает имя файла, для которого была прочитана последняя строка. До того, как прочитана первая строка (в том числе непосредственно после вызова метода nextfile()), возвращает None. Для стандартного потока ввода возвращает

’<stdin>’.

lineno()

Возвращает суммарный номер последней прочитанной строки. До того, как прочитана первая строка (в том числе непосредственно после вызова метода nextfile()), возвращает 0.

filelineno()

Возвращает номер последней прочитанной строки в текущем файле. До того, как прочитана первая строка (в том числе непосредственно после вызова метода nextfile()), возвращает 0.

isfirstline()

Возвращает 1, если последняя прочитанная строка является первой в текущем файле, иначе возвращает 0.

isstdin()

Возвращает 1, если последняя строка была прочитана со стандартного потока ввода (sys.stdin), иначе возвращает 0.

nextfile()

Закрывает текущий файл и переходит к следующему. Строки, не прочитанные из этого файла, не будут учитываться при вычислении суммарного номера строки. До прочтения первой строки эта функция не дает никакого эффекта.

close()

“Закрывает” объект.

readline()

Считывает и возвращает следующую строку. Этот метод увеличивает счетчик строк

на единицу, поэтому вызов obj.readline() внутри цикла ‘for line in obj’ приведет к ошибке (исключение RuntimeError).

30.2 ConfigParser — чтение конфигурационных файлов

Этот модуль определяет класс ConfigParser, реализующий чтение и обработку простых конфигурационных файлов, аналогичных по структуре ‘.ini’-файлам в Windows.

Конфигурационный файл состоит из разделов, начинающихся с заголовка вида ‘[ТБЪДЕМ]’ и содержащий строки вида ‘ЙНС: ЪОБЮЕОЙЕ’. Длинные значения могут быть записаны в несколько строк в стиле RFC 822. Также допускается использование строк вида ‘ЙНС=ЪОБЮЕОЙЕ’. Обратите внимание, что начальные символы пропуска из значения удаляются. Значения могут содержать строки формата, ссылающиеся на другие значения в этом же разделе или разделе DEFAULT (раздел значений по умолчанию):

foodir: %(dir)s/whatever dir=frob

В приведенном примере последовательность ‘%(dir)s’ будет заменена значением ‘dir’ (здесь оно равно ‘frob’). Дополнительные значения по умолчанию могут быть указаны при инициализации и извлечении. Строки, начинающиеся с символа ‘#’ или ‘;’ считаются комментариями и игнорируются.

ConfigParser([defaults])

Возвращает объект, отвечающий за чтение конфигурационного файла. Отображение defaults определяет значения по умолчанию: ключи в нем должны быть строками, определяющие имена, значения могут содержать последовательности вида ‘%(ÉÍÑ)s’. Заметим, что имя __name__ всегда имеет значение, равное имени раздела.

MAX_INTERPOLATION_DEPTH

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

Модуль также определяет следующую иерархию исключений:

Error

Базовый класс для всех исключений, которые генерируются при ошибках, характерных для данного модуля.

NoSectionError

Указанный раздел (атрибут section экземпляра исключения) не найден.

DuplicateSectionError

Раздел с таким именем (атрибут section экземпляра исключения) уже существует.

NoOptionError

Опция с указанным именем (атрибут option экземпляра исключения) не найдена в указанном разделе (атрибут section).

InterpolationError

Проблемы при раскрытии специальной последовательности вида ‘%(ÉÍÑ)s’ (атрибут reference экземпляра исключения, имена раздела и опции доступны через атрибуты section и option).

InterpolationDepthError

Достигнута максимальная глубина рекурсии (MAX_INTERPOLATION_DEPTH) при раскрытии специальных последовательностей в значении опции (имена раздела и опции доступны через атрибуты section и option экземпляра исключения).

MissingSectionHeaderError

Конфигурационный файл не содержит заголовков. Имя файла, номер строки и сама строка, в которой обнаружена ошибка, доступны через атрибуты filename, lineno и line экземпляра исключения.

ParsingError

Ошибка при анализе конфигурационного файла. Атрибут filename экземпляра исключения содержит имя конфигурационного файла и атрибут errors — список пар из номера и содержимого строки для всех строк, в которых обнаружены ошибки.

Экземпляры класса ConfigParser имеют следующие методы:

defaults()

Возвращает отображение со значениями по умолчанию.

sections()

Возвращает список имен доступных разделов. Имя DEFAULT в список не включается.

add_section(section)

Добавляет раздел с именем section. Если раздел с таким именем уже существует, генерируется исключение DuplicateSectionError.

has_section(section)

Возвращает 1, если есть раздел с именем section, иначе возвращает 0. Имя раздела ’DEFAULT’ не распознается.

options(section)

Возвращает имен доступных опций в разделе section.

has_option(section, option)

Возвращает 1, если существует раздел с именем section и содержит опцию с именем option, иначе возвращает 0. Этот метод доступен, начиная с версии 1.6.

read(filenames)

Считывает и обрабатывает конфигурационные файлы. Аргумент filenames может быть списком имен файлов или строкой, содержащей имя одного файла.

readfp(fp [, filename])

Считывает и обрабатывает конфигурационный файл, представленный файловым (или подобным) объектом fp (должен иметь метод readline()). Аргумент filename используется в качестве имени файла в сообщениях об ошибках. Если аргумент filename не задан, используется fp.name или ’<???>’, если объект fp не имеет атрибута name.

get(section, option [, raw [, vars]])

Возвращает значение опции option в разделе section. Если аргумент raw опущен или является ложью, метод get() раскрывает специальные последовательности, начинающиеся с символа ‘%’. При этом принимаются во внимание значения по умолчанию, переданные конструктору и этому методу в качестве аргумента vars. Значения, указанные в отображении vars имеют преимущество над значениями по умолчанию, переданными конструктору.

getint(section, option)

Возвращает значение опции option в разделе section в виде целого числа.

getfloat(section, option)

Возвращает значение опции option в разделе section в виде вещественного числа.

getboolean(section, option)

Возвращает значение опции option в разделе section в виде целого числа 0 или 1. В конфигурационном файле значение опции должно быть указано строкой ‘0’ или ‘1’, во всех остальных случаях генерируется исключение ValueError.

set(section, option, value)

Если существует раздел с именем section, устанавливает в нем значение опции option равным value. Если аргумент section является ложью или равен строке ’DEFAULT’, value запоминается как значение опции option по умолчанию. В остальных случаях генерируется исключение NoSectionError. Метод set() доступен, начиная с версии 1.6.

write(fp)

Записывает текущее состояние объекта в конфигурационный файл, представленный файловым (или подобным) объектом fp. Этот метод доступен, начиная с версии 1.6.

remove_option(section, option)

Удаляет опцию option из раздела section. Если аргумент section является ложью или равен строке ’DEFAULT’, удаляет значение опции option по умолчанию.

В остальных случаях, если раздел section отсутствует, генерируется исключение NoSectionError. Если опция присутствовала, возвращает 1, иначе возвращает 0. Метод remove_option() доступен, начиная с версии 1.6.

remove_section(section)

Полностью удаляет раздел section. Если раздел присутствовал, возвращает 1, иначе возвращает 0.

30.3shlex — простой синтаксический анализатор

Класс shlex, определенный в этом модуле, значительно упрощает написание синтаксических анализаторов для командных языков с простым синтаксисом, подобных UNIX shell. Такая возможность часто полезна для написания мини-языков, используемых, например, для написания конфигурационных файлов (см. также описание модуля

ConfigParser).

shlex([stream [, file]])

Инициализирует и возвращает объект, представляющий лексический анализатор. Аргумент stream должен быть файловым объектом (или подобным, с методами read() и readline()) и определяет поток ввода анализатора, по умолчанию используется sys.stdin. Если задан аргумент file, он определяет имя файла (используется для инициализации атрибута infile).

Экземпляры класса shlex имеют следующие методы:

get_token()

Возвращает очередную лексему. Лексема может быть считана из стека (если она была записана туда с помощью метода push_token()) или из входного потока. При достижении конца файла возвращает пустую строку.

push_token(str)

Записывает строку str в качестве лексемы в стек.

read_token()

Считывает из входного потока (игнорируя стек) и возвращает очередную лексему. Этот метод также игнорирует запросы на включения файла.

sourcehook(filename)

Этот метод вызывается для обработки запросов на включение файла. Аргумент filename является строкой, следующей за лексемой включения файла (атрибут source). Метод sourcehook() должен возвращать кортеж, содержащий имя файла и файловый (или подобный) объект.

416 Глава 30. Разное

error_leader([file [, line]])

Возвращает начало сообщения об ошибке в формате ’"file", line line: ’. Если аргументы file и/или line опущены, используются текущие имя файла и номер строки. Такой формат сообщения об ошибке является общепринятым и воспринимается редактором Emacs и другими инструментами UNIX.

Экземпляры класса shlex также имеют следующие атрибуты, управляющие процессом лексического анализа:

commenters

Строка символов, которые воспринимаются как начало комментария. Все символы от начала комментария до конца строки игнорируются. По умолчанию включает только символ ‘#’.

wordchars

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

whitespace

Строка из символов, которые считаются разделителями лексем (символы пропуска). По умолчанию этот атрибут равен ’ \t\r\n’.

quotes

Строка из символов, которые воспринимаются как кавычки. Лексема, начинающаяся с одного из символов кавычки, всегда заканчивается точно таким же символом (таким образом, строка в кавычках одного типа может содержать кавычки другого типа). По умолчанию включает одиночную и двойную кавычку.

infile

Имя текущего входного файла (или None, если имя файла не установлено). Полезен при конструировании сообщений об ошибке.

instream

Файловый объект, представляющий текущий входной поток.

source

По умолчанию этот атрибут равен None. Если ему присвоить строку, то эта строка будет восприниматься как лексема запроса на включение файла. Следующая после source лексема будет восприниматься как имя файла, содержимое которого должно быть обработано лексическим анализатором. После обработки включенного файла лексический анализатор продолжает обработку текущего потока.

debug

Целое число, определяющее, насколько подробной должна быть выводимая отладочная информация. Если атрибут debug равен 0, отладочная информация не выводится.

lineno

Номер текущей строки (число прочитанных символов перехода на новую строку плюс 1).

token

Буфер лексем. Может быть полезен при обработке исключений.

Обратите внимание, что символы, не входящие в строки wordchars, whitespace и quotes, воспринимаются как односимвольные лексемы. Кроме того, символы кавычек внутри слов теряют свое значение, а комментарии маскируют также и символ перехода на новую строку. Так, ввод ‘ain’t’ и ain#d\n’t будут восприняты как одна и та же лексема — строка "ain’t".

30.4cmd — создание командных интерпретаторов

Этот модуль определяет класс Cmd, который может служить основой при написании командных интерпретаторов, ориентированных на строки. Хорошим примером использования этого метода может послужить отладчик языка Python (модуль pdb).

Cmd()

Этот класс реализует основу интерпретатора. Производные от него классы должны предоставить методы, реализующие действия при вводе различных команд.

Экземпляры класса Cmd имеют следующие методы и атрибуты данных:

cmdloop([intro])

Выполняет в цикле следующие операции: выводит приглашение, воспринимает ввод, обрабатывает начало введенной команды и вызывает для ее выполнения соответствующий метод, передавая в качестве аргумента остаток строки. Аргумент intro (строка) определяет выводимый перед первым приглашением заголовок, по умолчанию используется атрибут intro.

Интерпретатор будет воспринимать команду ‘foo’ только, если объект имеет метод do_foo(). Символы ‘?’ и ‘!’ в начале строки воспринимаются как команды ‘help’ и ‘shell’ соответственно, конец файла — как команда ‘EOF’.

Предопределенный метод do_help с аргументом ’bar’ вызывает метод help_bar(). Без аргументов do_help() выводит список всех доступных тем, для которых может быть получена помощь (определен соответствующий метод help_*()), и список недокументированных команд. Класс Cmd не определяет методы do_shell() и do_EOF().

Большинство методов do_*() должно возвращать None. Если возвращаемое значение является истиной (и метод postcmd() не переопределен), работа интерпретатора будет завершена.

onecmd(str)

Воспринимает строку str, как если бы она была введена в ответ на приглашение интерпретатора.

misc_header

Заголовок к списку доступных тем помощи, не являющихся командами (то есть, для которых есть метод help_*(), но нет соответствующего метода do_*()).

undoc_header

Заголовок к списку недокументированных команд (для которых есть соответствующий метод do_*(), но нет метода help_*()).

ruler

Символ, который используется для линий под заголовком помощи. Если является пустой строкой, линия не будет использована. По умолчанию атрибут ruler равен

’=’.

30.5 calendar — функции для работы с календарем

Этот модуль предоставляет функции для работы с календарем, а также позволяет выводить календарь аналогично программе cal. По умолчанию считается, что неделя начинается с понедельника. Чтобы установить иной день, например воскресенье, используйте функцию setfirstweekday().

MONDAY

TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY

SUNDAY

Константы со значениями от 0 (понедельник) до 6 (воскресенье), представляющие дни недели.

setfirstweekday(weekday)

Устанавливает использование weekday (целое число от 0 до 6) в качестве первого дня недели. Например, следующий фрагмент устанавливает использование в качестве первого дня недели воскресенья:

import calendar calendar.setfirstweekday(calendar.SUNDAY)

firstweekday()

Возвращает целое число от 0 до 6, определяющее день недели, с которого (согласно текущим установкам) неделя начинается.

isleap(year)

Возвращает 1, если год year (целое число) является високосным, иначе возвращает 0.

leapdays(y1, y2)

Возвращает число високосных лет в промежутке с y1 по y2 - 1 год (включительно).

weekday(year, month, day)

Возвращает целое число, определяющее день недели для указанной даты. year — год (см. замечания в описании модуля time), month — месяц (от 1 до 12) и day — число (от 1 до 31). Например, следующий код позволяет вывести номера месяцев 2000 года, в которых 13 число приходится на пятницу:

>>>from calendar import weekday, FRIDAY

>>>for month in xrange(1, 13):

... if weekday(2000, month, 13)==FRIDAY:

... print month

...

10

monthrange(year, month)

Возвращает кортеж, содержащий первый день недели месяца (целое число от 0 до 6) и число дней в месяце для указанного года (аргумент year) и месяца (аргумент month).

monthcalendar(year, month)

Возвращает матрицу (список списков), представляющую календарь на месяц для указанного года (аргумент year) и месяца (аргумент month). Каждый элемент возвращаемого списка представляет собой список из семи элементов — чисел для каждого дня недели. Дни, выходящие за пределы месяца, представлены нулями. Неделя начинается с понедельника, если иной день не был установлен с помощью функции setfirstweekday().

month(theyear, themonth [, datewidth [, linesperweek]])

Возвращает строковое представление календаря на месяц для указанного года (аргумент theyear) и месяца (аргумент themonth). Аргументы datewidth и linesperweek определяют ширину поля даты и число строк, используемых для одной недели.

prmonth(theyear, themonth [, datewidth [, linesperweek]])

Выводит на стандартный поток вывода (sys.stdout) календарь на месяц. Аргументы имеют такое же значение, как и для функции month().

calendar(year [, datewidth [, linesperweek [, spaces]]])

Возвращает строковое представление в три колонки календаря на год year. Аргументы datewidth, linesperweek и spaces определяют ширину поля даты, число строк, используемых для одной недели, и количество пробелов между колонками с календарями на месяц.

prcal()

Выводит на стандартный поток вывода (sys.stdout) календарь на год. Аргументы имеют такое же значение, как и для функции calendar().