pyramid_jsonapi.py

def not_found_error(detail):
    error = {'id': 'not_found', 'detail': detail}
    return JSONApiObject(errors=[error])


class JSONApiObject:
    """Container for JSON API response."""

    def __init__(self, data=None, errors=None):
        self.data = data
        self.errors = errors


DESCRIBE_JSONAPI_FORMAT = {'name': 'jsonapi', 'schema_url': 'http://jsonapi.org/format/'}


def jsonapi_adapter(payload, request):
    """Adapter to enforce a valid JSON API schema."""

    response = {'meta': {'format': DESCRIBE_JSONAPI_FORMAT}}
    if payload.data:
        response['data'] = payload.data
    if payload.errors:
        response['errors'] = payload.errors
    return response


def segment_adapter(segment, request):
    return {
        'type': 'segments',
        'id': segment.id,
        'attributes': {
            'key': segment.key.decode('utf-8'),
        },
        'links': {
            'self': request.route_url('segments_show', id=segment.id),
        }
    }
    
def setup_json_renderer(config):
    renderer = pyramid.renderers.JSON()

    def datetime_adapter(obj, request):
        return obj.isoformat()

    renderer.add_adapter(datetime.datetime, datetime_adapter)
    renderer.add_adapter(JSONApiObject, jsonapi_adapter)
    renderer.add_adapter(models.Segment, segment_adapter)
    config.add_renderer('json', renderer)


def view_segments_index(request):
    segments = request.store.list_segments()
    return JSONApiObject([segment for segment in segments])

LGTM!

If needed, to add a default renderer:

config.add_renderer(None, renderer)

Then, no need to specify a renderer on view config.

Oh nice!
Is it safe to make json the default renderer? No corner cases?