1

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

3

4 u'''Some, basic definitions, functions and dependencies.

5

6 Use env variable C{PYGEODESY_XPACKAGES} to avoid import of dependencies

7 C{geographiclib}, C{numpy} and/or C{scipy}. Set C{PYGEODESY_XPACKAGES}

8 to a comma-separated list of package names to be excluded from import.

9'''

10# make sure int/int division yields float quotient

11 from __future__ import division

12 division = 1 / 2 # .albers, .azimuthal, .constants, etc., .utily

13 if not division:

14 raise ImportError('%s 1/2 == %s' % ('division', division))

15 del division

16

17# from pygeodesy.cartesianBase import CartesianBase # _MODS

18# from pygeodesy.constants import isneg0, NEG0 # _MODS

19 from pygeodesy.errors import _AttributeError, _ImportError, _NotImplementedError, \

20 _TypeError, _TypesError, _ValueError, _xAssertionError, \

21 _xkwds_get

22 from pygeodesy.internals import _0_0, _enquote, _passarg, _version_info

23 from pygeodesy.interns import MISSING, NN, _1_, _by_, _COMMA_, _DOT_, _DEPRECATED_, \

24 _ELLIPSIS4_, _EQUAL_, _in_, _invalid_, _N_A_, _not_, \

25 _not_scalar_, _odd_, _SPACE_, _UNDER_, _version_

26# from pygeodesy.latlonBase import LatLonBase # _MODS

27 from pygeodesy.lazily import _ALL_LAZY, _ALL_MODS as _MODS, _FOR_DOCS, _getenv, \

28 LazyImportError, _sys_version_info2

29# from pygeodesy.named import classname, modulename # _MODS

30# from pygeodesy.nvectorBase import NvectorBase # _MODS

31# from pygeodesy.props import _update_all # _MODS

32# from pygeodesy.streprs import Fmt # _MODS

33

34 from copy import copy as _copy, deepcopy as _deepcopy

35 from math import copysign as _copysign

36 import inspect as _inspect

37

38__all__ = _ALL_LAZY.basics

39__version__ = '24.05.15'

40

41_below_ = 'below'

42_list_tuple_types = (list, tuple)

43_PYGEODESY_XPACKAGES_ = 'PYGEODESY_XPACKAGES'

44_required_ = 'required'

45

46 try: # Luciano Ramalho, "Fluent Python", O'Reilly, 2016 p. 395, 2022 p. 577+

47 from numbers import Integral as _Ints, Real as _Scalars # .units

48 except ImportError:

49 try:

50 _Ints = int, long # int objects (C{tuple})

51 except NameError: # Python 3+

52 _Ints = int, # int objects (C{tuple})

53 _Scalars = (float,) + _Ints

54

55 try:

56 try: # use C{from collections.abc import ...} in Python 3.9+

57 from collections.abc import Sequence as _Sequence # in .points

58 except ImportError: # no .abc in Python 3.8- and 2.7-

59 from collections import Sequence as _Sequence # in .points

60 if isinstance([], _Sequence) and isinstance((), _Sequence):

61 # and isinstance(range(1), _Sequence):

62 _Seqs = _Sequence

63 else:

64 raise ImportError() # _AssertionError

65 except ImportError:

66 _Sequence = tuple # immutable for .points._Basequence

67 _Seqs = list, _Sequence # range for function len2 below

68

69 try:

70 _Bytes = unicode, bytearray # PYCHOK expected

71 _Strs = basestring, str # XXX , bytes

72 str2ub = ub2str = _passarg # avoids UnicodeDecodeError

73

74 def _Xstr(exc): # PYCHOK no cover

75 '''I{Invoke only with caught ImportError} B{C{exc}}.

76

77 C{... "can't import name _distributor_init" ...}

78

79 only for C{numpy}, C{scipy} import errors occurring

80 on arm64 Apple Silicon running macOS' Python 2.7.16?

81 '''

82 t = str(exc)

83 if '_distributor_init' in t:

84 from sys import exc_info

85 from traceback import extract_tb

86 tb = exc_info()[2] # 3-tuple (type, value, traceback)

