[gentoo-commits] proj/R_overlay:master commit in: roverlay/

[André Erdmann]

commit:     2e76c1e480434d43b6be4ade11d6ebd7a7025718
Author:     Andre Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Tue May 29 17:06:35 2012 +0000
Commit:     André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Tue May 29 17:06:35 2012 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=2e76c1e4

roverlay, ebuildcreator: module that accepts package_files, schedules their processing into jobs and returns ebuilds (but is todo)
	modified:   ebuildcreator.py

---
 roverlay/ebuildcreator.py |  356 +++++++--------------------------------------
 1 files changed, 54 insertions(+), 302 deletions(-)

diff --git a/roverlay/ebuildcreator.py b/roverlay/ebuildcreator.py
index fa648b8..f439c71 100644
--- a/roverlay/ebuildcreator.py
+++ b/roverlay/ebuildcreator.py
@@ -1,350 +1,102 @@
-# R Overlay -- ebuild creation
+# R Overlay -- ebuild creation, "master" module
 # Copyright 2006-2012 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
-# temporary import until logging is implemented
-from sys import stderr as logging
+from roverlay import ebuildjob.EbuildJob
 
-# temporary import until config and real constants are implemented
-from roverlay import tmpconst as const
 
-from roverlay.fileio import DescriptionReader
-
-# misc TODO notes:
-# * could use caching via decorators instead of wrappers (-> later)
-# * instead of including the ebuild header in every ebuild 'export' data:
-# ** link that header
-# ** ebuild_export = [ <header_link>, str, [,str]* ]
-#
+class EbuildCreator:
 
-class Ebuild:
-	# could move this to const
-	EBUILD_INDENT = "\t"
 
-	# reading every ebuild header file (copyright, inherit <eclass>) once at most
-	#  <ebuild header file> => [<content of this file>]
-	#  shared among all ebuilds
-	ebuild_headers = dict()
 
 	@classmethod
 	def __init__ ( self ):
-		"""Initializes an empty Ebuild. This is an object that can be used to
-		create text lines for an ebuild file."""
-
-		#self.name        = ''
-		#self.version     = ''
-		#self.origin      = ''
-		#self.pkg_file    = ''
-		#self.depend      = ''
-		#self.rdepend     = ''
-		#self.rsuggests   = ''
-		#self.description = ''
+		"""Initializes an EbuildCreator. This is an Object that controls the
+		R package -> ebuild creation. It continuously creates EbuildJobs for
+		every R package added.
+		"""
+		self.ebuild_headers = dict ()
+		self.depresolve_main = None # TODO
+		self.ebuild_jobs = []
 
-		# temporary var
-		#self.TODO = ''
+	# --- end of init (...) ---
 
-		# this will be a list of str when exported data have been calculated
-		self._ebuild_export = None
 
 	@classmethod
-	def get_ebuild ( self, description_data, force_update=False ):
-		"""
-		Wrapper function that returns ebuild 'export' data.
-		This is a list of str that has no newline chars at the end of each str.
+	def add_package ( self, package_file ):
+		"""Adds an R package to the EbuildCreator, which means that an EbuildJob
+		will be created for it. Returns the EbuildJob, which is also stored
+		in the job queue.
 
 		arguments:
-		* force_update -- force calculation of export data
-
+		* package_file -- path R package file
 		"""
-		if force_update or (self._ebuild_export is None):
-			self._ebuild_export = self._make_export ( description_data )
+		new_job = EbuildJob ( package_file, self.get_resolver ( False ) )
 
-		return self._ebuild_export
+		self.ebuild_jobs.append ( new_job )
 
-	@classmethod
-	def suggest_filename ( self ):
-		"""Suggests a file name for the ebuild.
-		Calculated using ebuild data, but TODO
-		"""
-		# name-version
-		return None
+		return new_job
+
+	# --- end of add_package (...) ---
 
 	@classmethod
-	def write_ebuild ( self, file_to_write, force_update=False ):
-		"""Writes this ebuild into a file
+	def get_resolver ( self, readonly=True ):
+		"""Returns a communication channel to the dependency resolver.
 
 		arguments:
-		* file_to_write -- path of the file to write (will be overwritten if existent)
-		* force_update -- force calculation of ebuild data, don't use cached results
-
-		**TODO notes : mkdir -p $(dirname)
+		readonly -- whether the channel is listen-only (no write methods) or not
+		            defaults to True
 		"""
-		try:
-			# try to get the ebuild lines before opening the file
-			line  = None
-			# append newline here or add in _make_export()
-			lines = [ line + "\n" for line in self.get_ebuild ( force_update ) ]
-			del line
-
-			fh = open ( file_to_write, 'w' )
-			fh.writelines ( lines )
-			fh.close ()
-
-			del lines, fh
-			return True
-		except IOError as err:
-			raise
-
-		# catch failure
-		return False
-
-		@classmethod
-		def _make_ebuild_lines ( self, ebuild_content ):
-			ebuild_export = []
-			last_line_empty = False
-			line = None
-
-			# remove repeated newlines ('repoman sez: ...')
-			for line in ebuild_content:
-				line = line.rstrip()
-				if line:
-					last_line_empty = False
-				elif not last_line_empty:
-					last_line_empty = True
-				else:
-					continue
-
-				ebuild_export.append ( line )
+		# <TODO>
+		return None
+		#return self.depresolve_main.get_channel()
 
-			del last_line_empty, line
-			return ebuild_content
+	# --- end of get_resolver (...) ---
 
+	@classmethod
+	def run ( self ):
+		"""Tells all EbuildJobs to run."""
+		for job in self.ebuild_jobs:
+			job.run()
 
+	@classmethod
+	def collect_ebuilds ( self ):
+		"""Returns all ebuilds. (They may not be ready / TODO)"""
+		return [ job.get_ebuild() for job in self.ebuild_jobs ]
 
-	@staticmethod
-	def _get_ebuild_header ( ebuild_header_file=None ):
+	@classmethod
+	def get_ebuild_header ( self, ebuild_header_file=None ):
 		"""Reads and returns the content of an ebuild header file.
 		This is a normal file that can be included in ebuilds.
 		Every header file will only be read on first access, it's content will
-		be stored in a dict that is shared among all Ebuild instances.
+		be stored in a dict that is shared among all EbuildCreator instances.
 
 		arguments:
-		ebuild_header_file -- path to the header file; defaults to none which
-		                      means that nothing will be read and an empty list
-		                      is returned
+		* ebuild_header_file -- path to the header file; defaults to none which
+		                        means that nothing will be read and an empty list
+		                        is returned.
 		"""
+
 		if ebuild_header_file is None:
 			# nothing to read
 			return []
 
-		elif (ebuild_header_file in ebuild_headers):
+		elif ebuild_header_file in self.ebuild_headers:
 			# previously read
-			return ebuild_headers [ebuild_header_file]
+			return self.ebuild_headers [ebuild_header_file]
 
 		else:
-			# do read
+			# read file
 			try:
-				fh = open (ebuild_header_file, 'rU')
+				fh = open ( ebuild_header_file, 'r' )
 				lines = fh.readlines()
 				fh.close()
-				ebuild_headers [ebuild_header_file] = lines
-				del lines, fh
-				return ebuild_headers [ebuild_header_file]
+				self.ebuild_headers [ebuild_header_file] = lines
+				del fh
+				return lines
 
 			except IOError as err:
+				# todo
 				raise
 
