From: cpebenito@tresys.com (Christopher J. PeBenito)
Date: Tue, 26 Jun 2012 09:17:27 -0400
Subject: [refpolicy] [PATCH v3 1/1] Refactoring code to support python3
In-Reply-To: <20120624130151.GA30127@siphos.be>
References: <20120624130151.GA30127@siphos.be>
Message-ID: <4FE9B667.3080202@tresys.com>
To: refpolicy@oss.tresys.com
List-Id: refpolicy.oss.tresys.com

On 06/24/12 09:01, Sven Vermeulen wrote:
> This patch includes the necessary refactoring to support python 3.
> 
> Changes since v2
> - Do not include contrib submodule (no relevant changes there)
> - Update in pyplate to fix a failure with str/unicode in doc generation

Merged.

> Signed-off-by: Sven Vermeulen <sven.vermeulen@siphos.be>
> ---
>  doc/templates/bool_list.html |    2 +-
>  doc/templates/interface.html |    4 +-
>  doc/templates/template.html  |    4 +-
>  doc/templates/tun_list.html  |    2 +-
>  policy/flask/flask.py        |    4 +-
>  support/genclassperms.py     |    8 ++--
>  support/genhomedircon        |    8 ++--
>  support/pyplate.py           |   18 ++++++---
>  support/sedoctool.py         |   87 +++++++++++++++++++++---------------------
>  support/segenxml.py          |   12 +++---
>  10 files changed, 78 insertions(+), 71 deletions(-)
> 
> diff --git a/doc/templates/bool_list.html b/doc/templates/bool_list.html
> index 2d852da..3a2f526 100644
> --- a/doc/templates/bool_list.html
> +++ b/doc/templates/bool_list.html
> @@ -2,7 +2,7 @@
>  
>  [[for bool in booleans]]
>  <div id="interfacesmall">
> -[[if bool.has_key('mod_layer')]]
> +[[if 'mod_layer' in bool]]
>  Module: <a href='[[bool['mod_layer']+ "_" + bool['mod_name'] + ".html#link_" + bool['bool_name']]]'>
>  [[bool['mod_name']]]</a><p/>
>  Layer: <a href='[[bool['mod_layer']]].html'>
> diff --git a/doc/templates/interface.html b/doc/templates/interface.html
> index 90eb436..0409361 100644
> --- a/doc/templates/interface.html
> +++ b/doc/templates/interface.html
> @@ -1,10 +1,10 @@
>  [[for int in interfaces]]
>  <a name="link_[[int['interface_name']]]"></a>
>  <div id="interface">
> -[[if int.has_key("mod_layer")]]
> +[[if "mod_layer" in int]]
>  	Layer: [[mod_layer]]<br>
>  [[end]]
> -[[if int.has_key("mod_name")]]
> +[[if "mod_name" in int]]
>  	Module: [[mod_name]]<br>
>  [[end]]
>  <div id="codeblock">
> diff --git a/doc/templates/template.html b/doc/templates/template.html
> index 251d227..03dd1d5 100644
> --- a/doc/templates/template.html
> +++ b/doc/templates/template.html
> @@ -1,10 +1,10 @@
>  [[for temp in templates]]
>  <a name="link_[[temp['template_name']]]"></a>
>  <div id="template">
> -[[if temp.has_key("mod_layer")]]
> +[[if "mod_layer" in temp]]
>  	Layer: [[mod_layer]]<br>
>  [[end]]
> -[[if temp.has_key("mod_name")]]
> +[[if "mod_name" in temp]]
>  	Module: [[mod_name]]<br>
>  [[end]]
>  <div id="codeblock">
> diff --git a/doc/templates/tun_list.html b/doc/templates/tun_list.html
> index 278f284..4daf8b4 100644
> --- a/doc/templates/tun_list.html
> +++ b/doc/templates/tun_list.html
> @@ -2,7 +2,7 @@
>  
>  [[for tun in tunables]]
>  <div id="interfacesmall">
> -[[if tun.has_key('mod_layer')]]
> +[[if 'mod_layer' in tun]]
>  Module: <a href='[[tun['mod_layer']+ "_" + tun['mod_name'] + ".html#link_" + tun['tun_name']]]'>
>  [[tun['mod_name']]]</a><p/>
>  Layer: <a href='[[tun['mod_layer']]].html'>
> diff --git a/policy/flask/flask.py b/policy/flask/flask.py
> index 8b4be50..ca566d8 100644
> --- a/policy/flask/flask.py
> +++ b/policy/flask/flask.py
> @@ -313,7 +313,7 @@ class Flask:
>  		results = []
>  		results.append(self.autogen)
>  		for c in self.vectors:
> -			if self.inherits.has_key(c):
> +			if c in self.inherits:
>  				i = self.inherits[c]
>  				count = len(self.common[i])
>  				if not (mode == self.KERNEL and self.userspace[c]):
> @@ -355,7 +355,7 @@ class Flask:
>  			count = 0
>  
>  			ps = []
> -			if self.inherits.has_key(c):
> +			if c in self.inherits:
>  				ps += self.common[self.inherits[c]]
>  			ps += self.vector[c]
>  			for p in ps: 
> diff --git a/support/genclassperms.py b/support/genclassperms.py
> index 732d645..6d6ce8b 100644
> --- a/support/genclassperms.py
> +++ b/support/genclassperms.py
> @@ -287,10 +287,10 @@ def error(error):
>  	Print an error message and exit.
>  	"""
>  
> -        sys.stderr.write("%s exiting for: " % sys.argv[0])
> -        sys.stderr.write("%s\n" % error)
> -        sys.stderr.flush()
> -        sys.exit(1)
> +	sys.stderr.write("%s exiting for: " % sys.argv[0])
> +	sys.stderr.write("%s\n" % error)
> +	sys.stderr.flush()
> +	sys.exit(1)
>  
>  # MAIN PROGRAM
>  app_name = sys.argv[0]
> diff --git a/support/genhomedircon b/support/genhomedircon
> index 01ef91d..33dbcc1 100644
> --- a/support/genhomedircon
> +++ b/support/genhomedircon
> @@ -82,7 +82,7 @@ def getPrefixes():
>  				u[5] != "/" and \
>  				string.count(u[5], "/") > 1:
>  			prefix = u[5][:string.rfind(u[5], "/")]
> -			if not prefixes.has_key(prefix):
> +			if not prefix in prefixes:
>  				prefixes[prefix] = ""
>  	return prefixes
>   
> @@ -133,7 +133,7 @@ def oldgenhomedircon(filecontextdir, filecontext):
>                  homedir = rc[1].split("=")[1]
>                  homedir = homedir.split("#")[0]
>                  homedir = homedir.strip()
> -                if not prefixes.has_key(homedir):
> +                if not homedir in prefixes:
>                          prefixes[homedir] = ""
>          else:
>                  #rc[0] == 256 means the file was there, we read it, but the grep didn't match
> @@ -149,7 +149,7 @@ def oldgenhomedircon(filecontextdir, filecontext):
>                  homedir = homedir.split("#")[0]
>                  homedir = homedir.strip()
>                  homedir = re.sub(r"[^/a-zA-Z0-9].*$", "", homedir)
> -                if not prefixes.has_key(homedir):
> +                if not homedir in prefixes:
>                          prefixes[homedir] = ""
>  
>          #the idea is that we need to find all of the home_root_t directories we do this by just accepting
> @@ -187,7 +187,7 @@ def oldgenhomedircon(filecontextdir, filecontext):
>                          if re.search(regex, potential, 0):
>                                  addme = 0
>                  if addme == 1:
> -                        if not prefixes.has_key(potential):
> +                        if not potential in prefixes:
>                                  prefixes[potential] = ""
>  
>  
> diff --git a/support/pyplate.py b/support/pyplate.py
> index c7532cc..44b662a 100644
> --- a/support/pyplate.py
> +++ b/support/pyplate.py
> @@ -51,7 +51,7 @@ PyPlate defines the following directives:
>  #
>  
>  from __future__ import nested_scopes
> -import sys, string, re, cStringIO
> +import sys, string, re, io
>  
>  re_directive = re.compile("\[\[(.*)\]\]")
>  re_for_loop = re.compile("for (.*) in (.*)")
> @@ -82,7 +82,10 @@ class Template:
>      file.close()
>  
>    def parse_string(self, template):
> -    file = cStringIO.StringIO(template)
> +    if sys.version_info >= (3,0):
> +      file = io.StringIO(template)
> +    else:
> +      file = io.StringIO(template.decode('utf-8'))
>      self.parse(file)
>      file.close()
>  
> @@ -111,7 +114,7 @@ class Template:
>      file.close()
>  
>    def execute_string(self, data):
> -    s = cStringIO.StringIO()
> +    s = io.StringIO()
>      self.execute(s, data)
>      return s.getvalue()
>  
> @@ -185,7 +188,7 @@ class ForTemplateNode(TemplateNode):
>    def execute(self, stream, data):
>      remember_vars = {}
>      for var in self.vars:
> -      if data.has_key(var):
> +      if var in data:
>          remember_vars[var] = data[var]
>      for list in eval(self.expression, globals(), data):
>        if is_sequence(list):
> @@ -264,7 +267,7 @@ class FunctionTemplateNode(TemplateNode):
>    def call(self, args, stream, data):
>      remember_vars = {}
>      for index, var in enumerate(self.vars):
> -      if data.has_key(var):
> +      if var in data:
>          remember_vars[var] = data[var]
>        data[var] = args[index]
>      TemplateNode.execute(self, stream, data)
> @@ -288,7 +291,10 @@ class CommentTemplateNode(LeafTemplateNode):
>  
>  class ExpressionTemplateNode(LeafTemplateNode):
>    def execute(self, stream, data):
> -    stream.write(str(eval(self.s, globals(), data)))
> +    if sys.version_info >= (3,0):
> +      stream.write(str(eval(self.s, globals(), data)))
> +    else:
> +      stream.write(str(eval(self.s, globals(), data)).decode('utf-8'))
>  
>  class ExecTemplateNode(LeafTemplateNode):
>    def __init__(self, parent, s):
> diff --git a/support/sedoctool.py b/support/sedoctool.py
> index 5bbaf76..afcdee4 100644
> --- a/support/sedoctool.py
> +++ b/support/sedoctool.py
> @@ -1,7 +1,7 @@
>  #!/usr/bin/python
>  
>  #  Author: Joshua Brindle <jbrindle@tresys.com>
> -#          Caleb Case <ccase@tresys.com>
> +#	  Caleb Case <ccase@tresys.com>
>  #
>  # Copyright (C) 2005 - 2006 Tresys Technology, LLC
>  #      This program is free software; you can redistribute it and/or modify
> @@ -62,7 +62,7 @@ def gen_booleans_conf(doc, file_name, namevalue_list):
>  	for node in doc.getElementsByTagName("bool"):
>  		for desc in node.getElementsByTagName("desc"):
>  			bool_desc = format_txt_desc(desc)
> -		s = string.split(bool_desc, "\n")
> +		s = bool_desc.split("\n")
>  		file_name.write("#\n")
>  		for line in s:
>  			file_name.write("# %s\n" % line)
> @@ -80,14 +80,14 @@ def gen_booleans_conf(doc, file_name, namevalue_list):
>  				bool_val = BOOL_DISABLED
>  
>  			if bool_name and bool_val:
> -	            		file_name.write("%s = %s\n\n" % (bool_name, bool_val))
> +				file_name.write("%s = %s\n\n" % (bool_name, bool_val))
>  				bool_name = bool_val = None
>  
>  	# tunables are currently implemented as booleans
>  	for node in doc.getElementsByTagName("tunable"):
>  		for desc in node.getElementsByTagName("desc"):
>  			bool_desc = format_txt_desc(desc)
> -		s = string.split(bool_desc, "\n")
> +		s = bool_desc.split("\n")
>  		file_name.write("#\n")
>  		for line in s:
>  			file_name.write("# %s\n" % line)
> @@ -105,7 +105,7 @@ def gen_booleans_conf(doc, file_name, namevalue_list):
>  				bool_val = BOOL_DISABLED
>  
>  			if bool_name and bool_val:
> -	            		file_name.write("%s = %s\n\n" % (bool_name, bool_val))
> +				file_name.write("%s = %s\n\n" % (bool_name, bool_val))
>  				bool_name = bool_val = None
>  
>  def gen_module_conf(doc, file_name, namevalue_list):
> @@ -153,7 +153,7 @@ def gen_module_conf(doc, file_name, namevalue_list):
>  			for desc in node.getElementsByTagName("summary"):
>  				if not desc.parentNode == node:
>  					continue
> -				s = string.split(format_txt_desc(desc), "\n")
> +				s = format_txt_desc(desc).split("\n")
>  				for line in s:
>  					file_name.write("# %s\n" % line)
>  
> @@ -209,39 +209,40 @@ def get_conf(conf):
>  
>  	return namevalue_list
>  
> -def first_cmp(a, b):
> +def first_cmp_func(a):
>  	"""
> -	Compares the two first elements of a list instead of the entire list.
> +	Return the first element to sort/compare on.
>  	"""
>  
> -	return cmp(a[0], b[0])
> +	return a[0]
>  
> -def int_cmp(a, b):
> +def int_cmp_func(a):
>  	"""
> -	Compares two interfaces.
> +	Return the interface name to sort/compare on.
>  	"""
>  
> -	return cmp(a["interface_name"], b["interface_name"])
> +	return a["interface_name"]
>  		
> -def temp_cmp(a, b):
> +def temp_cmp_func(a):
>  	"""
> -	Compares two templates.
> +	Return the template name to sort/compare on.
>  	"""
>  
> -	return cmp(a["template_name"], b["template_name"])
> +	return a["template_name"]
>  
> -def tun_cmp(a, b):
> +def tun_cmp_func(a):
>  	"""
> -	Compares two tunables.
> +	Return the tunable name to sort/compare on.
>  	"""
>  
> -	return cmp(a["tun_name"], b["tun_name"])
> -def bool_cmp(a, b):
> +	return a["tun_name"]
> +
> +def bool_cmp_func(a):
>  	"""
> -	Compares two booleans.
> +	Return the boolean name to sort/compare on.
>  	"""
>  
> -	return cmp(a["bool_name"], b["bool_name"])
> +	return a["bool_name"]
>  
>  def gen_doc_menu(mod_layer, module_list):
>  	"""
> @@ -249,18 +250,18 @@ def gen_doc_menu(mod_layer, module_list):
>  	"""
>  
>  	menu = []
> -	for layer, value in module_list.iteritems():
> +	for layer, value in module_list.items():
>  		cur_menu = (layer, [])
>  		menu.append(cur_menu)
>  		if layer != mod_layer and mod_layer != None:
>  			continue
>  		#we are in our layer so fill in the other modules or we want them all
> -		for mod, desc in value.iteritems():
> +		for mod, desc in value.items():
>  			cur_menu[1].append((mod, desc))
>  
> -	menu.sort(first_cmp)
> +	menu.sort(key=first_cmp_func)
>  	for x in menu:
> -		x[1].sort(first_cmp)
> +		x[1].sort(key=first_cmp_func)
>  	return menu
>  
>  def format_html_desc(node):
> @@ -364,7 +365,7 @@ def gen_docs(doc, working_dir, templatedir):
>  #arg, i have to go through this dom tree ahead of time to build up the menus
>  	module_list = {}
>  	for node in doc.getElementsByTagName("module"):
> -                mod_name = mod_layer = interface_buf = ''
> +		mod_name = mod_layer = interface_buf = ''
>  
>  		mod_name = node.getAttribute("name")
>  		mod_layer = node.parentNode.getAttribute("name")
> @@ -372,14 +373,14 @@ def gen_docs(doc, working_dir, templatedir):
>  		for desc in node.getElementsByTagName("summary"):
>  			if desc.parentNode == node and desc:
>  				mod_summary = format_html_desc(desc)
> -		if not module_list.has_key(mod_layer):
> +		if not mod_layer in module_list:
>  			module_list[mod_layer] = {}
>  
>  		module_list[mod_layer][mod_name] = mod_summary
>  
>  #generate index pages
>  	main_content_buf = ''
> -	for mod_layer,modules in module_list.iteritems():
> +	for mod_layer,modules in module_list.items():
>  		menu = gen_doc_menu(mod_layer, module_list)
>  
>  		layer_summary = None
> @@ -428,7 +429,7 @@ def gen_docs(doc, working_dir, templatedir):
>  	all_tunables = []
>  	all_booleans = []
>  	for node in doc.getElementsByTagName("module"):
> -                mod_name = mod_layer = mod_desc = interface_buf = ''
> +		mod_name = mod_layer = mod_desc = interface_buf = ''
>  
>  		mod_name = node.getAttribute("name")
>  		mod_layer = node.parentNode.getAttribute("name")
> @@ -485,7 +486,7 @@ def gen_docs(doc, working_dir, templatedir):
>  					   "interface_parameters" : interface_parameters,
>  					   "mod_name": mod_name,
>  					   "mod_layer" : mod_layer })
> -		interfaces.sort(int_cmp)	
> +		interfaces.sort(key=int_cmp_func)	
>  		interface_tpl = pyplate.Template(intdata)
>  		interface_buf = interface_tpl.execute_string({"interfaces" : interfaces})
>  	
> @@ -532,7 +533,7 @@ def gen_docs(doc, working_dir, templatedir):
>  					   "mod_name": mod_name,
>  					   "mod_layer" : mod_layer })
>  
> -		templates.sort(temp_cmp)	
> +		templates.sort(key=temp_cmp_func)	
>  		template_tpl = pyplate.Template(templatedata)
>  		template_buf = template_tpl.execute_string({"templates" : templates})
>  
> @@ -556,7 +557,7 @@ def gen_docs(doc, working_dir, templatedir):
>  					   "def_val" : boolean_dftval,
>  					   "mod_name": mod_name,
>  					   "mod_layer" : mod_layer })
> -		booleans.sort(bool_cmp)
> +		booleans.sort(key=bool_cmp_func)
>  		boolean_tpl = pyplate.Template(booldata)
>  		boolean_buf = boolean_tpl.execute_string({"booleans" : booleans})
>  
> @@ -580,7 +581,7 @@ def gen_docs(doc, working_dir, templatedir):
>  					   "def_val" : tunable_dftval,
>  					   "mod_name": mod_name,
>  					   "mod_layer" : mod_layer })
> -		tunables.sort(tun_cmp)
> +		tunables.sort(key=tun_cmp_func)
>  		tunable_tpl = pyplate.Template(tundata)
>  		tunable_buf = tunable_tpl.execute_string({"tunables" : tunables})
>  	
> @@ -639,7 +640,7 @@ def gen_docs(doc, working_dir, templatedir):
>  	menu_buf = menu_tpl.execute_string(menu_args)
>  	
>  	#build the interface index
> -	all_interfaces.sort(int_cmp)
> +	all_interfaces.sort(key=int_cmp_func)
>  	interface_tpl = pyplate.Template(intlistdata)
>  	interface_buf = interface_tpl.execute_string({"interfaces" : all_interfaces})
>  	int_file = "interfaces.html"
> @@ -654,7 +655,7 @@ def gen_docs(doc, working_dir, templatedir):
>  
>  
>  	#build the template index
> -	all_templates.sort(temp_cmp)
> +	all_templates.sort(key=temp_cmp_func)
>  	template_tpl = pyplate.Template(templistdata)
>  	template_buf = template_tpl.execute_string({"templates" : all_templates})
>  	temp_file = "templates.html"
> @@ -679,7 +680,7 @@ def gen_docs(doc, working_dir, templatedir):
>  			global_tun.append( { "tun_name" : tunable_name,
>  						"def_val" : default_value,
>  						"desc" : description } )
> -	global_tun.sort(tun_cmp)
> +	global_tun.sort(key=tun_cmp_func)
>  	global_tun_tpl = pyplate.Template(gtunlistdata)
>  	global_tun_buf = global_tun_tpl.execute_string({"tunables" : global_tun})
>  	global_tun_file = "global_tunables.html"
> @@ -694,7 +695,7 @@ def gen_docs(doc, working_dir, templatedir):
>  
>  	#build the tunable index
>  	all_tunables = all_tunables + global_tun
> -	all_tunables.sort(tun_cmp)
> +	all_tunables.sort(key=tun_cmp_func)
>  	tunable_tpl = pyplate.Template(tunlistdata)
>  	tunable_buf = tunable_tpl.execute_string({"tunables" : all_tunables})
>  	temp_file = "tunables.html"
> @@ -718,7 +719,7 @@ def gen_docs(doc, working_dir, templatedir):
>  			global_bool.append( { "bool_name" : bool_name,
>  						"def_val" : default_value,
>  						"desc" : description } )
> -	global_bool.sort(bool_cmp)
> +	global_bool.sort(key=bool_cmp_func)
>  	global_bool_tpl = pyplate.Template(gboollistdata)
>  	global_bool_buf = global_bool_tpl.execute_string({"booleans" : global_bool})
>  	global_bool_file = "global_booleans.html"
> @@ -733,7 +734,7 @@ def gen_docs(doc, working_dir, templatedir):
>  	
>  	#build the boolean index
>  	all_booleans = all_booleans + global_bool
> -	all_booleans.sort(bool_cmp)
> +	all_booleans.sort(key=bool_cmp_func)
>  	boolean_tpl = pyplate.Template(boollistdata)
>  	boolean_buf = boolean_tpl.execute_string({"booleans" : all_booleans})
>  	temp_file = "booleans.html"
> @@ -753,10 +754,10 @@ def error(error):
>  	Print an error message and exit.
>  	"""
>  
> -        sys.stderr.write("%s exiting for: " % sys.argv[0])
> -        sys.stderr.write("%s\n" % error)
> -        sys.stderr.flush()
> -        sys.exit(1)
> +	sys.stderr.write("%s exiting for: " % sys.argv[0])
> +	sys.stderr.write("%s\n" % error)
> +	sys.stderr.flush()
> +	sys.exit(1)
>  
>  def warning(warn):
>  	"""
> diff --git a/support/segenxml.py b/support/segenxml.py
> index d6c4fd5..5f4f7d0 100644
> --- a/support/segenxml.py
> +++ b/support/segenxml.py
> @@ -1,9 +1,9 @@
>  #!/usr/bin/python
>  
>  #  Author(s): Donald Miner <dminer@tresys.com>
> -#             Dave Sugar <dsugar@tresys.com>
> -#             Brian Williams <bwilliams@tresys.com>
> -#             Caleb Case <ccase@tresys.com>
> +#	     Dave Sugar <dsugar@tresys.com>
> +#	     Brian Williams <bwilliams@tresys.com>
> +#	     Caleb Case <ccase@tresys.com>
>  #
>  # Copyright (C) 2005 - 2006 Tresys Technology, LLC
>  #      This program is free software; you can redistribute it and/or modify
> @@ -335,9 +335,9 @@ def error(description):
>  	'''
>  
>  	sys.stderr.write("%s: " % sys.argv[0] )
> -        sys.stderr.write("error: " + description + "\n")
> -        sys.stderr.flush()
> -        sys.exit(1)
> +	sys.stderr.write("error: " + description + "\n")
> +	sys.stderr.flush()
> +	sys.exit(1)
>  
>  
>  
> 


-- 
Chris PeBenito
Tresys Technology, LLC
www.tresys.com | oss.tresys.com