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

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

""" 

A place for code to be called from the implementation of np.dtype 

 

String handling is much easier to do correctly in python. 

""" 

from __future__ import division, absolute_import, print_function 

 

import sys 

 

import numpy as np 

 

 

_kind_to_stem = { 

'u': 'uint', 

'i': 'int', 

'c': 'complex', 

'f': 'float', 

'b': 'bool', 

'V': 'void', 

'O': 'object', 

'M': 'datetime', 

'm': 'timedelta' 

} 

if sys.version_info[0] >= 3: 

_kind_to_stem.update({ 

'S': 'bytes', 

'U': 'str' 

}) 

else: 

_kind_to_stem.update({ 

'S': 'string', 

'U': 'unicode' 

}) 

 

 

def _kind_name(dtype): 

try: 

return _kind_to_stem[dtype.kind] 

except KeyError: 

raise RuntimeError( 

"internal dtype error, unknown kind {!r}" 

.format(dtype.kind) 

) 

 

 

def __str__(dtype): 

if dtype.fields is not None: 

return _struct_str(dtype, include_align=True) 

elif dtype.subdtype: 

return _subarray_str(dtype) 

elif issubclass(dtype.type, np.flexible) or not dtype.isnative: 

return dtype.str 

else: 

return dtype.name 

 

 

def __repr__(dtype): 

arg_str = _construction_repr(dtype, include_align=False) 

if dtype.isalignedstruct: 

arg_str = arg_str + ", align=True" 

return "dtype({})".format(arg_str) 

 

 

def _unpack_field(dtype, offset, title=None): 

""" 

Helper function to normalize the items in dtype.fields. 

 

Call as: 

 

dtype, offset, title = _unpack_field(*dtype.fields[name]) 

""" 

return dtype, offset, title 

 

 

def _isunsized(dtype): 

# PyDataType_ISUNSIZED 

return dtype.itemsize == 0 

 

 

def _construction_repr(dtype, include_align=False, short=False): 

""" 

Creates a string repr of the dtype, excluding the 'dtype()' part 

surrounding the object. This object may be a string, a list, or 

a dict depending on the nature of the dtype. This 

is the object passed as the first parameter to the dtype 

constructor, and if no additional constructor parameters are 

given, will reproduce the exact memory layout. 

 

Parameters 

---------- 

short : bool 

If true, this creates a shorter repr using 'kind' and 'itemsize', instead 

of the longer type name. 

 

include_align : bool 

If true, this includes the 'align=True' parameter 

inside the struct dtype construction dict when needed. Use this flag 

if you want a proper repr string without the 'dtype()' part around it. 

 

If false, this does not preserve the 

'align=True' parameter or sticky NPY_ALIGNED_STRUCT flag for 

struct arrays like the regular repr does, because the 'align' 

flag is not part of first dtype constructor parameter. This 

mode is intended for a full 'repr', where the 'align=True' is 

provided as the second parameter. 

""" 

if dtype.fields is not None: 

return _struct_str(dtype, include_align=include_align) 

elif dtype.subdtype: 

return _subarray_str(dtype) 

else: 

return _scalar_str(dtype, short=short) 

 

 

def _scalar_str(dtype, short): 

byteorder = _byte_order_str(dtype) 

 

if dtype.type == np.bool_: 

if short: 

return "'?'" 

else: 

return "'bool'" 

 

elif dtype.type == np.object_: 

# The object reference may be different sizes on different 

# platforms, so it should never include the itemsize here. 

return "'O'" 

 

elif dtype.type == np.string_: 

if _isunsized(dtype): 

return "'S'" 

else: 

return "'S%d'" % dtype.itemsize 

 

elif dtype.type == np.unicode_: 

if _isunsized(dtype): 

return "'%sU'" % byteorder 

else: 

return "'%sU%d'" % (byteorder, dtype.itemsize / 4) 

 

# unlike the other types, subclasses of void are preserved - but 

# historically the repr does not actually reveal the subclass 

elif issubclass(dtype.type, np.void): 

if _isunsized(dtype): 

return "'V'" 

else: 

return "'V%d'" % dtype.itemsize 

 

elif dtype.type == np.datetime64: 

return "'%sM8%s'" % (byteorder, _datetime_metadata_str(dtype)) 

 

elif dtype.type == np.timedelta64: 

return "'%sm8%s'" % (byteorder, _datetime_metadata_str(dtype)) 

 

elif np.issubdtype(dtype, np.number): 

# Short repr with endianness, like '<f8' 

if short or dtype.byteorder not in ('=', '|'): 

return "'%s%c%d'" % (byteorder, dtype.kind, dtype.itemsize) 

 

# Longer repr, like 'float64' 

else: 

return "'%s%d'" % (_kind_name(dtype), 8*dtype.itemsize) 

 

elif dtype.isbuiltin == 2: 

return dtype.type.__name__ 

 

else: 

raise RuntimeError( 

"Internal error: NumPy dtype unrecognized type number") 

 

 

