netrc — traitement de fichier netrc

Code source : Lib/netrc.py

La classe netrc analyse et encapsule le format de fichier netrc utilisé par le programme Unix ftp et d'autres clients FTP.

class netrc.netrc([file])

Une instance de netrc ou une instance de sous-classe encapsule les données à partir d'un fichier netrc. L'argument d'initialisation, s'il est présent, précise le fichier à analyser. Si aucun argument n'est donné, le fichier .netrc dans le répertoire d’accueil de l'utilisateur -- déterminé par os.path.expanduser() -- est lu. Sinon, l'exception FileNotFoundError sera levée. Les erreurs d'analyse lèveront NetrcParseError avec les informations de diagnostic, y compris le nom de fichier, le numéro de ligne, et le lexème. Si aucun argument n'est spécifié dans un système POSIX, la présence de mots de passe dans le fichier .netrc lèvera NetrcParseError si la propriété du fichier ou les permissions ne sont pas sécurisées (propriété d'un utilisateur autre que l'utilisateur exécutant le processus ou accessible en lecture ou en écriture par n'importe quel autre utilisateur). Le niveau de sécurité offert est ainsi équivalent à celui de ftp et d'autres programmes utilisant netrc.

Modifié dans la version 3.4: Ajout de la vérification d'autorisations POSIX.

Modifié dans la version 3.7: os.path.expanduser() est utilisée pour trouver l'emplacement du fichier netrc lorsque file n'est pas passé en tant qu'argument.

Modifié dans la version 3.10: netrc try UTF-8 encoding before using locale specific encoding.

exception netrc.NetrcParseError

Exception levée par la classe netrc lorsque des erreurs syntaxiques sont rencontrées dans le texte source. Les instances de cette exception fournissent trois attributs intéressants : msg est une explication textuelle de l'erreur, filename est le nom du fichier source et lineno donne le numéro de la ligne sur laquelle l'erreur a été trouvée.

Objets netrc

Une instance netrc a les méthodes suivantes :

netrc.authenticators(host)

Renvoie un triplet (login, account, password) pour s'authentifier auprès de l'hôte host. Si le fichier netrc ne contient pas d'entrée pour l'hôte donné, renvoie le triplet associé à l'entrée par défaut. Si aucun hôte correspondant ni aucune entrée par défaut n'est disponible, renvoie None.

netrc.__repr__()

Déverse les données de la classe sous forme de chaîne dans le format d'un fichier netrc. (Ceci ignore les commentaires et peut réorganiser les entrées).

Les instances de netrc ont des variables d'instance publiques :

netrc.hosts

Dictionnaire faisant correspondre les noms d'hôtes dans des triplets (login, account, password). L'entrée par défaut, le cas échéant, est représentée en tant que pseudo-hôte par ce nom.

netrc.macros

Dictionnaire faisant correspondre les noms de macro en listes de chaînes.

Note

Les mots de passe sont limités à un sous-ensemble du jeu de caractères ASCII. Toute ponctuation ASCII est autorisée dans les mots de passe, cependant notez que les espaces et les caractères non imprimables ne sont pas autorisés dans les mots de passe. C'est une limitation de la façon dont le fichier .netrc est analysé et pourra être supprimée à l'avenir.