pygeodesy 25.4.8__py2.py3-none-any.whl → 25.4.25__py2.py3-none-any.whl

pygeodesy/karney.py

@@ -143,18 +143,19 @@ in C{pygeodesy} are based on I{Karney}'s post U{Area of a spherical polygon
 # make sure int/int division yields float quotient, see .basics
 from __future__ import division as _; del _  # PYCHOK semicolon
 
-from pygeodesy.basics import _copysign, isint, neg, unsigned0, \
+from pygeodesy.basics import _copysign, _isin, isint, neg, unsigned0, \
                              _xgeographiclib, _zip
 from pygeodesy.constants import NAN, _isfinite as _math_isfinite, _0_0, \
                                _1_16th, _1_0, _2_0, _180_0, _N_180_0, _360_0
 from pygeodesy.errors import GeodesicError, _ValueError, _xkwds
 from pygeodesy.fmath import cbrt, fremainder, norm2  # Fhorner, Fsum
-from pygeodesy.internals import _getenv, _popen2, _PYGEODESY, _version_info
+from pygeodesy.internals import _getenv, _popen2, _PYGEODESY_ENV, typename, \
+                                _version_info
 from pygeodesy.interns import NN, _a12_, _area_, _azi1_, _azi2_, _azi12_, \
                              _composite_, _lat1_, _lat2_, _lon1_, _lon2_, \
                              _m12_, _M12_, _M21_, _number_, _s12_, _S12_, \
                              _SPACE_, _UNDER_, _X_, _1_, _2_,  _BAR_  # PYCHOK used!
-from pygeodesy.lazily import _ALL_DOCS, _ALL_LAZY, _ALL_MODS as _MODS
+from pygeodesy.lazily import _ALL_DOCS, _ALL_LAZY, _ALL_MODS as _MODS, _FOR_DOCS
 from pygeodesy.named import ADict, _NamedBase, _NamedTuple, notImplemented, _Pass
 from pygeodesy.props import deprecated_method, Property_RO, property_RO, \
                                                property_ROnce
@@ -165,10 +166,10 @@ from pygeodesy.utily import atan2d, sincos2d, tand, _unrollon,  fabs
 # from math import fabs  # from .utily
 
 __all__ = _ALL_LAZY.karney
-__version__ = '25.04.08'
+__version__ = '25.04.14'
 
 _2_4_       = '2.4'
-_K_2_0      = _getenv(_PYGEODESY(_xgeographiclib, 1), _2_)
+_K_2_0      = _getenv(_PYGEODESY_ENV(typename(_xgeographiclib)[2:]), _2_)
 _K_2_4      = _K_2_0 ==  _2_4_
 _K_2_0      = _K_2_4 or (_K_2_0 == _2_)
 _perimeter_ = 'perimeter'
@@ -216,7 +217,38 @@ class Area3Tuple(_NamedTuple):  # in .geodesicx.gxarea
 
 
 class Caps(object):
