class CFF(ProjectMetadataWriter):
"""Citation File Format (CFF) parser and saver."""
def __init__(
self,
path: Path,
create_if_not_exists: bool = True,
):
"""Citation File Format (CFF) parser.
See [somesy.core.writer.ProjectMetadataWriter.__init__][].
"""
self._yaml = YAML()
self._yaml.preserve_quotes = True
mappings: FieldKeyMapping = {
"name": ["title"],
"description": ["abstract"],
"homepage": ["url"],
"repository": ["repository-code"],
"documentation": IgnoreKey(),
"maintainers": ["contact"],
}
super().__init__(
path, create_if_not_exists=create_if_not_exists, direct_mappings=mappings
)
def _init_new_file(self):
"""Initialize new CFF file."""
self._data = {
"cff-version": "1.2.0",
"message": "If you use this software, please cite it using these metadata.",
"type": "software",
}
with open(self.path, "w") as f:
self._yaml.dump(self._data, f)
def _load(self):
"""Load the CFF file."""
with open(self.path) as f:
self._data = self._yaml.load(f)
def _validate(self):
"""Validate the CFF file."""
try:
citation = create_citation(self.path, None)
citation.validate()
except ValueError as e:
raise ValueError(f"CITATION.cff file is not valid!\n{e}") from e
def save(self, path: Optional[Path] = None) -> None:
"""Save the CFF object to a file."""
path = path or self.path
self._yaml.dump(self._data, path)
def _sync_authors(self, metadata: ProjectMetadata) -> None:
"""Ensure that publication authors are added all into author list."""
self.authors = self._sync_person_list(
self.authors, metadata.publication_authors()
)
@staticmethod
def _from_person(person: Person):
"""Convert project metadata person object to cff dict for person format."""
json_str = person.model_dump_json(
exclude={
"contribution",
"contribution_types",
"contribution_begin",
"contribution_end",
"author",
"publication_author",
"maintainer",
},
by_alias=True, # e.g. family_names -> family-names, etc.
)
return json.loads(json_str)
@staticmethod
def _to_person(person_obj) -> Person:
"""Parse CFF Person to a somesy Person."""
# construct (partial) Person while preserving key order from YAML
Person._aliases()
ret = Person.make_partial(person_obj)
ret.set_key_order(list(person_obj.keys()))
return ret