87 t4 = extract_tb(tb, 1)[0] # 4-tuple (file, line, name, 'import ...')

88 t = _SPACE_("can't", t4[3] or _N_A_)

89 del tb, t4

90 return t

91

92 except NameError: # Python 3+

93 from pygeodesy.interns import _utf_8_

94

95 _Bytes = bytes, bytearray

96 _Strs = str, # tuple

97 _Xstr = str

98

99 def str2ub(sb):

100 '''Convert C{str} to C{unicode bytes}.

101 '''

102 if isinstance(sb, _Strs):

103 sb = sb.encode(_utf_8_)

104 return sb

105

106 def ub2str(ub):

107 '''Convert C{unicode bytes} to C{str}.

108 '''

109 if isinstance(ub, _Bytes):

110 ub = str(ub.decode(_utf_8_))

111 return ub

112

113

114 def _args_kwds_names(func):

115 '''(INTERNAL) Get a C{func}'s args and kwds names, including

116 C{self} for methods.

117

118 @note: Python 2 may I{not} include the C{*args} nor the

119 C{**kwds} names.

120 '''

121 try:

122 args_kwds = _inspect.signature(func).parameters.keys()

123 except AttributeError: # .signature new Python 3+

124 args_kwds = _inspect.getargspec(func).args

125 return tuple(args_kwds)

126

127

128 def clips(sb, limit=50, white=NN):

129 '''Clip a string to the given length limit.

130

131 @arg sb: String (C{str} or C{bytes}).

132 @kwarg limit: Length limit (C{int}).

133 @kwarg white: Optionally, replace all whitespace (C{str}).

134

135 @return: The clipped or unclipped B{C{sb}}.

136 '''

137 T = type(sb)

138 if len(sb) > limit > 8:

139 h = limit // 2

140 sb = T(_ELLIPSIS4_).join((sb[:h], sb[-h:]))

141 if white: # replace whitespace

142 sb = T(white).join(sb.split())

143 return sb

144

145

146 def copysign0(x, y):

147 '''Like C{math.copysign(x, y)} except C{zero}, I{unsigned}.

148

149 @return: C{math.copysign(B{x}, B{y})} if B{C{x}} else

150 C{type(B{x})(0)}.

151 '''

152 return _copysign(x, (y if y else 0)) if x else copytype(0, x)

153

154

155 def copytype(x, y):

156 '''Return the value of B{x} as C{type} of C{y}.

157

158 @return: C{type(B{y})(B{x})}.

159 '''

160 return type(y)(x if x else _0_0)

161

162

163 def halfs2(str2):

164 '''Split a string in 2 halfs.

165

166 @arg str2: String to split (C{str}).

167

168 @return: 2-Tuple C{(_1st, _2nd)} half (C{str}).

169

170 @raise ValueError: Zero or odd C{len(B{str2})}.

171 '''

172 h, r = divmod(len(str2), 2)

173 if r or not h:

174 raise _ValueError(str2=str2, txt=_odd_)

175 return str2[:h], str2[h:]

176

177

178 def int1s(x):

179 '''Count the number of 1-bits in an C{int}, I{unsigned}.

180

181 @note: C{int1s(-B{x}) == int1s(abs(B{x}))}.

182 '''

183 try:

184 return x.bit_count() # Python 3.10+

185 except AttributeError:

186 # bin(-x) = '-' + bin(abs(x))

187 return bin(x).count(_1_)

188

189

190 def isbool(obj):

191 '''Is B{C{obj}}ect a C{bool}ean?

192

193 @arg obj: The object (any C{type}).

194

195 @return: C{True} if C{bool}ean, C{False} otherwise.

196 '''

197 return isinstance(obj, bool) # and (obj is False

198# or obj is True)

199

200 assert not (isbool(1) or isbool(0) or isbool(None)) # PYCHOK 2

201

202

203 def isCartesian(obj, ellipsoidal=None):

