Source code for inspirehep.modules.records.serializers.schemas.base

# -*- 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.

"""Schema for parsing literature records."""

from __future__ import absolute_import, division, print_function

from pybtex.database import Entry, Person
from six import text_type

from inspire_utils.logging import getStackTraceLogger
from marshmallow import Schema, fields

from ..fields_export import get_authors_with_role, extractor, bibtex_type_and_fields


LOGGER = getStackTraceLogger(__name__)


class PybtexSchema(object):
    def load(self, record):
        """Deserialize an INSPIRE record into a Pybtex Entity.

        Takes an INSPIRE record and converts it to a ``pybtex.database.Entity``.
        Special treatment is applied to authors, which are expressed using
        ``pybtex.database.Person`` if they are real persons, and passed like
        other fields if they are corporate authors. Human-authors supersede
        corporate authors.

        Args:
            record (dict): literature record from API

        Returns:
            pybtex.database.Entity: Pybtex entity
        """
        doc_type, fields = bibtex_type_and_fields(record)
        try:
            texkey = record['texkeys'][0]
        except KeyError:
            texkey = str(record['control_number'])
            LOGGER.error('No texkey for record ID {}'.format(record['control_number']))

        template_data = []

        for field in fields:
            if field in extractor.store:
                field_value = extractor.store[field](record, doc_type)
                if field_value:
                    maplet = field, text_type(field_value)
                    template_data.append(maplet)

        # Note: human-authors are put in `persons' dict, corporate author will be passed as a field in template data.
        data = (texkey, Entry(doc_type, template_data, persons={
            'author': [Person(x) for x in get_authors_with_role(record.get('authors', []), 'author')],
            'editor': [Person(x) for x in get_authors_with_role(record.get('authors', []), 'editor')]
        }))
        return data


class JSONSchemaUIV1(Schema):
    """JSON schema."""

    id = fields.Integer(attribute='pid.pid_value')
    metadata = fields.Raw()
    display = fields.Raw()
    links = fields.Raw()
    created = fields.Str()
    updated = fields.Str()