Differential D5273 Diff 19073 swh/indexer/metadata_dictionary/cff.py

Changeset View

Standalone View

swh/indexer/metadata_dictionary/cff.py

This file was added.

				import yaml

				from swh.indexer.codemeta import CROSSWALK_TABLE

				from .base import DictMapping, SingleFileMapping

				yaml.SafeLoader.yaml_implicit_resolvers = {
				k: [r for r in v if r[0] != "tag:yaml.org,2002:timestamp"]
				for k, v in yaml.SafeLoader.yaml_implicit_resolvers.items()
				}


				class CffMapping(DictMapping, SingleFileMapping):
				"""Dedicated class for Citation (CITATION.cff) mapping and translation"""

				name = "cff"
				filename = b"CITATION.cff"
				mapping = CROSSWALK_TABLE["Citation File Format Core (CFF-Core) 1.0.2"]
				string_fields = [
				"date-released",
				"keywords",
				"license",
				"abstract",
				"version",
				"doi",
				"repository-code",
				"authors",
				]

				def translate(self, raw_content):
				raw_content = raw_content.decode()
				content_dict = yaml.load(raw_content, Loader=yaml.SafeLoader)
				metadata = self._translate_dict(content_dict)

				metadata["@context"] = [
				"https://doi.org/10.5063/schema/codemeta-2.0",
				"http://schema.org",
				]

				for author in content_dict["authors"]:
				author_data = {}
				if "orcid" in author:
				author_data["@id"] = author["orcid"]
				author_data["@type"] = "Person"

				if "affiliation" in author:
				author_data["affiliation"] = {
				"@type": "Organization",
				"name": author["affiliation"],
				}
				if "family-names" in author:
				author_data["familyName"] = author["family-names"]
				vlorentzUnsubmitted Done Inline Actions could you move this part to a method? (`normalize_authors` iirc) vlorentz: could you move this part to a method? (`normalize_authors` iirc)
				KShivenduAuthorUnsubmitted Done Inline Actions I tried but something went wrong. I went in debugging mode to track the flow and found that the `normalize_translation` function made the output to be : "author": [ { "type": "Person" }, { "id": "https://orcid.org/0000-0003-4925-7248", "type": "Person" } ], But the playground gives the correct results in compact form. Have a look at it here KShivendu: I tried but something went wrong. I went in debugging mode to track the flow and found that the…
				vlorentzUnsubmitted Done Inline Actions It seems to works in `npm.py`. Try to find why it works for NPM but not CFF. vlorentz: It seems to works in `npm.py`. Try to find why it works for NPM but not CFF.
				if "given-names" in author:
				author_data["givenName"] = author["given-names"]

				vlorentzUnsubmitted Done Inline Actions isn't this redundant with the crosswalk? vlorentz: isn't this redundant with the crosswalk?
				KShivenduAuthorUnsubmitted Done Inline Actions Yes, it is. But when I put these two fields in `string_fields` the output is 'schema:codeRepository' : '....', 'schema:datePublished' : '....' not 'codeRepository' : '....', 'datePublished' : '....' But this doesn't happen with the other fields. Why is that? KShivendu: Yes, it is. But when I put these two fields in `string_fields` the output is ``` 'schema…
				vlorentzUnsubmitted Done Inline Actions It's a bug :) I'm working on it vlorentz: It's a bug :) I'm working on it
				vlorentzUnsubmitted Done Inline Actions Actually it isn't. (Well, it's an arguable design decision in Codemeta, but that's how it is). These fields are defined as: "datePublished": {"@id": "schema:datePublished", "@type": "schema:Date" }, and "codeRepository": { "@id": "schema:codeRepository", "@type": "@id"}, which means "the codemeta term is like the schema.org term, but with an extra constraint on the type". But the JSON-LD document you create does not match these type definitions. So when compacting, it can't be converted to the codemeta term, because of the constraint. So the fix should be to make them satisfy the type constraint. (Hint: the license field is defined the same way) vlorentz: Actually it isn't. (Well, it's an arguable design decision in Codemeta, but that's how it is).
				metadata["schema:author"].append(author_data)

				return metadata

				def normalize_license(self, s):
				if isinstance(s, str):
				return {"@id": "https://spdx.org/licenses/" + s}

				def normalize_doi(self, s):
				if isinstance(s, str):
				return {"@id": "https://doi.org/" + s}