[gentoo-commits] proj/gentoopm:master commit in: gentoopm/portagepm/, gentoopm/paludispm/, gentoopm/basepm/

[gentoo-commits] proj/gentoopm:master commit in: gentoopm/portagepm/, gentoopm/paludispm/, gentoopm/basepm/

[Michał Górny]

commit:     8c96b9f54c5834064c749c1055f195168cf25656
Author:     Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Mon Jul 18 18:17:14 2011 +0000
Commit:     Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Mon Jul 18 18:17:14 2011 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/gentoopm.git;a=commit;h=8c96b9f5

Add notes about non-working API parts.

---
 gentoopm/basepm/atom.py   |    2 +-
 gentoopm/paludispm/pkg.py |   12 ++++++++++++
 gentoopm/portagepm/pkg.py |    6 ++++++
 3 files changed, 19 insertions(+), 1 deletions(-)

diff --git a/gentoopm/basepm/atom.py b/gentoopm/basepm/atom.py
index 953982e..ef01c9b 100644
--- a/gentoopm/basepm/atom.py
+++ b/gentoopm/basepm/atom.py
@@ -200,7 +200,7 @@ class PMAtom(ABCObject):
 		@raise EmptyPackageSetError: when no packages match the atom
 		@raise AmbiguousPackageSetError: when packages with different keys
 			match the atom
-		@depracated: redundant and unclear, please use C{repo[atom]} instead
+		@deprecated: redundant and unclear, please use C{repo[atom]} instead
 		"""
 		return repo.select(self)
 

diff --git a/gentoopm/paludispm/pkg.py b/gentoopm/paludispm/pkg.py
index 6ae4f25..c38faf2 100644
--- a/gentoopm/paludispm/pkg.py
+++ b/gentoopm/paludispm/pkg.py
@@ -89,6 +89,18 @@ class PaludisMetadata(PMPackageMetadata):
 		self._pkg = pkg
 
 	def __getattr__(self, key):
+		"""
+		Get the value of a metadata key through an attribute.
+
+		@param key: the metadata key to catch
+		@type key: string
+		@return: the value of a metadata key, or C{''} when unset
+		@rtype: string
+		@raise AttributeError: when invalid metadata key referred
+		@raise NotImplementedError: when not-stringifiable key referred
+		@bug: not all values can be stringified, pretty printing API
+			hasn't been wrapped in Python yet
+		"""
 		if key not in self:
 			raise AttributeError('Unsupported metadata key: %s' % key)
 		m = self._pkg.find_metadata(key)

diff --git a/gentoopm/portagepm/pkg.py b/gentoopm/portagepm/pkg.py
index 2454685..be40d78 100644
--- a/gentoopm/portagepm/pkg.py
+++ b/gentoopm/portagepm/pkg.py
@@ -31,6 +31,12 @@ class PortagePackageDescription(PMPackageDescription):
 
 	@property
 	def long(self):
+		"""
+		The long package description.
+
+		@type: string/C{None}
+		@bug: Portage doesn't support parsing metadata.xml.
+		"""
 		return None # XXX
 
 class PortageDBCPV(PMPackage, CompletePortageAtom):

[gentoo-commits] proj/gentoopm:master commit in: gentoopm/portagepm/, gentoopm/paludispm/, gentoopm/basepm/

[Michał Górny]

commit:     7cb9227590dd157e089e4c26cfb615d951fb259c
Author:     Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Fri Sep  9 21:14:37 2011 +0000
Commit:     Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Fri Sep  9 21:14:37 2011 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/gentoopm.git;a=commit;h=7cb92275

Return None in .maintainers when not supported.

---
 gentoopm/basepm/pkg.py    |    4 ++--
 gentoopm/paludispm/pkg.py |    5 +++++
 gentoopm/portagepm/pkg.py |    4 ++++
 3 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/gentoopm/basepm/pkg.py b/gentoopm/basepm/pkg.py
index db3e707..c536a69 100644
--- a/gentoopm/basepm/pkg.py
+++ b/gentoopm/basepm/pkg.py
@@ -346,9 +346,9 @@ class PMPackage(PMAtom, FillMissingComparisons):
 	@abstractproperty
 	def maintainers(self):
 		"""
-		Get the package maintainer list.
+		Get the package maintainer list (or C{None} if unavailable).
 
-		@type: tuple(L{PMPackageMaintainer})
+		@type: tuple(L{PMPackageMaintainer})/C{None}
 		"""
 		pass
 

diff --git a/gentoopm/paludispm/pkg.py b/gentoopm/paludispm/pkg.py
index 5b19b98..fd090c6 100644
--- a/gentoopm/paludispm/pkg.py
+++ b/gentoopm/paludispm/pkg.py
@@ -181,6 +181,11 @@ class PaludisID(PMPackage, PaludisAtom):
 				self._get_meta(self._pkg.choices_key()))
 
 	@property
+	def maintainers(self):
+		# XXX: find_metadata() + magic
+		return None
+
+	@property
 	def _atom(self):
 		return self._pkg.uniquely_identifying_spec()
 

diff --git a/gentoopm/portagepm/pkg.py b/gentoopm/portagepm/pkg.py
index 1a7661f..b9df82d 100644
--- a/gentoopm/portagepm/pkg.py
+++ b/gentoopm/portagepm/pkg.py
@@ -151,6 +151,10 @@ class PortageDBCPV(PMPackage, CompletePortageAtom):
 				self._applied_use)
 
 	@property
+	def maintainers(self):
+		return None
+
+	@property
 	def slotted_atom(self):
 		cp = str(self.key)
 		slot = self.slot