# -*- coding: utf-8 -*-
#
# This file is part of INSPIRE.
# Copyright (C) 2014-2017 CERN.
#
# INSPIRE is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# INSPIRE is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
#
# In applying this license, CERN does not waive the privileges and immunities
# granted to it by virtue of its status as an Intergovernmental Organization
# or submit itself to any jurisdiction.
from __future__ import absolute_import, division, print_function
from itertools import chain
from invenio_indexer.api import current_record_to_index, RecordIndexer
from inspire_utils.record import get_value
[docs]def get_abstract(record):
"""Return the first abstract of a record.
Args:
record (InspireRecord): a record.
Returns:
str: the first abstract of the record.
Examples:
>>> record = {
... 'abstracts': [
... {
... 'source': 'arXiv',
... 'value': 'Probably not.',
... },
... ],
... }
>>> get_abstract(record)
'Probably not.'
"""
return get_value(record, 'abstracts.value[0]', default='')
[docs]def get_arxiv_categories(record):
"""Return all the arXiv categories of a record.
Args:
record (InspireRecord): a record.
Returns:
list(str): all the arXiv categories of the record.
Examples:
>>> record = {
... 'arxiv_eprints': [
... {
... 'categories': [
... 'hep-th',
... 'hep-ph',
... ],
... 'value': '1612.08928',
... },
... ],
... }
>>> get_arxiv_categories(record)
['hep-th', 'hep-ph']
"""
return list(chain.from_iterable(
get_value(record, 'arxiv_eprints.categories', default=[])))
[docs]def get_arxiv_id(record):
"""Return the first arXiv identifier of a record.
Args:
record (InspireRecord): a record.
Returns:
str: the first arXiv identifier of the record.
Examples:
>>> record = {
... 'arxiv_eprints': [
... {
... 'categories': [
... 'hep-th',
... 'hep-ph',
... ],
... 'value': '1612.08928',
... },
... ],
... }
>>> get_arxiv_id(record)
'1612.08928'
"""
return get_value(record, 'arxiv_eprints.value[0]', default='')
[docs]def get_collaborations(record):
"""Return the collaborations associated with a record.
Args:
record(InspireRecord): a record.
Returns:
list(str): the collaborations associated with the record.
Examples:
>>> record = {'collaborations': [{'value': 'CMS'}]}
>>> get_collaborations(record)
['CMS']
"""
return get_value(record, 'collaborations.value', default=[])
[docs]def get_inspire_categories(record):
"""Return all the INSPIRE categories of a record.
Args:
record (InspireRecord): a record.
Returns:
list(str): all the INSPIRE categories of the record.
Examples:
>>> record = {
... 'inspire_categories': [
... {'term': 'Experiment-HEP'},
... ],
... }
>>> get_inspire_categories(record)
['Experiment-HEP']
"""
return get_value(record, 'inspire_categories.term', default=[])
[docs]def get_keywords(record):
"""Return the keywords assigned to a record.
Args:
record(InspireRecord): a record.
Returns:
list(str): the keywords assigned to the record.
Examples:
>>> record = {
... 'keywords': [
... {
... 'schema': 'INSPIRE',
... 'value': 'CKM matrix',
... },
... ],
... }
>>> get_keywords(record)
['CKM matrix']
"""
return get_value(record, 'keywords.value', default=[])
[docs]def get_method(record):
"""Return the acquisition method of a record.
Args:
record (InspireRecord): a record.
Returns:
str: the acquisition method of the record.
Examples:
>>> record = {
... 'acquisition_source': {
... 'method': 'oai',
... 'source': 'arxiv',
... }
... }
>>> get_method(record)
'oai'
"""
return get_value(record, 'acquisition_source.method', default='')
[docs]def get_source(record):
"""Return the acquisition source of a record.
Args:
record (InspireRecord): a record.
Returns:
str: the acquisition source of the record.
Examples:
>>> record = {
... 'acquisition_source': {
... 'method': 'oai',
... 'source': 'arxiv',
... }
... }
>>> get_source(record)
'arxiv'
"""
return get_value(record, 'acquisition_source.source', default='')
[docs]def get_subtitle(record):
"""Return the first subtitle of a record.
Args:
record (InspireRecord): a record.
Returns:
str: the first subtitle of the record.
Examples:
>>> record = {
... 'titles': [
... {
... 'subtitle': 'A mathematical exposition',
... 'title': 'The General Theory of Relativity',
... },
... ],
... }
>>> get_subtitle(record)
'A mathematical exposition'
"""
return get_value(record, 'titles.subtitle[0]', default='')
[docs]def get_title(record):
"""Return the first title of a record.
Args:
record (InspireRecord): a record.
Returns:
str: the first title of the record.
Examples:
>>> record = {
... 'titles': [
... {
... 'subtitle': 'A mathematical exposition',
... 'title': 'The General Theory of Relativity',
... },
... ],
... }
>>> get_title(record)
'The General Theory of Relativity'
"""
return get_value(record, 'titles.title[0]', default='')
[docs]def create_index_op(record, version_type='external_gte'):
from inspirehep.modules.records.receivers import enhance_before_index
index, doc_type = current_record_to_index(record)
enhance_before_index(record)
return {
'_op_type': 'index',
'_index': index,
'_type': doc_type,
'_id': str(record.id),
'_version': record.revision_id,
'_version_type': version_type,
'_source': RecordIndexer._prepare_record(record, index, doc_type),
}