204 '''Is B{C{obj}}ect some C{Cartesian}?

205

206 @arg obj: The object (any C{type}).

207 @kwarg ellipsoidal: If C{None}, return the type of any C{Cartesian},

208 if C{True}, only an ellipsoidal C{Cartesian type}

209 or if C{False}, only a spherical C{Cartesian type}.

210

211 @return: C{type(B{obj}} if a C{Cartesian} of the required type, C{False}

212 if a C{Cartesian} of an other type or {None} otherwise.

213 '''

214 if ellipsoidal is not None:

215 try:

216 return obj.ellipsoidalCartesian if ellipsoidal else obj.sphericalCartesian

217 except AttributeError:

218 return None

219 return isinstanceof(obj, _MODS.cartesianBase.CartesianBase)

220

221

222 if _FOR_DOCS: # XXX avoid epydoc Python 2.7 error

223

224 def isclass(obj):

225 '''Is B{C{obj}}ect a C{Class} or C{type}?

226 '''

227 return _inspect.isclass(obj)

228 else:

229 isclass = _inspect.isclass

230

231

232 def iscomplex(obj, both=False):

233 '''Is B{C{obj}}ect a C{complex} or complex literal C{str}?

234

235 @arg obj: The object (any C{type}).

236 @kwarg both: If C{True}, check complex C{str} (C{bool}).

237

238 @return: C{True} if C{complex}, C{False} otherwise.

239 '''

240 try: # hasattr('conjugate', 'real' and 'imag')

241 return isinstance(obj, complex) or bool(both and isstr(obj) and

242 isinstance(complex(obj), complex)) # numbers.Complex?

243 except (TypeError, ValueError):

244 return False

245

246

247 def isDEPRECATED(obj):

248 '''Is B{C{obj}}ect a C{DEPRECATED} class, method or function?

249

250 @return: C{True} if C{DEPRECATED}, {False} if not or

251 C{None} if undetermined.

252 '''

253 try: # XXX inspect.getdoc(obj) or obj.__doc__

254 doc = obj.__doc__.lstrip()

255 return bool(doc and doc.startswith(_DEPRECATED_))

256 except AttributeError:

257 return None

258

259

260 def isfloat(obj, both=False):

261 '''Is B{C{obj}}ect a C{float} or float literal C{str}?

262

263 @arg obj: The object (any C{type}).

264 @kwarg both: If C{True}, check float C{str} (C{bool}).

265

266 @return: C{True} if C{float}, C{False} otherwise.

267 '''

268 try:

269 return isinstance(obj, float) or bool(both and

270 isstr(obj) and isinstance(float(obj), float))

271 except (TypeError, ValueError):

272 return False

273

274

275 try:

276 isidentifier = str.isidentifier # Python 3, must be str

277 except AttributeError: # Python 2-

278

279 def isidentifier(obj):

280 '''Is B{C{obj}}ect a Python identifier?

281 '''

282 return bool(obj and isstr(obj)

283 and obj.replace(_UNDER_, NN).isalnum()

284 and not obj[:1].isdigit())

285

286

287 def isinstanceof(obj, *Classes):

288 '''Is B{C{obj}}ect an instance of one of the C{Classes}?

289

290 @arg obj: The object (any C{type}).

291 @arg Classes: One or more classes (C{Class}).

292

293 @return: C{type(B{obj}} if one of the B{C{Classes}},

294 C{None} otherwise.

295 '''

296 return type(obj) if isinstance(obj, Classes) else None

297

298

299 def isint(obj, both=False):

300 '''Is B{C{obj}}ect an C{int} or integer C{float} value?

301

302 @arg obj: The object (any C{type}).

303 @kwarg both: If C{True}, check C{float} and L{Fsum}

304 type and value (C{bool}).

305

306 @return: C{True} if C{int} or I{integer} C{float}

307 or L{Fsum}, C{False} otherwise.

308

309 @note: Both C{isint(True)} and C{isint(False)} return

310 C{False} (and no longer C{True}).

311 '''

312 if isinstance(obj, _Ints):

313 return not isbool(obj)

314 elif both: # and isinstance(obj, (float, Fsum))

315 try: # NOT , _Scalars) to include Fsum!

316 return obj.is_integer()

317 except AttributeError:

