From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1SjHhk-0005hd-In for garchives@archives.gentoo.org; Mon, 25 Jun 2012 22:24:23 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 70DFF21C177; Mon, 25 Jun 2012 22:23:48 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id 2E39B21C177 for ; Mon, 25 Jun 2012 22:23:47 +0000 (UTC) Received: from hornbill.gentoo.org (hornbill.gentoo.org [94.100.119.163]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 473651B44AD for ; Mon, 25 Jun 2012 22:23:47 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by hornbill.gentoo.org (Postfix) with ESMTP id 2276CE5444 for ; Mon, 25 Jun 2012 22:23:44 +0000 (UTC) From: "Slava Bacherikov" To: gentoo-commits@lists.gentoo.org Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Slava Bacherikov" Message-ID: <1340663011.ac2250f01a4656a5f703c58ae16defb501396885.bacher09@gentoo> Subject: [gentoo-commits] proj/gentoo-packages:master commit in: gpackages/apps/packages/ X-VCS-Repository: proj/gentoo-packages X-VCS-Files: gpackages/apps/packages/scan.py X-VCS-Directories: gpackages/apps/packages/ X-VCS-Committer: bacher09 X-VCS-Committer-Name: Slava Bacherikov X-VCS-Revision: ac2250f01a4656a5f703c58ae16defb501396885 X-VCS-Branch: master Date: Mon, 25 Jun 2012 22:23:44 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: 7fd9b888-a381-48f2-b1ae-8376ef9148f6 X-Archives-Hash: bbdc9fe1ee9f18a659e9636d3bf7f4f8 commit: ac2250f01a4656a5f703c58ae16defb501396885 Author: Slava Bacherikov bacher09 org> AuthorDate: Mon Jun 25 22:23:31 2012 +0000 Commit: Slava Bacherikov bacherikov org ua> CommitDate: Mon Jun 25 22:23:31 2012 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=3Dproj/gentoo-packag= es.git;a=3Dcommit;h=3Dac2250f0 Add docstrings to scan.py file --- gpackages/apps/packages/scan.py | 35 +++++++++++++++++++++++++++++++++= ++ 1 files changed, 35 insertions(+), 0 deletions(-) diff --git a/gpackages/apps/packages/scan.py b/gpackages/apps/packages/sc= an.py index b19958d..52f9a12 100644 --- a/gpackages/apps/packages/scan.py +++ b/gpackages/apps/packages/scan.py @@ -93,6 +93,7 @@ def toint(val, defval): =20 =20 class Scanner(object): + "General class for scan and collect data from portage" def __init__(self, **kwargs): # maintainers_cache: maintainer.email as key, and maintainer obj= ect as # value @@ -136,11 +137,14 @@ class Scanner(object): self.is_scan_license_groups =3D bool_get('scan_license_groups', = False) =20 def show_time(self): + "Prints scan time" end =3D datetime.now() t_time =3D end - self.start_time self.output("Scanning time is: %s secconds.\n", t_time.total_sec= onds()) =20 def scan(self): + """General method for scan and collect data + It check object properties and scan only what property require""= " if self.is_scan_herds: self.scan_herds() =20 @@ -171,10 +175,23 @@ class Scanner(object): self.show_time() =20 def write(self, what, verbosity =3D 1): + """If object vervosity level are greate or equal to + method property verbosity prints param what + Args: + what -- string to print + vervosity -- level of verbosity that require for print strin= g + """ if verbosity <=3D self.verbosity: sys.stdout.write(what) =20 def output(self, format_str, whats, verbosity =3D 1): + """If object vervosity level are greate or equal to + method property verbosity prints param whats formated by param f= ormat_str + Args: + format_str -- formating string + what -- vals to print + vervosity -- level of verbosity that require for print strin= g + """ # Maybe implement lazy format string ? if verbosity <=3D self.verbosity: sys.stdout.write(format_str % whats) @@ -238,6 +255,7 @@ class Scanner(object): self.maitainers_cache_loaded =3D True =20 def scan_license_groups(self): + "Scan license groups" self.write('Scaning license groups\n', 3) for group, licenses in portage.license_groups.groups_dict.iterit= ems(): licenses_obj =3D self.get_licenses_objects(licenses) @@ -250,6 +268,7 @@ class Scanner(object): self.output("update license group '%s'\n", group, 2) =20 def scan_herds(self): + "Scan herds and maintainers in herds.xml" self.write('Scaning herds\n', 3) existent_herds =3D self.get_existent_herds() herds_dict =3D self.herds_object.get_herds_indict() @@ -313,6 +332,7 @@ class Scanner(object): return self.maintainers_cache =20 def scan_all_repos(self, **kwargs): + "Scan packages in all available trees" #cache_dict =3D anydbm.open('cache.db','c') =20 for repo in portage.iter_trees(): @@ -336,6 +356,10 @@ class Scanner(object): return repo =20 def scan_repo_by_name(self, repo_name, **kwargs): + """Scan repository by name, available repository names could be = se=20 + with manage.py listrepos command + Args: + repo_name -- repository name""" repo =3D self.get_repo_by_name(repo_name) =20 if repo is not None: @@ -357,6 +381,10 @@ class Scanner(object): return repo_obj =20 def scan_all_repo_info(self, delete =3D False): + """Scan all info (metada) of all available repositories + Args: + delete -- if this true that repository will delete + if portage would be not available""" ex_pk =3D [] for repo in portage.iter_trees(): repo_obj =3D self.get_repo_obj(repo, update_repo =3D True) @@ -514,6 +542,13 @@ class Scanner(object): =20 def scanpackages(self, porttree, porttree_obj, delete =3D True, force_update =3D False, update_cache =3D True, use_= cache =3D True): + """Scan packages (and ebuilds) in porttree + Args: + porttree -- `PortTree` object from packages_info + porttree_obj -- `RepositoryModel` object + delete -- if True will delete unavailable packages and ebuil= ds + force_update -- update packages and ebuilds even if manifest= not changed + """ =20 existend_categorys =3D [] for category in porttree.iter_categories():