Package pygeodesy :: Module errors
[frames] | no frames]

Module errors

Errors, exceptions, exception formatting and exception chaining.

Error, exception classes and functions to format PyGeodesy errors, including the setting of exception chaining in Python 3+.

By default, exception chaining is turned off. To enable exception chaining, use command line option python -X dev OR set env variable PYTHONDEVMODE=1 or to any non-empyty string OR set env variable PYGEODESY_EXCEPTION_CHAINING=std or to any non-empty string.


Version: 23.12.02

Classes
  AuxError
A rhumb.aux_ Aux, AuxDLat or AuxLat issue.
  ClipError
Clip box or clip region issue.
  CrossError
Error raised for zero or near-zero vectorial cross products, occurring for coincident or colinear points, lines or bearings.
  GeodesicError
Error raised for pygeodesy.geodesicx lack of convergence or other pygeodesy.geodesicx or pygeodesy.karney issues.
  IntersectionError
Error raised for line or circle intersection issues.
  LenError
Error raised for mis-matching len values.
  LimitError
Error raised for lat- or longitudinal values or deltas exceeding the given limit in functions pygeodesy.equirectangular, pygeodesy.equirectangular_, nearestOn* and simplify* or methods with limit or options keyword arguments.
  MGRSError
Military Grid Reference System (MGRS) parse or other Mgrs issue.
  NumPyError
Error raised for NumPy issues.
  ParseError
Error parsing degrees, radians or several other formats.
  PointsError
Error for an insufficient number of points.
  RangeError
Error raised for lat- or longitude values outside the clip, clipLat, clipLon in functions pygeodesy.parse3llh, pygeodesy.parseDMS, pygeodesy.parseDMS2 and pygeodesy.parseRad or the given limit in functions pygeodesy.clipDegrees and pygeodesy.clipRadians.
  RhumbError
A pygeodesy.rhumb.aux_, pygeodesy.rhumb.ekx or pygeodesy.rhumb.solve issue.
  TriangleError
Error raised for triangle, inter- or resection issues.
  SciPyError
Error raised for SciPy issues.
  SciPyWarning
Error thrown for SciPy warnings.
  TRFError
Terrestrial Reference Frame (TRF), Epoch, RefFrame or RefFrame conversion issue.
  UnitError
Default exception for units issues for a value exceeding the low or high limit.
  VectorError
Vector3d, Cartesian* or *Nvector issues.
Functions
 
crosserrors(raiser=None)
Report or ignore vectorial cross product errors.
 
exception_chaining(error=None)
Get an error's cause or the exception chaining setting.
 
isError(obj)
Check a (caught) exception.
 
itemsorted(adict, *args, **asorted_reverse)
Return the items of adict sorted alphabetically, case-insensitively and in ascending order.
 
limiterrors(raiser=None)
Get/set the throwing of LimitErrors.
 
rangerrors(raiser=None)
Get/set the throwing of RangeErrors.
Variables
  __all__ = _ALL_LAZY.errors
Function Details

crosserrors (raiser=None)

 

Report or ignore vectorial cross product errors.

Arguments:
  • raiser - Use True to throw or False to ignore CrossError exceptions. Use None to leave the setting unchanged.
Returns:
Previous setting (bool).

See Also: Property Vector3d[Base].crosserrors.

exception_chaining (error=None)

 

Get an error's cause or the exception chaining setting.

Arguments:
  • error - An error instance (Exception) or None.
Returns:
If error is None, return True if exception chaining is enabled for PyGeodesy errors, False if turned off and None if not available. If error is not None, return it's error cause or None.

Note: To enable exception chaining for pygeodesy errors, set env var PYGEODESY_EXCEPTION_CHAINING to any non-empty value prior to import pygeodesy.

isError (obj)

 

Check a (caught) exception.

Arguments:
  • obj - The exception C({Exception}).
Returns:
True if obj is a pygeodesy error, False if obj is a standard Python error of None if neither.

itemsorted (adict, *args, **asorted_reverse)

 

Return the items of adict sorted alphabetically, case-insensitively and in ascending order.

Arguments:
  • args - Optional argument(s) for method adict.items(B*{args}).
  • asorted_reverse - Use keyword argument asorted=False for case-sensitive sorting and reverse=True for results in descending order.

limiterrors (raiser=None)

 

Get/set the throwing of LimitErrors.

Arguments:
  • raiser - Choose True to raise or False to ignore LimitError exceptions. Use None to leave the setting unchanged.
Returns:
Previous setting (bool).

rangerrors (raiser=None)

 

Get/set the throwing of RangeErrors.

Arguments:
  • raiser - Choose True to raise or False to ignore RangeError exceptions. Use None to leave the setting unchanged.
Returns:
Previous setting (bool).