318 pass # XXX float(int(obj)) == obj?

319 return False

320

321

322 def isiterable(obj):

323 '''Is B{C{obj}}ect C{iterable}?

324

325 @arg obj: The object (any C{type}).

326

327 @return: C{True} if C{iterable}, C{False} otherwise.

328 '''

329 # <https://PyPI.org/project/isiterable/>

330 return hasattr(obj, '__iter__') # map, range, set

331

332

333 def isiterablen(obj):

334 '''Is B{C{obj}}ect C{iterable} and has C{len}gth?

335

336 @arg obj: The object (any C{type}).

337

338 @return: C{True} if C{iterable} with C{len}gth, C{False} otherwise.

339 '''

340 return hasattr(obj, '__len__') and hasattr(obj, '__getitem__')

341

342

343 try:

344 from keyword import iskeyword # Python 2.7+

345 except ImportError:

346

347 def iskeyword(unused):

348 '''Not Implemented, C{False} always.

349 '''

350 return False

351

352

353 def isLatLon(obj, ellipsoidal=None):

354 '''Is B{C{obj}}ect some C{LatLon}?

355

356 @arg obj: The object (any C{type}).

357 @kwarg ellipsoidal: If C{None}, return the type of any C{LatLon},

358 if C{True}, only an ellipsoidal C{LatLon type}

359 or if C{False}, only a spherical C{LatLon type}.

360

361 @return: C{type(B{obj}} if a C{LatLon} of the required type, C{False}

362 if a C{LatLon} of an other type or {None} otherwise.

363 '''

364 if ellipsoidal is not None:

365 try:

366 return obj.ellipsoidalLatLon if ellipsoidal else obj.sphericalLatLon

367 except AttributeError:

368 return None

369 return isinstanceof(obj, _MODS.latlonBase.LatLonBase)

370

371

372 def islistuple(obj, minum=0):

373 '''Is B{C{obj}}ect a C{list} or C{tuple} with non-zero length?

374

375 @arg obj: The object (any C{type}).

376 @kwarg minum: Minimal C{len} required C({int}).

377

378 @return: C{True} if a C{list} or C{tuple} with C{len} at

379 least B{C{minum}}, C{False} otherwise.

380 '''

381 return isinstance(obj, _list_tuple_types) and len(obj) >= minum

382

383

384 def isNvector(obj, ellipsoidal=None):

385 '''Is B{C{obj}}ect some C{Nvector}?

386

387 @arg obj: The object (any C{type}).

388 @kwarg ellipsoidal: If C{None}, return the type of any C{Nvector},

389 if C{True}, only an ellipsoidal C{Nvector type}

390 or if C{False}, only a spherical C{Nvector type}.

391

392 @return: C{type(B{obj}} if an C{Nvector} of the required type, C{False}

393 if an C{Nvector} of an other type or {None} otherwise.

394 '''

395 if ellipsoidal is not None:

396 try:

397 return obj.ellipsoidalNvector if ellipsoidal else obj.sphericalNvector

398 except AttributeError:

399 return None

400 return isinstanceof(obj, _MODS.nvectorBase.NvectorBase)

401

402

403 def isodd(x):

404 '''Is B{C{x}} odd?

405

406 @arg x: Value (C{scalar}).

407

408 @return: C{True} if odd, C{False} otherwise.

409 '''

410 return bool(int(x) & 1) # == bool(int(x) % 2)

411

412

413 def isscalar(obj, both=False):

414 '''Is B{C{obj}}ect an C{int} or integer C{float} value?

415

416 @arg obj: The object (any C{type}).

417 @kwarg both: If C{True}, check L{Fsum<Fsum.residual>}.

418

419 @return: C{True} if C{int}, C{float} or L{Fsum} with

420 zero residual, C{False} otherwise.

421 '''

422 if isinstance(obj, _Scalars):

423 return not isbool(obj)

424 elif both: # and isinstance(obj, Fsum)

425 try:

426 return bool(obj.residual == 0)

427 except (AttributeError, TypeError):

428 pass # XXX float(int(obj)) == obj?

429 return False

