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

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

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

class netrc.netrc([file])

Объект netrc или экземпляр подкласса инкапсулирует данные из файла netrc. Аргумент инициализации, если он присутствует, указывает на файл для парсинга. Если аргумент не указан, считывается файл .netrc в домашнем каталоге пользователя — как определено функцией os.path.expanduser(). В противном случае будет поднято исключение FileNotFoundError. Ошибки парсинга вызовут исключение NetrcParseError с диагностической информацией, включая имя файла, номер строки и завершающий токен. Если на POSIX-системе аргумент не указан, наличие паролей в файле .netrc вызовет исключение NetrcParseError, если права доступа к файлу небезопасны (владелец файла — пользователь, отличный от пользователя, запускающего процесс, или доступ для чтения или записи другими пользователями). Это реализует поведение безопасности, эквивалентное поведению программ ftp и других программ, использующих .netrc.

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

Изменено в версии 3.7: Для поиска расположения файла .netrc при отсутствии параметра file используется os.path.expanduser().

exception netrc.NetrcParseError

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

Объекты 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

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