From 73ed9c7e71633049ffb9cad333792cdcfef00243 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Wed, 6 Feb 2019 16:18:37 +0100
Subject: [PATCH] added a docstring
---
inventory_provider/juniper.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/inventory_provider/juniper.py b/inventory_provider/juniper.py
index a17825c0..68064862 100644
--- a/inventory_provider/juniper.py
+++ b/inventory_provider/juniper.py
@@ -322,6 +322,14 @@ def local_interfaces(
type=netifaces.AF_INET,
omit_link_local=True,
omit_loopback=True):
+ """
+ generator yielding IPv4Interface or IPv6Interface objects,
+ depending on the value of type
+ :param type: hopefully AF_INET or AF_INET6
+ :param omit_link_local: skip v6 fe80* addresses if true
+ :param omit_loopback: skip lo* interfaces if true
+ :return:
+ """
for n in netifaces.interfaces():
if omit_loopback and re.match(r'^lo\d+', n):
continue
--
GitLab