[gentoo-catalyst] [PATCH 1/4] catalyst: clean up unused module imports

[gentoo-catalyst] [PATCH 1/4] catalyst: clean up unused module imports

[Mike Frysinger]

---
 bin/catalyst | 2 --
 1 file changed, 2 deletions(-)

diff --git a/bin/catalyst b/bin/catalyst
index d0bc153..577e899 100755
--- a/bin/catalyst
+++ b/bin/catalyst
@@ -32,8 +32,6 @@ except KeyboardInterrupt:
 
 
 from catalyst.main import main
-from catalyst import __maintainer__
-from catalyst import __version__
 
 try:
 	main()
-- 
2.5.2

[gentoo-catalyst] [PATCH 2/4] lint: drop use of apply()

[Mike Frysinger]

This builtin has been deprecated since python-2.3, so call the function
directly instead of via apply.
---
 catalyst/base/stagebase.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/catalyst/base/stagebase.py b/catalyst/base/stagebase.py
index 7bc7522..fcdf729 100644
--- a/catalyst/base/stagebase.py
+++ b/catalyst/base/stagebase.py
@@ -1426,7 +1426,7 @@ class StageBase(TargetBase, ClearBase, GenBase):
 			print "--- Running action sequence: "+x
 			sys.stdout.flush()
 			try:
-				apply(getattr(self,x))
+				getattr(self, x)()
 			except LockInUse:
 				print "Error, unable to aquire the lock..."
 				print " Catalyst aborting...."
-- 
2.5.2

[gentoo-catalyst] [PATCH 3/4] main: delay root check until before we run

[Mike Frysinger]

This way we can run things like --help and verify argument/config parsing
all as non-root.  Only actual building requires root.
---
 catalyst/main.py | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/catalyst/main.py b/catalyst/main.py
index 4e83414..604c6ab 100644
--- a/catalyst/main.py
+++ b/catalyst/main.py
@@ -168,13 +168,6 @@ def build_target(addlargs):
 
 
 def main():
-
-	if os.getuid() != 0:
-		version()
-		# catalyst cannot be run as a normal user due to chroots, mounts, etc
-		print "!!! catalyst: This script requires root privileges to operate"
-		sys.exit(2)
-
 	# we need some options in order to work correctly
 	if len(sys.argv) < 2:
 		usage()
@@ -342,6 +335,11 @@ def main():
 	if "target" not in addlargs:
 		raise CatalystError("Required value \"target\" not specified.")
 
+	if os.getuid() != 0:
+		# catalyst cannot be run as a normal user due to chroots, mounts, etc
+		print "!!! catalyst: This script requires root privileges to operate"
+		sys.exit(2)
+
 	# everything is setup, so the build is a go
 	try:
 		success = build_target(addlargs)
-- 
2.5.2

[gentoo-catalyst] [PATCH 4/4] main: switch to argparse

[Mike Frysinger]

Switch from ad-hoc getopt parsing to the more powerful/standard argparse.
---
 catalyst/main.py | 191 +++++++++++++++++++++++++------------------------------
 1 file changed, 85 insertions(+), 106 deletions(-)

diff --git a/catalyst/main.py b/catalyst/main.py
index 604c6ab..2a25df4 100644
--- a/catalyst/main.py
+++ b/catalyst/main.py
@@ -6,9 +6,9 @@
 # Chris Gianelloni <wolf31o2@wolf31o2.org>
 # $Id$
 
+import argparse
 import os
 import sys
-import getopt
 import os.path
 
 __selfpath__ = os.path.abspath(os.path.dirname(__file__))
@@ -28,35 +28,6 @@ from catalyst.version import get_version
 conf_values={}
 
 
