Bump yapf version 0.7.1 -> 0.14.0

New flake8 versions are no longer compatible with
the old yapf version used.

1. Fixed 2 flake8 errors.
2. Fixed few docstring/RST errors.
3. Adjusted scripts/check_style.sh to the new yapf exit
codes
4. Rest of the changes were generated by running
the new yapf(0.14.0) on rest of the code.

Signed-off-by: Nadav Goldin <[email protected]>

Author: nvgoldin

README.rst

@@ -3,10 +3,6 @@ The Lago Project
 Lago is an add-hoc virtual framework which helps you build virtualized
 environments on your server or laptop for various use cases.
 
-It currently utilizes 'libvirt' for creating VMs, but we are working on adding
-more providers such as 'containers'.
+For the official docs see: http://lago.readthedocs.io
 
-TODO: Add the 'Lago story' and introduction.
-
-For more info on the Lago project, please visit the full documentation
-page at http://lago.readthedocs.io
+.. todo:: Add the 'Lago story' and introduction.

docs/Debugging_and_Troubleshooting.rst

@@ -81,7 +81,7 @@ the full command line.
 **NOTE**: You can use any other template repo if you specify your own json file
 there
 
-**TODO**: document the repo store json file format
+.. todo:: document the repo store json file format
 
 
 Initializing the prefix

docs/Jenkins_Example.rst

@@ -44,6 +44,7 @@ From within the cloned repository, run the following commands:
     lago start
 
 -   Installing the vms:
+
    -  Jenkins will be installed on the server.
    -  OpenJDK will be installed on the slaves.
 
@@ -81,8 +82,6 @@ When you done with the enviroment:
 Note:
  To turn on the vms, use::
 
-::
-
     lago start
 
 And if you will not have a need for the environment in the future:
@@ -97,4 +96,4 @@ And if you will not have a need for the environment in the future:
 If this simple example just got you even more interested, join the major leauge and try out the
 oVirt example! oVirt_Example_
 
-.. _oVirt_Example: oVirt_Example.html 
+.. _oVirt_Example: oVirt_Example.html

docs/Lago_Examples.rst

@@ -1,5 +1,5 @@
 Getting started with some Lago Examples!
-=======================================
+=========================================
 
 Get Lago up & running in no time using one of the available examples
 
@@ -9,7 +9,7 @@ Available Examples
 ------------------
 
 * Simple Jenkins server + slaves: Jenkins_Example_
-* Advanced oVirt example (using nested virtualization): oVirt_Example_ 
+* Advanced oVirt example (using nested virtualization): oVirt_Example_
 
 .. _Jenkins_Example: Jenkins_Example.html
 .. _oVirt_Example: oVirt_Example.html

docs/conf.py

@@ -40,7 +40,11 @@
         os.path.dirname(__file__), '../lago_template_repo'
     ]
 )
-subprocess.call(['make', '--directory=..', 'changelog', ])
+subprocess.call([
+    'make',
+    '--directory=..',
+    'changelog',
+])
 shutil.move('../ChangeLog', '_static/ChangeLog.txt')
 
 # Mock all the modules that are included by lago, so autoimport works as
@@ -226,12 +230,13 @@
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',
-        'searchbox.html',
-    ],
+    '**':
+        [
+            'about.html',
+            'navigation.html',
+            'relations.html',
+            'searchbox.html',
+        ],
 }
 
 # Additional templates that should be rendered to pages, maps page names to
@@ -301,9 +306,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (
-        master_doc, 'Lago.tex', u'Lago Documentation', u'David Caro', 'manual'
-    )
+    (master_doc, 'Lago.tex', u'Lago Documentation', u'David Caro', 'manual')
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

docs/index.rst

@@ -9,7 +9,7 @@ environments on your server or laptop for various use cases.
 It currently utilizes 'libvirt' for creating VMs, but we are working on adding
 more providers such as 'containers'.
 
-TODO: Add the 'Lago story' and introduction.
+.. todo:: Add the 'Lago story' and introduction.
 
 Getting started
 ---------------

lago/cmd.py

@@ -33,7 +33,10 @@
 import lago.plugins.cli
 import lago.templates
 from lago.config import config
-from lago import (log_utils, workdir as lago_workdir, )
+from lago import (
+    log_utils,
+    workdir as lago_workdir,
+)
 from lago.utils import (in_prefix, with_logging)
 
 LOGGER = logging.getLogger('cli')
