chrono.h revision 11986:c12e4625ab56 
1/*
2    pybind11/chrono.h: Transparent conversion between std::chrono and python's datetime
3
4    Copyright (c) 2016 Trent Houliston <trent@houliston.me> and
5                       Wenzel Jakob <wenzel.jakob@epfl.ch>
6
7    All rights reserved. Use of this source code is governed by a
8    BSD-style license that can be found in the LICENSE file.
9*/
10
11#pragma once
12
13#include "pybind11.h"
14#include <cmath>
15#include <ctime>
16#include <chrono>
17#include <datetime.h>
18
19// Backport the PyDateTime_DELTA functions from Python3.3 if required
20#ifndef PyDateTime_DELTA_GET_DAYS
21#define PyDateTime_DELTA_GET_DAYS(o)         (((PyDateTime_Delta*)o)->days)
22#endif
23#ifndef PyDateTime_DELTA_GET_SECONDS
24#define PyDateTime_DELTA_GET_SECONDS(o)      (((PyDateTime_Delta*)o)->seconds)
25#endif
26#ifndef PyDateTime_DELTA_GET_MICROSECONDS
27#define PyDateTime_DELTA_GET_MICROSECONDS(o) (((PyDateTime_Delta*)o)->microseconds)
28#endif
29
30NAMESPACE_BEGIN(pybind11)
31NAMESPACE_BEGIN(detail)
32
33template <typename type> class duration_caster {
34public:
35    typedef typename type::rep rep;
36    typedef typename type::period period;
37
38    typedef std::chrono::duration<uint_fast32_t, std::ratio<86400>> days;
39
40    bool load(handle src, bool) {
41        using namespace std::chrono;
42
43        // Lazy initialise the PyDateTime import
44        if (!PyDateTimeAPI) { PyDateTime_IMPORT; }
45
46        if (!src) return false;
47        // If invoked with datetime.delta object
48        if (PyDelta_Check(src.ptr())) {
49            value = type(duration_cast<duration<rep, period>>(
50                  days(PyDateTime_DELTA_GET_DAYS(src.ptr()))
51                + seconds(PyDateTime_DELTA_GET_SECONDS(src.ptr()))
52                + microseconds(PyDateTime_DELTA_GET_MICROSECONDS(src.ptr()))));
53            return true;
54        }
55        // If invoked with a float we assume it is seconds and convert
56        else if (PyFloat_Check(src.ptr())) {
57            value = type(duration_cast<duration<rep, period>>(duration<double>(PyFloat_AsDouble(src.ptr()))));
58            return true;
59        }
60        else return false;
61    }
62
63    // If this is a duration just return it back
64    static const std::chrono::duration<rep, period>& get_duration(const std::chrono::duration<rep, period> &src) {
65        return src;
66    }
67
68    // If this is a time_point get the time_since_epoch
69    template <typename Clock> static std::chrono::duration<rep, period> get_duration(const std::chrono::time_point<Clock, std::chrono::duration<rep, period>> &src) {
70        return src.time_since_epoch();
71    }
72
73    static handle cast(const type &src, return_value_policy /* policy */, handle /* parent */) {
74        using namespace std::chrono;
75
76        // Use overloaded function to get our duration from our source
77        // Works out if it is a duration or time_point and get the duration
78        auto d = get_duration(src);
79
80        // Lazy initialise the PyDateTime import
81        if (!PyDateTimeAPI) { PyDateTime_IMPORT; }
82
83        // Declare these special duration types so the conversions happen with the correct primitive types (int)
84        using dd_t = duration<int, std::ratio<86400>>;
85        using ss_t = duration<int, std::ratio<1>>;
86        using us_t = duration<int, std::micro>;
87
88        return PyDelta_FromDSU(duration_cast<dd_t>(d).count(),
89                               duration_cast<ss_t>(d % days(1)).count(),
90                               duration_cast<us_t>(d % seconds(1)).count());
91    }
92
93    PYBIND11_TYPE_CASTER(type, _("datetime.timedelta"));
94};
95
96// This is for casting times on the system clock into datetime.datetime instances
97template <typename Duration> class type_caster<std::chrono::time_point<std::chrono::system_clock, Duration>> {
98public:
99    typedef std::chrono::time_point<std::chrono::system_clock, Duration> type;
100    bool load(handle src, bool) {
101        using namespace std::chrono;
102
103        // Lazy initialise the PyDateTime import
104        if (!PyDateTimeAPI) { PyDateTime_IMPORT; }
105
106        if (!src) return false;
107        if (PyDateTime_Check(src.ptr())) {
108            std::tm cal;
109            cal.tm_sec   = PyDateTime_DATE_GET_SECOND(src.ptr());
110            cal.tm_min   = PyDateTime_DATE_GET_MINUTE(src.ptr());
111            cal.tm_hour  = PyDateTime_DATE_GET_HOUR(src.ptr());
112            cal.tm_mday  = PyDateTime_GET_DAY(src.ptr());
113            cal.tm_mon   = PyDateTime_GET_MONTH(src.ptr()) - 1;
114            cal.tm_year  = PyDateTime_GET_YEAR(src.ptr()) - 1900;
115            cal.tm_isdst = -1;
116
117            value = system_clock::from_time_t(std::mktime(&cal)) + microseconds(PyDateTime_DATE_GET_MICROSECOND(src.ptr()));
118            return true;
119        }
120        else return false;
121    }
122
123    static handle cast(const std::chrono::time_point<std::chrono::system_clock, Duration> &src, return_value_policy /* policy */, handle /* parent */) {
124        using namespace std::chrono;
125
126        // Lazy initialise the PyDateTime import
127        if (!PyDateTimeAPI) { PyDateTime_IMPORT; }
128
129        std::time_t tt = system_clock::to_time_t(src);
130        // this function uses static memory so it's best to copy it out asap just in case
131        // otherwise other code that is using localtime may break this (not just python code)
132        std::tm localtime = *std::localtime(&tt);
133
134        // Declare these special duration types so the conversions happen with the correct primitive types (int)
135        using us_t = duration<int, std::micro>;
136
137        return PyDateTime_FromDateAndTime(localtime.tm_year + 1900,
138                                          localtime.tm_mon + 1,
139                                          localtime.tm_mday,
140                                          localtime.tm_hour,
141                                          localtime.tm_min,
142                                          localtime.tm_sec,
143                                          (duration_cast<us_t>(src.time_since_epoch() % seconds(1))).count());
144    }
145    PYBIND11_TYPE_CASTER(type, _("datetime.datetime"));
146};
147
148// Other clocks that are not the system clock are not measured as datetime.datetime objects
149// since they are not measured on calendar time. So instead we just make them timedeltas
150// Or if they have passed us a time as a float we convert that
151template <typename Clock, typename Duration> class type_caster<std::chrono::time_point<Clock, Duration>>
152: public duration_caster<std::chrono::time_point<Clock, Duration>> {
153};
154
155template <typename Rep, typename Period> class type_caster<std::chrono::duration<Rep, Period>>
156: public duration_caster<std::chrono::duration<Rep, Period>> {
157};
158
159NAMESPACE_END(detail)
160NAMESPACE_END(pybind11)
161