File: cim_types.py

package info (click to toggle)
pywbem 0.8.0~dev650-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 872 kB
  • ctags: 1,115
  • sloc: python: 10,652; xml: 101; makefile: 19
file content (274 lines) | stat: -rw-r--r-- 8,702 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
#
# (C) Copyright 2003, 2004 Hewlett-Packard Development Company, L.P.
# (C) Copyright 2006, 2007 Novell, Inc. 
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; version 2 of the License.
#   
# This program 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
# Lesser General Public License for more details.
#   
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#

# Author: Tim Potter <tpot@hp.com>
# Author: Bart Whiteley <bwhiteley@suse.de>

"""
Subclasses of builtin Python types to remember CIM types.  This is
necessary as we need to remember whether an integer property is a
uint8, uint16, uint32 etc, while still being able to treat it as a
integer.
"""

from datetime import tzinfo, datetime, timedelta
import re

class MinutesFromUTC(tzinfo):
    """Fixed offset in minutes from UTC."""
    def __init__(self, offset):
        self.__offset = timedelta(minutes = offset)
    def utcoffset(self, dt):
        return self.__offset
    def dst(self, dt):
        return timedelta(0)

class CIMType(object):
    """Base type for all CIM types."""
    
class CIMDateTime(CIMType) :
    """A CIM DateTime."""

    def __init__(self, dtarg):
        """Construct a new CIMDateTime

        Arguments:
        dtarg -- Can be a string in CIM datetime format, a datetime.datetime, 
            a datetime.timedelta, or a CIMDateTime.

        """

        self.cimtype = 'datetime'
        self.__timedelta = None
        self.__datetime = None
        if isinstance(dtarg, basestring):
            date_pattern = re.compile(r'^(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\.(\d{6})([+|-])(\d{3})')
            s = date_pattern.search(dtarg)
            if s is not None:
                g = s.groups()
                offset = int(g[8])
                if g[7] == '-':
                    offset = -offset
                try:
                    self.__datetime = datetime(int(g[0]), int(g[1]),
                                               int(g[2]), int(g[3]),
                                               int(g[4]), int(g[5]),
                                               int(g[6]), MinutesFromUTC(offset))
                except ValueError as exc:
                    raise ValueError('dtarg argument "%s" has invalid field '\
                                     'values for CIM datetime timestamp '\
                                     'format: %s' % (dtarg, exc))
            else:
                tv_pattern = re.compile(r'^(\d{8})(\d{2})(\d{2})(\d{2})\.(\d{6})(:)(000)')
                s = tv_pattern.search(dtarg)
                if s is not None:
                    g = s.groups()
                    # Because the input values are limited by the matched pattern,
                    # timedelta() never throws any exception.
                    self.__timedelta =  timedelta(days=int(g[0]),
                                                  hours=int(g[1]),
                                                  minutes=int(g[2]),
                                                  seconds=int(g[3]),
                                                  microseconds=int(g[4]))
                else:
                    raise ValueError('dtarg argument "%s" has an invalid CIM '\
                                     'datetime format' % dtarg)
        elif isinstance(dtarg, datetime):
            self.__datetime = dtarg; 
        elif isinstance(dtarg, timedelta):
            self.__timedelta = dtarg
        elif isinstance(dtarg, CIMDateTime):
            self.__datetime = dtarg.__datetime
            self.__timedelta = dtarg.__timedelta
        else:
            raise TypeError('dtarg argument "%s" has an invalid type: %s '\
                            '(expected datetime, timedelta, string, or '\
                            'CIMDateTime)' % (dtarg, type(dtarg)))

    @property
    def minutes_from_utc(self):
        """Return the timezone as +/- minutes from UTC"""
        offset = 0
        if self.__datetime is not None and \
                self.__datetime.utcoffset() is not None:
            offset = self.__datetime.utcoffset().seconds / 60
            if self.__datetime.utcoffset().days == -1:
                offset = -(60*24 - offset)
        return offset

    @property
    def datetime(self):
        return self.__datetime

    @property
    def timedelta(self):
        return self.__timedelta

    @property
    def is_interval(self):
        return self.__timedelta is not None

    @staticmethod
    def get_local_utcoffset():
        """Return minutes +/- UTC for the local timezone"""
        utc = datetime.utcnow()
        local = datetime.now()
        if local < utc:
            return - int(float((utc - local).seconds) / 60 + .5)
        else:
            return int(float((local - utc).seconds) / 60 + .5)

    @classmethod
    def now(cls, tzi=None):
        if tzi is None:
            tzi = MinutesFromUTC(cls.get_local_utcoffset())
        return cls(datetime.now(tzi))

    @classmethod
    def fromtimestamp(cls, ts, tzi=None):
        if tzi is None:
            tzi = MinutesFromUTC(cls.get_local_utcoffset())
        return cls(datetime.fromtimestamp(ts, tzi))

    def __str__ (self):
        if self.is_interval:
            hour = self.__timedelta.seconds / 3600
            minute = (self.__timedelta.seconds - hour * 3600) / 60
            second = self.__timedelta.seconds - hour * 3600 - minute * 60
            return '%08d%02d%02d%02d.%06d:000' % \
                    (self.__timedelta.days, hour, minute, second, 
                            self.__timedelta.microseconds)
        else:
            offset = self.minutes_from_utc
            sign = '+'
            if offset < 0:
                sign = '-'
                offset = -offset
            return '%d%02d%02d%02d%02d%02d.%06d%s%03d' % \
                   (self.__datetime.year, self.__datetime.month, 
                    self.__datetime.day, self.__datetime.hour,
                    self.__datetime.minute, self.__datetime.second, 
                    self.__datetime.microsecond, sign, offset)

    def __repr__ (self):
        return '%s(%s)'%(self.__class__.__name__, `str(self)`)

    def __getstate__(self):
        return str(self)

    def __setstate__(self, arg):
        self.__init__(arg)

    def __cmp__(self, other):
        if self is other:
            return 0
        elif not isinstance(other, CIMDateTime):
            return 1
        return (cmp(self.__datetime, other.__datetime) or 
                cmp(self.__timedelta, other.__timedelta))