@@ -130,9 +133,8 @@ def do_init(
     if virt_config is None:
         virt_config = os.path.abspath('LagoInitFile')
 
-    os.environ['LAGO_INITFILE_PATH'] = os.path.dirname(
-        os.path.abspath(virt_config)
-    )
+    os.environ['LAGO_INITFILE_PATH'
+               ] = os.path.dirname(os.path.abspath(virt_config))
 
     if prefix_name == 'current':
         prefix_name = 'default'
@@ -339,10 +341,8 @@ def do_shell(prefix, host, args=None, **kwargs):
     except KeyError:
         LOGGER.error('Unable to find VM %s', host)
         LOGGER.info(
-            'Available VMs:\n\t' + '\n\t'.join(
-                prefix.virt_env.get_vms().keys(
-                )
-            )
+            'Available VMs:\n\t' +
+            '\n\t'.join(prefix.virt_env.get_vms().keys())
         )
         raise
 
@@ -380,10 +380,8 @@ def do_console(prefix, host, **kwargs):
     except KeyError:
         LOGGER.error('Unable to find VM %s', host)
         LOGGER.info(
-            'Available VMs:\n\t' + '\n\t'.join(
-                prefix.virt_env.get_vms().keys(
-                )
-            )
+            'Available VMs:\n\t' +
+            '\n\t'.join(prefix.virt_env.get_vms().keys())
         )
         raise
 
@@ -402,44 +400,51 @@ def do_status(prefix, out_format, **kwargs):
         uuid = f.read()
 
     info_dict = {
-        'Prefix': {
-            'Base directory': prefix.paths.prefix,
-            'UUID': uuid,
-            'Networks': dict(
-                (
-                    net.name(),
-                    {
-                        'gateway': net.gw(),
-                        'status': net.alive() and 'up' or 'down',
-                        'management': net.is_management(),
-                    }
-                ) for net in prefix.virt_env.get_nets().values()
-            ),
-            'VMs': dict(
-                (
-                    vm.name(),
-                    {
-                        'distro': vm.distro(),
-                        'root password': vm.root_password(),
-                        'status': vm.state(),
-                        'snapshots': ', '.join(vm._spec['snapshots'].keys()),
-                        'VNC port': vm.vnc_port() if vm.alive() else None,
-                        'metadata': vm.metadata,
-                        'NICs': dict(
-                            (
-                                'eth%d' % i,
-                                {
-                                    'network': nic['net'],
-                                    'ip': nic.get('ip', 'N/A'),
-                                }
-
-                            ) for i, nic in enumerate(vm.nics())
-                        ),
-                    }
-
-                ) for vm in prefix.virt_env.get_vms().values()
-            ),
-        },
+        'Prefix':
+            {
+                'Base directory':
+                    prefix.paths.prefix,
+                'UUID':
+                    uuid,
+                'Networks':
+                    dict(
+                        (
+                            net.name(), {
+                                'gateway': net.gw(),
+                                'status': net.alive() and 'up' or 'down',
+                                'management': net.is_management(),
+                            }
+                        ) for net in prefix.virt_env.get_nets().values()
+                    ),
+                'VMs':
+                    dict(
+                        (
+                            vm.name(), {
+                                'distro':
+                                    vm.distro(),
+                                'root password':
+                                    vm.root_password(),
+                                'status':
+                                    vm.state(),
+                                'snapshots':
+                                    ', '.join(vm._spec['snapshots'].keys()),
+                                'VNC port':
+                                    vm.vnc_port() if vm.alive() else None,
+                                'metadata':
+                                    vm.metadata,
+                                'NICs':
+                                    dict(
+                                        (
+                                            'eth%d' % i, {
+                                                'network': nic['net'],
+                                                'ip': nic.get('ip', 'N/A'),
+                                            }
+                                        ) for i, nic in enumerate(vm.nics())
+                                    ),
+                            }
+                        ) for vm in prefix.virt_env.get_vms().values()
+                    ),
+            },
     }
 
     print out_format.format(info_dict)
@@ -499,10 +504,8 @@ def do_copy_from_vm(prefix, host, remote_path, local_path, **kwargs):
     except KeyError:
         LOGGER.error('Unable to find VM %s', host)
         LOGGER.info(
-            'Available VMs:\n\t' + '\n\t'.join(
-                prefix.virt_env.get_vms().keys(
-                )
-            )
+            'Available VMs:\n\t' +
+            '\n\t'.join(prefix.virt_env.get_vms().keys())
         )
         raise
 
@@ -541,10 +544,8 @@ def do_copy_to_vm(prefix, host, remote_path, local_path, **kwargs):
     except KeyError:
         LOGGER.error('Unable to find VM %s', host)
         LOGGER.info(
-            'Available VMs:\n\t' + '\n\t'.join(
-                prefix.virt_env.get_vms().keys(
-                )
-            )
+            'Available VMs:\n\t' +
+            '\n\t'.join(prefix.virt_env.get_vms().keys())
         )
         raise
 
@@ -609,10 +610,7 @@ def create_parser(cli_plugins, out_plugins):
         help='Log level to use'
     )
     parser.add_argument(
-        '--logdepth',
-        default=3,
-        type=int,
-        help='How many task levels to show'
+        '--logdepth', default=3, type=int, help='How many task levels to show'
     )
 
     try:
@@ -774,7 +772,10 @@ def main():
     out_plugins = lago.plugins.load_plugins(
         lago.plugins.PLUGIN_ENTRY_POINTS['out']
     )
-    parser = create_parser(cli_plugins=cli_plugins, out_plugins=out_plugins, )
+    parser = create_parser(
+        cli_plugins=cli_plugins,
+        out_plugins=out_plugins,
+    )
     args = parser.parse_args()
     config.update_args(args)
 

lago/config.py

@@ -42,9 +42,7 @@ def _get_configs_path():
 
     paths = []
     xdg_paths = [
-        path for path in base_dirs.load_config_paths(
-            'lago', 'lago.conf'
-        )
+        path for path in base_dirs.load_config_paths('lago', 'lago.conf')
     ]
     paths.extend([path for path in CONFS_PATH if os.path.exists(path)])
     paths.extend(reversed(xdg_paths))
@@ -54,10 +52,10 @@ def _get_configs_path():
 def get_env_dict(root_section):
     """Read all Lago variables from the environment.
     The lookup format is:
-      LAGO_VARNAME - will land into 'lago' section
-      LAGO__SECTION1__VARNAME - will land into 'section1' section, notice
-      the double '__'.
-      LAGO__LONG_SECTION_NAME__VARNAME - will land into 'long_section_name'
+    LAGO_VARNAME - will land into 'lago' section
+    LAGO__SECTION1__VARNAME - will land into 'section1' section, notice
+    the double '__'.
+    LAGO__LONG_SECTION_NAME__VARNAME - will land into 'long_section_name'
 
 
     Returns:
@@ -122,9 +120,9 @@ def __init__(self, root_section='lago'):
     def load(self):
         """Load all configuration from INI format files and ENV, always
         preferring the last read. Order of loading is:
-          1) Custom paths as defined in constants.CONFS_PATH
-          2) XDG standard paths
-          3) Environment variables
+        1) Custom paths as defined in constants.CONFS_PATH
+        2) XDG standard paths
+        3) Environment variables
 
         Returns:
             dict: dict of section configuration dicts
@@ -169,10 +167,8 @@ def update_parser(self, parser):
         configp.read_dict(self._config)
         configp.read_string(ini_str)
         self._config.update(
-            {
-                s: dict(configp.items(s))
-                for s in configp.sections()
-            }
+            {s: dict(configp.items(s))
+             for s in configp.sections()}
         )
 
     def get(self, *args):

lago/log_utils.py

@@ -27,7 +27,10 @@
 import sys
 import datetime
 import threading
-from collections import (OrderedDict, deque, )
+from collections import (
+    OrderedDict,
+    deque,
+)
 from functools import wraps
 
 #: Message to be shown when a task is started
@@ -439,7 +442,10 @@ def handle_error(self):
             return
 
         # All the parents inherit the failure
-        self.mark_parent_tasks_as_failed(self.cur_task, flush_logs=True, )
+        self.mark_parent_tasks_as_failed(
+            self.cur_task,
+            flush_logs=True,
+        )
 
         # Show the start headers for all the parent tasks if they were not
         # shown by the depth level limit
@@ -501,9 +507,9 @@ def pretty_emit(self, record, is_header=False, task_level=None):
 
         if is_header:
             extra_prefix = (
-                self.get_task_indicator(task_level - 1) + ' ' + (
-                    '' if self.am_i_main_thread else '[%s] ' % self.cur_thread
-                ) + task + ': '
+                self.get_task_indicator(task_level - 1) + ' ' +
+                ('' if self.am_i_main_thread else '[%s] ' % self.cur_thread) +
+                task + ': '
             )
             record.levelno = logging.INFO
         else: