From 92fcfce9627359398c0de00deb15897061c118d2 Mon Sep 17 00:00:00 2001 From: necoro <> Date: Sun, 24 Sep 2006 17:31:24 +0000 Subject: Started some documentation --- geneticone/gui/main.py | 151 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 105 insertions(+), 46 deletions(-) (limited to 'geneticone/gui') diff --git a/geneticone/gui/main.py b/geneticone/gui/main.py index e0dceef..b533e11 100644 --- a/geneticone/gui/main.py +++ b/geneticone/gui/main.py @@ -41,11 +41,11 @@ class EmergeQueue: def __init__ (self, tree = None, console = None, packages = None): """Constructor. - @param tree: Tree to append all the items to. + @param tree: Tree to append all the items to. Default: None. @type tree: gtk.TreeStore - @param console: Output is shown here. + @param console: Output is shown here. Default: None @type console: vte.Terminal - @param packages: The list of packages sorted by categories. We will delete the appropriate category if we updated sth. + @param packages: The list of packages sorted by categories. We will delete the appropriate category if we updated sth. Default: None @type packages: dictionary: {category: list_of_packages}.""" self.mergequeue = [] @@ -56,111 +56,165 @@ class EmergeQueue: self.console = console self.packages = packages - if self.tree: + if self.tree: self.emergeIt = self.tree.append(None, ["Emerge"]) self.unmergeIt = self.tree.append(None, ["Unmerge"]) else: self.emergeIt = self.unmergeIt = None def update_tree (self, it, cpv): - try: + """This updates the tree recursivly. + + @param it: iterator where to append + @type it: gtk.TreeIter + @param cpv: The package to append. + @type cpv: string (cat/pkg-ver) + + @raise geneticone.BlockedException: When occured during dependency-calculation.""" + + # get depencies + if cpv in self.deps: deps = self.deps[cpv] - except KeyError: + else: deps = geneticone.find_packages("="+cpv)[0].get_dep_packages() self.deps.update({cpv : deps}) subIt = self.tree.append(it, [cpv]) + # recursive call for d in deps: try: self.update_tree(subIt, d) except geneticone.BlockedException, e: + # remove the project while self.tree.iter_parent(subIt): subIt = self.tree.iter_parent(subIt) self.remove_children(subIt) raise e + # add iter self.iters.update({cpv: subIt}) - def append (self, sth, unmerge = False, update = False): + def append (self, cpv, unmerge = False, update = False): """Appends a cpv either to the merge queue or to the unmerge-queue. - Also update the tree-view.""" + Also updates the tree-view. + + @param cpv: Package to add + @type cpv: string (cat/pkg-ver) + @param unmerge: Set to True if you want to unmerge this package - else False. Default: False + @type unmerge: boolean + @param update: Set to True if a package is going to be updated (e.g. if the use-flags changed). Default: False + @type update: boolean""" + if not unmerge: try: # insert dependencies - pkg = geneticone.find_packages("="+sth)[0] + pkg = geneticone.find_packages("="+cpv)[0] deps = pkg.get_dep_packages() if update: - if deps == self.deps[sth]: - return + if deps == self.deps[cpv]: + return # nothing changed - return else: - parentIt = self.tree.iter_parent(self.iters[sth]) - self.remove(self.iters[sth]) - self.deps.update({sth: deps}) - self.update_tree(parentIt, sth) - else: - self.mergequeue.append(sth) - self.deps.update({sth : deps}) - - # update tree - if self.emergeIt: - self.update_tree(self.emergeIt, sth) + parentIt = self.tree.iter_parent(self.iters[cpv]) + self.remove(self.iters[cpv]) + self.deps.update({cpv: deps}) + self.update_tree(parentIt, cpv) + else: # not update + self.mergequeue.append(cpv) + self.deps.update({cpv : deps}) + if self.emergeIt: self.update_tree(self.emergeIt, cpv) - except geneticone.BlockedException, e : + except geneticone.BlockedException, e : # there is sth blocked --> call blocked_dialog blocks = e[0] - blocked_dialog(sth, blocks) + blocked_dialog(cpv, blocks) return - else: - self.unmergequeue.append(sth) + else: # unmerge + self.unmergequeue.append(cpv) if self.unmergeIt: # update tree - self.tree.append(self.unmergeIt, [sth]) + self.tree.append(self.unmergeIt, [cpv]) - def update_packages(self, process, packages): - """This updates the packages-list. It simply removes all affected categories so they have to be rebuilt.""" - process.wait() + def _update_packages(self, packages, process = None): + """This updates the packages-list. It simply removes all affected categories so they have to be rebuilt. + + @param packages: The packages which we emerged. + @type packages: list of cpvs + @param process: The process we have to wait for before we can do our work. Default: None. + @type process: subprocess.Popen""" + + if process: process.wait() for p in packages: try: - cat = geneticone.split_package_name(p)[0] + cat = geneticone.split_package_name(p)[0] # get category while cat[0] in ["=",">","<","!"]: cat = cat[1:] - print cat, + print "Category: "+cat , del self.packages[cat] - print "deleted" - except KeyError: + print "marked for refreshing" + except KeyError: # not in self.packages - ignore pass def _emerge (self, options, packages, it): - """Calls emerge and updates the terminal.""" + """Calls emerge and updates the terminal. + + @param options: options to send to emerge + @type options: list + @param packages: packages to emerge + @type packages: list + @param it: Iterator which points to an entry whose children will be removed after completion. + @type it: gtk.TreeIter""" + + # open tty (master, slave) = pty.openpty() self.console.set_pty(master) + + # start emerge process = Popen(["/usr/bin/python","/usr/bin/emerge"]+options+packages, stdout = slave, stderr = STDOUT, shell = False) - Thread(target=self.update_packages, args=(process, packages)).start() + Thread(target=self._update_packages, args=(packages, process)).start() + + # remove self.remove_children(it) def emerge (self, force = False): - """Emerges everything in the merge-queue. If force is 'False' (default) only 'emerge -pv' is called.""" - if len(self.mergequeue) == 0: return + """Emerges everything in the merge-queue. + + @param force: If False, '-pv' is send to emerge. Default: False. + @type force: boolean""" + if len(self.mergequeue) == 0: return # nothing in queue + + # prepare package-list list = [] for k in self.mergequeue: list += ["="+k] s = [] if not force: s = ["-pv"] + self._emerge(s, list, self.emergeIt) def unmerge (self, force = False): - """Unmerges everything in the umerge-queue. If force is 'False' (default) only "emerge -pv -C" is called.""" - if len(self.unmergequeue) == 0: return + """Unmerges everything in the umerge-queue. - list = self.unmergequeue[:] + @param force: If False, '-pv' is send to emerge. Default: False. + @type force: boolean""" + + if len(self.unmergequeue) == 0: return # nothing in queue + + list = self.unmergequeue[:] # copy the unmerge-queue + + # set options s = ["-C"] if not force: s = ["-Cpv"] + self._emerge(s,list, self.unmergeIt) def remove_children (self, parentIt): - """Removes all children of a given parent TreeIter.""" + """Removes all children of a given parent TreeIter. + + @param parentIt: The iter from which to remove all children. + @type parentIt: gtk.TreeIter""" + childIt = self.tree.iter_children(parentIt) while childIt: @@ -169,18 +223,23 @@ class EmergeQueue: self.remove(temp) def remove (self, it): - """Removes a specific item in the tree.""" + """Removes a specific item in the tree. This does not remove the top-entries. + + @param it: Iterator which points to the entry we are going to remove. + @type it: gtk.TreeIter""" + if self.tree.iter_parent(it): # NEVER remove our top stuff cpv = self.tree.get_value(it,0) - if self.tree.get_string_from_iter(it).split(":")[0] == self.tree.get_string_from_iter(self.emergeIt): + if self.tree.get_string_from_iter(it).split(":")[0] == self.tree.get_string_from_iter(self.emergeIt): # in Emerge try: self.mergequeue.remove(cpv) del self.iters[cpv] del self.deps[cpv] - except ValueError: + except ValueError: # this is a dependency - ignore pass flags.remove_new_use_flags(cpv) - else: + + else: # in Unmerge self.unmergequeue.remove(cpv) self.tree.remove(it) -- cgit v1.2.3-70-g09d2