-def usage():
-	print """Usage catalyst [options] [-C variable=value...] [ -s identifier]
- -a --clear-autoresume  clear autoresume flags
- -c --config            use specified configuration file
- -C --cli               catalyst commandline (MUST BE LAST OPTION)
- -d --debug             enable debugging
- -f --file              read specfile
- -F --fetchonly         fetch files only
- -h --help              print this help message
- -p --purge             clear tmp dirs,package cache, autoresume flags
- -P --purgeonly         clear tmp dirs,package cache, autoresume flags and exit
- -T --purgetmponly      clear tmp dirs and autoresume flags and exit
- -s --snapshot          generate a release snapshot
- -V --version           display version information
- -v --verbose           verbose output
-
-Usage examples:
-
-Using the commandline option (-C, --cli) to build a Portage snapshot:
-catalyst -C target=snapshot version_stamp=my_date
-
-Using the snapshot option (-s, --snapshot) to build a release snapshot:
-catalyst -s 20071121"
-
-Using the specfile option (-f, --file) to build a stage target:
-catalyst -f stage1-specfile.spec
-"""
-
-
 def version():
 	print get_version()
 	print "Copyright 2003-2008 Gentoo Foundation"
@@ -167,96 +138,104 @@ def build_target(addlargs):
 	return target.run()
 
 
-def main():
-	# we need some options in order to work correctly
-	if len(sys.argv) < 2:
-		usage()
-		sys.exit(2)
-
-	# parse out the command line arguments
-	try:
-		opts, _args = getopt.getopt(sys.argv[1:], "apPThvdc:C:f:FVs:", ["purge", "purgeonly", "purgetmponly", "help", "version", "debug",
-			"clear-autoresume", "config=", "cli=", "file=", "fetch", "verbose","snapshot="])
-
-	except getopt.GetoptError:
-		usage()
-		sys.exit(2)
-
-	myconfig=""
-	myspecfile=""
-	mycmdline=[]
-
-	# check preconditions
-	if len(opts) == 0:
-		print "!!! catalyst: please specify one of either -f or -C\n"
-		usage()
-		sys.exit(2)
-
-	options = set()
-
-	run = False
-	for o, a in opts:
-		if o in ("-h", "--help"):
-			version()
-			usage()
-			sys.exit(1)
+class FilePath(object):
+	"""Argparse type for getting a path to a file."""
 
-		if o in ("-V", "--version"):
-			print get_version()
-			sys.exit(1)
+	def __init__(self, exists=True):
+		self.exists = exists
 
-		if o in ("-d", "--debug"):
-			conf_values["DEBUG"] = True
-			conf_values["VERBOSE"] = True
+	def __call__(self, string):
+		if not os.path.exists(string):
+			raise argparse.ArgumentTypeError('file does not exist: %s' % string)
+		return string
 
-		if o in ("-c", "--config"):
-			myconfig=a
+	def __repr__(self):
+		return '%s(exists=%s)' % (type(self).__name__, self.exists)
 
-		if o in ("-C", "--cli"):
-			run = True
-			x=sys.argv.index(o)+1
-			while x < len(sys.argv):
-				mycmdline.append(sys.argv[x])
-				x=x+1
 
