[edk2-devel][edk2-staging/EdkRepo][PATCH v2 2/8] EdkRepo: Argument String Refactor Manifest Command

[Nate DeSimone]

Reviewed-by: Nate DeSimone <nathaniel.l.desimone at intel.com>

-----Original Message-----
From: Desimone, Ashley E <ashley.e.desimone at intel.com> 
Sent: Wednesday, November 6, 2019 2:40 PM
To: devel at edk2.groups.io
Cc: Desimone, Nathaniel L <nathaniel.l.desimone at intel.com>; Pandya, Puja <puja.pandya at intel.com>
Subject: [edk2-devel][edk2-staging/EdkRepo][PATCH v2 2/8] EdkRepo: Argument String Refactor Manifest Command

Update setup.py to add edkrepo.commands.arguments.
Move all argument strings for manifest_command.py to edkrepo/commands/arguments/manifest_args.py and remove unused strings.

Signed-off-by: Ashley E Desimone <ashley.e.desimone at intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone at intel.com>
Cc: Puja Pandya <puja.pandya at intel.com>
---
 edkrepo/commands/arguments/__init__.py      |  8 ++++++++
 edkrepo/commands/arguments/manifest_args.py | 15 +++++++++++++++
 edkrepo/commands/manifest_command.py        |  7 +++----
 edkrepo/common/argument_strings.py          |  5 -----
 setup.py                                    |  2 +-
 5 files changed, 27 insertions(+), 10 deletions(-)  create mode 100644 edkrepo/commands/arguments/__init__.py
 create mode 100644 edkrepo/commands/arguments/manifest_args.py

diff --git a/edkrepo/commands/arguments/__init__.py b/edkrepo/commands/arguments/__init__.py
new file mode 100644
index 0000000..dea6eb4
--- /dev/null
+++ b/edkrepo/commands/arguments/__init__.py
@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+#
+## @file
+# __init__.py
+#
+# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> # 
+SPDX-License-Identifier: BSD-2-Clause-Patent #
diff --git a/edkrepo/commands/arguments/manifest_args.py b/edkrepo/commands/arguments/manifest_args.py
new file mode 100644
index 0000000..25b9773
--- /dev/null
+++ b/edkrepo/commands/arguments/manifest_args.py
@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+#
+## @file
+# manifest_args.py
+#
+# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> # 
+SPDX-License-Identifier: BSD-2-Clause-Patent #
+
+''' Contains the help and description strings for arguments in the 
+manifest command meta data.
+'''
+
+COMMAND_DESCRIPTION = 'Lists the available projects.'
+ARCHIVED_HELP = 'Include a listing of archived projects.'
\ No newline at end of file
diff --git a/edkrepo/commands/manifest_command.py b/edkrepo/commands/manifest_command.py
index 32cac7f..44218c9 100644
--- a/edkrepo/commands/manifest_command.py
+++ b/edkrepo/commands/manifest_command.py
@@ -12,11 +12,10 @@ import os
 
 from colorama import Fore
 
-# Our modules
 from edkrepo.commands.edkrepo_command import EdkrepoCommand  from edkrepo.commands.edkrepo_command import ColorArgument
+import edkrepo.commands.arguments.manifest_args as arguments
 from edkrepo.common.edkrepo_exception import EdkrepoWorkspaceInvalidException -from edkrepo.common.argument_strings import MANIFEST_COMMAND_DESCRIPTION, ARCHIVED_HELP, MANIFEST_VERBOSE_HELP  from edkrepo.common.common_repo_functions import pull_latest_manifest_repo, verify_manifest_data  from edkrepo.common.ui_functions import init_color_console  from edkrepo.config.config_factory import get_workspace_manifest @@ -30,14 +29,14 @@ class ManifestCommand(EdkrepoCommand):
     def get_metadata(self):
         metadata = {}
         metadata['name'] = 'manifest'
-        metadata['help-text'] = MANIFEST_COMMAND_DESCRIPTION
+        metadata['help-text'] = arguments.COMMAND_DESCRIPTION
         args = []
         metadata['arguments'] = args
         args.append({'name': 'archived',
                      'short-name': 'a',
                      'positional': False,
                      'required': False,
-                     'help-text': ARCHIVED_HELP})
+                     'help-text': arguments.ARCHIVED_HELP})
         args.append(ColorArgument)
         return metadata
 
diff --git a/edkrepo/common/argument_strings.py b/edkrepo/common/argument_strings.py
index 93db079..fd74f37 100644
--- a/edkrepo/common/argument_strings.py
+++ b/edkrepo/common/argument_strings.py
@@ -41,11 +41,6 @@ UPDATE_LOCAL_MANIFEST_DESCRIPTION = 'Updates the global manifest repository and  UPDATE_LOCAL_MANIFEST_HELP = 'Updates the local manifest file found in the <workspace>/repo directory prior to performing sync operations.'
 SYNC_OVERRIDE_HELP = 'Without this flag sync operations will not be completed if the updated manifest adds/removes repositories or if there are local commits on the target branch.'
 
-#Args for manifest_command.py
-MANIFEST_COMMAND_DESCRIPTION = 'Lists project manifests'
-ARCHIVED_HELP = 'Include archived projects'
-MANIFEST_VERBOSE_HELP = 'Show XML path'
-
 #Args  for checkout_command.py
 CHECKOUT_COMMAND_DESCRIPTION = 'The checkout command enables checking out a specific branch combination from the project manifest located in the <workspace>/repo directory or the sha of a specific commit which will update all repos in the workspace to this commit.\nNote that checkout SHA will put the affected repos into detached head mode.\n'
 CHECKOUT_COMBINATION_DESCRIPTION = 'EdkRepo checkout <Combination or sha>\n'
diff --git a/setup.py b/setup.py
index ed07594..4be04f1 100755
--- a/setup.py
+++ b/setup.py
@@ -12,7 +12,7 @@ from setuptools import setup  setup(name='edkrepo',
       version='2.0.0',
       description='The edkrepo tools',
-      packages=['edkrepo', 'edkrepo.commands', 'edkrepo.common', 'edkrepo.config', 'edkrepo_manifest_parser', 'project_utils'],
+      packages=['edkrepo', 'edkrepo.commands', 
+ 'edkrepo.commands.arguments', 'edkrepo.common', 'edkrepo.config', 
+ 'edkrepo_manifest_parser', 'project_utils'],
       package_data={
          },
       include_package_data=True,
--
2.16.2.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#50095): https://edk2.groups.io/g/devel/message/50095
Mute This Topic: https://groups.io/mt/44653245/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-