430

431

432 def issequence(obj, *excls):

433 '''Is B{C{obj}}ect some sequence type?

434

435 @arg obj: The object (any C{type}).

436 @arg excls: Classes to exclude (C{type}), all positional.

437

438 @note: Excluding C{tuple} implies excluding C{namedtuple}.

439

440 @return: C{True} if a sequence, C{False} otherwise.

441 '''

442 return isinstance(obj, _Seqs) and not (excls and isinstance(obj, excls))

443

444

445 def isstr(obj):

446 '''Is B{C{obj}}ect some string type?

447

448 @arg obj: The object (any C{type}).

449

450 @return: C{True} if a C{str}, C{bytes}, ...,

451 C{False} otherwise.

452 '''

453 return isinstance(obj, _Strs)

454

455

456 def issubclassof(Sub, *Supers):

457 '''Is B{C{Sub}} a class and sub-class of some other class(es)?

458

459 @arg Sub: The sub-class (C{Class}).

460 @arg Supers: One or more C(super) classes (C{Class}).

461

462 @return: C{True} if a sub-class of any B{C{Supers}}, C{False}

463 if not (C{bool}) or C{None} if not a class or if no

464 B{C{Supers}} are given or none of those are a class.

465 '''

466 if isclass(Sub):

467 t = tuple(S for S in Supers if isclass(S))

468 if t:

469 return bool(issubclass(Sub, t))

470 return None

471

472

473 def itemsorted(adict, *items_args, **asorted_reverse):

474 '''Return the items of C{B{adict}} sorted I{alphabetically,

475 case-insensitively} and in I{ascending} order.

476

477 @arg items_args: Optional positional argument(s) for method

478 C{B{adict}.items(B*{items_args})}.

479 @kwarg asorted_reverse: Use C{B{asorted}=False} for I{alphabetical,

480 case-sensitive} sorting and C{B{reverse}=True} for

481 sorting in C{descending} order.

482 '''

483 def _ins(item): # functools.cmp_to_key

484 k, v = item

485 return k.lower()

486

487 def _reverse_key(asorted=True, reverse=False):

488 return dict(reverse=reverse, key=_ins if asorted else None)

489

490 items = adict.items(*items_args) if items_args else adict.items()

491 return sorted(items, **_reverse_key(**asorted_reverse))

492

493

494 def len2(items):

495 '''Make built-in function L{len} work for generators, iterators,

496 etc. since those can only be started exactly once.

497

498 @arg items: Generator, iterator, list, range, tuple, etc.

499

500 @return: 2-Tuple C{(n, items)} of the number of items (C{int})

501 and the items (C{list} or C{tuple}).

502 '''

503 if not isinstance(items, _Seqs): # NOT hasattr(items, '__len__'):

504 items = list(items)

505 return len(items), items

506

507

508 def map1(fun1, *xs): # XXX map_

509 '''Call a single-argument function to each B{C{xs}}

510 and return a C{tuple} of results.

511

512 @arg fun1: 1-Arg function (C{callable}).

513 @arg xs: Arguments (C{any positional}).

514

515 @return: Function results (C{tuple}).

516 '''

517 return tuple(map(fun1, xs))

518

519

520 def map2(fun, *xs):

521 '''Like Python's B{C{map}} but returning a C{tuple} of results.

522

523 Unlike Python 2's built-in L{map}, Python 3+ L{map} returns a

524 L{map} object, an iterator-like object which generates the

525 results only once. Converting the L{map} object to a tuple

526 maintains the Python 2 behavior.

527

528 @arg fun: Function (C{callable}).

529 @arg xs: Arguments (C{all positional}).

530

531 @return: Function results (C{tuple}).

532 '''

533 return tuple(map(fun, *xs))

534

535

536 def neg(x, neg0=None):

537 '''Negate C{x} and optionally, negate C{0.0} and C{-0.0}.

538

539 @kwarg neg0: Defines the return value for zero C{B{x}}: if C{None}

540 return C{0.0}, if C{True} return C{NEG0 if B{x}=0.0}

541 and C{0.0 if B{x}=NEG0} or if C{False} return C{B{x}}

542 I{as-is} (C{bool} or C{None}).

543

544 @return: C{-B{x} if B{x} else 0.0, NEG0 or B{x}}.

545 '''