-		if o in ("-f", "--file"):
-			run = True
-			myspecfile=a
+def get_parser():
+	"""Return an argument parser"""
+	epilog = """Usage examples:
 
-		if o in ("-F", "--fetchonly"):
-			options.add("fetch")
+Using the commandline option (-C, --cli) to build a Portage snapshot:
+$ catalyst -C target=snapshot version_stamp=my_date
 
-		if o in ("-v", "--verbose"):
-			conf_values["VERBOSE"]="1"
+Using the snapshot option (-s, --snapshot) to build a release snapshot:
+$ catalyst -s 20071121
 
-		if o in ("-s", "--snapshot"):
-			if len(sys.argv) < 3:
-				print "!!! catalyst: missing snapshot identifier\n"
-				usage()
-				sys.exit(2)
-			else:
-				run = True
-				mycmdline.append("target=snapshot")
-				mycmdline.append("version_stamp="+a)
+Using the specfile option (-f, --file) to build a stage target:
+$ catalyst -f stage1-specfile.spec"""
+
+	parser = argparse.ArgumentParser(epilog=epilog, formatter_class=argparse.RawDescriptionHelpFormatter)
+	parser.add_argument('-d', '--debug',
+		default=False, action='store_true',
+		help='enable debugging')
+	parser.add_argument('-v', '--verbose',
+		default=False, action='store_true',
+		help='verbose output')
+	parser.add_argument('-c', '--config',
+		type=FilePath(),
+		help='use specified configuration file')
+	parser.add_argument('-f', '--file',
+		type=FilePath(),
+		help='read specfile')
+	parser.add_argument('-F', '--fetchonly',
+		default=False, action='store_true',
+		help='fetch files only')
+	parser.add_argument('-a', '--clear-autoresume',
+		default=False, action='store_true',
+		help='clear autoresume flags')
+	parser.add_argument('-p', '--purge',
+		default=False, action='store_true',
+		help='clear tmp dirs, package cache, autoresume flags')
+	parser.add_argument('-P', '--purgeonly',
+		default=False, action='store_true',
+		help='clear tmp dirs, package cache, autoresume flags and exit')
+	parser.add_argument('-T', '--purgetmponly',
+		default=False, action='store_true',
+		help='clear tmp dirs and autoresume flags and exit')
+	parser.add_argument('-s', '--snapshot',
+		help='generate a release snapshot')
+	parser.add_argument('-V', '--version',
+		action='version', version=get_version(),
+		help='display version information')
+	parser.add_argument('-C', '--cli',
+		default=[], nargs=argparse.REMAINDER,
+		help='catalyst commandline (MUST BE LAST OPTION)')
+	return parser
 
-		if o in ("-p", "--purge"):
-			options.add("purge")
 
-		if o in ("-P", "--purgeonly"):
-			options.add("purgeonly")
+def main():
+	parser = get_parser()
+	opts = parser.parse_args(sys.argv[1:])
 
-		if o in ("-T", "--purgetmponly"):
-			options.add("purgetmponly")
+	# Parse the command line options.
+	myconfig = opts.config
+	myspecfile = opts.file
+	mycmdline = opts.cli[:]
 
-		if o in ("-a", "--clear-autoresume"):
-			options.add("clear-autoresume")
+	if opts.snapshot:
+		mycmdline.append('target=snapshot')
+		mycmdline.append('version_stamp=' + opts.snapshot)
 
-	#print "MAIN: cli options =", options
+	conf_values['DEBUG'] = opts.debug
+	conf_values['VERBOSE'] = opts.debug or opts.verbose
 
-	if not run:
-		print "!!! catalyst: please specify one of either -f or -C\n"
-		usage()
-		sys.exit(2)
+	options = set()
+	if opts.fetchonly:
+		options.add('fetch')
+	if opts.purge:
+		options.add('purge')
+	if opts.purgeonly:
+		options.add('purgeonly')
+	if opts.purgetmponly:
+		options.add('purgetmponly')
+	if opts.clear_autoresume:
+		options.add('clear-autoresume')
+
+	# Make sure we have some work before moving further.
+	if not myspecfile and not mycmdline:
+		parser.error('please specify one of either -f or -C or -s')
 
 	# made it this far so start by outputting our version info
 	version()
-- 
2.5.2

Re: [gentoo-catalyst] [PATCH 4/4] main: switch to argparse

[Brian Dolbec]

On Tue,  6 Oct 2015 12:46:29 -0400
Mike Frysinger <vapier@gentoo.org> wrote:

