Differential D1694 Diff 5856 swh/loader/base/build_revision.py

Changeset View

Standalone View

swh/loader/base/build_revision.py

This file was added.

				# Copyright (C) 2019 The Software Heritage developers
				# See the AUTHORS file at the top-level directory of this distribution
				# License: GNU General Public License version 3, or any later version
				# See top-level LICENSE file for more information

				from datetime import datetime
				from swh.model.identifiers import normalize_timestamp
				from dateutil import parser as date_parser


				class construct_revision:
				ardumontAuthorUnsubmitted Done Inline Actions Please as mentioned already, use CamelCase as defined everywhere else (same goes for other classes). ardumont: Please as mentioned already, use CamelCase as defined everywhere else (same goes for other…
				"""Construct revision from the metadata of the package version

				Construct the revision for a package version using the metadata provided.
				There are several hookpoints that can be overridden as per the need of
				package manager.

				"""

				UTC_OFFSET = 0
				SWH_PERSON = {
				'name': b'Software Heritage',
				'fullname': b'Software Heritage',
				'email': b'robot@softwareheritage.org'
				}
				REVISION_MESSAGE = b'swh-loader-base: synthetic revision message'

				def modify_revision(self, revision):
				"""Make modification on revision created
				If the revision of a package manager needs to be in a specific format,
				this method can be overridden to perform that operation insted of
				overriding the `compute_revision()`.

				Args:
				revision (dict): Created revision

				Returns:
				dict: Modified revision
				"""
				return revision

				def compute_revision(self, directory, package_source_data):
				"""Compute a revision.

				Args:
				directory (str): absolute path to the tarball
				package_source_data (dict): Information about the package
				release version

				Returns:
				dict: Revision

				"""
				revision = {
				'metadata': self.find_metadata(package_source_data),
				'date': {
				'timestamp': self.find_date(package_source_data),
				'offset': self.UTC_OFFSET,
				ardumontAuthorUnsubmitted Done Inline Actions I realize that it's not necessary true. The offset should be part of the `find_date` implementation... ardumont: I realize that it's not necessary true. The offset should be part of the `find_date`…
				nahimilegaUnsubmitted Done Inline Actions Yes, you are correct, actually, it is already the part of `find_date`, but I realized it now nahimilega: Yes, you are correct, actually, it is already the part of `find_date`, but I realized it now
				},
				'committer_date': {
				'timestamp': self.find_date(package_source_data),
				'offset': self.UTC_OFFSET,
				},
				'author': self.find_author(package_source_data),
				'committer': self.find_author(package_source_data),
				'type': self.find_type(package_source_data),
				'message': self.find_message(package_source_data),
				'directory': self.directory(directory),
				'synthetic': self.find_synthetic(),
				'parents': [],
				}

				return self.modify_revision(revision)

				def find_synthetic(self):
				return True

				def find_type(self, package_source_data):
				return package_source_data['nature']

				def find_message(self, package_source_data):
				return self.REVISION_MESSAGE

				def directory(self, directory):
				return directory.hash

				def find_author(self, package_source_data):
				if 'author' in package_source_data:
				return package_source_data['author']
				return self.SWH_PERSON

				def find_metadata(self, package_source_data):
				return {
				'package': package_source_data
				}

				def find_date(self, package_source_data):
				try:
				# if 'date' in package_source_data:
				date = date_parser.parse(package_source_data['date'])
				return normalize_timestamp(int(date.timestamp()))
				except Exception:
				now = datetime.now()
				return normalize_timestamp(int(datetime.timestamp(now)))