Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

 

# -*- coding: utf-8 -*- 

 

u'''Floating point and other formatting utilities. 

 

''' 

 

from pygeodesy.basics import isint, _IsNotError, isscalar 

from pygeodesy.lazily import _ALL_LAZY 

 

# all public contants, classes and functions 

__all__ = _ALL_LAZY.streprs 

__version__ = '20.03.12' 

 

_EeFfGg = ('F', 'f', 'E', 'e', 'G', 'g') # float formats 

 

 

def _streprs(prec, objs, fmt, ints, floats, strepr): 

'''(INTERNAL) Helper for C{fstr}, C{pairs}, C{reprs} and C{strs} 

''' 

if fmt in _EeFfGg: 

fmt = '%.' + str(abs(prec)) + fmt 

elif fmt.startswith('%'): 

fmt = fmt.replace('*', str(abs(prec))) 

else: 

t = '[%s]%s' % ('%.*', '|'.join(_EeFfGg)) 

raise _IsNotError(t, fmt=fmt, Error=ValueError) 

 

for o in objs: 

if floats or isinstance(o, float): 

t = fmt % (float(o),) 

if ints and (isint(o, both=True) or # for ... 

# corner case testLcc lon0=-96.0 

t.rstrip('0').endswith('.')): 

t = t.split('.')[0] 

elif prec > 1: 

t = fstrzs(t) 

elif strepr: 

t = strepr(o) 

else: 

raise _IsNotError('scalar', floats=o) 

yield t 

 

 

def anstr(name, OKd='._-', sub='_'): 

'''Make a valid name of alphanumeric and OKd characters. 

 

@param name: The original name (C{str}). 

@keyword OKd: Other acceptable characters (C{str}). 

@keyword sub: Substitute for invalid charactes (C{str}). 

 

@return: The modified name (C{str}). 

 

@note: Leading and trailing whitespace characters are removed 

and intermediate whitespace characters are coalesced 

and substituted. 

''' 

s = n = str(name).strip() 

for c in n: 

if not (c.isalnum() or c in OKd or c in sub): 

s = s.replace(c, ' ') 

return sub.join(s.strip().split()) 

 

 

def attrs(inst, *names, **kwds): # prec=6, fmt='F', ints=False, Nones=False, sep='=' 

'''Get instance attributes as I{name=value} strings, with floats handled like L{fstr}. 

 

@param inst: The instance (any C{type}). 

@param names: The attribute names (C{str}s). 

@keyword kwds: Keyword argument for function L{pairs}, except 

C{B{Nones}=True} to in-/exclude missing or 

attributes with a C{None} I{value}. 

 

@return: A C{tuple(B{C{sep}}.join(t) for t in zip(I{names}, reprs(I{values}, 

...)))} of C{str}s. 

''' 

Nones = kwds.pop('Nones', True) 

 

def items(): 

for n in names: 

v = getattr(inst, n, None) 

if Nones or v is not None: 

yield n, v 

 

return pairs(items(), **kwds) 

 

 

def enstr2(easting, northing, prec, *extras): 

'''Return easting, northing string representations. 

 

@param easting: Easting from false easting (C{meter}). 

@param northing: Northing from from false northing (C{meter}). 

@param prec: Precision in number of digits (C{int}). 

@param extras: Optional leading items (C{str}s). 

 

@return: B{C{extras}} + 2-Tuple C{(eastingStr, northingStr)}. 

 

@raise ValueError: Invalid B{C{prec}}. 

''' 

w = prec // 2 

try: 

p10 = (1e-4, 1e-3, 1e-2, 1e-1, 1)[w - 1] # 10**(5 - w) 

except IndexError: 

raise ValueError('%s invalid: %r' % ('prec', prec)) 

return extras + ('%0*d' % (w, int(easting * p10)), 

'%0*d' % (w, int(northing * p10))) 

 

 

def fstr(floats, prec=6, fmt='F', ints=False, sep=', '): 

'''Convert floats to string, optionally stripped of trailing zero decimals. 

 

@param floats: List, sequence, tuple, etc. (C{scalar}s or C{scalar}). 

@keyword prec: The C{float} precision, number of decimal digits (0..9). 

Trailing zero decimals are stripped if B{C{prec}} is 

positive, but kept for negative B{C{prec}} values. 

@keyword fmt: Optional, float format (C{str}). 

@keyword ints: Optionally, remove the decimal dot (C{bool}). 

@keyword sep: Separator joining the B{C{floats}} (C{str}). 

 

@return: The C{B{sep}.join(strs(B{floats}, ...)} string or a single 

C{strs((B{floats},), ...)} if B{C{floats}} is C{scalar} (C{str}). 

''' 

if isscalar(floats): 

floats = (floats,) 

return sep.join(_streprs(prec, floats, fmt, ints, True, None)) 

 

 

