From 5643cfc20d3e8c9ab55013370604d9f9499201e2 Mon Sep 17 00:00:00 2001
From: Sergio Oliveira Campos <seocam@redhat.com>
Date: Tue, 7 Apr 2020 16:07:52 -0300
Subject: [PATCH] Adjusted doc strings to follow PEP 257.
---
.../module_utils/ansible_freeipa_module.py | 48 ++++++-------------
.../action_plugins/ipaclient_get_otp.py | 19 ++++----
roles/ipaclient/library/ipaclient_get_otp.py | 13 ++---
roles/ipaclient/library/ipaclient_test.py | 4 +-
setup.cfg | 4 ++
5 files changed, 35 insertions(+), 53 deletions(-)
diff --git a/plugins/module_utils/ansible_freeipa_module.py b/plugins/module_utils/ansible_freeipa_module.py
index 9e3254a3..7f76c7d5 100644
--- a/plugins/module_utils/ansible_freeipa_module.py
+++ b/plugins/module_utils/ansible_freeipa_module.py
@@ -63,9 +63,7 @@ if six.PY3:
def valid_creds(module, principal): # noqa
- """
- Get valid credintials matching the princial, try GSSAPI first
- """
+ """Get valid credintials matching the princial, try GSSAPI first."""
if "KRB5CCNAME" in os.environ:
ccache = os.environ["KRB5CCNAME"]
module.debug('KRB5CCNAME set to %s' % ccache)
@@ -103,9 +101,7 @@ def valid_creds(module, principal): # noqa
def temp_kinit(principal, password):
- """
- kinit with password using a temporary ccache
- """
+ """Kinit with password using a temporary ccache."""
if not password:
raise RuntimeError("The password is not set")
if not principal:
@@ -123,9 +119,7 @@ def temp_kinit(principal, password):
def temp_kdestroy(ccache_dir, ccache_name):
- """
- Destroy temporary ticket and remove temporary ccache
- """
+ """Destroy temporary ticket and remove temporary ccache."""
if ccache_name is not None:
run([paths.KDESTROY, '-c', ccache_name], raiseonerr=False)
if ccache_dir is not None:
@@ -133,9 +127,7 @@ def temp_kdestroy(ccache_dir, ccache_name):
def api_connect(context=None):
- """
- Create environment, initialize api and connect to ldap2
- """
+ """Create environment, initialize api and connect to ldap2."""
env = Env()
env._bootstrap()
env._finalize_core(**dict(DEFAULT_CONFIG))
@@ -157,28 +149,24 @@ def api_connect(context=None):
def api_command(module, command, name, args):
- """
- Call ipa.Command
- """
+ """Call ipa.Command."""
return api.Command[command](name, **args)
def api_command_no_name(module, command, args):
- """
- Call ipa.Command without a name.
- """
+ """Call ipa.Command without a name."""
return api.Command[command](**args)
def api_check_param(command, name):
- """
- Return if param exists in command param list
- """
+ """Return if param exists in command param list."""
return name in api.Command[command].params
def execute_api_command(module, principal, password, command, name, args):
"""
+ Execute an API command.
+
Get KRB ticket if not already there, initialize api, connect,
execute command and destroy ticket again if it has been created also.
"""
@@ -300,10 +288,7 @@ def api_get_realm():
def gen_add_del_lists(user_list, res_list):
- """
- Generate the lists for the addition and removal of members using the
- provided user and ipa settings
- """
+ """Generate the lists for the addition and removal of members."""
add_list = list(set(user_list or []) - set(res_list or []))
del_list = list(set(res_list or []) - set(user_list or []))
@@ -312,8 +297,9 @@ def gen_add_del_lists(user_list, res_list):
def encode_certificate(cert):
"""
- Encode a certificate using base64 with also taking FreeIPA and Python
- versions into account
+ Encode a certificate using base64.
+
+ It also takes FreeIPA and Python versions into account.
"""
if isinstance(cert, (str, unicode, bytes)):
encoded = base64.b64encode(cert)
@@ -335,9 +321,7 @@ def is_valid_port(port):
def is_ipv4_addr(ipaddr):
- """
- Test if figen IP address is a valid IPv4 address
- """
+ """Test if figen IP address is a valid IPv4 address."""
try:
socket.inet_pton(socket.AF_INET, ipaddr)
except socket.error:
@@ -346,9 +330,7 @@ def is_ipv4_addr(ipaddr):
def is_ipv6_addr(ipaddr):
- """
- Test if figen IP address is a valid IPv6 address
- """
+ """Test if figen IP address is a valid IPv6 address."""
try:
socket.inet_pton(socket.AF_INET6, ipaddr)
except socket.error:
diff --git a/roles/ipaclient/action_plugins/ipaclient_get_otp.py b/roles/ipaclient/action_plugins/ipaclient_get_otp.py
index b7e80567..dcddc0ae 100644
--- a/roles/ipaclient/action_plugins/ipaclient_get_otp.py
+++ b/roles/ipaclient/action_plugins/ipaclient_get_otp.py
@@ -33,9 +33,7 @@ from ansible.plugins.action import ActionBase
def run_cmd(args, stdin=None):
- """
- Execute an external command.
- """
+ """Execute an external command."""
p_in = None
p_out = subprocess.PIPE
p_err = subprocess.PIPE
@@ -53,8 +51,10 @@ def run_cmd(args, stdin=None):
def kinit_password(principal, password, ccache_name, config):
"""
- Perform kinit using principal/password, with the specified config file
- and store the TGT in ccache_name.
+ Perform kinit using principal/password.
+
+ It uses the specified config file to kinit and stores the TGT
+ in ccache_name.
"""
args = ["/usr/bin/kinit", principal, '-c', ccache_name]
old_config = os.environ.get('KRB5_CONFIG')
@@ -71,8 +71,10 @@ def kinit_password(principal, password, ccache_name, config):
def kinit_keytab(principal, keytab, ccache_name, config):
"""
- Perform kinit using principal/keytab, with the specified config file
- and store the TGT in ccache_name.
+ Perform kinit using principal/keytab.
+
+ It uses the specified config file to kinit and stores the TGT
+ in ccache_name.
"""
if gssapi is None:
raise ImportError("gssapi is not available")
@@ -126,7 +128,7 @@ class ActionModule(ActionBase):
def run(self, tmp=None, task_vars=None):
"""
- handler for credential cache transfer
+ Handle credential cache transfer.
ipa* commands can either provide a password or a keytab file
in order to authenticate on the managed node with Kerberos.
@@ -142,7 +144,6 @@ class ActionModule(ActionBase):
Then the IPA commands can use this credential cache file.
"""
-
if task_vars is None:
task_vars = dict()
diff --git a/roles/ipaclient/library/ipaclient_get_otp.py b/roles/ipaclient/library/ipaclient_get_otp.py
index f0c35c7d..93734295 100644
--- a/roles/ipaclient/library/ipaclient_get_otp.py
+++ b/roles/ipaclient/library/ipaclient_get_otp.py
@@ -135,8 +135,7 @@ if six.PY3:
def get_host_diff(ipa_host, module_host):
"""
- Compares two dictionaries containing host attributes and builds a dict
- of differences.
+ Compare two host dicts and builds a dict of differences.
:param ipa_host: the host structure seen from IPA
:param module_host: the target host structure seen from the module params
@@ -164,7 +163,7 @@ def get_host_diff(ipa_host, module_host):
def get_module_host(module):
"""
- Creates a structure representing the host information
+ Create a structure representing the host information.
Reads the module parameters and builds the host structure as expected from
the module
@@ -189,7 +188,7 @@ def get_module_host(module):
def ensure_host_present(module, api, ipahost):
"""
- Ensures that the host exists in IPA and has the same attributes.
+ Ensure that the host exists in IPA and has the same attributes.
:param module: the ansible module
:param api: IPA api handle
@@ -246,7 +245,7 @@ def ensure_host_present(module, api, ipahost):
def ensure_host_absent(module, api, host):
"""
- Ensures that the host does not exist in IPA
+ Ensure that the host does not exist in IPA.
:param module: the ansible module
:param api: the IPA API handle
@@ -271,9 +270,7 @@ def ensure_host_absent(module, api, host):
def main():
- """
- Main routine for the ansible module.
- """
+
module = AnsibleModule(
argument_spec=dict(
principal=dict(default='admin'),
diff --git a/roles/ipaclient/library/ipaclient_test.py b/roles/ipaclient/library/ipaclient_test.py
index 8e1d11cf..d5d7f718 100644
--- a/roles/ipaclient/library/ipaclient_test.py
+++ b/roles/ipaclient/library/ipaclient_test.py
@@ -235,7 +235,6 @@ def is_client_configured():
:returns: boolean
"""
-
return (os.path.isfile(paths.IPA_DEFAULT_CONF) and
os.path.isfile(os.path.join(paths.IPA_CLIENT_SYSRESTORE,
sysrestore.SYSRESTORE_STATEFILE)))
@@ -243,11 +242,10 @@ def is_client_configured():
def get_ipa_conf():
"""
- Return IPA configuration read from /etc/ipa/default.conf
+ Return IPA configuration read from `/etc/ipa/default.conf`.
:returns: dict containing key,value
"""
-
parser = RawConfigParser()
parser.read(paths.IPA_DEFAULT_CONF)
result = dict()
diff --git a/setup.cfg b/setup.cfg
index d73375ef..d87f6f06 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -26,3 +26,7 @@ extend-ignore = E203
per-file-ignores =
plugins/*:E402
roles/*:E402
+
+[pydocstyle]
+inherit = false
+ignore = D1,D212,D203
--
GitLab