From 0ef87c849febf9395853e44e6ed220c3748a343a Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Thu, 28 Sep 2017 04:37:54 +0200 Subject: [PATCH] virt: PEP8 compliancy and doc fixes (#30917) This PR includes: - PEP8 compliancy fixes - Documentation fixes --- lib/ansible/modules/cloud/misc/virt.py | 162 +++++++++++-------------- test/sanity/pep8/legacy-files.txt | 1 - 2 files changed, 74 insertions(+), 89 deletions(-) diff --git a/lib/ansible/modules/cloud/misc/virt.py b/lib/ansible/modules/cloud/misc/virt.py index d18fa37de50..edfd3aec861 100644 --- a/lib/ansible/modules/cloud/misc/virt.py +++ b/lib/ansible/modules/cloud/misc/virt.py @@ -1,21 +1,18 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# Copyright 2007, 2012 Red Hat, Inc +# Copyright: (c) 2007, 2012 Red Hat, Inc # Michael DeHaan # Seth Vidal -# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type - ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community'} - DOCUMENTATION = ''' --- module: virt @@ -29,46 +26,35 @@ options: - name of the guest VM being managed. Note that VM must be previously defined with xml. required: true - default: null - aliases: [] state: description: - Note that there may be some lag for state requests like C(shutdown) since these refer only to VM states. After starting a guest, it may not be immediately accessible. - required: false - choices: [ "running", "shutdown", "destroyed", "paused" ] - default: "no" + choices: [ destroyed, paused, running, shutdown ] command: description: - - in addition to state management, various non-idempotent commands are available. See examples - required: false - choices: ["create","status", "start", "stop", "pause", "unpause", - "shutdown", "undefine", "destroy", "get_xml", - "freemem", "list_vms", "info", "nodeinfo", "virttype", "define"] + - In addition to state management, various non-idempotent commands are available. + choices: [ create, define, destroy, freemem, get_xml, info, list_vms, nodeinfo, pause, shutdown, start, status, stop, undefine, unpause, virttype ] autostart: description: - - start VM at host startup - choices: [True, False] + - start VM at host startup. + type: bool version_added: "2.3" - default: null uri: description: - - libvirt connection uri - required: false + - libvirt connection uri. default: qemu:///system xml: description: - - XML document used with the define command - required: false - default: null + - XML document used with the define command. requirements: - - "python >= 2.6" - - "libvirt-python" + - python >= 2.6 + - libvirt-python author: - - "Ansible Core Team" - - "Michael DeHaan" - - "Seth Vidal" + - Ansible Core Team + - Michael DeHaan + - Seth Vidal ''' EXAMPLES = ''' @@ -131,28 +117,29 @@ from ansible.module_utils._text import to_native VIRT_FAILED = 1 VIRT_SUCCESS = 0 -VIRT_UNAVAILABLE=2 +VIRT_UNAVAILABLE = 2 ALL_COMMANDS = [] -VM_COMMANDS = ['create','status', 'start', 'stop', 'pause', 'unpause', - 'shutdown', 'undefine', 'destroy', 'get_xml', 'define'] -HOST_COMMANDS = ['freemem', 'list_vms', 'info', 'nodeinfo', 'virttype'] +VM_COMMANDS = ['create', 'define', 'destroy', 'get_xml', 'pause', 'shutdown', 'status', 'start', 'stop' 'undefine', 'unpause'] +HOST_COMMANDS = ['freemem', 'info', 'list_vms', 'nodeinfo', 'virttype'] ALL_COMMANDS.extend(VM_COMMANDS) ALL_COMMANDS.extend(HOST_COMMANDS) VIRT_STATE_NAME_MAP = { - 0 : "running", - 1 : "running", - 2 : "running", - 3 : "paused", - 4 : "shutdown", - 5 : "shutdown", - 6 : "crashed" + 0: 'running', + 1: 'running', + 2: 'running', + 3: 'paused', + 4: 'shutdown', + 5: 'shutdown', + 6: 'crashed', } + class VMNotFound(Exception): pass + class LibvirtConnection(object): def __init__(self, uri, module): @@ -230,11 +217,11 @@ class LibvirtConnection(object): def get_status2(self, vm): state = vm.info()[0] - return VIRT_STATE_NAME_MAP.get(state,"unknown") + return VIRT_STATE_NAME_MAP.get(state, "unknown") def get_status(self, vmid): state = self.find_vm(vmid).info()[0] - return VIRT_STATE_NAME_MAP.get(state,"unknown") + return VIRT_STATE_NAME_MAP.get(state, "unknown") def nodeinfo(self): return self.conn.getInfo() @@ -288,7 +275,7 @@ class Virt(object): state = [] for vm in vms: state_blurb = self.conn.get_status(vm) - state.append("%s %s" % (vm,state_blurb)) + state.append("%s %s" % (vm, state_blurb)) return state def info(self): @@ -301,31 +288,30 @@ class Virt(object): # This throws exceptions, so convert them to strings here and # assume the other end of the xmlrpc connection can figure things # out or doesn't care. - info[vm] = { - "state" : VIRT_STATE_NAME_MAP.get(data[0],"unknown"), - "maxMem" : str(data[1]), - "memory" : str(data[2]), - "nrVirtCpu" : data[3], - "cpuTime" : str(data[4]), - } - info[vm]["autostart"] = self.conn.get_autostart(vm) + info[vm] = dict( + state=VIRT_STATE_NAME_MAP.get(data[0], "unknown"), + maxMem=str(data[1]), + memory=str(data[2]), + nrVirtCpu=data[3], + cpuTime=str(data[4]), + autostart=self.conn.get_autostart(vm), + ) return info def nodeinfo(self): self.__get_conn() - info = dict() data = self.conn.nodeinfo() - info = { - "cpumodel" : str(data[0]), - "phymemory" : str(data[1]), - "cpus" : str(data[2]), - "cpumhz" : str(data[3]), - "numanodes" : str(data[4]), - "sockets" : str(data[5]), - "cpucores" : str(data[6]), - "cputhreads" : str(data[7]) - } + info = dict( + cpumodel=str(data[0]), + phymemory=str(data[1]), + cpus=str(data[2]), + cpumhz=str(data[3]), + numanodes=str(data[4]), + sockets=str(data[5]), + cpucores=str(data[6]), + cputhreads=str(data[7]) + ) return info def list_vms(self, state=None): @@ -366,7 +352,6 @@ class Virt(object): self.conn.shutdown(vmid) return 0 - def pause(self, vmid): """ Pause the machine with the given vmid. """ @@ -441,27 +426,28 @@ class Virt(object): self.__get_conn() return self.conn.define_from_xml(xml) + def core(module): - state = module.params.get('state', None) - autostart = module.params.get('autostart', None) - guest = module.params.get('name', None) - command = module.params.get('command', None) - uri = module.params.get('uri', None) - xml = module.params.get('xml', None) + state = module.params.get('state', None) + autostart = module.params.get('autostart', None) + guest = module.params.get('name', None) + command = module.params.get('command', None) + uri = module.params.get('uri', None) + xml = module.params.get('xml', None) v = Virt(uri, module) - res = {} + res = dict() - if state and command=='list_vms': + if state and command == 'list_vms': res = v.list_vms(state=state) if not isinstance(res, dict): - res = { command: res } + res = {command: res} return VIRT_SUCCESS, res if state: if not guest: - module.fail_json(msg = "state change requires a guest specified") + module.fail_json(msg="state change requires a guest specified") if state == 'running': if v.status(guest) is 'paused': @@ -493,10 +479,10 @@ def core(module): if command: if command in VM_COMMANDS: if not guest: - module.fail_json(msg = "%s requires 1 argument: guest" % command) + module.fail_json(msg="%s requires 1 argument: guest" % command) if command == 'define': if not xml: - module.fail_json(msg = "define requires xml argument") + module.fail_json(msg="define requires xml argument") try: v.get_vm(guest) except VMNotFound: @@ -505,13 +491,13 @@ def core(module): return VIRT_SUCCESS, res res = getattr(v, command)(guest) if not isinstance(res, dict): - res = { command: res } + res = {command: res} return VIRT_SUCCESS, res elif hasattr(v, command): res = getattr(v, command)() if not isinstance(res, dict): - res = { command: res } + res = {command: res} return VIRT_SUCCESS, res else: @@ -519,21 +505,21 @@ def core(module): module.fail_json(msg="expected state or command parameter to be specified") -def main(): - module = AnsibleModule(argument_spec=dict( - name = dict(aliases=['guest']), - state = dict(choices=['running', 'shutdown', 'destroyed', 'paused']), - autostart = dict(type='bool'), - command = dict(choices=ALL_COMMANDS), - uri = dict(default='qemu:///system'), - xml = dict(), - )) +def main(): + module = AnsibleModule( + argument_spec=dict( + name=dict(type='str', aliases=['guest']), + state=dict(type='str', choices=['destroyed', 'pause', 'running', 'shutdown']), + autostart=dict(type='bool'), + command=dict(type='str', choices=ALL_COMMANDS), + uri=dict(type='str', default='qemu:///system'), + xml=dict(type='str'), + ), + ) if not HAS_VIRT: - module.fail_json( - msg='The `libvirt` module is not importable. Check the requirements.' - ) + module.fail_json(msg='The `libvirt` module is not importable. Check the requirements.') rc = VIRT_SUCCESS try: @@ -541,7 +527,7 @@ def main(): except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) - if rc != 0: # something went wrong emit the msg + if rc != 0: # something went wrong emit the msg module.fail_json(rc=rc, msg=result) else: module.exit_json(**result) diff --git a/test/sanity/pep8/legacy-files.txt b/test/sanity/pep8/legacy-files.txt index 314f0afc052..74198145e7b 100644 --- a/test/sanity/pep8/legacy-files.txt +++ b/test/sanity/pep8/legacy-files.txt @@ -102,7 +102,6 @@ lib/ansible/modules/cloud/lxd/lxd_profile.py lib/ansible/modules/cloud/misc/ovirt.py lib/ansible/modules/cloud/misc/rhevm.py lib/ansible/modules/cloud/misc/serverless.py -lib/ansible/modules/cloud/misc/virt.py lib/ansible/modules/cloud/misc/virt_net.py lib/ansible/modules/cloud/misc/virt_pool.py lib/ansible/modules/cloud/misc/xenserver_facts.py