> Switch from ad-hoc getopt parsing to the more powerful/standard
> argparse. ---
>  catalyst/main.py | 191
> +++++++++++++++++++++++++------------------------------ 1 file
> changed, 85 insertions(+), 106 deletions(-)
> 
> diff --git a/catalyst/main.py b/catalyst/main.py
> index 604c6ab..2a25df4 100644
> --- a/catalyst/main.py
> +++ b/catalyst/main.py
> @@ -6,9 +6,9 @@
>  # Chris Gianelloni <wolf31o2@wolf31o2.org>
>  # $Id$
>  
> +import argparse
>  import os
>  import sys
> -import getopt
>  import os.path
>  
>  __selfpath__ = os.path.abspath(os.path.dirname(__file__))
> @@ -28,35 +28,6 @@ from catalyst.version import get_version
>  conf_values={}
>  
>  
> -def usage():
> -	print """Usage catalyst [options] [-C variable=value...]
> [ -s identifier]
> - -a --clear-autoresume  clear autoresume flags
> - -c --config            use specified configuration file
> - -C --cli               catalyst commandline (MUST BE LAST OPTION)
> - -d --debug             enable debugging
> - -f --file              read specfile
> - -F --fetchonly         fetch files only
> - -h --help              print this help message
> - -p --purge             clear tmp dirs,package cache, autoresume
> flags
> - -P --purgeonly         clear tmp dirs,package cache, autoresume
> flags and exit
> - -T --purgetmponly      clear tmp dirs and autoresume flags and exit
> - -s --snapshot          generate a release snapshot
> - -V --version           display version information
> - -v --verbose           verbose output
> -
> -Usage examples:
> -
> -Using the commandline option (-C, --cli) to build a Portage snapshot:
> -catalyst -C target=snapshot version_stamp=my_date
> -
> -Using the snapshot option (-s, --snapshot) to build a release
> snapshot: -catalyst -s 20071121"
> -
> -Using the specfile option (-f, --file) to build a stage target:
> -catalyst -f stage1-specfile.spec
> -"""
> -
> -
>  def version():
>  	print get_version()
>  	print "Copyright 2003-2008 Gentoo Foundation"
> @@ -167,96 +138,104 @@ def build_target(addlargs):
>  	return target.run()
>  
>  
> -def main():
> -	# we need some options in order to work correctly
> -	if len(sys.argv) < 2:
> -		usage()
> -		sys.exit(2)
> -
> -	# parse out the command line arguments
> -	try:
> -		opts, _args = getopt.getopt(sys.argv[1:],
> "apPThvdc:C:f:FVs:", ["purge", "purgeonly", "purgetmponly", "help",
> "version", "debug",
> -			"clear-autoresume", "config=", "cli=",
> "file=", "fetch", "verbose","snapshot="]) -
> -	except getopt.GetoptError:
> -		usage()
> -		sys.exit(2)
> -
> -	myconfig=""
> -	myspecfile=""
> -	mycmdline=[]
> -
> -	# check preconditions
> -	if len(opts) == 0:
> -		print "!!! catalyst: please specify one of either -f
> or -C\n"
> -		usage()
> -		sys.exit(2)
> -
> -	options = set()
> -
> -	run = False
> -	for o, a in opts:
> -		if o in ("-h", "--help"):
> -			version()
> -			usage()
> -			sys.exit(1)
> +class FilePath(object):
> +	"""Argparse type for getting a path to a file."""
>  
> -		if o in ("-V", "--version"):
> -			print get_version()
> -			sys.exit(1)
> +	def __init__(self, exists=True):
> +		self.exists = exists
>  
> -		if o in ("-d", "--debug"):
> -			conf_values["DEBUG"] = True
> -			conf_values["VERBOSE"] = True
> +	def __call__(self, string):
> +		if not os.path.exists(string):
> +			raise argparse.ArgumentTypeError('file does
> not exist: %s' % string)
> +		return string
>  
> -		if o in ("-c", "--config"):
> -			myconfig=a
> +	def __repr__(self):
> +		return '%s(exists=%s)' % (type(self).__name__,
> self.exists) 
> -		if o in ("-C", "--cli"):
> -			run = True
> -			x=sys.argv.index(o)+1
> -			while x < len(sys.argv):
> -				mycmdline.append(sys.argv[x])
> -				x=x+1
>  
> -		if o in ("-f", "--file"):
> -			run = True
> -			myspecfile=a
> +def get_parser():
> +	"""Return an argument parser"""
> +	epilog = """Usage examples:
>  
> -		if o in ("-F", "--fetchonly"):
> -			options.add("fetch")
> +Using the commandline option (-C, --cli) to build a Portage snapshot:
> +$ catalyst -C target=snapshot version_stamp=my_date
>  
> -		if o in ("-v", "--verbose"):
> -			conf_values["VERBOSE"]="1"
> +Using the snapshot option (-s, --snapshot) to build a release
> snapshot: +$ catalyst -s 20071121
>  
> -		if o in ("-s", "--snapshot"):
> -			if len(sys.argv) < 3:
> -				print "!!! catalyst: missing
> snapshot identifier\n"
> -				usage()
> -				sys.exit(2)
> -			else:
> -				run = True
> -				mycmdline.append("target=snapshot")
> -				mycmdline.append("version_stamp="+a)
> +Using the specfile option (-f, --file) to build a stage target:
> +$ catalyst -f stage1-specfile.spec"""
> +
> +	parser = argparse.ArgumentParser(epilog=epilog,
> formatter_class=argparse.RawDescriptionHelpFormatter)
> +	parser.add_argument('-d', '--debug',
> +		default=False, action='store_true',
> +		help='enable debugging')
> +	parser.add_argument('-v', '--verbose',
> +		default=False, action='store_true',
> +		help='verbose output')
> +	parser.add_argument('-c', '--config',
> +		type=FilePath(),
> +		help='use specified configuration file')
> +	parser.add_argument('-f', '--file',
> +		type=FilePath(),
> +		help='read specfile')
> +	parser.add_argument('-F', '--fetchonly',
> +		default=False, action='store_true',
> +		help='fetch files only')
> +	parser.add_argument('-a', '--clear-autoresume',
> +		default=False, action='store_true',
> +		help='clear autoresume flags')
> +	parser.add_argument('-p', '--purge',
> +		default=False, action='store_true',
> +		help='clear tmp dirs, package cache, autoresume
> flags')
> +	parser.add_argument('-P', '--purgeonly',
> +		default=False, action='store_true',
> +		help='clear tmp dirs, package cache, autoresume
> flags and exit')
> +	parser.add_argument('-T', '--purgetmponly',
> +		default=False, action='store_true',
> +		help='clear tmp dirs and autoresume flags and exit')
> +	parser.add_argument('-s', '--snapshot',
> +		help='generate a release snapshot')
> +	parser.add_argument('-V', '--version',
> +		action='version', version=get_version(),
> +		help='display version information')
> +	parser.add_argument('-C', '--cli',
> +		default=[], nargs=argparse.REMAINDER,
> +		help='catalyst commandline (MUST BE LAST OPTION)')
> +	return parser
>  
> -		if o in ("-p", "--purge"):
> -			options.add("purge")
>  
> -		if o in ("-P", "--purgeonly"):
> -			options.add("purgeonly")
> +def main():
> +	parser = get_parser()
> +	opts = parser.parse_args(sys.argv[1:])
>  
> -		if o in ("-T", "--purgetmponly"):
> -			options.add("purgetmponly")
> +	# Parse the command line options.
> +	myconfig = opts.config
> +	myspecfile = opts.file
> +	mycmdline = opts.cli[:]
>  
> -		if o in ("-a", "--clear-autoresume"):
> -			options.add("clear-autoresume")
> +	if opts.snapshot:
> +		mycmdline.append('target=snapshot')
> +		mycmdline.append('version_stamp=' + opts.snapshot)
>  
> -	#print "MAIN: cli options =", options
> +	conf_values['DEBUG'] = opts.debug
> +	conf_values['VERBOSE'] = opts.debug or opts.verbose
>  
> -	if not run:
> -		print "!!! catalyst: please specify one of either -f
> or -C\n"
> -		usage()
> -		sys.exit(2)
> +	options = set()
> +	if opts.fetchonly:
> +		options.add('fetch')
> +	if opts.purge:
> +		options.add('purge')
> +	if opts.purgeonly:
> +		options.add('purgeonly')
> +	if opts.purgetmponly:
> +		options.add('purgetmponly')
> +	if opts.clear_autoresume:
> +		options.add('clear-autoresume')
> +
> +	# Make sure we have some work before moving further.
> +	if not myspecfile and not mycmdline:
> +		parser.error('please specify one of either -f or -C
> or -s') 
>  	# made it this far so start by outputting our version info
>  	version()

Wow, your chipping away at the long TODO list at a fast pace :)

all 4 are good to merge.

-- 
Brian Dolbec <dolsen>