PEP 8 Fix + String Formatting (#106)

Author: vkmrishad

examples/exapp

@@ -28,6 +28,7 @@ helps['abc list'] = """
           text: {cli_name} abc list
 """.format(cli_name=cli_name)
 
+
 def a_test_command_handler():
     return [{'a': 1, 'b': 1234}, {'a': 3, 'b': 4}]
 
@@ -36,6 +37,7 @@ def abc_list_command_handler():
     import string
     return list(string.ascii_lowercase)
 
+
 def hello_command_handler(myarg=None, abc=None):
     return ['hello', 'world', myarg, abc]
 
@@ -51,13 +53,15 @@ WELCOME_MESSAGE = r"""
 Welcome to the cool new CLI!
 """
 
+
 class MyCLIHelp(CLIHelp):
 
     def __init__(self, cli_ctx=None):
         super(MyCLIHelp, self).__init__(cli_ctx=cli_ctx,
                                         privacy_statement='My privacy statement.',
                                         welcome_message=WELCOME_MESSAGE)
 
+
 class MyCommandsLoader(CLICommandsLoader):
 
     def load_command_table(self, args):
@@ -73,6 +77,7 @@ class MyCommandsLoader(CLICommandsLoader):
             ac.argument('myarg', type=int, default=100)
         super(MyCommandsLoader, self).load_arguments(command)
 
+
 mycli = CLI(cli_name=cli_name,
             config_dir=os.path.join('~', '.{}'.format(cli_name)),
             config_env_var_prefix=cli_name,

examples/exapp2

@@ -28,6 +28,7 @@ helps['abc list'] = """
           text: {cli_name} abc list
 """.format(cli_name=cli_name)
 
+
 def a_test_command_handler():
     return [{'a': 1, 'b': 1234}, {'a': 3, 'b': 4}]
 
@@ -36,6 +37,7 @@ def abc_list_command_handler():
     import string
     return list(string.ascii_lowercase)
 
+
 def hello_command_handler(myarg=None, abc=None):
     return ['hello', 'world', myarg, abc]
 
@@ -51,13 +53,15 @@ WELCOME_MESSAGE = r"""
 Welcome to the cool new CLI!
 """
 
+
 class MyCLIHelp(CLIHelp):
 
     def __init__(self, cli_ctx=None):
         super(MyCLIHelp, self).__init__(cli_ctx=cli_ctx,
                                         privacy_statement='My privacy statement.',
                                         welcome_message=WELCOME_MESSAGE)
 
+
 class MyCommandsLoader(CLICommandsLoader):
 
     def load_command_table(self, args):

examples/test_exapp

@@ -12,18 +12,22 @@ from knack import CLI
 from knack.commands import CLICommandsLoader, CommandGroup
 from knack.arguments import ArgumentsContext
 
-## DEFINE MY CLI
+# DEFINE MY CLI
+
 
 def a_test_command_handler():
     return [{'a': 1, 'b': 1234}, {'a': 3, 'b': 4}]
 
+
 def abc_list_command_handler():
     import string
     return list(string.ascii_lowercase)
 
+
 def hello_command_handler(myarg=None, abc=None):
     return ['hello', 'world', myarg, abc]
 
+
 class MyCommandsLoader(CLICommandsLoader):
 
     def load_command_table(self, args):
@@ -39,19 +43,22 @@ class MyCommandsLoader(CLICommandsLoader):
             ac.argument('myarg', type=int, default=100)
         super(MyCommandsLoader, self).load_arguments(command)
 
+
 name = 'exapp4'
 
 mycli = CLI(cli_name=name,
             config_dir=os.path.join('~', '.{}'.format(name)),
             config_env_var_prefix=name,
             commands_loader_cls=MyCommandsLoader)
 
-## END OF - DEFINE MY CLI
 
-## DEFINE MY TESTS
+# END OF - DEFINE MY CLI
+
+# DEFINE MY TESTS
 
 from knack.testsdk import ScenarioTest, JMESPathCheck
 
+
 class TestMyScenarios(ScenarioTest):
 
     def __init__(self, method_name):
@@ -72,7 +79,8 @@ class TestMyScenarios(ScenarioTest):
             JMESPathCheck('length(@)', 2),
         ])
 