# CIM integer types

class CIMInt(CIMType, long):
    pass

class Uint8(CIMInt):
    cimtype = 'uint8'

class Sint8(CIMInt):
    cimtype = 'sint8'

class Uint16(CIMInt):
    cimtype = 'uint16'

class Sint16(CIMInt):
    cimtype = 'sint16'

class Uint32(CIMInt):
    cimtype = 'uint32'

class Sint32(CIMInt):
    cimtype = 'sint32'

class Uint64(CIMInt):
    cimtype = 'uint64'

class Sint64(CIMInt):
    cimtype = 'sint64'

# CIM float types

class CIMFloat(CIMType, float):
    pass

class Real32(CIMFloat):
    cimtype = 'real32'

class Real64(CIMFloat):
    cimtype = 'real64'

def cimtype(obj):
    """Return the CIM type name of an object as a string.  For a list, the
    type is the type of the first element as CIM arrays must be
    homogeneous."""
    
    if isinstance(obj, CIMType):
        return obj.cimtype

    if isinstance(obj, bool):
        return 'boolean'

    if isinstance(obj, (str, unicode)):
        return 'string'

    if isinstance(obj, list):
        return cimtype(obj[0])

    if isinstance(obj, (datetime, timedelta)):
        return 'datetime'

    raise TypeError("Invalid CIM type for %s" % str(obj))



def atomic_to_cim_xml(obj):
    """Convert an atomic type to CIM external form"""
    if isinstance(obj, bool):
        if obj:
            return "true"
        else:
            return "false"

    elif isinstance(obj, CIMDateTime):
        return unicode(obj)

    elif isinstance(obj, datetime):
        return unicode(CIMDateTime(obj))

    elif obj is None:
        return obj
    elif cimtype(obj) == 'real32':
        return u'%.8E' % obj
    elif cimtype(obj) == 'real64':
        return u'%.16E' % obj
    elif isinstance(obj, str):
        return obj.decode('utf-8')
    else: # e.g. unicode, int
        return unicode(obj)