← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python3.4/trusty-proposed

« back to all changes in this revision

Viewing changes to Doc/library/netrc.rst

  • Committer: Package Import Robot
  • Author(s): Matthias Klose
  • Date: 2013-11-25 09:44:27 UTC
  • Revision ID: package-import@ubuntu.com-20131125094427-lzxj8ap5w01lmo7f
Tags: upstream-3.4~b1
Import upstream version 3.4~b1

Show diffs side-by-side

added added

removed removed

Lines of Context:
Doc/library/netrc.rst
 
1
 
 
2
:mod:`netrc` --- netrc file processing
 
3
======================================
 
4
 
 
5
.. module:: netrc
 
6
   :synopsis: Loading of .netrc files.
 
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
 
 
14
The :class:`netrc` class parses and encapsulates the netrc file format used by
 
15
the Unix :program:`ftp` program and other FTP clients.
 
16
 
 
17
 
 
18
.. class:: netrc([file])
 
19
 
 
20
   A :class:`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 will
 
23
   be read.  Parse errors will raise :exc:`NetrcParseError` with diagnostic
 
24
   information including the file name, line number, and terminating token.
 
25
   If no argument is specified on a POSIX system, the presence of passwords in
 
26
   the :file:`.netrc` file will raise a :exc:`NetrcParseError` if the file
 
27
   ownership or permissions are insecure (owned by a user other than the user
 
28
   running the process, or accessible for read or write by any other user).
 
29
   This implements security behavior equivalent to that of ftp and other
 
30
   programs that use :file:`.netrc`.
 
31
 
 
32
   .. versionchanged:: 3.4 Added the POSIX permission check.
 
33
 
 
34
 
 
35
.. exception:: NetrcParseError
 
36
 
 
37
   Exception raised by the :class:`netrc` class when syntactical errors are
 
38
   encountered in source text.  Instances of this exception provide three
 
39
   interesting attributes:  :attr:`msg` is a textual explanation of the error,
 
40
   :attr:`filename` is the name of the source file, and :attr:`lineno` gives the
 
41
   line number on which the error was found.
 
42
 
 
43
 
 
44
.. _netrc-objects:
 
45
 
 
46
netrc Objects
 
47
-------------
 
48
 
 
49
A :class:`netrc` instance has the following methods:
 
50
 
 
51
 
 
52
.. method:: netrc.authenticators(host)
 
53
 
 
54
   Return a 3-tuple ``(login, account, password)`` of authenticators for *host*.
 
55
   If the netrc file did not contain an entry for the given host, return the tuple
 
56
   associated with the 'default' entry.  If neither matching host nor default entry
 
57
   is available, return ``None``.
 
58
 
 
59
 
 
60
.. method:: netrc.__repr__()
 
61
 
 
62
   Dump the class data as a string in the format of a netrc file. (This discards
 
63
   comments and may reorder the entries.)
 
64
 
 
65
Instances of :class:`netrc` have public instance variables:
 
66
 
 
67
 
 
68
.. attribute:: netrc.hosts
 
69
 
 
70
   Dictionary mapping host names to ``(login, account, password)`` tuples.  The
 
71
   'default' entry, if any, is represented as a pseudo-host by that name.
 
72
 
 
73
 
 
74
.. attribute:: netrc.macros
 
75
 
 
76
   Dictionary mapping macro names to string lists.
 
77
 
 
78
.. note::
 
79
 
 
80
   Passwords are limited to a subset of the ASCII character set.  All ASCII
 
81
   punctuation is allowed in passwords, however, note that whitespace and
 
82
   non-printable characters are not allowed in passwords.  This is a limitation
 
83
   of the way the .netrc file is parsed and may be removed in the future.
 
84