Differential D617 Diff 1934 swh/indexer/codemeta.py

Changeset View

Standalone View

swh/indexer/codemeta.py

This file was added.

				# Copyright (C) 2018 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

				import csv
				import json
				import os.path

				import swh.indexer
				from pyld import jsonld

				_DATA_DIR = os.path.join(os.path.dirname(swh.indexer.__file__), 'data')

				CROSSWALK_TABLE_PATH = os.path.join(_DATA_DIR, 'codemeta', 'crosswalk.csv')

				CODEMETA_CONTEXT_PATH = os.path.join(_DATA_DIR, 'codemeta', 'codemeta.jsonld')


				with open(CODEMETA_CONTEXT_PATH) as fd:
				CODEMETA_CONTEXT = json.load(fd)

				CODEMETA_CONTEXT_URL = 'https://doi.org/10.5063/schema/codemeta-2.0'
				CODEMETA_URI = 'https://codemeta.github.io/terms/'
				zackUnsubmitted Done Inline Actions This URI is here as a constant (good!) but its value is repeated in many places in the rest of this diff (bad :-)), violating DRY. It would be nice to remove other occurrences of this verbatim URI, e.g., using dictionary comprehension or string concatenation referencing this constant. zack: This URI is here as a constant (good!) but its value is repeated in many places in the rest of…


				# CodeMeta properties that we cannot properly represent.
				PROPERTY_BLACKLIST = {
				'https://codemeta.github.io/terms/softwareRequirements',
				'https://codemeta.github.io/terms/softwareSuggestions',
				}


				def _read_crosstable(fd):
				reader = csv.reader(fd)
				try:
				header = next(reader)
				except StopIteration:
				raise ValueError('empty file')

				data_sources = set(header) - {'Parent Type', 'Property',
				'Type', 'Description'}
				assert 'codemeta-V1' in data_sources

				codemeta_translation = {data_source: {} for data_source in data_sources}

				for line in reader: # For each canonical name
				canonical_name = CODEMETA_URI + dict(zip(header, line))['Property']
				if canonical_name in PROPERTY_BLACKLIST:
				continue
				for (col, value) in zip(header, line): # For each cell in the row
				if col in data_sources:
				# If that's not the parentType/property/type/description
				for local_name in value.split('/'):
				# For each of the data source's properties that maps
				# to this canonical name
				if local_name.strip():
				codemeta_translation[col][local_name.strip()] = \
				canonical_name

				return codemeta_translation


				with open(CROSSWALK_TABLE_PATH) as fd:
				CROSSWALK_TABLE = _read_crosstable(fd)


				def _document_loader(url):
				"""Document loader for pyld.

				Reads the local codemeta.jsonld file instead of fetching it
				from the Internet every single time."""
				if url == CODEMETA_CONTEXT_URL:
				return {
				'contextUrl': None,
				'documentUrl': url,
				'document': CODEMETA_CONTEXT,
				}
				elif url == CODEMETA_URI:
				raise Exception('{} is CodeMeta\'s URI, use {} as context url'.format(
				CODEMETA_URI, CODEMETA_CONTEXT_URL))
				else:
				raise Exception(url)


				def compact(doc):
				"""Same as `pyld.jsonld.compact`, but in the context of CodeMeta."""
				return jsonld.compact(doc, CODEMETA_CONTEXT_URL,
				options={'documentLoader': _document_loader})


				def expand(doc):
				"""Same as `pyld.jsonld.expand`, but in the context of CodeMeta."""
				return jsonld.expand(doc,
				options={'documentLoader': _document_loader})