546 return (-x) if x else (

547 _0_0 if neg0 is None else (

548 x if not neg0 else (

549 _0_0 if signBit(x) else _MODS.constants.

550 NEG0))) # PYCHOK indent

551

552

553 def neg_(*xs):

554 '''Negate all C{xs} with L{neg}.

555

556 @return: A C{map(neg, B{xs})}.

557 '''

558 return map(neg, xs)

559

560

561 def _neg0(x):

562 '''(INTERNAL) Return C{NEG0 if x < 0 else _0_0},

563 unlike C{_copysign_0_0} which returns C{_N_0_0}.

564 '''

565 return _MODS.constants.NEG0 if x < 0 else _0_0

566

567

568 def _req_d_by(where, name=NN): # in .basics

569 '''(INTERNAL) Get the fully qualified name.

570 '''

571 m = _MODS.named.modulename(where, prefixed=True)

572 if name:

573 m = _DOT_(m, name)

574 return _SPACE_(_required_, _by_, m)

575

576

577 def _reverange(n, stop=-1, step=-1):

578 '''(INTERNAL) Reversed range yielding C{n-1, n-1-step, ..., stop+1}.

579 '''

580 return range(n - 1, stop, step)

581

582

583 def signBit(x):

584 '''Return C{signbit(B{x})}, like C++.

585

586 @return: C{True} if C{B{x} < 0} or C{NEG0} (C{bool}).

587 '''

588 return x < 0 or _MODS.constants.isneg0(x)

589

590

591 def _signOf(x, ref): # in .fsums

592 '''(INTERNAL) Return the sign of B{C{x}} versus B{C{ref}}.

593 '''

594 return (-1) if x < ref else (+1 if x > ref else 0)

595

596

597 def signOf(x):

598 '''Return sign of C{x} as C{int}.

599

600 @return: -1, 0 or +1 (C{int}).

601 '''

602 try:

603 s = x.signOf() # Fsum instance?

604 except AttributeError:

605 s = _signOf(x, 0)

606 return s

607

608

609 def splice(iterable, n=2, **fill):

610 '''Split an iterable into C{n} slices.

611

612 @arg iterable: Items to be spliced (C{list}, C{tuple}, ...).

613 @kwarg n: Number of slices to generate (C{int}).

614 @kwarg fill: Optional fill value for missing items.

615

616 @return: A generator for each of B{C{n}} slices,

617 M{iterable[i::n] for i=0..n}.

618

619 @raise TypeError: Invalid B{C{n}}.

620

621 @note: Each generated slice is a C{tuple} or a C{list},

622 the latter only if the B{C{iterable}} is a C{list}.

623

624 @example:

625

626 >>> from pygeodesy import splice

627

628 >>> a, b = splice(range(10))

629 >>> a, b

630 ((0, 2, 4, 6, 8), (1, 3, 5, 7, 9))

631

632 >>> a, b, c = splice(range(10), n=3)

633 >>> a, b, c

634 ((0, 3, 6, 9), (1, 4, 7), (2, 5, 8))

635

636 >>> a, b, c = splice(range(10), n=3, fill=-1)

637 >>> a, b, c

638 ((0, 3, 6, 9), (1, 4, 7, -1), (2, 5, 8, -1))

639

640 >>> tuple(splice(list(range(9)), n=5))

641 ([0, 5], [1, 6], [2, 7], [3, 8], [4])

642

643 >>> splice(range(9), n=1)

644 <generator object splice at 0x0...>

645 '''

646 if not isint(n):

647 raise _TypeError(n=n)

648

649 t = _xiterablen(iterable)

650 if not isinstance(t, _list_tuple_types):

651 t = tuple(t)

652

653 if n > 1:

654 if fill:

655 fill = _xkwds_get(fill, fill=MISSING)

656 if fill is not MISSING:

657 m = len(t) % n

658 if m > 0: # same type fill

