1:mod:`!netrc` --- netrc file processing 2======================================= 3 4.. module:: netrc 5 :synopsis: Loading of .netrc files. 6 7.. moduleauthor:: Eric S. Raymond <esr@snark.thyrsus.com> 8.. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> 9 10**Source code:** :source:`Lib/netrc.py` 11 12-------------- 13 14The :class:`~netrc.netrc` class parses and encapsulates the netrc file format used by 15the Unix :program:`ftp` program and other FTP clients. 16 17 18.. class:: netrc([file]) 19 20 A :class:`~netrc.netrc` instance or subclass instance encapsulates data from a netrc 21 file. The initialization argument, if present, specifies the file to parse. If 22 no argument is given, the file :file:`.netrc` in the user's home directory -- 23 as determined by :func:`os.path.expanduser` -- will be read. Otherwise, 24 a :exc:`FileNotFoundError` exception will be raised. 25 Parse errors will raise :exc:`NetrcParseError` with diagnostic 26 information including the file name, line number, and terminating token. 27 If no argument is specified on a POSIX system, the presence of passwords in 28 the :file:`.netrc` file will raise a :exc:`NetrcParseError` if the file 29 ownership or permissions are insecure (owned by a user other than the user 30 running the process, or accessible for read or write by any other user). 31 This implements security behavior equivalent to that of ftp and other 32 programs that use :file:`.netrc`. 33 34 .. versionchanged:: 3.4 Added the POSIX permission check. 35 36 .. versionchanged:: 3.7 37 :func:`os.path.expanduser` is used to find the location of the 38 :file:`.netrc` file when *file* is not passed as argument. 39 40 .. versionchanged:: 3.10 41 :class:`netrc` try UTF-8 encoding before using locale specific 42 encoding. 43 The entry in the netrc file no longer needs to contain all tokens. The missing 44 tokens' value default to an empty string. All the tokens and their values now 45 can contain arbitrary characters, like whitespace and non-ASCII characters. 46 If the login name is anonymous, it won't trigger the security check. 47 48 49.. exception:: NetrcParseError 50 51 Exception raised by the :class:`~netrc.netrc` class when syntactical errors are 52 encountered in source text. Instances of this exception provide three 53 interesting attributes: 54 55 .. attribute:: msg 56 57 Textual explanation of the error. 58 59 .. attribute:: filename 60 61 The name of the source file. 62 63 .. attribute:: lineno 64 65 The line number on which the error was found. 66 67 68.. _netrc-objects: 69 70netrc Objects 71------------- 72 73A :class:`~netrc.netrc` instance has the following methods: 74 75 76.. method:: netrc.authenticators(host) 77 78 Return a 3-tuple ``(login, account, password)`` of authenticators for *host*. 79 If the netrc file did not contain an entry for the given host, return the tuple 80 associated with the 'default' entry. If neither matching host nor default entry 81 is available, return ``None``. 82 83 84.. method:: netrc.__repr__() 85 86 Dump the class data as a string in the format of a netrc file. (This discards 87 comments and may reorder the entries.) 88 89Instances of :class:`~netrc.netrc` have public instance variables: 90 91 92.. attribute:: netrc.hosts 93 94 Dictionary mapping host names to ``(login, account, password)`` tuples. The 95 'default' entry, if any, is represented as a pseudo-host by that name. 96 97 98.. attribute:: netrc.macros 99 100 Dictionary mapping macro names to string lists. 101