-## END OF - DEFINE MY TESTS
+# END OF - DEFINE MY TESTS
+
 
 if __name__ == '__main__':
     unittest.main()

knack/config.py

@@ -43,7 +43,7 @@ def __init__(self, config_dir=None, config_env_var_prefix=None, config_file_name
         self.config_dir = os.environ.get('{}CONFIG_DIR'.format(env_var_prefix), default_config_dir)
         configuration_file_name = config_file_name or CLIConfig._DEFAULT_CONFIG_FILE_NAME
         self.config_path = os.path.join(self.config_dir, configuration_file_name)
-        self._env_var_format = env_var_prefix + '{section}_{option}'
+        self._env_var_format = '{}{}'.format(env_var_prefix, '{section}_{option}')
         self.config_parser.read(self.config_path)
 
     def env_var_name(self, section, option):

knack/help.py

@@ -23,7 +23,7 @@
 
 def _get_preview_tag():
     import colorama
-    PREVIEW_TAG = colorama.Fore.CYAN + '[Preview]' + colorama.Fore.RESET
+    PREVIEW_TAG = '{}[Preview]{}'.format(colorama.Fore.CYAN, colorama.Fore.RESET)
     PREVIEW_TAG_LEN = len(PREVIEW_TAG) - 2 * len(colorama.Fore.RESET)
     return (PREVIEW_TAG, PREVIEW_TAG_LEN)
 

knack/log.py

@@ -25,7 +25,7 @@ def get_logger(module_name=None):
     :rtype: logger
     """
     if module_name:
-        logger_name = '{}.'.format(CLI_LOGGER_NAME) + module_name
+        logger_name = '{}.{}'.format(CLI_LOGGER_NAME, module_name)
     else:
         logger_name = CLI_LOGGER_NAME
     return logging.getLogger(logger_name)
@@ -41,7 +41,7 @@ def get_color_wrapper(cls, level):
 
             def _color_wrapper(color_marker):
                 def wrap_msg_with_color(msg):
-                    return color_marker + msg + colorama.Style.RESET_ALL
+                    return '{}{}{}'.format(color_marker, msg, colorama.Style.RESET_ALL)
                 return wrap_msg_with_color
 
             cls.COLOR_MAP = {

tests/test_cli_scenarios.py

@@ -15,6 +15,7 @@
 from knack.invocation import CommandInvoker
 from tests.util import MockContext
 
+
 class TestCLIScenarios(unittest.TestCase):
 
     def setUp(self):
@@ -27,6 +28,7 @@ def invoke_with_command_table(self, command, command_table):
 
     def test_list_value_parameter(self):
         handler_args = {}
+
         def handler(args):
             handler_args.update(args)
 
@@ -47,7 +49,6 @@ def handler(_):
         command.add_argument('var', '--var', '-v')
         cmd_table = {'test command': command}
 
-
         def _test(cmd_line):
             ci = CommandInvoker(cli_ctx=self.mock_ctx)
             self.mock_ctx.invocation = ci
@@ -121,5 +122,6 @@ def load_command_table(self, args):
         self.assertEqual(expected_output, mock_stdout.getvalue())
         self.assertEqual(0, exit_code)
 
+
 if __name__ == '__main__':
     unittest.main()

tests/test_command_registration.py

@@ -10,6 +10,7 @@
 from knack.arguments import CLIArgumentType, CLICommandArgument, ArgumentsContext
 from tests.util import MockContext
 
+
 def _dictContainsSubset(expected, actual):
     """Checks whether actual is a superset of expected.
        Helper for deprecated assertDictContainsSubset"""
@@ -53,7 +54,6 @@ def sample_command_handler2(group_name, resource_name, opt_param=None, expand=No
                                 raw=False, **operation_config):
         pass
 
-
     def test_register_cli_argument(self):
         cl = CLICommandsLoader(self.mock_ctx)
         command_name = 'test register sample-command'
@@ -93,7 +93,6 @@ def test_register_command_custom_excluded_params(self):
         self.assertEqual(len(command_metadata.arguments), 4, 'We expected exactly 4 arguments')
         self.assertIn(command_name, cl.command_table)
 
-
     def test_register_command(self):
         cl = CLICommandsLoader(self.mock_ctx)
         command_name = 'test register sample-command'
@@ -151,6 +150,7 @@ def test_register_command_confirmation_bool(self):
 
     def test_register_command_confirmation_callable(self):
         cl = CLICommandsLoader(self.mock_ctx)
+
         def confirm_callable(_):
             pass
         command_name = 'test sample-command'
@@ -345,5 +345,6 @@ def test_cli_ctx_type_error(self):
         with self.assertRaises(TypeError):
             CLICommandsLoader(cli_ctx=object())
 
+
 if __name__ == '__main__':
     unittest.main()

tests/test_completion.py

@@ -10,6 +10,7 @@
 from knack.completion import CLICompletion, CaseInsensitiveChoicesCompleter, ARGCOMPLETE_ENV_NAME
 from tests.util import MockContext
 
+
 class TestCompletion(unittest.TestCase):
 
     def setUp(self):
@@ -73,5 +74,6 @@ def test_case_insensitive_choices_list_multi_case_with_prefix(self):
         expected_result = ['YelLoW']
         self.assertListEqual(actual_result, expected_result)
 
+
 if __name__ == '__main__':
     unittest.main()

tests/test_help.py

@@ -58,7 +58,7 @@ def test_short_summary_no_fullstop(self):
         obj = HelpObject()
         original_summary = 'This summary has no fullstop'
         obj.short_summary = original_summary
-        self.assertEqual(obj.short_summary, original_summary + '.')
+        self.assertEqual(obj.short_summary, '{}.'.format(original_summary))
 
     def test_short_summary_fullstop(self):
         obj = HelpObject()

tests/test_output.py

@@ -13,6 +13,7 @@
 from knack.util import CommandResultItem, normalize_newlines
 from tests.util import MockContext
 
+
 class TestOutput(unittest.TestCase):
 
     def setUp(self):

tests/test_parser.py

@@ -11,6 +11,7 @@
 from knack.arguments import enum_choice_list
 from tests.util import MockContext
 
+
 class TestParser(unittest.TestCase):
 
     def setUp(self):

tests/test_prompting.py

@@ -316,5 +316,6 @@ def test_prompt_choice_list_question_with_help_string(self, _):
                 self.assertEqual(0, actual_result)
             self.assertTrue('Your real favourite.' in mock_stdout.getvalue())
 
+
 if __name__ == '__main__':
     unittest.main()

tests/test_query.py

@@ -78,5 +78,6 @@ def test_query_invalid_4(self):
         with self.assertRaises(ValueError):
             CLIQuery.jmespath_type(query)
 
+
 if __name__ == '__main__':
     unittest.main()

tests/test_util.py

@@ -9,6 +9,7 @@
 
 from knack.util import todict, to_snake_case
 
+
 class TestUtils(unittest.TestCase):
 
     def test_application_todict_none(self):
@@ -86,5 +87,6 @@ def test_to_snake_case_already_snake(self):
         actual = to_snake_case(the_input)
         self.assertEqual(expected, actual)
 
+
 if __name__ == '__main__':
     unittest.main()

tests/util.py

@@ -7,6 +7,7 @@
 
 from knack.cli import CLI, CLICommandsLoader
 
+
 class MockContext(CLI):
 
     def __init__(self):