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

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

 

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

 

u'''Floating point and other formatting utilities. 

 

''' 

 

from pygeodesy.basics import isint, isscalar 

from pygeodesy.errors import _IsnotError, _ValueError, _xkwds_pop 

from pygeodesy.interns import NN, _COMMA_SPACE_, _DOT_, _E_, _EQUAL_, \ 

_H_, _item_ps, _N_, _PERCENT_, _scalar_, \ 

_SPACE_, _STAR_, _UNDERSCORE_, _0_ 

from pygeodesy.lazily import _ALL_LAZY 

 

__all__ = _ALL_LAZY.streprs 

__version__ = '20.10.12' 

 

# formats %G and %.g drop all trailing zeros and the 

# decimal point making the float appear as an int 

_e = 'e' # imported by .ellipsoids 

_E = _E_ 

_g = 'g' # imported by .units 

_Gg = ('G', _g) 

_Fmt = 'F' # imported by .ellipsoids, .named, .trf 

_EeFfGg = (_Fmt, 'f', _E, _e) + _Gg # float formats 

 

 

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

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

''' 

if fmt in _EeFfGg: 

fGg = fmt in _Gg 

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

elif fmt.startswith(_PERCENT_): 

fGg = False 

fmt = fmt.replace(_STAR_, str(abs(prec))) 

else: 

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

raise _ValueError(fmt=fmt, txt='not %r' % (t,)) 

 

for o in objs: 

if force 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(_DOT_)): 

t = t.split(_DOT_)[0] 

elif prec > 1: 

t = fstrzs(t, ap1z=fGg) 

elif strepr: 

t = strepr(o) 

else: 

raise _IsnotError(_scalar_, floats=o) 

yield t 

 

 

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

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

 

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

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

@kwarg 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, _SPACE_) 

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

 

 

def attrs(inst, *names, **kwds): # prec=6, fmt=_Fmt, ints=False, Nones=True, sep=_EQUAL_ 

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

 

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

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

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

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

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

 

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

of C{str}s. 

''' 

Nones = _xkwds_pop(kwds, 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. 

 

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

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

@arg prec: Precision in number of digits (C{int}, [1..5]). 

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

 

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

 

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

''' 

w = int(prec) // 2 

if not 0 < w < 6: 

raise _ValueError(prec=prec) 

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

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

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

 

 

def fstr(floats, prec=6, fmt=_Fmt, ints=False, sep=_COMMA_SPACE_, strepr=None): 

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

 

@arg floats: Single or a list, sequence, tuple, etc. (C{scalar}s). 

@kwarg 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. 

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

@kwarg ints: Optionally, remove the decimal dot for C{int} values (C{bool}). 

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

@kwarg strepr: Optional callable to format non-C{floats} (typically 

C{repr}, C{str}) or C{None} to raise a TypeError. 

 

@return: The C{sep.join(strs(floats, ...)} joined (C{str}) or single 

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

''' 

if isscalar(floats): 

floats = (floats,) 

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

 

 

def _fstrENH2(inst, prec, m): 

'''(INTERNAL) For C{Css.} and C{Lcc.} C{toRepr} and C{toStr}. 

''' 

t = (fstr(inst.easting, prec=prec), 

fstr(inst.northing, prec=prec)) 

T = _E_, _N_ 

if inst.height: # abs(self.height) > EPS 

t += ('%+.2f%s' % (inst.height, m)), 

T += _H_, 

return t, T 

 

 

def fstrzs(efstr, ap1z=False): 

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

 

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

@kwarg ap1z: Append the decimal point and one zero decimal 

if the B{C{efstr}} is all digits (C{bool}). 

 

@return: Float (C{str}). 

''' 

s = efstr.find(_DOT_) 

if s >= 0: 

e = efstr.rfind(_e) 

if e < 0: 

e = efstr.rfind(_E) 

if e < 0: 

e = len(efstr) 

s += 2 # keep 1st _DOT_ + _0_ 

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

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

 

elif ap1z: 

# %.G and %.g formats drop the decimal 

# point and all trailing zeros, ... 

if efstr.isdigit(): 

efstr += _DOT_ + _0_ # ... append or ... 

else: # ... insert one dot and zero 

e = efstr.rfind(_e) 

if e < 0: 

e = efstr.rfind(_E) 

if e > 0: 

efstr = efstr[:e] + _DOT_ + _0_ + efstr[e:] 

 

return efstr 

 

 

def hstr(height, prec=2, fmt='%+.*f', ints=False, m=NN): 

'''Return a string for the height value. 

 

@arg height: Height value (C{float}). 

@kwarg 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. 

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

@kwarg ints: Optionally, remove the decimal dot for C{int} values (C{bool}). 

@kwarg m: Optional unit of the height (C{str}). 

''' 

h = next(_streprs(prec, (height,), fmt, ints, True, None)) 

return h if not m else (h + str(m)) 

 

 

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

'''Return the string representation of an instantiation. 

 

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

@arg args: Optional positional arguments. 

@kwarg 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=_Fmt, ints=False, sep=_EQUAL_): 

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

 

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

@kwarg 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. 

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

@kwarg ints: Optionally, remove the decimal dot fir C{int} values (C{bool}). 

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

 

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

of C{str}s. 

''' 

try: 

if isinstance(items, dict): 

items = sorted(items.items()) 

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

items = tuple(items) 

# can't unzip empty items tuple, list, etc. 

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

except (TypeError, ValueError): 

raise _IsnotError(dict.__name__, '2-tuples', items=items) 

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

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

 

 

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

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

 

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

@kwarg 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. 

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

@kwarg ints: Optionally, remove the decimal dot fir C{int} values (C{bool}). 

 

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

''' 

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

 

 

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

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

 

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

@kwarg 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. 

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

@kwarg ints: Optionally, remove the decimal dot fir C{int} values (C{bool}). 

 

@return: A C{tuple(map(fstr|str, 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. 

 

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

@arg args: Optional positional arguments. 

@kwarg kwds: Optional keyword arguments. 

 

@return: Representation (C{str}). 

''' 

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

return _item_ps(name, _COMMA_SPACE_.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.