def _byte_order_str(dtype): 

""" Normalize byteorder to '<' or '>' """ 

# hack to obtain the native and swapped byte order characters 

swapped = np.dtype(int).newbyteorder('s') 

native = swapped.newbyteorder('s') 

 

byteorder = dtype.byteorder 

if byteorder == '=': 

return native.byteorder 

if byteorder == 's': 

# TODO: this path can never be reached 

return swapped.byteorder 

elif byteorder == '|': 

return '' 

else: 

return byteorder 

 

 

def _datetime_metadata_str(dtype): 

# TODO: this duplicates the C append_metastr_to_string 

unit, count = np.datetime_data(dtype) 

if unit == 'generic': 

return '' 

elif count == 1: 

return '[{}]'.format(unit) 

else: 

return '[{}{}]'.format(count, unit) 

 

 

def _struct_dict_str(dtype, includealignedflag): 

# unpack the fields dictionary into ls 

names = dtype.names 

fld_dtypes = [] 

offsets = [] 

titles = [] 

for name in names: 

fld_dtype, offset, title = _unpack_field(*dtype.fields[name]) 

fld_dtypes.append(fld_dtype) 

offsets.append(offset) 

titles.append(title) 

 

# Build up a string to make the dictionary 

 

# First, the names 

ret = "{'names':[" 

ret += ",".join(repr(name) for name in names) 

 

# Second, the formats 

ret += "], 'formats':[" 

ret += ",".join( 

_construction_repr(fld_dtype, short=True) for fld_dtype in fld_dtypes) 

 

# Third, the offsets 

ret += "], 'offsets':[" 

ret += ",".join("%d" % offset for offset in offsets) 

 

# Fourth, the titles 

if any(title is not None for title in titles): 

ret += "], 'titles':[" 

ret += ",".join(repr(title) for title in titles) 

 

# Fifth, the itemsize 

ret += "], 'itemsize':%d" % dtype.itemsize 

 

if (includealignedflag and dtype.isalignedstruct): 

# Finally, the aligned flag 

ret += ", 'aligned':True}" 

else: 

ret += "}" 

 

return ret 

 

 

def _is_packed(dtype): 

""" 

Checks whether the structured data type in 'dtype' 

has a simple layout, where all the fields are in order, 

and follow each other with no alignment padding. 

 

When this returns true, the dtype can be reconstructed 

from a list of the field names and dtypes with no additional 

dtype parameters. 

 

Duplicates the C `is_dtype_struct_simple_unaligned_layout` functio. 

""" 

total_offset = 0 

for name in dtype.names: 

fld_dtype, fld_offset, title = _unpack_field(*dtype.fields[name]) 

if fld_offset != total_offset: 

return False 

total_offset += fld_dtype.itemsize 

if total_offset != dtype.itemsize: 

return False 

return True 

 

 

def _struct_list_str(dtype): 

items = [] 

for name in dtype.names: 

fld_dtype, fld_offset, title = _unpack_field(*dtype.fields[name]) 

 

item = "(" 

if title is not None: 

item += "({!r}, {!r}), ".format(title, name) 

else: 

item += "{!r}, ".format(name) 

# Special case subarray handling here 

if fld_dtype.subdtype is not None: 

base, shape = fld_dtype.subdtype 

item += "{}, {}".format( 

_construction_repr(base, short=True), 

shape 

) 

else: 

item += _construction_repr(fld_dtype, short=True) 

 

item += ")" 

items.append(item) 

 

return "[" + ", ".join(items) + "]" 

 

 

def _struct_str(dtype, include_align): 

# The list str representation can't include the 'align=' flag, 

# so if it is requested and the struct has the aligned flag set, 

# we must use the dict str instead. 

if not (include_align and dtype.isalignedstruct) and _is_packed(dtype): 

sub = _struct_list_str(dtype) 

 

else: 

sub = _struct_dict_str(dtype, include_align) 

 

# If the data type isn't the default, void, show it 

if dtype.type != np.void: 

return "({t.__module__}.{t.__name__}, {f})".format(t=dtype.type, f=sub) 

else: 

return sub 

 

 

def _subarray_str(dtype): 

base, shape = dtype.subdtype 

return "({}, {})".format( 

_construction_repr(base, short=True), 

shape 

) 

 

 

def _name_get(dtype): 

# provides dtype.name.__get__ 

 

if dtype.isbuiltin == 2: 

# user dtypes don't promise to do anything special 

return dtype.type.__name__ 

 

# Builtin classes are documented as returning a "bit name" 

name = dtype.type.__name__ 

 

# handle bool_, str_, etc 

if name[-1] == '_': 

name = name[:-1] 

 

# append bit counts to str, unicode, and void 

if np.issubdtype(dtype, np.flexible) and not _isunsized(dtype): 

name += "{}".format(dtype.itemsize * 8) 

 

# append metadata to datetimes 

elif dtype.type in (np.datetime64, np.timedelta64): 

name += _datetime_metadata_str(dtype) 

 

return name