# Coverage for pygeodesy/errors.py : 96%

## 230 statements 221 run 9 missing 18 excluded

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 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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 | # -*- coding: utf-8 -*- u'''Errors, exceptions and exception chaining. Error, exception classes and functions to format PyGeodesy errors, including the setting of I{exception chaining} in Python 3+. By default, I{exception chaining} is turned off. To enable I{exception chaining}, use command line option C{python -X dev} or set environment variable C{PYTHONDEVMODE} to C{1} or any non-empyty string OR set environment variable C{PYGEODESY_EXCEPTION_CHAINING} to C{'std'} or any other non-empty string. ''' from pygeodesy.interns import MISSING, NN, _a_,_an_, _and_, \ _COLON_, _COMMA_, _COMMASPACE_, \ _datum_, _ellipsoidal_, _EQUAL_, \ _invalid_, _len_, _name_, _no_, \ _not_, _or_, _SPACE_, _UNDER_, __vs__ from pygeodesy.lazily import _ALL_LAZY, _env, _PYTHON_X_DEV __all__ = _ALL_LAZY.errors # _ALL_DOCS('_InvalidError', '_IsnotError') __version__ = '21.06.18' _limiterrors = True # imported by .formy _multiple_ = 'multiple' _name_value_ = repr('name=value') _rangerrors = True # imported by .dms _specified_ = 'specified' try: _exception_chaining = None # not available _ = Exception().__cause__ # Python 3+ exception chaining if _PYTHON_X_DEV or _env.get('PYGEODESY_EXCEPTION_CHAINING', NN): # == _std_ _exception_chaining = True # turned on, std raise AttributeError # allow exception chaining _exception_chaining = False # turned off def _error_chain(inst, other=None): '''(INTERNAL) Set or avoid Python 3+ exception chaining. Setting C{inst.__cause__ = None} is equivalent to syntax C{raise Error(...) from None} to avoid exception chaining. @arg inst: An error instance (C{Exception}). @kwarg other: The previous error instance (C{Exception}) or C{None} to avoid exception chaining. @see: Alex Martelli, et.al., "Python in a Nutshell", 3rd Ed., page 163, O'Reilly, 2017, U{PEP-3134<https://www.Python.org/dev/peps/pep-3134>}, U{here <https://StackOverflow.com/questions/17091520/how-can-i-more- easily-suppress-previous-exceptions-when-i-raise-my-own-exception>} and U{here<https://StackOverflow.com/questions/1350671/ inner-exception-with-traceback-in-python>}. ''' inst.__cause__ = other # None, no exception chaining return inst except AttributeError: # Python 2+ def _error_chain(inst, **unused): # PYCHOK expected return inst # no-op class _AssertionError(AssertionError): '''(INTERNAL) Format an C{AssertionError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # txt=_invalid_ _error_init(AssertionError, self, name_value, **txt_name_values) class _AttributeError(AttributeError): '''(INTERNAL) Format an C{AttributeError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # txt=_invalid_ _error_init(AttributeError, self, name_value, **txt_name_values) class _IndexError(IndexError): '''(INTERNAL) Format an C{IndexError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # txt=_invalid_ _error_init(IndexError, self, name_value, **txt_name_values) class _NameError(NameError): '''(INTERNAL) Format a C{NameError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # txt=_invalid_ _error_init(NameError, self, name_value, **txt_name_values) class _NotImplementedError(NotImplementedError): '''(INTERNAL) Format a C{NotImplementedError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # txt=_invalid_ _error_init(NotImplementedError, self, name_value, **txt_name_values) class _OverflowError(OverflowError): '''(INTERNAL) Format an C{OverflowError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # txt=_invalid_ _error_init(OverflowError, self, name_value, **txt_name_values) class _TypeError(TypeError): '''(INTERNAL) Format a C{TypeError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): _error_init(TypeError, self, name_value, fmt_name_value='type(%s) (%r)', **txt_name_values) class _TypesError(_TypeError): '''(INTERNAL) Format a C{TypeError} without exception chaining. ''' def __init__(self, name, value, *Types): t = _not_(_an(_or(*(t.__name__ for t in Types)))) _TypeError.__init__(self, name, value, txt=t) class _ValueError(ValueError): '''(INTERNAL) Format a C{ValueError} without exception chaining. ''' def __init__(self, *name_value, **txt_name_values): # name, value, txt=_invalid_ _error_init(ValueError, self, name_value, **txt_name_values) class CrossError(_ValueError): '''Error raised for zero or near-zero vectorial cross products, occurring for coincident or colinear points, paths or bearings. ''' pass class IntersectionError(_ValueError): '''Error raised for path or circle intersection issues. ''' def __init__(self, *args, **kwds): # txt=_invalid_ '''New L{IntersectionError}. ''' if args: _ValueError.__init__(self, _SPACE_(*args), **kwds) else: _ValueError.__init__(self, **kwds) class LenError(_ValueError): '''Error raised for mis-matching C{len} values. ''' def __init__(self, where, **lens_txt): # txt=None '''New L{LenError}. @arg where: Object with C{.__name__} attribute (C{class}, C{method}, or C{function}). @kwarg lens_txt: Two or more C{name=len(name)} pairs (C{keyword arguments}). ''' from pygeodesy.streprs import Fmt as _Fmt x = _xkwds_pop(lens_txt, txt=_invalid_) ns, vs = zip(*sorted(lens_txt.items())) ns = _COMMASPACE_.join(ns) vs = __vs__.join(map(str, vs)) t = _SPACE_(_Fmt.PAREN(where.__name__, ns), _len_, vs) _ValueError.__init__(self, t, txt=x) class LimitError(_ValueError): '''Error raised for lat- or longitudinal deltas exceeding the B{C{limit}} in functions L{equirectangular} and L{equirectangular_} and C{nearestOn*} and C{simplify*} functions or methods. ''' pass class NumPyError(_ValueError): '''Error raised for C{NumPy} errors. ''' pass class ParseError(_ValueError): '''Error parsing degrees, radians or several other formats. ''' pass class PointsError(_ValueError): '''Error for an insufficient number of points. ''' pass class RangeError(_ValueError): '''Error raised for lat- or longitude values outside the B{C{clip}}, B{C{clipLat}}, B{C{clipLon}} or B{C{limit}} range in function L{clipDegrees}, L{clipRadians}, L{parse3llh}, L{parseDMS}, L{parseDMS2} or L{parseRad}. @see: Function L{rangerrors}. ''' pass class SciPyError(PointsError): '''Error raised for C{SciPy} errors. ''' pass class SciPyWarning(PointsError): '''Error thrown for C{SciPy} warnings. To raise C{SciPy} warnings as L{SciPyWarning} exceptions, Python C{warnings} must be filtered as U{warnings.filterwarnings('error') <https://docs.Python.org/3/library/warnings.html#the-warnings-filter>} I{prior to} C{import scipy} or by setting environment variable U{PYTHONWARNINGS<https://docs.Python.org/3/using/cmdline.html #envvar-PYTHONWARNINGS>} or with C{python} command line option U{-W<https://docs.Python.org/3/using/cmdline.html#cmdoption-w>} as C{error}. ''' pass class TRFError(_ValueError): '''Terrestrial Reference Frame (TRF), L{Epoch}, L{RefFrame} or L{RefFrame} conversion issue. ''' pass class UnitError(_ValueError): '''Default exception for L{units} issues. ''' pass class VectorError(_ValueError): '''L{Vector3d}, C{Cartesian*} or C{*Nvector} issues. ''' pass def _an(noun): '''(INTERNAL) Prepend an article to a noun based on the pronounciation of the first letter. ''' return _SPACE_((_an_ if noun[:1].lower() in 'aeinoux' else _a_), noun) def _and(*words): '''(INTERNAL) Join C{words} with C{", "} and C{" and "}. ''' t, w = NN, list(words) if w: t = w.pop() if w: w = _COMMASPACE_.join(w) t = _SPACE_(w, _and_, t) return t def crosserrors(raiser=None): '''Report or ignore vectorial cross product errors. @kwarg raiser: Use C{True} to throw or C{False} to ignore L{CrossError} exceptions. Use C{None} to leave the setting unchanged. @return: Previous setting (C{bool}). @see: Property C{Vector3d[Base].crosserrors}. ''' from pygeodesy.vector3dBase import Vector3dBase t = Vector3dBase._crosserrors # XXX class attr! if raiser in (True, False): Vector3dBase._crosserrors = raiser return t def _datum_datum(datum1, datum2, Error=None): '''(INTERNAL) Check for datum or ellipsoid match. ''' if Error: E1, E2 = datum1.ellipsoid, datum2.ellipsoid if E1 != E2: raise Error(E2.named2, txt=_incompatible(E1.named2)) elif datum1 != datum2: t = _SPACE_(_datum_, repr(datum1.name), _not_, repr(datum2.name)) raise _AssertionError(t) def _error_init(Error, inst, name_value, fmt_name_value='%s (%r)', txt=_invalid_, **name_values): # by .lazily '''(INTERNAL) Format an error text and initialize an C{Error} instance. @arg Error: The error super-class (C{Exception}). @arg inst: Sub-class instance to be initialized (C{_Exception}). @arg name_value: Either just a value or several name, value, ... positional arguments (C{str}, any C{type}), in particular for name conflicts with keyword arguments of C{error_init} or which can't be used as C{name=value} keyword arguments. @kwarg fmt_name_value: Format for (name, value) (C{str}). @kwarg txt: Optional explanation of the error (C{str}). @kwarg name_values: One or more C{B{name}=value} pairs overriding any B{C{name_value}} positional arguments. ''' if name_values: t = _or(*sorted(fmt_name_value % t for t in name_values.items())) elif len(name_value) > 1: t = _or(*sorted(fmt_name_value % t for t in zip(name_value[0::2], name_value[1::2]))) elif name_value: t = str(name_value[0]) else: t = _SPACE_(_name_value_, str(MISSING)) if txt is None: x = NN else: x = str(txt) or _invalid_ c = _COMMA_ if _COLON_ in t else _COLON_ t = _SPACE_(t + c, x) Error.__init__(inst, t) # inst.__x_txt__ = x # hold explanation _error_chain(inst) # no Python 3+ exception chaining _error_under(inst) def _error_under(inst): '''(INTERNAL) Remove leading underscore from instance' class name. ''' n = inst.__class__.__name__ if n.startswith(_UNDER_): inst.__class__.__name__ = n.lstrip(_UNDER_) return inst def exception_chaining(error=None): '''Get the previous exception's or exception chaining setting. @kwarg error: An error instance (C{Exception}) or C{None}. @return: If C{B{error}=None}, return C{True} if exception chaining is enabled for PyGeodesy errors, C{False} if turned off and C{None} if not available. If B{C{error}} is not C{None}, return the previous, chained error or C{None} otherwise. @note: Set C{env} variable C{PYGEODESY_EXCEPTION_CHAINING} to any non-empty value prior to C{import pygeodesy} to enable exception chaining for C{pygeodesy} errors. ''' return _exception_chaining if error is None else \ getattr(error, '__cause__', None) def _incompatible(this): '''(INTERNAL) Format an incompatible text. ''' return 'incompatible with ' + str(this) def _InvalidError(Error=_ValueError, **txt_name_values): # txt=_invalid_, name=value [, ...] '''(INTERNAL) Create an C{Error} instance. @kwarg Error: The error class or sub-class (C{Exception}). @kwarg txt_name_values: One or more C{B{name}=value} pairs and optionally, a C{B{txt}=...} keyword argument to override the default C{B{txt}='invalid'} @return: An B{C{Error}} instance. ''' try: e = Error(**txt_name_values) except TypeError: # std *Error takes no keyword arguments e = _ValueError(**txt_name_values) e = Error(str(e)) _error_chain(e) _error_under(e) return e def _IsnotError(*nouns, **name_value_Error): # name=value [, Error=TypeeError] '''Create a C{TypeError} for an invalid C{name=value} type. @arg nouns: One or more expected class or type names, usually nouns (C{str}). @kwarg name_value_Error: One C{B{name}=value} pair and optionally, an C{B{Error}=...} keyword argument to override the default C{B{Error}=TypeError}. @return: A C{TypeError} or an B{C{Error}} instance. ''' from pygeodesy.streprs import Fmt as _Fmt Error = _xkwds_pop(name_value_Error, Error=TypeError) n, v = _xkwds_popitem(name_value_Error) if name_value_Error else ( _name_value_, MISSING) # XXX else tuple(...) t = _or(*nouns) or _specified_ if len(nouns) > 1: t = _an(t) e = Error(_SPACE_(n, _Fmt.PAREN(repr(v)), _not_, t)) _error_chain(e) _error_under(e) return e def limiterrors(raiser=None): '''Get/set the throwing of L{LimitError}s. @kwarg raiser: Choose C{True} to raise or C{False} to ignore L{LimitError} exceptions. Use C{None} to leave the setting unchanged. @return: Previous setting (C{bool}). ''' global _limiterrors t = _limiterrors if raiser in (True, False): _limiterrors = raiser return t def _or(*words): '''(INTERNAL) Join C{words} with C{", "} and C{" or "}. ''' t, w = NN, list(words) if w: t = w.pop() if w: w = _COMMASPACE_.join(w) t = _SPACE_(w, _or_, t) return t def _parseX(parser, *args, **name_values_Error): # name=value[, ..., Error=ParseError] '''(INTERNAL) Invoke a parser and handle exceptions. @arg parser: The parser (C{callable}). @arg args: Any parser positional arguments (any C{type}s). @kwarg name_values_Error: One or more C{B{name}=value} pairs and optionally, an C{B{Error}=...} keyword argument to override the default C{B{Error}=ParseError}. @return: Parser result. @raise ParseError: Or the specified C{B{Error}=...}. @raise RangeError: If that error occurred. ''' try: return parser(*args) except RangeError as x: t = str(x) E = type(x) _ = _xkwds_pop(name_values_Error, Error=None) except (AttributeError, IndexError, TypeError, ValueError) as x: t = str(x) E = _xkwds_pop(name_values_Error, Error=ParseError) raise _InvalidError(Error=E, txt=t, **name_values_Error) def rangerrors(raiser=None): '''Get/set the throwing of L{RangeError}s. @kwarg raiser: Choose C{True} to raise or C{False} to ignore L{RangeError} exceptions. Use C{None} to leave the setting unchanged. @return: Previous setting (C{bool}). ''' global _rangerrors t = _rangerrors if raiser in (True, False): _rangerrors = raiser return t def _SciPyIssue(x, *extras): # PYCHOK no cover if isinstance(x, (RuntimeWarning, UserWarning)): X = SciPyWarning else: X = SciPyError # PYCHOK not really t = _SPACE_(str(x).strip(), *extras) return _error_chain(X(t), other=x) def _xellipsoidal(**name_value): '''(INTERNAL) Check an I{ellipsoidal} item. @return: The B{C{value}} if ellipsoidal. @raise TypeError: Not ellipsoidal B{C{value}}. ''' try: for n, v in name_value.items(): if v.isEllipsoidal: return v break else: n = v = MISSING except AttributeError: pass raise _TypeError(n, v, txt=_not_(_ellipsoidal_)) def _xError(x, **kwds): '''(INTERNAL) Embellish an exception. @arg x: The exception instance (usually, C{_Error}). @arg kwds: Embelishments (C{any}). ''' X = x.__class__ t = str(x) try: # C{_Error} style return X(txt=t, **kwds) except TypeError: # no keyword arguments pass # not an C{_Error}, format as C{_Error} return X(str(_ValueError(txt=t, **kwds))) try: _ = {}.__or__ # {} | {} # Python 3.9+ def _xkwds(kwds, **dflts): '''(INTERNAL) Override C{dflts} with specified C{kwds}. ''' return (dflts | kwds) if kwds else dflts except AttributeError: from copy import copy as _copy def _xkwds(kwds, **dflts): # PYCHOK expected '''(INTERNAL) Override C{dflts} with specified C{kwds}. ''' d = dflts if kwds: d = _copy(d) d.update(kwds) return d def _xkwds_Error(_xkwds_func, kwds, name_txt, txt='default'): # Helper for _xkwds_get and _xkwds_pop below from pygeodesy.streprs import Fmt, pairs f = _COMMASPACE_.join(pairs(kwds) + pairs(name_txt)) f = Fmt.PAREN(_xkwds_func.__name__, f) t = _multiple_ if name_txt else _no_ t = _SPACE_(t, _EQUAL_(_name_, txt), 'kwargs') return _AssertionError(f, txt=t) def _xkwds_get(kwds, **name_default): '''(INTERNAL) Get a C{kwds} value by C{name}, or the C{default}. ''' if len(name_default) == 1: for n, d in name_default.items(): return kwds.get(n, d) raise _xkwds_Error(_xkwds_get, kwds, name_default) def _xkwds_not(*args, **kwds): '''(INTERNAL) Return C{kwds} with a value not in C{args}. ''' return dict((n, v) for n, v in kwds.items() if v not in args) def _xkwds_pop(kwds, **name_default): '''(INTERNAL) Pop a C{kwds} value by C{name}, or the C{default}. ''' if len(name_default) == 1: return kwds.pop(*name_default.popitem()) raise _xkwds_Error(_xkwds_pop, kwds, name_default) def _xkwds_popitem(name_value): '''(INTERNAL) Return exactly one C{(name, value)} item. ''' t = name_value.popitem() # XXX AttributeError, KeyError if not name_value: # must be empty return t raise _xkwds_Error(_xkwds_popitem, (t,), name_value, txt='value') # **) MIT License # # Copyright (C) 2016-2021 -- 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.