-    '''(INTERNAL) Overriden by C{Caps} below.
+    '''I{Enum}-style masks to be bit-C{or}'ed to specify C{geodesic}, C{rhumb}
+       or C{-lines} capabilities (C{caps}) and method results (C{outmask}).
+
+       C{AREA} - compute the area C{S12},
+
+       C{AZIMUTH} - include azimuths C{azi1} and C{azi2},
+
+       C{DISTANCE} - compute distance C{s12} and angular distance C{a12},
+
+       C{DISTANCE_IN} - allow distance C{s12} in method C{.Direct},
+
+       C{EMPTY} - nothing, formerly aka C{NONE},
+
+       C{GEODESICSCALE} - compute geodesic scales C{M12} and C{M21},
+
+       C{LATITUDE} - compute latitude C{lat2},
+
+       C{LINE_OFF} - Line without updates from parent C{geodesic} or C{rhumb}.
+
+       C{LONGITUDE} - compute longitude C{lon2},
+
+       C{LONG_UNROLL} - unroll C{lon2} in method C{.Direct},
+
+       C{REDUCEDLENGTH} - compute the reduced length C{m12},
+
+       C{REVERSE2} - reverse azimuth C{azi2} by 180 degrees,
+
+       and C{ALL} - all of the above.
+
+       C{STANDARD} = C{AZIMUTH | DISTANCE | LATITUDE | LONGITUDE}
+
+       C{LINE_CAPS} = C{STANDARD | DISTANCE_IN | REDUCEDLENGTH | GEODESICSCALE}
     '''
     EMPTY         =  0        # formerly aka NONE
     _CAP_1        =  1 << 0   # for goedesici/-w
@@ -224,6 +256,8 @@ class Caps(object):
     _CAP_2        =  1 << 2
     _CAP_3        =  1 << 3   # for goedesici/-w
     _CAP_4        =  1 << 4   # for goedesicw
+#                 =  1 << 5   # unused
+#                 =  1 << 6   # unused
     _CAP_ALL      =  0x1F
 #   _CAP_MASK     = _CAP_ALL
     LATITUDE      =  1 << 7   # compute latitude C{lat2}
@@ -235,25 +269,21 @@ class Caps(object):
     GEODESICSCALE =  1 << 13 | _CAP_1 | _CAP_2  # compute geodesic scales C{M12} and C{M21}
     AREA          =  1 << 14 | _CAP_4  # compute area C{S12}
 
-    STANDARD      =  AZIMUTH | DISTANCE | LATITUDE | LONGITUDE
-
-    _DIRECT3      =  AZIMUTH  | LATITUDE | LONGITUDE  # for goedesicw only
-    _INVERSE3     =  AZIMUTH  | DISTANCE  # for goedesicw only
-    _STD          =  STANDARD  # for goedesicw only
-    _STD_LINE     = _STD      | DISTANCE_IN  # for goedesici/-w
+    STANDARD      =  AZIMUTH  | DISTANCE | LATITUDE | LONGITUDE
+    STANDARD_LINE =  STANDARD | DISTANCE_IN  # for goedesici/-w
 
-    LINE_CAPS     = _STD_LINE | REDUCEDLENGTH | GEODESICSCALE  # .geodesici only
+    LINE_CAPS     =  STANDARD_LINE | REDUCEDLENGTH | GEODESICSCALE  # .geodesici only
     LONG_UNROLL   =  1 << 15  # unroll C{lon2} in .Direct and .Position
 #                 =  1 << 16  # unused
     LINE_OFF      =  1 << 17  # Line without updates from parent geodesic or rhumb
     REVERSE2      =  1 << 18  # reverse C{azi2}
     ALL           =  0x7F80 | _CAP_ALL  # without LONG_UNROLL, LINE_OFF, REVERSE2 and _DEBUG_*
 
-    LATITUDE_LONGITUDE         = LATITUDE | LONGITUDE
-    LATITUDE_LONGITUDE_AREA    = LATITUDE | LONGITUDE | AREA
+    AZIMUTH_DISTANCE        = AZIMUTH | DISTANCE
+    AZIMUTH_DISTANCE_AREA   = AZIMUTH | DISTANCE | AREA
 
-    AZIMUTH_DISTANCE           = AZIMUTH | DISTANCE
-    AZIMUTH_DISTANCE_AREA      = AZIMUTH | DISTANCE | AREA
+    LATITUDE_LONGITUDE      = LATITUDE | LONGITUDE
+    LATITUDE_LONGITUDE_AREA = LATITUDE | LONGITUDE | AREA
 
     _SALP_CALPs_   =  1 << 19  # (INTERNAL) GeodesicExact._GenInverse
 
@@ -264,6 +294,9 @@ class Caps(object):
     _DEBUG_ALL     = _DEBUG_AREA | _DEBUG_DIRECT | _DEBUG_INVERSE | \
                      _DEBUG_LINE | _SALP_CALPs_
 
+    _DIRECT3       =  AZIMUTH  | LATITUDE | LONGITUDE  # for goedesicw only
+    _INVERSE3      =  AZIMUTH  | DISTANCE  # for goedesicw only
+
     _OUT_ALL       =  ALL  # see geographiclib.geodesiccapabilities.py
     _OUT_MASK      =  ALL | LONG_UNROLL | REVERSE2 | _DEBUG_ALL
 
@@ -277,7 +310,7 @@ class Caps(object):
     def items(self):
         '''Yield all I{public} C{Caps} as 2-tuple C{(NAME, mask)}.
         '''
-        for n, C in Caps.__class__.__dict__.items():
+        for n, C in type(self).__dict__.items():
             if isint(C) and not n.startswith(_UNDER_) \
                         and n.replace(_UNDER_, NN).isupper():
                 yield n, C
@@ -289,37 +322,10 @@ class Caps(object):
                         if C and (Cask & C) == C)  # and int1s(C) <= 3
         return sep.join(s) if sep else tuple(s)
 
-Caps = Caps()  # PYCHOK singleton
-'''I{Enum}-style masks to be bit-C{or}'ed to specify geodesic or
-rhumb capabilities (C{caps}) and results (C{outmask}).
-
-C{AREA} - compute area C{S12},
-
-C{AZIMUTH} - include azimuths C{azi1} and C{azi2},
-
-C{DISTANCE} - compute distance C{s12} and angular distance C{a12},
-
-C{DISTANCE_IN} - allow distance C{s12} in C{.Direct},
-
-C{EMPTY} - nothing, formerly aka C{NONE},
-
-C{GEODESICSCALE} - compute geodesic scales C{M12} and C{M21},
-
-C{LATITUDE} - compute latitude C{lat2},
-
-C{LINE_OFF} - Line without updates from parent geodesic or rhumb.
-
-C{LONGITUDE} - compute longitude C{lon2},
-
-C{LONG_UNROLL} - unroll C{lon2} in C{.Direct},
-
-C{REDUCEDLENGTH} - compute reduced length C{m12},
-
-C{REVERSE2} - reverse C{azi2},
-
-and C{ALL} - all of the above.
-
-C{STANDARD} = C{AZIMUTH | DISTANCE | DISTANCE_IN | LATITUDE | LONGITUDE}'''
+if _FOR_DOCS:  # PYCHOK force ...
+    pass  # ... CAPS.__doc__ into epydoc
+else:
+    Caps = Caps()  # PYCHOK singleton
 
 _key2Caps = dict(a12 =Caps.DISTANCE,  # in GDict._unCaps
                  azi2=Caps.AZIMUTH,
@@ -349,7 +355,7 @@ class _CapsBase(_NamedBase):  # in .auxilats, .geodesicx.gxbases
     LONG_UNROLL   = Caps.LONG_UNROLL
     REDUCEDLENGTH = Caps.REDUCEDLENGTH
     STANDARD      = Caps.STANDARD
-    _STD_LINE     = Caps._STD_LINE  # for geodesici
+    STANDARD_LINE = Caps.STANDARD_LINE  # for geodesici
 
     _caps         = 0  # None
     _debug        = 0  # or Caps._DEBUG_...
@@ -363,11 +369,11 @@ class _CapsBase(_NamedBase):  # in .auxilats, .geodesicx.gxbases
     def caps_(self, caps):
         '''Check the available capabilities.
 