-	@staticmethod
-	def _make_var ( varname, value=None, indent_level=0 ):
-		"""Returns a variable definitions that can be used in ebuilds, optionally
-		with indention.
-
-		arguments:
-		* varname -- name of the variable (e.g. DEPEND)
-		* value -- value of the variable; an empty var (DEPEND="") will be returned
-		           if unset (the default)
-		* indent_level -- indent var definition by indent_level levels
-		"""
-
-		if value:
-			return indent_level * EBUILD_INDENT + varname + '"' + value + '"'
-		else:
-			# empty var
-			return indent_level * EBUILD_INDENT + varname + '""'
-
-	@classmethod
-	def _make_export ( self, description_data, ebuild_header=None ):
-		"""Creates ebuild data that can be written into stdout or a file
-
-		arguments:
-		ebuild_header_file -- path to the header file; defaults to none which
-		                      means that nothing will be read and an empty list
-		                      is returned
-		"""
-
-		# this method is todo
-
-		if not isinstance (description_data, dict):
-			#todo
-			raise Exception ( "bad description data" )
-
-		errors = dict()
-
-		ebuild_content = Ebuild._get_ebuild_header ( ebuild_header )
-
-		# repeated and leading empty lines will be removed later
-		ebuild_content.append ( "" )
-
-		# the code below this line does not work
-		return
-		#raise Exception ( "under construction ..." )
-
-		if self.pkg_file:
-			ebuild_content.append ( _make_var ( "PKG_FILE" , self.pkg_file ) )
-		else:
-			# absense of a pkg source file is an error
-			errors ['PKG_FILE'] = "missing"
-
-		if self.origin:
-			ebuild_content.append ( _make_var ( "PKG_ORIGIN", self.origin ) )
-		else:
-			errors ['PKG_ORIGIN'] = "missing"
-
-		ebuild_content.append ( "" )
-
-		if self.description:
-			ebuild_content.append ( _make_var ( "DESCRIPTION", self.TODO ) )
-		else:
-			ebuild_content.append ( _make_var ( "DESCRIPTION", "<none>" ) )
-			#errors ['DESCRIPTION'] = "missing"
-
-		# determine SRC_URI (origin + pkg_file)
-		if self.pkg_file and self.origin and False:
-			# SRC_URI ~= <> + origin + pkg_file
-			ebuild_content.append ( _make_var ( "SRC_URI", "" ) )
-		else:
-			# either RESTRICT+=" fetch" or treat missing SRC_URI as critical
-			errors ['SRC_URI'] = "missing"
-
-		ebuild_content.append ( "" )
-
-		#LICENSE (!!)
-
-		rdepend = '${DEPEND:-} ' + self.rdepend
-
-		# inherit IUSE from eclass
-		iuse = '${IUSE:-}'
-
-		if self.rsuggests:
-			iuse    += ' R_suggests'
-			rdepend += ' R_suggests ? ${R_SUGGESTS}'
-			ebuild_content.append ( _make_var ( "R_SUGGESTS", self.rsuggests ) )
-
-		ebuild_content.append ( _make_var ( "IUSE", iuse ) )
-		ebuild_content.append ( "" )
-
-		# DEPEND="${DEPEND:-} <pkg dependencies>" to inherit deps from eclass
-		ebuild_content.append ( _make_var (
-											"DEPEND", '${DEPEND:-} ' + self.depend ) )
-
-		ebuild_content.append ( _make_var ( "RDEPEND", rdepend ) )
-
-		# (!!) TODO
-		if errors:
-			raise Exception ( "^^^missing components for ebuild^^^" )
-			#return None
-
-		return self._make_ebuild_lines ( ebuild_content )
-
-class EbuildCreator:
-# could move this to Ebuild
-
-		@classmethod
-		def __init__ ( self,  description_data ):
-			""""Initializes an EbuildCreator.
-			[todo]
-			"""
-			self._description_data = description_data
-
-			self._ebuild = None
-
-		@classmethod
-		def run ( self ):
-			"""Tells this EbuildCreator to operate which produces an Ebuild object
-			that can later be shown or written into a file.
-			"""
-			#todo
-			self._ebuild = None
-
-			if self._description_data is None:
-				return False
-
-			ebuild = Ebuild()
-			dref = self._description_data
-
-			ebuild.name = dref ['Package']
-			ebuild.version = dref ['Version']
-
-			ebuild.origin = "TODO"
-			ebuild.pkg_file = "TODO"
-
-			# depend rdepend rsuggest
-			ebuild.depend  = "TODO"
-			ebuild.rdepend = "TODO"
-			ebuild.suggest = "TODO"
-
-			if 'Description' in dref:
-				ebuild.description = dref ['Description']
-			elif 'Title' in dref:
-				ebuild.description = dref ['Title']
-			else:
-				ebuild.description = "<none>"
-
-			# <dep resolution here?>
-
-			ebuild.get_ebuild ( self._description_data )
-
-			# todo
-			return None
-
-
-		@classmethod
-		def show ( self ):
-			"""Prints the ebuild to stdout/err or into log"""
-			pass
-
-		@classmethod
-		def write ( self ):
-			"""Writes the ebuild into a file"""
-			pass
-
-		@classmethod
-		def ready ( self ):
-			"""Returns true if an Ebuild has been produced, else false."""
-			return not (self._ebuild is None)
-
-
-class EbuildFactory:
-
-		@classmethod
-		def __init__ ( self ):
-			"""Initializes an ebuild factory. This continously produces EbuildCreator
-			for every get_ebuild_creator ( tarball ) call.
-			"""
-			self.desc_reader = DescriptionReader()
-
-		@classmethod
-		def get_ebuild_creator ( self, tarball ):
-			"""Creates and returns an ebuild creator that will handle
-			the data retrieved from <tarball>.
-
-			arguments:
-			* tarball -- tarball to read
-			"""
-			data = self.desc_reader.readfile ( tarball )
-			if data:
-				return EbuildCreator ( data )
-			else:
-				return None
-
-
+	# --- end of get_ebuild_header (...) ---