commit: eb9a4d026ef453e392faff35925537bee74c9d80 Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org> AuthorDate: Sun Jul 10 07:45:34 2022 +0000 Commit: Brian Dolbec <dolsen <AT> gentoo <DOT> org> CommitDate: Sun Jul 10 07:49:28 2022 +0000 URL: https://gitweb.gentoo.org/proj/gentoolkit.git/commit/?id=eb9a4d02
equery meta: Migrate to portage's MetadataXML class Portage's metadata handling code was originally ported from gentoolkit. Finally get around to migrating, eliminating duplicate code. Bug: https://bugs.gentoo.org/573030 Signed-off-by: Brian Dolbec <dolsen <AT> gentoo.org> pym/gentoolkit/metadata.py | 256 --------------------------------------------- pym/gentoolkit/package.py | 10 +- 2 files changed, 7 insertions(+), 259 deletions(-) diff --git a/pym/gentoolkit/metadata.py b/pym/gentoolkit/metadata.py deleted file mode 100644 index 479456a..0000000 --- a/pym/gentoolkit/metadata.py +++ /dev/null @@ -1,256 +0,0 @@ -# Copyright(c) 2009, Gentoo Foundation -# -# Licensed under the GNU General Public License, v2 - -"""Provides an easy-to-use python interface to Gentoo's metadata.xml file. - - Example usage: - >>> pkg_md = MetaData('/var/db/repos/gentoo/app-accessibility/espeak-ng/metadata.xml') - >>> pkg_md - <MetaData '/var/db/repos/gentoo/app-accessibility/espeak-ng/metadata.xml'> - >>> for maint in pkg_md.maintainers(): - ... print('{0} ({1})'.format(maint.email, maint.name)) - ... - [email protected] (William Hubbs) - >>> for flag in pkg_md.use(): - ... print(flag.name, '->', flag.description) - ... - async -> Enables asynchronous commands - klatt -> Enables Klatt formant synthesis and implementation - l10n_ru -> Builds extended Russian Dictionary file - l10n_zh -> Builds extended Chinese (Mandarin and Cantonese) Dictionary files - man -> Builds and installs manpage with app-text/ronn - mbrola -> Adds support for mbrola voices - >>> upstream = pkg_md.upstream() - >>> upstream - [<_Upstream {'node': <Element 'upstream' at 0x7f952a73b2c0>, - 'maintainers': [<_Maintainer '[email protected]'>], - 'changelogs': ['https://github.com/espeak-ng/espeak-ng/releases.atom'], - 'docs': [], 'bugtrackers': [], - 'remoteids': [('espeak-ng/espeak-ng', 'github')]}>] - >>> upstream[0].maintainers[0].name - 'Reece H. Dunn' -""" - -__all__ = ("MetaData",) -__docformat__ = "epytext" - -# ======= -# Imports -# ======= - -import re -import xml.etree.cElementTree as etree - -# ======= -# Classes -# ======= - - -class _Maintainer: - """An object for representing one maintainer. - - @type email: str or None - @ivar email: Maintainer's email address. Used for both Gentoo and upstream. - @type name: str or None - @ivar name: Maintainer's name. Used for both Gentoo and upstream. - @type description: str or None - @ivar description: Description of what a maintainer does. Gentoo only. - @type restrict: str or None - @ivar restrict: e.g. >=portage-2.2 means only maintains versions - of Portage greater than 2.2. Should be DEPEND string with < and > - converted to < and > respectively. - @type status: str or None - @ivar status: If set, either 'active' or 'inactive'. Upstream only. - """ - - def __init__(self, node): - self.email = None - self.name = None - self.description = None - self.restrict = node.get("restrict") - self.status = node.get("status") - for attr in node.iter(): - setattr(self, attr.tag, attr.text) - - def __repr__(self): - return "<%s %r>" % (self.__class__.__name__, self.email) - - -class _Useflag: - """An object for representing one USE flag. - - @todo: Is there any way to have a keyword option to leave in - <pkg> and <cat> for later processing? - @type name: str or None - @ivar name: USE flag - @type restrict: str or None - @ivar restrict: e.g. >=portage-2.2 means flag is only avaiable in - versions greater than 2.2 - @type description: str - @ivar description: description of the USE flag - """ - - def __init__(self, node): - self.name = node.get("name") - self.restrict = node.get("restrict") - _desc = "" - if node.text: - _desc = node.text - for child in node.iter(): - # prevent duplicate text - if child.text and child.text not in _desc: - _desc += child.text - if child.tail and not child.tail in _desc: - _desc += child.tail - # This takes care of tabs and newlines left from the file - self.description = re.sub(r"\s+", " ", _desc) - - def __repr__(self): - return "<%s %r>" % (self.__class__.__name__, self.name) - - -class _Upstream: - """An object for representing one package's upstream. - - @type maintainers: list - @ivar maintainers: L{_Maintainer} objects for each upstream maintainer - @type changelogs: list - @ivar changelogs: URLs to upstream's ChangeLog file in str format - @type docs: list - @ivar docs: Sequence of tuples containing URLs to upstream documentation - in the first slot and 'lang' attribute in the second, e.g., - [('http.../docs/en/tut.html', None), ('http.../doc/fr/tut.html', 'fr')] - @type bugtrackers: list - @ivar bugtrackers: URLs to upstream's bugtracker. May also contain an email - address if prepended with 'mailto:' - @type remoteids: list - @ivar remoteids: Sequence of tuples containing the project's hosting site - name in the first slot and the project's ID name or number for that - site in the second, e.g., [('sourceforge', 'systemrescuecd')] - """ - - def __init__(self, node): - self.node = node - self.maintainers = self.upstream_maintainers() - self.changelogs = self.upstream_changelogs() - self.docs = self.upstream_documentation() - self.bugtrackers = self.upstream_bugtrackers() - self.remoteids = self.upstream_remoteids() - - def __repr__(self): - return "<%s %r>" % (self.__class__.__name__, self.__dict__) - - def upstream_bugtrackers(self): - """Retrieve upstream bugtracker location from xml node.""" - return [e.text for e in self.node.findall("bugs-to")] - - def upstream_changelogs(self): - """Retrieve upstream changelog location from xml node.""" - return [e.text for e in self.node.findall("changelog")] - - def upstream_documentation(self): - """Retrieve upstream documentation location from xml node.""" - result = [] - for elem in self.node.findall("doc"): - lang = elem.get("lang") - result.append((elem.text, lang)) - return result - - def upstream_maintainers(self): - """Retrieve upstream maintainer information from xml node.""" - return [_Maintainer(m) for m in self.node.findall("maintainer")] - - def upstream_remoteids(self): - """Retrieve upstream remote ID from xml node.""" - return [(e.text, e.get("type")) for e in self.node.findall("remote-id")] - - -class MetaData: - """Access metadata.xml""" - - def __init__(self, metadata_path): - """Parse a valid metadata.xml file. - - @type metadata_path: str - @param metadata_path: path to a valid metadata.xml file - @raise IOError: if C{metadata_path} can not be read - """ - - self.metadata_path = metadata_path - self._xml_tree = etree.parse(metadata_path) - - # Used for caching - self._descriptions = None - self._maintainers = None - self._useflags = None - self._upstream = None - - def __repr__(self): - return "<%s %r>" % (self.__class__.__name__, self.metadata_path) - - def descriptions(self): - """Return a list of text nodes for <longdescription>. - - @rtype: list - @return: package description in string format - @todo: Support the C{lang} attribute - """ - - if self._descriptions is not None: - return self._descriptions - - long_descriptions = self._xml_tree.findall("longdescription") - self._descriptions = [e.text for e in long_descriptions] - return self._descriptions - - def maintainers(self): - """Get maintainers' name, email and description. - - @rtype: list - @return: a sequence of L{_Maintainer} objects in document order. - """ - - if self._maintainers is not None: - return self._maintainers - - self._maintainers = [] - for node in self._xml_tree.findall("maintainer"): - self._maintainers.append(_Maintainer(node)) - - return self._maintainers - - def use(self): - """Get names and descriptions for USE flags defined in metadata. - - @rtype: list - @return: a sequence of L{_Useflag} objects in document order. - """ - - if self._useflags is not None: - return self._useflags - - self._useflags = [] - for node in self._xml_tree.iter("flag"): - self._useflags.append(_Useflag(node)) - - return self._useflags - - def upstream(self): - """Get upstream contact information. - - @rtype: list - @return: a sequence of L{_Upstream} objects in document order. - """ - - if self._upstream is not None: - return self._upstream - - self._upstream = [] - for node in self._xml_tree.findall("upstream"): - self._upstream.append(_Upstream(node)) - - return self._upstream - - -# vim: set ts=4 sw=4 tw=79: diff --git a/pym/gentoolkit/package.py b/pym/gentoolkit/package.py index 1110bf5..51bb329 100644 --- a/pym/gentoolkit/package.py +++ b/pym/gentoolkit/package.py @@ -123,14 +123,18 @@ class Package(CPV): @property def metadata(self): - """Instantiate a L{gentoolkit.metadata.MetaData} object here.""" + """Instantiate a L{portage.xml.MetaDataXML} object here.""" - from gentoolkit.metadata import MetaData + from portage.xml.metadata import MetaDataXML if self._metadata is None: metadata_path = os.path.join(self.package_path(), "metadata.xml") + projects_path = os.path.join( + self._settings["PORTDIR"], "metadata/projects.xml" + ) + try: - self._metadata = MetaData(metadata_path) + self._metadata = MetaDataXML(metadata_path, projects_path) except IOError as error: import errno
