Coverage for pygeodesy/interns.py: 97%
450 statements
« prev ^ index » next coverage.py v7.2.2, created at 2024-05-02 14:35 -0400
« prev ^ index » next coverage.py v7.2.2, created at 2024-05-02 14:35 -0400
1# -*- coding: utf-8 -*-
3u'''Single C{str}ing constants, C{intern}'ed across C{pygeodesy}
4modules and function L{pygeodesy.machine}.
5'''
6import sys as _sys
7try:
8 _intern = intern # PYCHOK in .lazily
9except NameError: # Python 3+
10 _intern = _sys.intern
12_COMMASPACE_ = ', ' # overriden below
13_pf2List = [] # cached _platform2 list
14_Py3List = [] # cached _pythonarchine list
16_sub_packages = 'auxilats', 'deprecated', 'geodesicx', 'rhumb' # PYCHOK in .lazily,
17# ... make._dist, MANIFEST, setup.setup, test.bases, test.testModules
20class _Dash(str):
21 '''(INTERNAL) Extended C{str} for prefix_DASH_.
22 '''
23 def __call__(self, *args):
24 '''Join C{self} plus all B{C{args}} like C{'-'.join((self,) + B{args})}.
25 '''
26 return _DASH_(self, *args) # re-callable
29class _Int(int):
30 '''(INTERNAL) Unique C{int}.
31 '''
32 pass
35class Str_(str):
36 '''Extended, I{callable} C{str} class, not nameable.
38 @see: Nameable and callable class L{pygeodesy.Str}.
39 '''
40 def join_(self, *args):
41 '''Join all positional B{C{args}} like C{self.join(B{args})}.
43 @return: All B{C{args}} joined by this instance (L{Str_}).
45 @note: An other L{Str_} instance is returned to make the
46 result re-callable.
47 '''
48 return Str_(str.join(self, map(str, args))) # re-callable
50 __call__ = join_
52NN = Str_('') # PYCHOK Nomen Nescio <https://Wiktionary.org/wiki/N.N.>
55class _Prefix(Str_):
56 '''(INTERNAL) Extended C{str} for prefix.
57 '''
58 def __call__(self, *args):
59 '''Join C{self} plus all B{C{args}} like C{" ".join((self,) + B{args})}.
60 '''
61 return _SPACE_.join_(self, *args) # re-callable
64class _PyPy__(str): # overwritten by singleton below
65 '''(INTERNAL) Extended C{str} for C{"PyPy"} and version.
66 '''
67 def __call__(self, version=NN):
68 '''Return C{"PyPy <version>"} or C{NN}.
69 '''
70 v = version or _sys.version
71 if _PyPy__ in v:
72 v = v.split(_PyPy__)[1].split(None, 1)[0] # == _DOT_.join(_sys.pypy_version_info[:3])
73 return NN(_PyPy__, v)
74 else:
75 return NN
78class _Python_(str): # overwritten by singleton below
79 '''(INTERNAL) Extended C{str} for C{"Python"} and version.
80 '''
81 def __call__(self, version=NN):
82 '''Return C{"Python <version>"}.
83 '''
84 v = version or _sys.version
85 return _SPACE_(self, v.split(None, 1)[0])
88class _Range(str):
89 '''(INTERNAL) Extended C{str} for C{range} strings.
90 '''
91 def __call__(self, lo, hi, lopen=False, ropen=False,
92 prec=0, sep=_COMMASPACE_):
93 '''Return the range as C{"(lo, hi)"}, C{"(lo, hi]"},
94 C{"[lo, hi)"} or C{"[lo, hi]"}.
95 '''
96 from pygeodesy.streprs import Fmt
97 r = NN(Fmt.f(lo, prec=prec), sep,
98 Fmt.f(hi, prec=prec))
99 f = (Fmt.PAREN if ropen else Fmt.LOPEN) if lopen else \
100 (Fmt.ROPEN if ropen else Fmt.SQUARE)
101 return f(r)
104class _Slicer(str):
105 '''(INTERNAL) String slicer C{.fromX} or C{.tillY}.
106 '''
107 def __getattr__(self, name): # .fromX, .tillY
108 n = len(name) - 4
109 if n > 0:
110 # assert len('till') == len(_from_) == 4
111 if name.startswith('till'):
112 i = self.find(name[4:])
113 return self if i < 0 else _Slicer(self[:i + n])
114 elif name.startswith(_from_):
115 i = self.find(name[4:])
116 return self if i < 0 else _Slicer(self[i:])
117 return str.__getattr__(self, name) # PYCHOK no cover
120class MISSING(object):
121 '''(INTERNAL) Singleton C{str}.
122 '''
123 def toRepr(self, **unused):
124 return self.__class__.__name__
126 __repr__ = __str__ = toStr = toRepr
128MISSING = MISSING() # PYCHOK singleton
129MISSING.__name__ = str(MISSING)
131# __DUNDER__-style names would get mangled in classes
132_0_ = '0' # PYCHOK 'zero'
133_0to9_ = '0123456789' # PYCHOK OK
134_1_ = '1' # PYCHOK OK
135_2_ = '2' # PYCHOK OK
136_3_ = '3' # PYCHOK OK
137_4_ = '4' # PYCHOK OK
138_a_ = 'a' # PYCHOK OK
139_A_ = 'A' # PYCHOK OK
140_a12_ = 'a12' # PYCHOK OK
141_area_ = 'area' # PYCHOK OK
142_Airy1830_ = 'Airy1830' # PYCHOK OK
143_AiryModified_ = 'AiryModified' # PYCHOK OK
144_ambiguous_ = 'ambiguous' # PYCHOK OK
145_AMPERSAND_ = Str_('&') # PYCHOK OK
146_an_ = 'an' # PYCHOK OK
147_and_ = 'and' # PYCHOK OK
148# _AND_ = _AMPERSAND_ # PYCHOK OK
149_angle_ = 'angle' # PYCHOK OK
150_antipodal_ = 'antipodal' # PYCHOK OK
151_areaOf_ = 'areaOf' # PYCHOK OK
152_arg_ = 'arg' # PYCHOK OK
153# _ASTERISK_ = _STAR_ # PYCHOK OK
154_at_ = 'at' # PYCHOK OK
155_AT_ = Str_('@') # PYCHOK OK
156_AtoZnoIO_ = _Slicer('ABCDEFGHJKLMNPQRSTUVWXYZ') # PYCHOK in .gars, .mgrs and .wgrs
157_attribute_ = 'attribute' # PYCHOK OK
158_azi1_ = 'azi1' # PYCHOK OK
159_azi12_ = 'azi12' # PYCHOK OK
160_azi2_ = 'azi2' # PYCHOK OK
161_azimuth_ = 'azimuth' # PYCHOK OK
162_b_ = 'b' # PYCHOK OK
163_B_ = 'B' # PYCHOK OK
164_BACKSLASH_ = Str_('\\') # PYCHOK OK
165_band_ = 'band' # PYCHOK OK
166_BANG_ = Str_('!') # PYCHOK OK
167_BAR_ = Str_('|') # PYCHOK OK
168_bearing_ = 'bearing' # PYCHOK OK
169_Bessel1841_ = 'Bessel1841' # PYCHOK OK
170_beta_ = 'beta' # PYCHOK OK
171_by_ = 'by' # PYCHOK OK
172_c_ = 'c' # PYCHOK OK
173_C_ = 'C' # PYCHOK OK
174_cartesian_ = 'cartesian' # PYCHOK OK
175_center_ = 'center' # PYCHOK OK
176# _CIRCUMFLEX_ = Str_('^') # PYCHOK OK
177_Clarke1866_ = 'Clarke1866' # PYCHOK OK
178_Clarke1880IGN_ = 'Clarke1880IGN' # PYCHOK OK
179_clip_ = 'clip' # PYCHOK OK
180_clipid_ = 'clipid' # PYCHOK OK
181_coincident_ = 'coincident' # PYCHOK OK
182_colinear_ = 'colinear' # PYCHOK OK
183_COLON_ = Str_(':') # PYCHOK OK
184_COLONSPACE_ = Str_(': ') # PYCHOK OK
185_COMMA_ = Str_(',') # PYCHOK OK
186_COMMASPACE_ = Str_(_COMMASPACE_) # PYCHOK OK
187_composite_ = 'composite' # PYCHOK OK
188_concentric_ = 'concentric' # PYCHOK OK
189_convergence_ = _Prefix('convergence') # PYCHOK OK
190_conversion_ = 'conversion' # PYCHOK OK
191_convex_ = 'convex' # PYCHOK OK
192_cubic_ = 'cubic' # PYCHOK OK
193_d_ = 'd' # PYCHOK OK
194_D_ = 'D' # PYCHOK OK
195_DASH_ = Str_('-') # PYCHOK == _MINUS_
196_datum_ = 'datum' # PYCHOK OK
197_decode3_ = 'decode3' # PYCHOK OK
198_deg_ = 'deg' # PYCHOK OK
199_degrees_ = 'degrees' # PYCHOK OK
200_degrees2_ = 'degrees2' # PYCHOK SQUARED
201_delta_ = 'delta' # PYCHOK OK
202_DEPRECATED_ = 'DEPRECATED' # PYCHOK OK
203_DEQUALSPACED_ = Str_(' == ') # PYCHOK OK
204_distance_ = 'distance' # PYCHOK OK
205_distant_ = _Prefix('distant') # PYCHOK OK
206_doesn_t_exist_ = "doesn't exist" # PYCHOK OK
207_DOT_ = Str_('.') # PYCHOK OK
208_down_ = 'down' # PYCHOK OK
209_e_ = 'e' # PYCHOK OK
210_E_ = 'E' # PYCHOK OK
211_earth_ = 'earth' # PYCHOK OK
212_east_ = 'east' # PYCHOK OK
213_easting_ = 'easting' # PYCHOK OK
214_ecef_ = 'ecef' # PYCHOK OK
215_edge_ = 'edge' # PYCHOK OK
216_elevation_ = 'elevation' # PYCHOK OK
217_ELLIPSIS_ = Str_('...') # PYCHOK OK
218_ELLIPSIS4_ = Str_('....') # PYCHOK OK
219# _ELLIPSISPACED_ = Str_(' ... ') # PYCHOK <https://www.ThePunctuationGuide.com/ellipses.html>
220_ellipsoid_ = 'ellipsoid' # PYCHOK OK
221_ellipsoidal_ = 'ellipsoidal' # PYCHOK OK
222_enabled_ = 'enabled' # PYCHOK OK
223_encode_ = 'encode' # PYCHOK OK
224_end_ = 'end' # PYCHOK OK
225_epoch_ = 'epoch' # PYCHOK OK
226_eps_ = 'eps' # PYCHOK OK
227_EQUAL_ = Str_('=') # PYCHOK OK
228_EQUALSPACED_ = Str_(' = ') # PYCHOK OK
229_Error_ = 'Error' # PYCHOK OK
230_exceed_PI_radians_ = 'exceed PI radians' # PYCHOK OK
231_exceeds_ = _Prefix('exceeds') # PYCHOK OK
232# _EXCLAMATION_ = _BANG_ # PYCHOK OK
233_exists_ = 'exists' # PYCHOK OK
234_f_ = 'f' # PYCHOK OK
235_F_ = 'F' # PYCHOK OK
236_feet_ = 'feet' # PYCHOK OK
237_few_ = 'few' # PYCHOK OK
238_fi_ = 'fi' # PYCHOK OK
239_finite_ = 'finite' # PYCHOK OK
240_from_ = 'from' # PYCHOK OK
241_g_ = 'g' # PYCHOK OK
242_gamma_ = 'gamma' # PYCHOK OK
243_GRS80_ = 'GRS80' # PYCHOK OK
244_h_ = 'h' # PYCHOK OK
245_H_ = 'H' # PYCHOK OK
246_HASH_ = '#' # PYCHOK OK
247_height_ = 'height' # PYCHOK OK
248_hemipole_ = 'hemipole' # PYCHOK OK
249_i_ = 'i' # PYCHOK OK
250_immutable_ = 'immutable' # PYCHOK OK
251_in_ = 'in' # PYCHOK OK
252_incompatible_ = 'incompatible' # PYCHOK OK
253_INF_ = 'INF' # PYCHOK OK
254_infinite_ = 'infinite' # PYCHOK _not_finite_
255_initial_ = 'initial' # PYCHOK OK
256_inside_ = 'inside' # PYCHOK OK
257_insufficient_ = 'insufficient' # PYCHOK OK
258_intersection_ = 'intersection' # PYCHOK OK
259_Intl1924_ = 'Intl1924' # PYCHOK OK
260_invalid_ = 'invalid' # PYCHOK OK
261_invokation_ = 'invokation' # PYCHOK OK
262_isclockwise_ = 'isclockwise' # PYCHOK OK
263_ispolar_ = 'ispolar' # PYCHOK OK
264_j_ = 'j' # PYCHOK OK
265_k0_ = 'k0' # PYCHOK OK
266_kind_ = 'kind' # PYCHOK OK
267_knots_ = 'knots' # PYCHOK OK
268_Krassovski1940_ = 'Krassovski1940' # PYCHOK OK
269_Krassowsky1940_ = 'Krassowsky1940' # PYCHOK OK
270_LANGLE_ = '<' # PYCHOK OK
271_lam_ = 'lam' # PYCHOK OK
272_lat_ = 'lat' # PYCHOK OK
273_lat0_ = 'lat0' # PYCHOK OK
274_lat1_ = 'lat1' # PYCHOK OK
275_lat2_ = 'lat2' # PYCHOK OK
276_latlon_ = 'latlon' # PYCHOK OK
277_LatLon_ = 'LatLon' # PYCHOK OK
278_LCURLY_ = '{' # PYCHOK LBRACE
279_len_ = 'len' # PYCHOK OK
280_limit_ = 'limit' # PYCHOK OK
281_line_ = 'line' # PYCHOK OK
282_linear_ = 'linear' # PYCHOK OK
283_LPAREN_ = '(' # PYCHOK OK
284_lon_ = 'lon' # PYCHOK OK
285_lon0_ = 'lon0' # PYCHOK OK
286_lon1_ = 'lon1' # PYCHOK OK
287_lon2_ = 'lon2' # PYCHOK OK
288_low_ = 'low' # PYCHOK OK
289_LSQUARE_ = '[' # PYCHOK LBRACK
290_ltp_ = 'ltp' # PYCHOK OK
291_m_ = 'm' # PYCHOK OK
292_M_ = 'M' # PYCHOK OK
293_m12_ = 'm12' # PYCHOK OK
294_M12_ = 'M12' # PYCHOK OK
295_M21_ = 'M21' # PYCHOK OK
296_MANT_DIG_ = 'MANT_DIG' # PYCHOK OK
297_MAX_ = 'MAX' # PYCHOK OK
298_mean_ = 'mean' # PYCHOK OK
299_meanOf_ = 'meanOf' # PYCHOK OK
300_meridional_ = 'meridional' # PYCHOK OK
301_meter_ = 'meter' # PYCHOK OK
302_meter2_ = 'meter2' # PYCHOK SQUARED
303_MGRS_ = 'MGRS' # PYCHOK OK
304_MIN_ = 'MIN' # PYCHOK OK
305_MINUS_ = _DASH_ # PYCHOK OK
306_module_ = 'module' # PYCHOK OK
307_n_ = 'n' # PYCHOK OK
308_N_ = 'N' # PYCHOK OK
309_n_a_ = 'n/a' # PYCHOK OK
310_N_A_ = 'N/A' # PYCHOK OK
311_NAD27_ = 'NAD27' # PYCHOK OK
312_NAD83_ = 'NAD83' # PYCHOK OK
313_name_ = 'name' # PYCHOK OK
314_NAN_ = 'NAN' # PYCHOK OK
315_near_ = _Dash('near') # PYCHOK OK
316_nearestOn2_ = 'nearestOn2' # PYCHOK OK
317_negative_ = 'negative' # PYCHOK OK
318_NL_ = Str_('\n') # PYCHOK OK
319_NLATvar_ = Str_(_NL_ + '@var ') # PYCHOK OK
320_NLHASH_ = Str_(_NL_ + '# ') # PYCHOK OK
321# _NLNL_ = _DNL_ # PYCHOK OK
322_NN_ = 'NN' # PYCHOK OK
323_no_ = _Prefix('no') # PYCHOK OK
324_north_ = 'north' # PYCHOK OK
325_northing_ = 'northing' # PYCHOK OK
326_NorthPole_ = 'NorthPole' # PYCHOK OK
327_not_ = _Prefix('not') # PYCHOK OK
328_NOTEQUAL_ = _BANG_ + _EQUAL_ # PYCHOK OK
329_not_finite_ = 'not finite' # PYCHOK _not_(_finite_), _infinite_
330_not_scalar_ = 'not scalar' # PYCHOK _not_(_scalar_)
331_NTF_ = 'NTF' # PYCHOK OK
332_null_ = 'null' # PYCHOK OK
333_number_ = 'number' # PYCHOK OK
334_numpy_ = 'numpy' # PYCHOK OK
335_Nv00_ = 'Nv00' # PYCHOK OK
336_of_ = 'of' # PYCHOK OK
337_on_ = 'on' # PYCHOK OK
338_opposite_ = 'opposite' # PYCHOK OK
339_or_ = 'or' # PYCHOK OK
340_other_ = 'other' # PYCHOK OK
341_outside_ = 'outside' # PYCHOK OK
342_overlap_ = 'overlap' # PYCHOK OK
343_parallel_ = 'parallel' # PYCHOK OK
344_PERCENT_ = '%' # PYCHOK OK
345_PERCENTDOTSTAR_ = '%.*' # PYCHOK _DOT_(_PERCENT_, _STAR_)
346_phi_ = 'phi' # PYCHOK OK
347_PLUS_ = Str_('+') # PYCHOK OK
348_PLUSMINUS_ = _PLUS_ + _MINUS_ # PYCHOK OK
349_point_ = 'point' # PYCHOK OK
350_points_ = 'points' # PYCHOK OK
351_pole_ = 'pole' # PYCHOK OK
352_precision_ = 'precision' # PYCHOK OK
353_prime_vertical_ = 'prime_vertical' # PYCHOK OK
354_pygeodesy_ = 'pygeodesy' # PYCHOK OK
355_pygeodesy_abspath_ = 'pygeodesy_abspath' # PYCHOK OK
356_PyPy__ = _PyPy__('PyPy ') # PYCHOK + _SPACE_
357_Python_ = _Python_('Python') # PYCHOK singleton
358_python_ = 'python' # PYCHOK OK
359_QUOTE1_ = "'" # PYCHOK OK
360_QUOTE2_ = '"' # PYCHOK OK
361# _QUOTE3_ = "'''" # PYCHOK OK
362# _QUOTE6_ = '"""' # PYCHOK OK
363_R_ = 'R' # PYCHOK OK
364_radians_ = 'radians' # PYCHOK OK
365_radians2_ = 'radians2' # PYCHOK SQUARED
366_radius_ = 'radius' # PYCHOK OK
367_radius1_ = 'radius1' # PYCHOK OK
368_radius2_ = 'radius2' # PYCHOK OK
369_range_ = _Range('range') # PYCHOK OK
370_RANGLE_ = '>' # PYCHOK OK
371_RCURLY_ = '}' # PYCHOK RBRACE
372_reciprocal_ = 'reciprocal' # PYCHOK OK
373_reframe_ = 'reframe' # PYCHOK OK
374_resolution_ = 'resolution' # PYCHOK OK
375_rIn_ = 'rIn' # PYCHOK OK
376_RPAREN_ = ')' # PYCHOK OK
377_RSQUARE_ = ']' # PYCHOK RBRACK
378_s_ = 's' # PYCHOK OK
379_S_ = 'S' # PYCHOK OK
380_s12_ = 's12' # PYCHOK OK
381_S12_ = 'S12' # PYCHOK OK
382_scalar_ = 'scalar' # PYCHOK OK
383_scale_ = 'scale' # PYCHOK OK
384_scale0_ = 'scale0' # PYCHOK OK
385_scipy_ = 'scipy' # PYCHOK OK
386_semi_circular_ = 'semi-circular' # PYCHOK OK
387_sep_ = 'sep' # PYCHOK OK
388_singular_ = 'singular' # PYCHOK OK
389_SLASH_ = Str_('/') # PYCHOK OK
390_small_ = 'small' # PYCHOK OK
391_Sphere_ = 'Sphere' # PYCHOK OK
392_spherical_ = 'spherical' # PYCHOK OK
393_SouthPole_ = 'SouthPole' # PYCHOK OK
394_SPACE_ = Str_(' ') # PYCHOK OK
395_specified_ = 'specified' # PYCHOK OK
396_STAR_ = Str_('*') # PYCHOK OK
397_start_ = 'start' # PYCHOK OK
398_std_ = 'std' # PYCHOK OK
399_stdev_ = 'stdev' # PYCHOK OK
400_supported_ = 'supported' # PYCHOK OK
401_tbd_ = 'tbd' # PYCHOK OK
402_TILDE_ = '~' # PYCHOK OK
403_to_ = 'to' # PYCHOK OK
404_tolerance_ = _Prefix('tolerance') # PYCHOK OK
405_too_ = _Prefix('too') # PYCHOK OK
406_transform_ = 'transform' # PYCHOK OK
407_UNDER_ = Str_('_') # PYCHOK OK
408_units_ = 'units' # PYCHOK OK
409_UNUSED_ = 'UNUSED' # PYCHOK OK
410_up_ = 'up' # PYCHOK OK
411_UPS_ = 'UPS' # PYCHOK OK
412_utf_8_ = 'utf-8' # PYCHOK OK
413_UTM_ = 'UTM' # PYCHOK OK
414_V_ = 'V' # PYCHOK OK
415_valid_ = 'valid' # PYCHOK OK
416_value_ = 'value' # PYCHOK OK
417_version_ = 'version' # PYCHOK OK
418_vs_ = 'vs' # PYCHOK OK
419_W_ = 'W' # PYCHOK OK
420_WGS72_ = 'WGS72' # PYCHOK OK
421_WGS84_ = 'WGS84' # PYCHOK OK
422_width_ = 'width' # PYCHOK OK
423_with_ = 'with' # PYCHOK OK
424_x_ = 'x' # PYCHOK OK
425_X_ = 'X' # PYCHOK OK
426_xyz_ = 'xyz' # PYCHOK OK
427_y_ = 'y' # PYCHOK OK
428_Y_ = 'Y' # PYCHOK OK
429_z_ = 'z' # PYCHOK OK
430_Z_ = 'Z' # PYCHOK OK
431_zone_ = 'zone' # PYCHOK OK
433_EW_ = _E_ + _W_ # PYCHOK common cardinals
434_NE_ = _N_ + _E_ # PYCHOK positive ones
435_NS_ = _N_ + _S_ # PYCHOK OK
436_NSEW_ = _NS_ + _EW_ # PYCHOK OK
437_NW_ = _N_ + _W_ # PYCHOK OK
438_SE_ = _S_ + _E_ # PYCHOK OK
439_SW_ = _S_ + _W_ # PYCHOK negative ones
440# _NESW_ = _NE_ + _SW_ # PYCHOK clockwise
442_DDOT_ = Str_(_DOT_ * 2) # PYCHOK OK
443# _DEQUAL_ = Str_(_EQUAL_ * 2) # PYCHOK OK
444_DNL_ = Str_(_NL_ * 2) # PYCHOK OK
445# _DSLASH_ = Str_(_SLASH_ * 2) # PYCHOK OK
446# _DSTAR_ = Str_(_STAR_ * 2) # PYCHOK OK
447_DUNDER_ = Str_(_UNDER_ * 2) # PYCHOK OK
449_LR_PAIRS = {_LANGLE_: _RANGLE_,
450 _LCURLY_: _RCURLY_,
451 _LPAREN_: _RPAREN_,
452 _LSQUARE_: _RSQUARE_} # PYCHOK OK
455def _dunder_nameof(inst, *dflt):
456 '''(INTERNAL) Get the double_underscore __name__ attr.
457 '''
458 try:
459 return inst.__name__
460 except AttributeError:
461 pass
462 return dflt[0] if dflt else inst.__class__.__name__
465def _enquote(strs, quote=_QUOTE2_): # in .basics, .solveBase
466 '''(INTERNAL) Enquote a string containing whitespace.
467 '''
468 if len(strs.split()) > 1:
469 strs = NN(quote, strs, quote)
470 return strs
473def _headof(name):
474 '''(INTERNAL) Get the head name of qualified C{name} or the C{name}.
475 '''
476 i = name.find(_DOT_)
477 return name if i < 0 else name[:i]
480def _is(a, b): # PYCHOK no cover
481 '''(INTERNAL) C{a is b}? in C{PyPy}
482 '''
483 return (a == b) if _isPyPy() else (a is b)
486def _isPyPy():
487 '''(INTERNAL) Is this C{PyPy}?
488 '''
489 # platform.python_implementation() == 'PyPy'
490 return _pythonarchine()[0].startswith(_PyPy__)
493def _load_lib(name):
494 '''(INTERNAL) Load a C{dylib}, B{C{name}} must startwith('lib').
495 '''
496 # macOS 11+ (aka 10.16) no longer provides direct loading of
497 # system libraries. As a result, C{ctypes.util.find_library}
498 # will not find any library, unless previously installed by a
499 # low-level dlopen(name) call (with the library base C{name}).
500 from ctypes import CDLL
501 from ctypes.util import find_library
503 ns = find_library(name), name
504 if _sys.platform[:6] == 'darwin': # and os.name == 'posix'
505 from ctypes import _dlopen, DEFAULT_MODE
506 from os.path import join
507 ns += (_DOT_(name, 'dylib'),
508 _DOT_(name, 'framework'), join(
509 _DOT_(name, 'framework'), name))
510 else: # non-macOS
511 DEFAULT_MODE = 0
513 def _dlopen(*unused):
514 return True
516 for n in ns:
517 try:
518 if n and _dlopen(n, DEFAULT_MODE): # pre-load handle
519 lib = CDLL(n) # == ctypes.cdll.LoadLibrary(n)
520 if lib._name: # has a qualified name
521 return lib
522 except (AttributeError, OSError):
523 pass
525 return None # raise OSError
528def machine():
529 '''Return standard C{platform.machine}, but distinguishing Intel I{native}
530 from Intel I{emulation} on Apple Silicon (on macOS only).
532 @return: Machine C{'arm64'} for Apple Silicon I{native}, C{'x86_64'}
533 for Intel I{native}, C{"arm64_x86_64"} for Intel I{emulation},
534 etc. (C{str} with C{comma}s replaced by C{underscore}s).
535 '''
536 return _platform2()[1]
539def _platform2(sep=NN):
540 '''(INTERNAL) Get platform architecture and machine as C{2-list} or C{str}.
541 '''
542 L = _pf2List
543 if not L:
544 import platform
545 m = platform.machine() # ARM64, arm64, x86_64, iPhone13,2, etc.
546 m = m.replace(_COMMA_, _UNDER_)
547 if m.lower() == 'x86_64': # on Intel or Rosetta2 ...
548 v = platform.mac_ver() # ... and only on macOS ...
549 if v and _version2(v[0]) > (10, 15): # ... 11+ aka 10.16
550 # <https://Developer.Apple.com/forums/thread/659846>
551 if _sysctl_uint('sysctl.proc_translated') == 1: # and \
552# _sysctl_uint('hw.optional.arm64') == 1: # PYCHOK indent
553 m = _UNDER_('arm64', m) # Apple Si emulating Intel x86-64
554 L[:] = [platform.architecture()[0], # bits
555 m] # arm64, arm64_x86_64, x86_64, etc.
556 return sep.join(L) if sep else L # 2-list()
559def _pythonarchine(sep=NN): # in test/bases.py versions
560 '''(INTERNAL) Get PyPy and Python versions and C{_platform2} as C{3- or 4-list} or C{str}.
561 '''
562 L = _Py3List
563 if not L:
564 v = _sys.version
565 L[:] = [_Python_(v)] + _platform2()
566 pypy = _PyPy__(v)
567 if pypy:
568 L.insert(0, pypy)
569 return sep.join(L) if sep else L # 3- or 4-list
572def _sysctl_uint(name):
573 '''(INTERNAL) Get an unsigned int sysctl item by name, use on macOS ONLY!
574 '''
575 libc = _load_lib('libc')
576 if libc: # <https://StackOverflow.com/questions/759892/python-ctypes-and-sysctl>
577 from ctypes import byref, c_char_p, c_size_t, c_uint, sizeof # get_errno
578 n = name if str is bytes else bytes(name, _utf_8_) # PYCHOK isPython2 = str is bytes
579 u = c_uint(0)
580 z = c_size_t(sizeof(u))
581 r = libc.sysctlbyname(c_char_p(n), byref(u), byref(z), None, c_size_t(0))
582 else: # could find or load 'libc'
583 r = -2
584 return int(r if r else u.value) # -1 ENOENT error, -2 no libc
587def _tailof(name):
588 '''(INTERNAL) Get the base name of qualified C{name} or the C{name}.
589 '''
590 i = name.rfind(_DOT_) + 1
591 return name[i:] if i > 0 else name
594def _under(name): # PYCHOK in .datums, .auxilats, .ups, .utm, .utmupsBase, ...
595 '''(INTERNAL) Prefix C{name} with I{underscore}.
596 '''
597 return name if name.startswith(_UNDER_) else NN(_UNDER_, name)
600def _usage(file_py, *args): # in .etm
601 '''(INTERNAL) Build "usage: python -m ..." cmd line for module B{C{file_py}}.
602 '''
603 import os
604 m = os.path.dirname(file_py).replace(os.getcwd(), _ELLIPSIS_) \
605 .replace(os.sep, _DOT_).strip()
606 b, x = os.path.splitext(os.path.basename(file_py))
607 if x == '.py' and b != '__main__':
608 m = _DOT_(m or _pygeodesy_, b)
609 p = NN(_python_, _sys.version_info[0])
610 return NN('usage', _SPACE_(_COLON_, p, '-m', _enquote(m), *args))
613def _version2(version, n=2):
614 '''(INTERNAL) Split C{B{version} str} into a C{1-, 2- or 3-tuple} of C{int}s.
615 '''
616 t = _version_ints(version.split(_DOT_, 2))
617 if len(t) < n:
618 t += (0,) * n
619 return t[:n]
622def _version_info(package): # in .Base.karney, .basics
623 '''(INTERNAL) Get the C{package.__version_info__} as a 2- or
624 3-tuple C{(major, minor, revision)} if C{int}s.
625 '''
626 try:
627 return _version_ints(package.__version_info__)
628 except AttributeError:
629 return _version2(package.__version__.strip(), n=3)
632def _version_ints(vs):
633 # helper for _version2 and _version_info above
635 def _ints(vs):
636 for v in vs:
637 try:
638 yield int(v.strip())
639 except (TypeError, ValueError):
640 pass
642 return tuple(_ints(vs))
645__all__ = (_NN_, # not MISSING!
646 Str_.__name__, # classes
647 machine.__name__) # in .lazily
648__version__ = '24.03.20'
650if __name__ == '__main__':
652 from pygeodesy import itemsorted, printf
654 t = b = 0
655 for n, v in itemsorted(locals(), asorted=False, reverse=True):
656 if n.endswith(_UNDER_) and n.startswith(_UNDER_) and \
657 not n.startswith(_DUNDER_):
658 t += 1
659 b += len(v)
660 m = n[1:-1]
661 if m != v and m.replace(_UNDER_, _SPACE_) != v:
662 printf('%4d: %s = %r', t, n, v)
663 n = len(locals())
664 printf('%4d (%d) names, %s chars total, %.2f chars avg', t, n, b, float(b) / t, nl=1)
666# **) MIT License
667#
668# Copyright (C) 2016-2024 -- mrJean1 at Gmail -- All Rights Reserved.
669#
670# Permission is hereby granted, free of charge, to any person obtaining a
671# copy of this software and associated documentation files (the "Software"),
672# to deal in the Software without restriction, including without limitation
673# the rights to use, copy, modify, merge, publish, distribute, sublicense,
674# and/or sell copies of the Software, and to permit persons to whom the
675# Software is furnished to do so, subject to the following conditions:
676#
677# The above copyright notice and this permission notice shall be included
678# in all copies or substantial portions of the Software.
679#
680# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
681# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
682# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
683# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
684# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
685# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
686# OTHER DEALINGS IN THE SOFTWARE.