659 t = t + type(t)((fill,) * (n - m))

660 for i in range(n):

661 # XXX t[i::n] chokes PyChecker

662 yield t[slice(i, None, n)]

663 else:

664 yield t # 1 slice, all

665

666

667 def _splituple(strs, *sep_splits): # in .mgrs, .osgr, .webmercator

668 '''(INTERNAL) Split a C{comma}- or C{whitespace}-separated

669 string into a C{tuple} of stripped strings.

670 '''

671 t = (strs.split(*sep_splits) if sep_splits else

672 strs.replace(_COMMA_, _SPACE_).split()) if strs else ()

673 return tuple(s.strip() for s in t if s)

674

675

676 def unsigned0(x):

677 '''Unsign if C{0.0}.

678

679 @return: C{B{x}} if B{C{x}} else C{0.0}.

680 '''

681 return x if x else _0_0

682

683

684 def _xcopy(obj, deep=False):

685 '''(INTERNAL) Copy an object, shallow or deep.

686

687 @arg obj: The object to copy (any C{type}).

688 @kwarg deep: If C{True} make a deep, otherwise

689 a shallow copy (C{bool}).

690

691 @return: The copy of B{C{obj}}.

692 '''

693 return _deepcopy(obj) if deep else _copy(obj)

694

695

696 def _xdup(obj, deep=False, **items):

697 '''(INTERNAL) Duplicate an object, replacing some attributes.

698

699 @arg obj: The object to copy (any C{type}).

700 @kwarg deep: If C{True} copy deep, otherwise shallow.

701 @kwarg items: Attributes to be changed (C{any}).

702

703 @return: A duplicate of B{C{obj}} with modified

704 attributes, if any B{C{items}}.

705

706 @raise AttributeError: Some B{C{items}} invalid.

707 '''

708 d = _xcopy(obj, deep=deep)

709 for n, v in items.items():

710 if getattr(d, n, v) != v:

711 setattr(d, n, v)

712 elif not hasattr(d, n):

713 t = _MODS.named.classname(obj)

714 t = _SPACE_(_DOT_(t, n), _invalid_)

715 raise _AttributeError(txt=t, obj=obj, **items)

716# if items:

717# _MODS.props._update_all(d)

718 return d

719

720

721 def _xgeographiclib(where, *required):

722 '''(INTERNAL) Import C{geographiclib} and check required version.

723 '''

724 try:

725 _xpackage(_xgeographiclib)

726 import geographiclib

727 except ImportError as x:

728 raise _xImportError(x, where, Error=LazyImportError)

729 return _xversion(geographiclib, where, *required)

730

731

732 def _xImportError(exc, where, Error=_ImportError, **name):

733 '''(INTERNAL) Embellish an C{Lazy/ImportError}.

734 '''

735 t = _req_d_by(where, **name)

736 return Error(_Xstr(exc), txt=t, cause=exc)

737

738

739 def _xinstanceof(*Types, **names_values):

740 '''(INTERNAL) Check C{Types} of all C{name=value} pairs.

741

742 @arg Types: One or more classes or types (C{class}), all

743 positional.

744 @kwarg names_values: One or more C{B{name}=value} pairs

745 with the C{value} to be checked.

746

747 @raise TypeError: One B{C{names_values}} pair is not an

748 instance of any of the B{C{Types}}.

749 '''

750 if not (Types and names_values):

751 raise _xAssertionError(_xinstanceof, *Types, **names_values)

752

753 for n, v in names_values.items():

754 if not isinstance(v, Types):

755 raise _TypesError(n, v, *Types)

756

757

758 def _xiterable(obj):

759 '''(INTERNAL) Return C{obj} if iterable, otherwise raise C{TypeError}.

760 '''

761 return obj if isiterable(obj) else _xiterror(obj, _xiterable) # PYCHOK None

762

763

764 def _xiterablen(obj):

765 '''(INTERNAL) Return C{obj} if iterable with C{__len__}, otherwise raise C{TypeError}.

766 '''

767 return obj if isiterablen(obj) else _xiterror(obj, _xiterablen) # PYCHOK None

