Source code for invenio_formatter.filters.datetime

# -*- coding: utf-8 -*-
#
# This file is part of Invenio.
# Copyright (C) 2015-2018 CERN.
#
# Invenio is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details.

"""Datetime Jinja filters."""

from __future__ import absolute_import, print_function

import arrow



[docs]def from_isodate(value, strict=False):
    """Convert an ISO formatted date into a Date object.

    :param value: The ISO formatted date.
    :param strict: If value is ``None``, then if strict is ``True`` it returns
        the Date object of today, otherwise it returns ``None``.
        (Default: ``False``)
    :returns: The Date object or ``None``.
    """
    if value or strict:
        return arrow.get(value).date()




[docs]def from_isodatetime(value, strict=False):
    """Convert an ISO formatted datetime into a Date object.

    :param value: The ISO formatted datetime.
    :param strict: If value is ``None``, then if strict is ``True`` it returns
        the Date object of today, otherwise it returns ``None``.
        (Default: ``False``)
    :returns: The Date object or ``None``.
    """
    if value or strict:
        return arrow.get(value).datetime




[docs]def format_arrow(value, format_string):
    """Format an arrow datetime object.

    :param value: The arrow datetime object.
    :param format_string: The date format string
    :returns: Returns a string representation of the given arrow datetime
        object, formatted according to the given format string.

    .. note::
        Do not use this filter to format date/times presented to an end
        user. Instead use ``datetimeformat`` or ``dateformat`` from
        Invenio-I18N.
    """
    assert isinstance(value, arrow.Arrow)
    return value.format(format_string)




[docs]def to_arrow(value):
    """Convert a Date object to an arrow datetime object."""
    return arrow.get(value)