blob: 90255df8d3c8e7882e68574e1a06f7555279796d [file] [log] [blame]
Guido van Rossum54f22ed2000-02-04 15:10:34 +00001"""An object-oriented interface to .netrc files."""
2
Tim Peters2344fae2001-01-15 00:50:52 +00003# Module and documentation by Eric S. Raymond, 21 Dec 1998
Guido van Rossum9c30c241998-12-22 05:19:29 +00004
Guido van Rossum1e1cfa31999-05-03 18:10:37 +00005import os, shlex
Guido van Rossum9c30c241998-12-22 05:19:29 +00006
Fred Drakeec6ec902001-03-06 06:33:08 +00007__all__ = ["netrc", "NetrcParseError"]
8
9
10class NetrcParseError(Exception):
11 """Exception raised on syntax errors in the .netrc file."""
12 def __init__(self, msg, filename=None, lineno=None):
Guido van Rossum815bee42001-04-15 12:51:42 +000013 self.filename = filename
Fred Drakeec6ec902001-03-06 06:33:08 +000014 self.lineno = lineno
15 self.msg = msg
16 Exception.__init__(self, msg)
17
18 def __str__(self):
19 return "%s (%s, line %s)" % (self.msg, self.filename, self.lineno)
20
Skip Montanaro269b83b2001-02-06 01:07:02 +000021
Guido van Rossum9c30c241998-12-22 05:19:29 +000022class netrc:
23 def __init__(self, file=None):
Raymond Hettinger16e3c422002-06-01 16:07:16 +000024 if file is None:
Paul Prescodb845f3b2002-03-18 02:13:48 +000025 try:
26 file = os.path.join(os.environ['HOME'], ".netrc")
27 except KeyError:
28 raise IOError("Could not find .netrc: $HOME is not set")
Guido van Rossum9c30c241998-12-22 05:19:29 +000029 self.hosts = {}
30 self.macros = {}
Guido van Rossumc12a8132007-10-26 04:29:23 +000031 with open(file) as fp:
32 self._parse(file, fp)
33
34 def _parse(self, file, fp):
Guido van Rossum9c30c241998-12-22 05:19:29 +000035 lexer = shlex.shlex(fp)
Raymond Hettinger6eca3582003-04-23 18:59:54 +000036 lexer.wordchars += r"""!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~"""
Guido van Rossum9c30c241998-12-22 05:19:29 +000037 while 1:
38 # Look for a machine, default, or macdef top-level keyword
39 toplevel = tt = lexer.get_token()
Fred Drake8152d322000-12-12 23:20:45 +000040 if not tt:
Guido van Rossum9c30c241998-12-22 05:19:29 +000041 break
42 elif tt == 'machine':
43 entryname = lexer.get_token()
44 elif tt == 'default':
45 entryname = 'default'
Tim Peters2344fae2001-01-15 00:50:52 +000046 elif tt == 'macdef': # Just skip to end of macdefs
Guido van Rossum9c30c241998-12-22 05:19:29 +000047 entryname = lexer.get_token()
48 self.macros[entryname] = []
Andrew M. Kuchling366a1df2002-03-22 02:46:41 +000049 lexer.whitespace = ' \t'
Guido van Rossum9c30c241998-12-22 05:19:29 +000050 while 1:
51 line = lexer.instream.readline()
Andrew M. Kuchling366a1df2002-03-22 02:46:41 +000052 if not line or line == '\012':
53 lexer.whitespace = ' \t\r\n'
Guido van Rossum9c30c241998-12-22 05:19:29 +000054 break
Guido van Rossum9c30c241998-12-22 05:19:29 +000055 self.macros[entryname].append(line)
Andrew M. Kuchling366a1df2002-03-22 02:46:41 +000056 continue
Guido van Rossum9c30c241998-12-22 05:19:29 +000057 else:
Fred Drakeec6ec902001-03-06 06:33:08 +000058 raise NetrcParseError(
59 "bad toplevel token %r" % tt, file, lexer.lineno)
Guido van Rossum9c30c241998-12-22 05:19:29 +000060
61 # We're looking at start of an entry for a named machine or default.
Raymond Hettingerb34ef942003-04-24 20:11:20 +000062 login = ''
63 account = password = None
Andrew M. Kuchling366a1df2002-03-22 02:46:41 +000064 self.hosts[entryname] = {}
Guido van Rossum9c30c241998-12-22 05:19:29 +000065 while 1:
66 tt = lexer.get_token()
Andrew M. Kuchling366a1df2002-03-22 02:46:41 +000067 if (tt=='' or tt == 'machine' or
68 tt == 'default' or tt =='macdef'):
Raymond Hettingerb34ef942003-04-24 20:11:20 +000069 if password:
Guido van Rossum9c30c241998-12-22 05:19:29 +000070 self.hosts[entryname] = (login, account, password)
71 lexer.push_token(tt)
72 break
73 else:
Fred Drakeec6ec902001-03-06 06:33:08 +000074 raise NetrcParseError(
75 "malformed %s entry %s terminated by %s"
76 % (toplevel, entryname, repr(tt)),
77 file, lexer.lineno)
Guido van Rossum9c30c241998-12-22 05:19:29 +000078 elif tt == 'login' or tt == 'user':
79 login = lexer.get_token()
80 elif tt == 'account':
81 account = lexer.get_token()
82 elif tt == 'password':
83 password = lexer.get_token()
84 else:
Fred Drakeec6ec902001-03-06 06:33:08 +000085 raise NetrcParseError("bad follower token %r" % tt,
86 file, lexer.lineno)
Guido van Rossum9c30c241998-12-22 05:19:29 +000087
88 def authenticators(self, host):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000089 """Return a (user, account, password) tuple for given host."""
Raymond Hettinger54f02222002-06-01 14:18:47 +000090 if host in self.hosts:
Guido van Rossum9c30c241998-12-22 05:19:29 +000091 return self.hosts[host]
Raymond Hettinger54f02222002-06-01 14:18:47 +000092 elif 'default' in self.hosts:
Guido van Rossum9c30c241998-12-22 05:19:29 +000093 return self.hosts['default']
94 else:
95 return None
96
97 def __repr__(self):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000098 """Dump the class data in the format of a .netrc file."""
Guido van Rossum9c30c241998-12-22 05:19:29 +000099 rep = ""
100 for host in self.hosts.keys():
101 attrs = self.hosts[host]
102 rep = rep + "machine "+ host + "\n\tlogin " + repr(attrs[0]) + "\n"
103 if attrs[1]:
104 rep = rep + "account " + repr(attrs[1])
105 rep = rep + "\tpassword " + repr(attrs[2]) + "\n"
106 for macro in self.macros.keys():
107 rep = rep + "macdef " + macro + "\n"
108 for line in self.macros[macro]:
109 rep = rep + line
110 rep = rep + "\n"
111 return rep
112
Tim Peters2344fae2001-01-15 00:50:52 +0000113if __name__ == '__main__':
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000114 print(netrc())