768

769

770 def _xiterror(obj, _xwhich):

771 '''(INTERNAL) Helper for C{_xinterable} and C{_xiterablen}.

772 '''

773 t = _not_(_xwhich.__name__[2:]) # _dunder_nameof

774 raise _TypeError(repr(obj), txt=t)

775

776

777 def _xnumpy(where, *required):

778 '''(INTERNAL) Import C{numpy} and check required version.

779 '''

780 try:

781 _xpackage(_xnumpy)

782 import numpy

783 except ImportError as x:

784 raise _xImportError(x, where)

785 return _xversion(numpy, where, *required)

786

787

788 def _xor(x, *xs):

789 '''(INTERNAL) Exclusive-or C{x} and C{xs}.

790 '''

791 for x_ in xs:

792 x ^= x_

793 return x

794

795

796 def _xpackage(_xpkg):

797 '''(INTERNAL) Check dependency to be excluded.

798 '''

799 n = _xpkg.__name__[2:] # _dunder_nameof

800 if n in _XPACKAGES:

801 x = _SPACE_(n, _in_, _PYGEODESY_XPACKAGES_)

802 e = _enquote(_getenv(_PYGEODESY_XPACKAGES_, NN))

803 raise ImportError(_EQUAL_(x, e))

804

805

806 def _xscalar(**names_values):

807 '''(INTERNAL) Check all C{name=value} pairs to be C{scalar}.

808 '''

809 for n, v in names_values.items():

810 if not isscalar(v):

811 raise _TypeError(n, v, txt=_not_scalar_)

812

813

814 def _xscipy(where, *required):

815 '''(INTERNAL) Import C{scipy} and check required version.

816 '''

817 try:

818 _xpackage(_xscipy)

819 import scipy

820 except ImportError as x:

821 raise _xImportError(x, where)

822 return _xversion(scipy, where, *required)

823

824

825 def _xsubclassof(*Classes, **names_values):

826 '''(INTERNAL) Check (super) class of all C{name=value} pairs.

827

828 @arg Classes: One or more classes or types (C{class}), all

829 positional.

830 @kwarg names_values: One or more C{B{name}=value} pairs

831 with the C{value} to be checked.

832

833 @raise TypeError: One B{C{names_values}} pair is not a

834 (sub-)class of any of the B{C{Classes}}.

835 '''

836 if not (Classes and names_values):

837 raise _xAssertionError(_xsubclassof, *Classes, **names_values)

838

839 for n, v in names_values.items():

840 if not issubclassof(v, *Classes):

841 raise _TypesError(n, v, *Classes)

842

843

844 def _xversion(package, where, *required, **name):

845 '''(INTERNAL) Check the C{package} version vs B{C{required}}.

846 '''

847 if required:

848 t = _version_info(package)

849 if t[:len(required)] < required:

850 t = _SPACE_(package.__name__, # _dunder_nameof

851 _version_, _DOT_(*t),

852 _below_, _DOT_(*required),

853 _req_d_by(where, **name))

854 raise ImportError(t)

855 return package

856

857

858 def _xzip(*args, **strict): # PYCHOK no cover

859 '''(INTERNAL) Standard C{zip(..., strict=True)}.

860 '''

861 s = _xkwds_get(strict, strict=True)

862 if s:

863 if _zip is zip: # < (3, 10)

864 t = _MODS.streprs.unstr(_xzip, *args, strict=s)

865 raise _NotImplementedError(t, txt=None)

866 return _zip(*args)

867 return zip(*args)

868

869

870 if _sys_version_info2 < (3, 10): # see .errors

871 _zip = zip # PYCHOK exported

872 else: # Python 3.10+

873

874 def _zip(*args):

875 return zip(*args, strict=True)

876

877_XPACKAGES = _splituple(_getenv(_PYGEODESY_XPACKAGES_, NN).lower())

878

879# **) MIT License

880#

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

882#

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

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

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

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

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

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

889#

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

891# in all copies or substantial portions of the Software.

892#

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

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

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

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

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

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

899# OTHER DEALINGS IN THE SOFTWARE.