-           @arg caps: Bit-or'ed combination of L{Caps} values
-                      for all capabilities to be checked.
+           @arg caps: Bit-or'ed combination of L{Caps<pygeodesy.karney.Caps>}
+                      values for all capabilities to be checked.
 
-           @return: C{True} if I{all} B{C{caps}} are available,
-                    C{False} otherwise (C{bool}).
+           @return: C{True} if I{all} B{C{caps}} are available, C{False}
+                    otherwise (C{bool}).
         '''
         caps &= Caps._OUT_ALL
         return (self.caps & caps) == caps
@@ -538,7 +544,7 @@ class Inverse10Tuple(_GTuple):
 
 
 class _kWrapped(object):  # in .geodesicw
-    ''''(INTERNAL) Wrapper for some of I{Karney}'s U{geographiclib
+    '''(INTERNAL) Wrapper for some of I{Karney}'s U{geographiclib
         <https://PyPI.org/project/geographiclib>} classes.
     '''
 
@@ -548,7 +554,7 @@ class _kWrapped(object):  # in .geodesicw
            <https://PyPI.org/project/geographiclib>} package is installed,
            otherwise raise a C{LazyImportError}.
         '''
-        g = _xgeographiclib(self.__class__.__module__, 1, 49)
+        g = _xgeographiclib(type(self).__module__, 1, 49)
         from geographiclib.geodesic import Geodesic
         g.Geodesic = Geodesic
         from geographiclib.geodesicline import GeodesicLine
@@ -674,9 +680,9 @@ class _Xables(object):
         return NN
 
     def _path(self, which, *dir_):
-        self.ENV = E = _PYGEODESY(which)
-        return _getenv(E, NN) or \
-               (NN(dir_[0], which.__name__) if dir_ else E)
+        n = typename(which, which)
+        self.ENV = E = _PYGEODESY_ENV(n)
+        return _getenv(E, NN) or (NN(dir_[0], n) if dir_ else E)
 
     def X_not(self, path):
         return 'env %s=%r not executable' % (self.ENV, path)
@@ -754,7 +760,7 @@ def _diff182(deg0, deg, K_2_0=False):
             d, t = _sum2(_r(-deg0, _360),
                          _r( deg,  _360))
             d, t = _sum2(_r( d,    _360), t)
-            if d in (_0_0, _180_0, _N_180_0):
+            if _isin(d, _0_0, _180_0, _N_180_0):
                 d = _copysign(d, -t if t else (deg - deg0))
         else:
             _n = _norm180
@@ -819,7 +825,7 @@ def _norm180(deg):  # mimick geomath.Math.AngNormalize
         return _wrapped.Math.AngNormalize(deg)
     except AttributeError:
         d = fremainder(deg, _360_0)
-        if d in (_180_0, _N_180_0):
+        if _isin(d, _180_0, _N_180_0):
             d = _copysign(_180_0, deg) if _K_2_0 else _180_0
         return d
 
@@ -1036,7 +1042,7 @@ def _unsigned2(x):
     return (neg(x), True) if _signBit(x) else (x, False)
 
 
-__all__ += _ALL_DOCS(_CapsBase)
+__all__ += _ALL_DOCS(Caps, _CapsBase)
 
 # **) MIT License
 #

pygeodesy/ktm.py

@@ -42,7 +42,7 @@ U{GeographicLib<https://GeographicLib.SourceForge.io>} documentation.
 # make sure int/int division yields float quotient
 from __future__ import division as _; del _  # PYCHOK semicolon
 
-from pygeodesy.basics import copysign0, isodd, neg, neg_, \
+from pygeodesy.basics import copysign0, _isin, isodd, neg, neg_, \
                             _reverange, _xinstanceof
 from pygeodesy.constants import INF, _K0_UTM, PI, PI_2, _0_0s, _0_0, \
                                _1_0, _90_0, _copysignINF
@@ -50,7 +50,7 @@ from pygeodesy.datums import Datum, _spherical_datum, _WGS84,  _EWGS84
 # from pygeodesy.ellipsoids import _EWGS84  # from .datums
 from pygeodesy.errors import _ValueError, _xkwds_pop2, _Xorder
 from pygeodesy.fmath import fdot_, hypot, hypot1
-from pygeodesy.interns import _COMMASPACE_, _singular_
+from pygeodesy.interns import _COMMASPACE_, _DMAIN_, _singular_
 from pygeodesy.karney import _atan2d, _diff182, _fix90, _norm180, \
                              _polynomial, _unsigned2
 # from pygeodesy.lazily import _ALL_LAZY  # from .named
@@ -66,7 +66,7 @@ from cmath import polar
 from math import asinh, cos, cosh, degrees, fabs, sin, sinh, sqrt, tanh
 
 __all__ = _ALL_LAZY.ktm
-__version__ = '24.11.24'
+__version__ = '25.04.14'
 
 
 class KTMError(_ValueError):
@@ -141,7 +141,7 @@ class KTransverseMercator(_NamedBase):
 
         if f is not None:
             self.ellipsoid = a_earth, f
-        elif a_earth in (_EWGS84, _WGS84, None):
+        elif _isin(a_earth, None, _EWGS84, _WGS84):
             pass
         elif isinstance(a_earth, Datum):
             self.datum = a_earth
@@ -603,7 +603,7 @@ _BetCoeffs = {  # Generated by Maxima on 2015-05-14 22:55:13-04:00
 
 assert set(_AlpCoeffs.keys()) == set(_BetCoeffs.keys())
 
-if __name__ == '__main__':
+if __name__ == _DMAIN_:
 
     from pygeodesy.internals import _usage
     from sys import argv, exit as _exit

pygeodesy/latlonBase.py

@@ -10,7 +10,7 @@ u'''(INTERNAL) Base class L{LatLonBase} for all elliposiodal, spherical and N-ve
       U{RhumbLine<https://GeographicLib.SourceForge.io/C++/doc/classGeographicLib_1_1RhumbLine.html>} classes.
 '''
 
-from pygeodesy.basics import isstr, map1, _xinstanceof,  _passarg
+from pygeodesy.basics import _isin, isstr, map1, _xinstanceof
 from pygeodesy.constants import EPS, EPS0, EPS1, EPS4, INT0, R_M, \
                                _EPSqrt as _TOL, _0_0, _0_5, _1_0, \
                                _360_0, _umod_360
@@ -22,13 +22,8 @@ from pygeodesy.errors import _AttributeError, IntersectionError, \
                              _ValueError, _xattr, _xdatum, _xError, \
                              _xkwds, _xkwds_get, _xkwds_item2, _xkwds_not
 # from pygeodesy.fmath import favg  # _MODS
-# from pygeodesy.formy import antipode, compassAngle, cosineAndoyerLambert_, \
-#                             cosineForsytheAndoyerLambert_, cosineLaw, \
-#                             equirectangular, euclidean, flatLocal_, \
-#                             flatPolar, _hartzell, haversine, isantipode, \
-#                             _isequalTo, isnormal, normal, philam2n_xyz, \
-#                             thomas_, vincentys  # as _formy
-# from pygeodesy.internals import _passarg  # from .basics
+# from pygeodesy import formy as _formy  # .MODS.into
+from pygeodesy.internals import _passarg, typename
 from pygeodesy.interns import NN, _COMMASPACE_, _concentric_, _height_, \
                              _intersection_, _LatLon_, _m_, _negative_, \
                              _no_, _overlap_, _too_,  _point_  # PYCHOK used!
@@ -53,13 +48,13 @@ from contextlib import contextmanager
 from math import asin, cos, degrees, fabs, radians
 
 __all__ = _ALL_LAZY.latlonBase
-__version__ = '24.12.31'
+__version__ = '25.04.21'
 
 _formy = _MODS.into(formy=__name__)
 
 
 class LatLonBase(_NamedBase, _NamedLocal):
-    '''(INTERNAL) Base class for ellipsoidal and spherical C{LatLon}s.
+    '''(INTERNAL) Base class for ellipsoidal and spherical C{satLon}s.
     '''
     _clipid = INT0  # polygonal clip, see .booleans
     _datum  = None  # L{Datum}, to be overriden
@@ -532,7 +527,7 @@ class LatLonBase(_NamedBase, _NamedLocal):
                  L{haversineTo}, L{thomasTo} and L{vincentysTo} and U{local, flat Earth
                  approximation<https://www.edwilliams.org/avform.htm#flat>}.
         '''
-        r = radius if radius in (None, R_M, _1_0, 1) else Radius(radius)
+        r = radius if _isin(radius, None, R_M, _1_0, 1) else Radius(radius)
         return self._distanceTo_(_formy.flatLocal_, other, radius=r, **wrap)  # PYCHOK kwargs
 
     hubenyTo = flatLocalTo  # for Karl Hubeny
@@ -710,7 +705,7 @@ class LatLonBase(_NamedBase, _NamedLocal):
         else:
             hp = hq = Height(height)
 
-#       n = self.name or unused.__name__
+#       n = self.name or typename(unused)
         p = q = self.classof(P.lat2, P.lon2, datum=g_or_r.datum, height=hp)  # name=n
         p._iteration = P.iteration
         if P is not Q:
@@ -1321,10 +1316,11 @@ class LatLonBase(_NamedBase, _NamedLocal):
         if E:
             for p in (p, c):
                 e = _xattr(p, Ecef=None)
-                if e not in (None, E):  # PYCHOK no cover
+                if not _isin(e, None, E):  # PYCHOK no cover
                     n, _ = _xkwds_item2(name_point)
-                    n = Fmt.INDEX(n, i)
-                    raise _ValueError(n, e, txt=_incompatible(E.__name__))  # txt__
+                    n =  Fmt.INDEX(n, i)
+                    t = _incompatible(typename(E))
+                    raise _ValueError(n, e, txt=t)  # txt__
         return c
 
     def toDatum(self, datum2, height=None, **name):
@@ -1344,13 +1340,13 @@ class LatLonBase(_NamedBase, _NamedLocal):
 
            @raise EcefError: A C{.datum} or an ECEF issue.
         '''
-        return self._ecef9 if height in (None, self.height) else \
+        return self._ecef9 if _isin(height, None, self.height) else \
                self._Ecef_forward(self.lat, self.lon, height=height, M=M)
 
     @deprecated_method
     def to3llh(self, height=None):  # PYCHOK no cover
         '''DEPRECATED, use property L{latlonheight} or C{latlon.to3Tuple(B{height})}.'''
-        return self.latlonheight if height in (None, self.height) else \
+        return self.latlonheight if _isin(height, None, self.height) else \
                self.latlon.to3Tuple(height)
 
     def toNormal(self, deep=False, **name):
@@ -1666,7 +1662,7 @@ def _trilaterate5(p1, d1, p2, d2, p3, d3, area=True, eps=EPS1, radius=R_M, wrap=
         return Trilaterate5Tuple(float(r), p, float(m), p, 0)
 
     n, f = (_overlap_, max) if area else (_intersection_, min)
-    t = _COMMASPACE_(_no_(n), '%s %.3g' % (f.__name__, m))
+    t = _COMMASPACE_(_no_(n), '%s %.3g' % (typename(f), m))
     raise IntersectionError(area=area, eps=eps, wrap=wrap, txt=t)