netrc — обработка файла netrc

Новая в версии 1.5.2.

Исходный код: Lib/netrc.py

Класс netrc парсит и инкапсулирует формат файла netrc, используемый программой Unix ftp и другими клиентами FTP.

class netrc.netrc([file]): Экземпляр класса netrc или экземпляр подкласса инкапсулирует данные из файла netrc. Аргумент инициализации, если он присутствует, указывает на файл для парсинга. Если аргумент не указан, будет прочитан файл .netrc в домашнем каталоге пользователя. Ошибки парсинга вызовут исключение NetrcParseError с диагностической информацией, включая имя файла, номер строки и завершающий токен. Если на POSIX-системе аргумент не указан, наличие паролей в файле .netrc вызовет исключение NetrcParseError, если права доступа к файлу небезопасны (файл принадлежит пользователю, отличному от пользователя, запускающего процесс, или доступен для чтения или записи любым другим пользователем). Это реализует поведение безопасности, эквивалентное поведению программ ftp и других программ, использующих .netrc.

Изменено в версии 2.7.6: Добавлен POSIX-проверка прав доступа.

exception netrc.NetrcParseError: Исключение, генерируемое классом netrc при обнаружении синтаксических ошибок в исходном тексте. Экземпляры этого исключения предоставляют три интересных атрибута: msg — текстовое объяснение ошибки, filename — имя исходного файла и lineno — номер строки, в которой была обнаружена ошибка.

1. Объекты netrc

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

netrc.authenticators(host): Возвращает кортеж из 3 элементов (login, account, password) аутентификаторов для host. Если в файле netrc не было записи для данного хоста, возвращает кортеж, связанный с записью ‘default’. Если ни запись для соответствующего хоста, ни запись ‘default’ не доступны, возвращает None.

netrc.__repr__(): Выводит данные класса в виде строки в формате файла netrc. (Это отбрасывает комментарии и может изменить порядок записей.)

Экземпляры класса netrc имеют публичные переменные экземпляра:

netrc.hosts: Словарь, сопоставляющий имена хостов с кортежами (login, account, password). Запись ‘default’, если она есть, представлена псевдо-хостом с этим именем.

netrc.macros: Словарь, сопоставляющий имена макросов спискам строк.

Примечание

Пароли ограничены подмножеством символов ASCII. Предыдущие версии этого модуля имели очень ограниченный функционал. Начиная с версии 2.3, в паролях разрешены все знаки препинания ASCII. Однако обратите внимание, что пробелы и непечатаемые символы запрещены в паролях. Это ограничение связано с тем, как парсится файл .netrc, и может быть удалено в будущем.