def fstrzs(efstr): 

'''Strip trailing zero decimals from a C{float} string. 

 

@param efstr: Float with or without exponent (C{str}). 

 

@return: Float (C{str}). 

''' 

s = efstr.find('.') + 2 # keep 1st '.0' 

if s > 1: 

e = efstr.rfind('e') 

if e < 0: 

e = efstr.rfind('E') 

if e < 0: 

e = len(efstr) 

if s < e and efstr[e-1] == '0': 

efstr = efstr[:s] + efstr[s:e].rstrip('0') + efstr[e:] 

return efstr 

 

 

def instr(inst, *args, **kwds): 

'''Return the string representation of an instantion. 

 

@param inst: The instance (any C{type}). 

@param args: Optional positional arguments. 

@keyword kwds: Optional keyword arguments. 

 

@return: Representation (C{str}). 

''' 

from pygeodesy.named import classname 

return unstr(classname(inst), *args, **kwds) 

 

 

def pairs(items, prec=6, fmt='F', ints=False, sep='='): 

'''Convert items to I{name=value} strings, with floats handled like L{fstr}. 

 

@param items: Name-value pairs (C{dict} or 2-{tuple}s of any C{type}s). 

@keyword prec: The C{float} precision, number of decimal digits (0..9). 

Trailing zero decimals are stripped if B{C{prec}} is 

positive, but kept for negative B{C{prec}} values. 

@keyword fmt: Optional, float format (C{str}). 

@keyword ints: Optionally, remove the decimal dot (C{bool}). 

@keyword sep: Separator joining I{names} and I{values} (C{str}). 

 

@return: A C{tuple(B{C{sep}}.join(t) for t in zip(I{names}, reprs(I{values}, 

...)))} of C{str}s. 

''' 

try: 

if isinstance(items, dict): 

items = sorted(items.items()) 

elif not isinstance(items, (list, tuple)): 

items = tuple(items) 

n, v = zip(*items) if items else ((), ()) 

except (TypeError, ValueError): 

raise _IsNotError('dict', '2-tuples', items=items) 

v = _streprs(prec, v, fmt, ints, False, repr) 

return tuple(sep.join(t) for t in zip(n, v)) 

 

 

def reprs(objs, prec=6, fmt='F', ints=False): 

'''Convert objects to C{repr} strings, with floats handled like L{fstr}. 

 

@param objs: List, sequence, tuple, etc. (any C{type}s). 

@keyword prec: The C{float} precision, number of decimal digits (0..9). 

Trailing zero decimals are stripped if B{C{prec}} is 

positive, but kept for negative B{C{prec}} values. 

@keyword fmt: Optional, float format (C{str}). 

@keyword ints: Optionally, remove the decimal dot (C{bool}). 

 

@return: A C{tuple(map(fstr|repr, B{objs}))} of C{str}s. 

''' 

return tuple(_streprs(prec, objs, fmt, ints, False, repr)) if objs else () 

 

 

def strs(objs, prec=6, fmt='F', ints=False): 

'''Convert objects to C{str} strings, with floats handled like L{fstr}. 

 

@param objs: List, sequence, tuple, etc. (any C{type}s). 

@keyword prec: The C{float} precision, number of decimal digits (0..9). 

Trailing zero decimals are stripped if B{C{prec}} is 

positive, but kept for negative B{C{prec}} values. 

@keyword fmt: Optional, float format (C{str}). 

@keyword ints: Optionally, remove the decimal dot (C{bool}). 

 

@return: A C{tuple(map(fstr|str, B{objs}))} of C{str}s. 

''' 

return tuple(_streprs(prec, objs, fmt, ints, False, str)) if objs else () 

 

 

def unstr(name, *args, **kwds): 

'''Return the string representation of an invokation. 

 

@param name: Function, method or class name (C{str}). 

@param args: Optional positional arguments. 

@keyword kwds: Optional keyword arguments. 

 

@return: Representation (C{str}). 

''' 

t = reprs(args) + pairs(sorted(kwds.items())) 

return '%s(%s)' % (name, ', '.join(t)) 

 

# **) MIT License 

# 

# Copyright (C) 2016-2020 -- mrJean1 at Gmail -- All Rights Reserved. 

# 

# Permission is hereby granted, free of charge, to any person obtaining a 

# copy of this software and associated documentation files (the "Software"), 

# to deal in the Software without restriction, including without limitation 

# the rights to use, copy, modify, merge, publish, distribute, sublicense, 

# and/or sell copies of the Software, and to permit persons to whom the 

# Software is furnished to do so, subject to the following conditions: 

# 

# The above copyright notice and this permission notice shall be included 

# in all copies or substantial portions of the Software. 

# 

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 

# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 

# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 

# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 

# OTHER DEALINGS IN THE SOFTWARE.