# Coverage for pygeodesy/dms.py : 96%

## 276 statements 265 run 11 missing 33 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 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 | # -*- coding: utf-8 -*- u'''Parsers and formatters of angles in degrees, minutes and seconds or radians. Functions to parse and format bearing, compass, lat- and longitudes in various forms of degrees, minutes and seconds with or without degrees, minute and second symbols plus a compass point suffix, including parsing of C{decimal} and C{sexagecimal} degrees. After I{(C) Chris Veness 2011-2015} published under the same MIT Licence**, see U{Latitude/Longitude<https://www.Movable-Type.co.UK/scripts/latlong.html>} and U{Vector-based geodesy<https://www.Movable-Type.co.UK/scripts/latlong-vectors.html>}. @var F_D: Format degrees as unsigned "deg°" with symbol, plus compass point suffix C{N, S, E} or C{W} (C{str}). @var F_DM: Format degrees as unsigned "deg°min′" with symbols, plus suffix (C{str}). @var F_DMS: Format degrees as unsigned "deg°min′sec″" with symbols, plus suffix (C{str}). @var F_DEG: Format degrees as unsigned "[D]DD" I{without} symbol, plus suffix (C{str}). @var F_MIN: Format degrees as unsigned "[D]DDMM" I{without} symbols, plus suffix (C{str}). @var F_SEC: Format degrees as unsigned "[D]DDMMSS" I{without} symbols, plus suffix (C{str}). @var F_D60: Format degrees as unsigned "[D]DD.MMSS" C{sexagecimal} I{without} symbols, plus suffix (C{str}). @var F__E: Format degrees as unsigned "%E" I{without} symbols, plus suffix (C{str}). @var F__F: Format degrees as unsigned "%F" I{without} symbols, plus suffix (C{str}). @var F__G: Format degrees as unsigned "%G" I{without} symbols, plus suffix (C{str}). @var F_RAD: Convert degrees to radians and format as unsigned "RR" with symbol, plus suffix (C{str}). @var F_D_: Format degrees as signed "-/deg°" with symbol, I{without} suffix (C{str}). @var F_DM_: Format degrees as signed "-/deg°min′" with symbols, I{without} suffix (C{str}). @var F_DMS_: Format degrees as signed "-/deg°min′sec″" with symbols, I{without} suffix (C{str}). @var F_DEG_: Format degrees as signed "-/[D]DD" I{without} symbol, I{without} suffix (C{str}). @var F_MIN_: Format degrees as signed "-/[D]DDMM" I{without} symbols, I{without} suffix (C{str}). @var F_SEC_: Format degrees as signed "-/[D]DDMMSS" I{without} symbols, I{without} suffix (C{str}). @var F_D60_: Format degrees as signed "-/[D]DD.MMSS" C{sexagecimal} I{without} symbols, I{without} suffix (C{str}). @var F__E_: Format degrees as signed "-/%E" I{without} symbols, I{without} suffix (C{str}). @var F__F_: Format degrees as signed "-/%F" I{without} symbols, I{without} suffix (C{str}). @var F__G_: Format degrees as signed "-/%G" I{without} symbols, I{without} suffix (C{str}). @var F_RAD_: Convert degrees to radians and format as signed "-/RR" I{without} symbol, I{without} suffix (C{str}). @var F_D__: Format degrees as signed "-/+deg°" with symbol, I{without} suffix (C{str}). @var F_DM__: Format degrees as signed "-/+deg°min′" with symbols, I{without} suffix (C{str}). @var F_DMS__: Format degrees as signed "-/+deg°min′sec″" with symbols, I{without} suffix (C{str}). @var F_DEG__: Format degrees as signed "-/+[D]DD" I{without} symbol, I{without} suffix (C{str}). @var F_MIN__: Format degrees as signed "-/+[D]DDMM" I{without} symbols, without suffix (C{str}). @var F_SEC__: Format degrees as signed "-/+[D]DDMMSS" I{without} symbols, I{without} suffix (C{str}). @var F_D60__: Format degrees as signed "-/+[D]DD.MMSS" C{sexagecimal} I{without} symbols, I{without} suffix (C{str}). @var F__E__: Format degrees as signed "-/+%E" I{without} symbols, I{without} suffix (C{str}). @var F__F__: Format degrees as signed "-/+%F" I{without} symbols, I{without} suffix (C{str}). @var F__G__: Format degrees as signed "-/+%G" I{without} symbols, I{without} suffix (C{str}). @var F_RAD__: Convert degrees to radians and format as signed "-/+RR" I{without} symbol, I{without} suffix (C{str}). @var S_DEG: Degrees symbol, default C{"°"} @var S_MIN: Minutes symbol, default C{"′"} aka I{PRIME} @var S_SEC: Seconds symbol, default C{"″"} aka I{DOUBLE_PRIME} @var S_RAD: Radians symbol, default C{""} aka L{pygeodesy.NN} @var S_DMS: If C{True} include, otherwise cancel all DMS symbols, default C{True}. @var S_SEP: Separator between C{deg°|min′|sec″|suffix}, default C{""} aka L{pygeodesy.NN} @note: In Python 2-, L{S_DEG}, L{S_MIN}, L{S_SEC}, L{S_RAD} and L{S_SEP} may be multi-byte, non-ascii characters and if so, I{not} C{unicode}. ''' from pygeodesy.basics import copysign0, isodd, issequence, isstr, map2, \ neg as _neg # in .ups from pygeodesy.constants import _umod_360, _0_0, _0_5, _60_0, _360_0, _3600_0 from pygeodesy.errors import ParseError, _parseX, RangeError, rangerrors, _TypeError, \ _ValueError, _xkwds, _xkwds_get from pygeodesy.interns import NN, _arg_, _COMMA_, _d_, _DASH_, _deg_, _degrees_, _DOT_, \ _0_, _e_, _E_, _EW_, _f_, _F_, _g_, _MINUS_, _N_, _NE_, \ _NS_, _NSEW_, _NW_, _PERCENTDOTSTAR_, _PLUS_, _PLUSMINUS_, \ _QUOTE1_, _QUOTE2_, _radians_, _S_, _SE_, _SPACE_, _SW_, _W_ from pygeodesy.lazily import _ALL_LAZY, _ALL_MODS as _MODS from pygeodesy.streprs import Fmt, fstr, fstrzs, _0wpF from math import fabs, modf, radians try: from string import letters as _LETTERS except ImportError: # Python 3+ from string import ascii_letters as _LETTERS __all__ = _ALL_LAZY.dms __version__ = '23.03.19' _beyond_ = 'beyond' _DDDMMSS_ = 'DDDMMSS' _deg_min_ = 'deg+min' _keyword_ = 'keyword' _of_ = 'of' _SDIGITS_ = '-0123456789+' _sexagecimal_ = 'sexagecimal' _SEXAGECIMUL = 1.e4 # sexagecimal C{D.MMSSss} into decimal C{DMMSS.ss} F_D, F_DM, F_DMS, F_DEG, F_MIN, F_SEC, F_D60, F__E, F__F, F__G, F_RAD = _F_s = ( _d_, 'dm', 'dms', _deg_, 'min', 'sec', 'd60', _e_, _f_, _g_, 'rad') F_D_, F_DM_, F_DMS_, F_DEG_, F_MIN_, F_SEC_, F_D60_, F__E_, F__F_, F__G_, F_RAD_ = (NN( _MINUS_, _) for _ in _F_s) F_D__, F_DM__, F_DMS__, F_DEG__, F_MIN__, F_SEC__, F_D60__, F__E__, F__F__, F__G__, F_RAD__ = (NN( _PLUS_, _) for _ in _F_s) del _F_s _F_case = {F_D: F_D, F_DEG: F_D, _degrees_: F_D, # unsigned _F_s F_DM: F_DM, F_MIN: F_DM, _deg_min_: F_DM, F_D60: F_D60, F_RAD: F_RAD, _radians_: F_RAD, F__E: F__E, F__F: F__F, F__G: F__G} # default F_DMS _F_prec = {F_D: 6, F_DM: 4, F_DMS: 2, # default precs F_DEG: 6, F_MIN: 4, F_SEC: 2, F_D60: 0, F__E: 8, F__F: 8, F__G: 8, F_RAD: 5} _F_symb = set((F_D, F_DM, F_DMS, _deg_min_)) # == {} pychok -Tb S_DEG = _DEGREES_ = '°' # ord() = 176 S_MIN = _MINUTES_ = '′' # PRIME S_SEC = _SECONDS_ = '″' # DOUBLE_PRIME S_RAD = _RADIANS_ = NN # PYCHOK radians symbol "" S_DMS = True # include DMS symbols S_SEP = NN # separator between deg|min|sec|suffix "" S_NUL = NN # empty string, kept INTERNAL # note: ord(_DEGREES_) == ord('°') == 176, ord('˚') == 730 _S_norm = {S_DEG: _DEGREES_, '˚': _DEGREES_, '^': _DEGREES_, # _d_: _DEGREES_, S_MIN: _MINUTES_, '’': _MINUTES_, _QUOTE1_: _MINUTES_, # _r_: _RADIANS_ S_SEC: _SECONDS_, '”': _SECONDS_, _QUOTE2_: _SECONDS_} _WINDS = (_N_, 'NbE', 'NNE', 'NEbN', _NE_, 'NEbE', 'ENE', 'EbN', _E_, 'EbS', 'ESE', 'SEbE', _SE_, 'SEbS', 'SSE', 'SbE', _S_, 'SbW', 'SSW', 'SWbS', _SW_, 'SWbW', 'WSW', 'WbS', _W_, 'WbN', 'WNW', 'NWbW', _NW_, 'NWbN', 'NNW', 'NbW') def _D603(sep, s_D=_DOT_, s_M=None, s_S=S_NUL, s_DMS=S_DMS, **unused): '''(INTERNAL) Get the overridden or default pseudo-C{DMS} symbols. ''' if s_DMS: M = sep if s_M is None else s_M return s_D, (M or S_NUL), s_S else: # no overriden symbols return _DOT_, sep, S_NUL def _DMS3(form, s_D=S_DEG, s_M=S_MIN, s_S=S_SEC, s_DMS=S_DMS, **unused): '''(INTERNAL) Get the overridden or default C{DMS} symbols. ''' return (s_D, s_M, s_S) if s_DMS and form in _F_symb else (S_NUL, S_NUL, S_NUL) def _dms3(d, ddd, p, w): '''(INTERNAL) Format C{d} as (deg, min, sec) C{str}s with leading zeros. ''' d, s = divmod(round(d * _3600_0, p), _3600_0) m, s = divmod(s, _60_0) return (_0wpF(ddd, 0, d), _0wpF( 2, 0, m), _0wpF(w+2, p, s)) def _fstrzs(t, **unused): '''(INTERNAL) Pass-thru version of C{.streprs.fstrzs}. ''' return t def _split3(strDMS, suffix=_NSEW_): '''(INTERNAL) Return sign, stripped B{C{strDMS}} and compass point. ''' t = strDMS.strip() s = t[:1] # sign or digit P = t[-1:] # compass point or digit or dot t = t.lstrip(_PLUSMINUS_).rstrip(suffix).strip() return s, t, P def _toDMS(deg, form, prec, sep, ddd, suff, s_D_M_S): # MCCABE 13 in .units '''(INTERNAL) Convert C{deg} to C{str}, with/-out sign, DMS symbols and/or suffix. ''' try: deg = float(deg) except (TypeError, ValueError) as x: raise _ValueError(deg=deg, form=form, prec=prec, cause=x) if form[:1] in _PLUSMINUS_: # signed sign = _MINUS_ if deg < 0 else ( _PLUS_ if deg > 0 and form[:1] == _PLUS_ else NN) form = form.lstrip(_PLUSMINUS_) suff = NN # no suffix if signed else: # suffixed sign = NN # no sign if suffixed if suff and sep: # no sep if no suffix suff = NN(sep, suff) try: F = _F_case[form] # .strip() except KeyError: form = form.lower() # .strip() F = _F_case.get(form, F_DMS) if prec is None: z = p = _F_prec.get(F, 6) else: z = int(prec) p = abs(z) w = p + (1 if p else 0) z = fstrzs if z > 1 else _fstrzs d = fabs(deg) if F is F_DMS: # 'deg+min+sec', default D, M, S = _DMS3(form, **s_D_M_S) d, m, s = _dms3(d, ddd, p, w) t = NN(sign, d, D, sep, m, M, sep, z(s), S, suff) elif F is F_DM: # 'deg+min' D, M, _ = _DMS3(form, **s_D_M_S) d, m = divmod(round(d * _60_0, p), _60_0) t = NN(sign, _0wpF(ddd, 0, d), D, sep, z(_0wpF(w+2, p, m)), M, suff) elif F is F_D: # 'deg' D, _, _ = _DMS3(form, **s_D_M_S) t = NN(sign, z(_0wpF(w+ddd, p, d)), D, suff) elif F is F_D60: # 'deg.MM|SSss|' D, M, S = _D603(sep, **s_D_M_S) d, m, s = _dms3(d, ddd, p, w) t = z(s).split(_DOT_) + [S, suff] t = NN(sign, d, D, m, M, *t) elif F is F_RAD: R = _xkwds_get(s_D_M_S, s_R=S_RAD) r = NN(_PERCENTDOTSTAR_, _F_) % (p, radians(d)) t = NN(sign, z(r), R, suff) else: # F in (F__E, F__F, F__G) D = _xkwds_get(s_D_M_S, s_D=S_NUL) d = NN(_PERCENTDOTSTAR_, F) % (p, d) # XXX form? t = NN(sign, z(d, ap1z=F is F__G), D, suff) return t # NOT unicode in Python 2- def bearingDMS(bearing, form=F_D, prec=None, sep=S_SEP, **s_D_M_S): '''Convert bearing to a string (without compass point suffix). @arg bearing: Bearing from North (compass C{degrees360}). @kwarg form: Format specifier for B{C{deg}} (C{str} or L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, L{F_D60}, L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, L{F_SEC_}, L{F_D60_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, L{F_MIN__}, L{F_SEC__}, L{F_D60__}, L{F__E__}, L{F__F__}, L{F__G__} or L{F_RAD__}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @kwarg sep: Separator between degrees, minutes, seconds, suffix (C{str}). @kwarg s_D_M_S: Optional keyword arguments C{B{s_D}=str}, C{B{s_M}=str}, C{B{s_S}=str} and C{B{s_DMS}=True} to override any or cancel all DMS symbols, defaults L{S_DEG}, L{S_MIN} respectively L{S_SEC}. @return: Compass degrees per the specified B{C{form}} (C{str}). @see: Function L{pygeodesy.toDMS}. ''' return _toDMS(_umod_360(bearing), form, prec, sep, 1, NN, s_D_M_S) def _clip(angle, limit, units): '''(INTERNAL) Helper for C{clipDegrees} and C{clipRadians}. ''' c = min(limit, max(-limit, angle)) if c != angle and rangerrors(): t = _SPACE_(fstr(angle, prec=6, ints=True), _beyond_, copysign0(limit, angle), units) raise RangeError(t, txt=None) return c def clipDegrees(deg, limit): '''Clip a lat- or longitude to the given range. @arg deg: Unclipped lat- or longitude (C{scalar degrees}). @arg limit: Valid C{-/+B{limit}} range (C{degrees}). @return: Clipped value (C{degrees}). @raise RangeError: If B{C{deg}} outside the valid C{-/+B{limit}} range and L{pygeodesy.rangerrors} set to C{True}. ''' return _clip(deg, limit, _degrees_) if limit and limit > 0 else deg def clipRadians(rad, limit): '''Clip a lat- or longitude to the given range. @arg rad: Unclipped lat- or longitude (C{radians}). @arg limit: Valid C{-/+B{limit}} range (C{radians}). @return: Clipped value (C{radians}). @raise RangeError: If B{C{rad}} outside the valid C{-/+B{limit}} range and L{pygeodesy.rangerrors} set to C{True}. ''' return _clip(rad, limit, _radians_) if limit and limit > 0 else rad def compassDMS(bearing, form=F_D, prec=None, sep=S_SEP, **s_D_M_S): '''Convert bearing to a string suffixed with compass point. @arg bearing: Bearing from North (compass C{degrees360}). @kwarg form: Format specifier for B{C{deg}} (C{str} or L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, L{F_D60}, L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, L{F_SEC_}, L{F_D60_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, L{F_MIN__}, L{F_SEC__}, L{F_D60__}, L{F__E__}, L{F__F__}, L{F__G__} or L{F_RAD__}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @kwarg sep: Separator between degrees, minutes, seconds, suffix (C{str}). @kwarg s_D_M_S: Optional keyword arguments C{B{s_D}=str}, C{B{s_M}=str} C{B{s_S}=str} and C{B{s_DMS}=True} to override any or cancel all DMS symbols, defaults L{S_DEG}, L{S_MIN} respectively L{S_SEC}. @return: Compass degrees and point in the specified form (C{str}). @see: Function L{pygeodesy.toDMS}. ''' b = _umod_360(bearing) return _toDMS(b, form, prec, sep, 1, compassPoint(b), s_D_M_S) def compassPoint(bearing, prec=3): '''Convert bearing to a compass point. @arg bearing: Bearing from North (compass C{degrees360}). @kwarg prec: Precision, number of compass point characters: 1 for cardinal or basic winds, 2 for intercardinal or ordinal or principal winds, 3 for secondary-intercardinal or half-winds or 4 for quarter-winds). @return: Compass point (1-, 2-, 3- or 4-letter C{str}). @raise ValueError: Invalid B{C{prec}}. @see: U{Dms.compassPoint <https://GitHub.com/ChrisVeness/geodesy/blob/master/dms.js>} and U{Compass rose<https://WikiPedia.org/wiki/Compass_rose>}. @example: >>> p = compassPoint(24, 1) # 'N' >>> p = compassPoint(24, 2) # 'NE' >>> p = compassPoint(24, 3) # 'NNE' >>> p = compassPoint(24) # 'NNE' >>> p = compassPoint(11, 4) # 'NbE' >>> p = compassPoint(30, 4) # 'NEbN' >>> p = compassPoint(11.249) # 'N' >>> p = compassPoint(11.25) # 'NNE' >>> p = compassPoint(-11.25) # 'N' >>> p = compassPoint(348.749) # 'NNW' ''' try: # like .streprs.enstr2 m = 2 << prec if m in (4, 8, 16, 32): w = 32 // m # not round(), i.e. half-even rounding in Python 3+, # but round-away-from-zero as int(b + 0.5) iff b is # non-negative, otherwise int(b + copysign0(_0_5, b)) w *= int(_umod_360(bearing) * m / _360_0 + _0_5) % m return _WINDS[w] raise ValueError except (IndexError, TypeError, ValueError) as x: raise _ValueError(bearing=bearing, prec=prec, cause=x) def degDMS(deg, prec=6, s_D=S_DEG, s_M=S_MIN, s_S=S_SEC, neg=_MINUS_, pos=NN): '''Convert degrees to a string in degrees, minutes I{or} seconds. @arg deg: Value in degrees (C{scalar degrees}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @kwarg s_D: D symbol for degrees (C{str}). @kwarg s_M: M symbol for minutes (C{str}) or C{""}. @kwarg s_S: S symbol for seconds (C{str}) or C{""}. @kwarg neg: Optional sign for negative (C{'-'}). @kwarg pos: Optional sign for positive (C{''}). @return: I{Either} degrees, minutes I{or} seconds (C{str}). @see: Function L{pygeodesy.toDMS}. ''' try: deg = float(deg) except (TypeError, ValueError) as x: raise _ValueError(deg=deg, prec=prec, cause=x) d, s = fabs(deg), s_D if d < 1: if s_M: d *= _60_0 if d < 1 and s_S: d *= _60_0 s = s_S else: s = s_M elif s_S: d *= _3600_0 s = s_S z = int(prec) t = Fmt.F(d, prec=abs(z)) if z > 1: t = fstrzs(t) n = neg if deg < 0 else pos return NN(n, t, s) # NOT unicode in Python 2- def latDMS(deg, form=F_DMS, prec=None, sep=S_SEP, **s_D_M_S): '''Convert latitude to a string, optionally suffixed with N or S. @arg deg: Latitude to be formatted (C{scalar degrees}). @kwarg form: Format specifier for B{C{deg}} (C{str} or L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, L{F_D60}, L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, L{F_SEC_}, L{F_D60_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, L{F_MIN__}, L{F_SEC__}, L{F_D60__}, L{F__E__}, L{F__F__}, L{F__G__} or L{F_RAD__}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @kwarg sep: Separator between degrees, minutes, seconds, suffix (C{str}). @kwarg s_D_M_S: Optional keyword arguments C{B{s_D}=str}, C{B{s_M}=str} C{B{s_S}=str} and C{B{s_DMS}=True} to override any or cancel all DMS symbols, defaults L{S_DEG}, L{S_MIN} respectively L{S_SEC}. @return: Degrees in the specified form (C{str}). @see: Functions L{pygeodesy.toDMS} and L{pygeodesy.lonDMS}. ''' p = _S_ if deg < 0 else _N_ return _toDMS(deg, form, prec, sep, 2, p, s_D_M_S) def latlonDMS(lls, **m_form_prec_sep_s_D_M_S): '''Convert one or more C{LatLon} instances to strings. @arg lls: Single or list, sequence, tuple, etc. (C{LatLon}s). @kwarg m_form_prec_sep_s_D_M_S: Optional C{B{m}eter}, C{B{form}at}, C{B{prec}ision}, I{DEPRECATED} B{C{sep}}, B{C{s_D}}, B{C{s_M}}, B{C{s_S}} and B{C{s_DMS}} keyword arguments, see method C{LatLon.toStr} and functions L{pygeodesy.latDMS} and L{pygeodesy.lonDMS}. @return: A C{tuple} of C{str}s if B{C{lls}} is a list, sequence, tuple, etc. of C{LatLon} instances or a single C{str} if B{C{lls}} is a single C{LatLon}. @see: Functions L{pygeodesy.latDMS}, L{pygeodesy.latlonDMS_}, L{pygeodesy.lonDMS} and L{pygeodesy.toDMS} and method C{LatLon.toStr}. @note: Keyword argument C{B{sep}=None} to return a C{str}ing instead of the C{tuple}, has been I{DEPRECATED}, use C{B{sep}.join(B{latlonDMS_}(...))}. ''' sep, kwds = _latlonDMS_sep2(latlonDMS, **m_form_prec_sep_s_D_M_S) if isinstance(lls, _MODS.latlonBase.LatLonBase): t = lls.toStr(**kwds) elif issequence(lls): t = tuple(ll.toStr(**kwds) for ll in lls) if sep: # XXX TO BE REMOVED t = sep.join(t) else: raise _TypeError(lls=lls, **m_form_prec_sep_s_D_M_S) return t def latlonDMS_(*lls, **m_form_prec_sep_s_D_M_S): '''Convert one or more C{LatLon} instances to strings. @arg lls: The instances, all positional arguments (C{LatLon}s). @kwarg m_form_prec_sep_s_D_M_S: Optional C{B{m}eter}, C{B{form}at}, C{B{prec}ision}, I{DEPRECATED} B{C{sep}}, B{C{s_D}}, B{C{s_M}}, B{C{s_S}} and B{C{s_DMS}} keyword arguments, see method C{LatLon.toStr} and functions L{pygeodesy.latDMS} and L{pygeodesy.lonDMS}. @return: A C{tuple} of C{str}s if 2 or more C{LatLon} instances or a single C{str} if only a single C{LatLon} instance is given in B{C{lls}}. @see: Function L{pygeodesy.latlonDMS}. @note: Keyword argument C{B{sep}=None} to return a C{str}ing instead of the C{tuple}, has been I{DEPRECATED}, use C{B{sep}.join(B{latlonDMS_}(...))}. ''' sep, kwds = _latlonDMS_sep2(latlonDMS, **m_form_prec_sep_s_D_M_S) if not lls: raise _ValueError(lls=lls, **m_form_prec_sep_s_D_M_S) elif len(lls) < 2: lls, sep = lls[0], None t = latlonDMS(lls, **kwds) return sep.join(t) if sep else t def _latlonDMS_sep2(where, sep=None, **kwds): '''DEPRECATED, instead use: %r.join(%s(...))''' if sep: k = _SPACE_(_keyword_, _arg_, Fmt.EQUAL(sep=repr(sep)), _of_) n = where.__name__ t = _latlonDMS_sep2.__doc__ % (sep, n) _MODS.props._throwarning(k, n, t) return sep, kwds def lonDMS(deg, form=F_DMS, prec=None, sep=S_SEP, **s_D_M_S): '''Convert longitude to a string, optionally suffixed with E or W. @arg deg: Longitude to be formatted (C{scalar degrees}). @kwarg form: Format specifier for B{C{deg}} (C{str} or L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, L{F_D60}, L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, L{F_SEC_}, L{F_D60_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, L{F_MIN__}, L{F_SEC__}, L{F_D60__}, L{F__E__}, L{F__F__}, L{F__G__} or L{F_RAD__}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @kwarg sep: Separator between degrees, minutes, seconds, suffix (C{str}). @kwarg s_D_M_S: Optional keyword arguments C{B{s_D}=str}, C{B{s_M}=str} C{B{s_S}=str} and C{B{s_DMS}=True} to override any or cancel all DMS symbols, defaults L{S_DEG}, L{S_MIN} respectively L{S_SEC}. @return: Degrees in the specified form (C{str}). @see: Functions L{pygeodesy.toDMS} and L{pygeodesy.latDMS}. ''' p = _W_ if deg < 0 else _E_ return _toDMS(deg, form, prec, sep, 3, p, s_D_M_S) def normDMS(strDMS, norm=None, **s_D_M_S): '''Normalize all degrees, minutes and seconds (DMS) symbols in a string to the default symbols L{S_DEG}, L{S_MIN}, L{S_SEC}. @arg strDMS: Original DMS string (C{str}). @kwarg norm: Optional replacement symbol (C{str}) or C{None} for the default DMS symbols). Use C{B{norm}=""} to remove all DMS symbols. @kwarg s_D_M_S: Optional, alternate DMS symbols C{B{s_D}=str}, C{B{s_M}=str}, C{B{s_S}=str} and/or C{B{s_R}=str} for radians, each to be replaced by B{C{norm}}. @return: Normalized DMS (C{str}). ''' def _s2S2(s_D=S_DEG, s_M=S_MIN, s_S=S_SEC, s_R=S_RAD): d = {s_D: S_DEG, s_M: S_MIN, s_S: S_SEC, s_R: S_RAD} for s, S in _xkwds(d, **_S_norm).items(): if s: yield s, S # XXX strDMS isn't unicode in Python 2- and looping # thru strDMS will yield each byte, hence the loop # thru _s2S2 and replacing the DMS symbols in strDMS if norm is None: # back to default DMS for s, S in _s2S2(**s_D_M_S): if s != S: strDMS = strDMS.replace(s, S) else: # replace or remove all DMS n = norm or NN for s, _ in _s2S2(**s_D_M_S): if s != n: strDMS = strDMS.replace(s, n) if n: strDMS = strDMS.rstrip(n) # XXX not .strip? return strDMS # NOT unicode in Python 2- def parseDDDMMSS(strDDDMMSS, suffix=_NSEW_, sep=S_SEP, clip=0, sexagecimal=False): # MCCABE 14 '''Parse a lat- or longitude represention forms as [D]DDMMSS in degrees. @arg strDDDMMSS: Degrees in any of several forms (C{str}) and types (C{float}, C{int}, other). @kwarg suffix: Optional, valid compass points (C{str}, C{tuple}). @kwarg sep: Optional separator between "[D]DD", "MM", "SS", B{C{suffix}} (L{S_SEP}). @kwarg clip: Optionally, limit value to range C{-/+B{clip}} (C{degrees}). @kwarg sexagecimal: If C{True}, convert C{"D.MMSS"} or C{float(D.MMSS)} to C{base-60} "MM" and "SS" digits. See C{form}s L{F_D60}, L{F_D60_} and L{F_D60__}. @return: Degrees (C{float}). @raise ParseError: Invalid B{C{strDDDMMSS}} or B{C{clip}} or the form of B{C{strDDDMMSS}} is incompatible with the suffixed or B{C{suffix}} compass point. @raise RangeError: Value of B{C{strDDDMMSS}} outside the valid C{-/+B{clip}} range and L{pygeodesy.rangerrors} set to C{True}. @note: Type C{str} values "[D]DD", "[D]DDMM", "[D]DDMMSS" and "[D]DD.MMSS" for B{C{strDDDMMSS}} are parsed properly only if I{either} unsigned and suffixed with a valid, compatible, C{cardinal} L{compassPoint} I{or} signed I{or} unsigned, unsuffixed and with keyword argument B{C{suffix}="NS"}, B{C{suffix}="EW"} or a compatible L{compassPoint}. @note: Unlike function L{parseDMS}, type C{float}, C{int} and other non-C{str} B{C{strDDDMMSS}} values are interpreted as C{form} [D]DDMMSS or [D]DD.MMSS. For example, C{int(1230)} is returned as 12.5 and I{not 1230.0} degrees. However, C{int(345)} is considered C{form} "DDD" 345 I{and not "DDMM" 0345}, unless B{C{suffix}} specifies the compass point. Also, C{float(15.0523)} is returned as 15.0523 decimal degrees and I{not 15°5′23″ sexagecimal}. To consider the latter, use C{float(15.0523)} or C{"15.0523"} and specify the keyword argument C{B{sexagecimal}=True}. @see: Functions L{pygeodesy.parseDMS}, L{pygeodesy.parseDMS2} and L{pygeodesy.parse3llh}. ''' def _DDDMMSS(strDDDMMSS, suffix, sep, clip, sexagecimal): S = suffix.upper() if isstr(strDDDMMSS): t = strDDDMMSS.replace(sep, NN) if sep else strDDDMMSS s, t, P = _split3(t, S) f = t.split(_DOT_) n = len(f[0]) f = NN.join(f) if 1 < n < 8 and f.isdigit() and ( # dddN/S/E/W or ddd or +/-ddd (P in S and s.isdigit()) or (P.isdigit() and s in _SDIGITS_ # PYCHOK indent and S in _WINDS)): # check [D]DDMMSS form and compass point X = _EW_ if isodd(n) else _NS_ if not (P in X or (S in X and (P.isdigit() or P == _DOT_))): t = _DDDMMSS_[int(X is _NS_):(n | 1)], _DASH_.join(X) raise ParseError('form %s applies %s' % t) elif not sexagecimal: # try other forms return _DMS2deg(strDDDMMSS, S, sep, clip, {}) if sexagecimal: # move decimal dot from ... n += 4 # ... [D]DD.MMSSs to [D]DDMMSS.s if n < 6: raise ParseError('%s digits (%s)' % (_sexagecimal_, n)) z = n - len(f) # zeros to append t = (f + (_0_ * z)) if z > 0 else _DOT_(f[:n], f[n:]) f = _0_0 # fraction else: # float or int to [D]DDMMSS[.fff] f, m = float(strDDDMMSS), 0 if sexagecimal: f *= _SEXAGECIMUL m = 6 s = P = _0_ # anything except NN, _S_, _SW_, _W_ if f < 0: f = -f s = _MINUS_ f, i = modf(f) # returns ... t = str(int(i)) # ... float(i) n = len(t) # number of digits to ... if n < m: # ... required min or ... t = (_0_ * (m - n)) + t # ... match the given compass point elif S in (_NS_ if isodd(n) else _EW_): t = _0_ + t # P = S # elif n > 1: # P = (_EW_ if isodd(n) else _NS_)[0] n = len(t) if n < 4: # [D]DD[.ddd] t = (float(t) + f), else: f += float(t[n-2:]) if n < 6: # [D]DDMM[.mmm] t = float(t[:n-2]), f else: # [D]DDMMSS[.sss] t = float(t[:n-4]), float(t[n-4:n-2]), f d = _dms2deg(s, P, *t) return clipDegrees(d, float(clip)) if clip else d return _parseX(_DDDMMSS, strDDDMMSS, suffix, sep, clip, sexagecimal, strDDDMMSS=strDDDMMSS, suffix=suffix, sexagecimal=sexagecimal) def _dms2deg(s, P, deg, min=_0_0, sec=_0_0): '''(INTERNAL) Helper for C{parseDDDMMSS} and C{_DMS2deg}. ''' deg += (min + (sec / _60_0)) / _60_0 if s == _MINUS_ or (P and P in _SW_): deg = _neg(deg) return deg def _DMS2deg(strDMS, suffix, sep, clip, s_D_M_S): '''(INTERNAL) Helper for C{parseDDDMMSS} and C{parseDMS}. ''' try: d = float(strDMS) except (TypeError, ValueError): s, t, P = _split3(strDMS, suffix.upper()) if sep: # remove all DMS symbols t = t.replace(sep, _SPACE_) t = normDMS(t, norm=NN, **s_D_M_S) else: # replace all DMS symbols t = normDMS(t, norm=_SPACE_, **s_D_M_S) t = map2(float, t.strip().split()) d = _dms2deg(s, P, *t[:3]) return clipDegrees(d, float(clip)) if clip else d def parseDMS(strDMS, suffix=_NSEW_, sep=S_SEP, clip=0, **s_D_M_S): # MCCABE 14 '''Parse a lat- or longitude representation in C{degrees}. This is very flexible on formats, allowing signed decimal degrees, degrees and minutes or degrees minutes and seconds optionally suffixed by a cardinal compass point. A variety of symbols, separators and suffixes are accepted, for example "3°37′09″W". Minutes and seconds may be omitted. @arg strDMS: Degrees in any of several forms (C{str}) and types (C{float}, C{int}, other). @kwarg suffix: Optional, valid compass points (C{str}, C{tuple}). @kwarg sep: Optional separator between deg°, min′, sec″, B{C{suffix}} (C{''}). @kwarg clip: Optionally, limit value to range C{-/+B{clip}} (C{degrees}). @kwarg s_D_M_S: Optional, alternate symbol for degrees C{B{s_D}=str}, minutes, C{B{s_M}=str} and/or seconds C{B{s_S}=str}. @return: Degrees (C{float}). @raise ParseError: Invalid B{C{strDMS}} or B{C{clip}}. @raise RangeError: Value of B{C{strDMS}} outside the valid C{-/+B{clip}} range and L{pygeodesy.rangerrors} set to C{True}. @note: Unlike function L{parseDDDMMSS}, type C{float}, C{int} and other non-C{str} B{C{strDMS}} values are considered decimal (and not sexagecimal) degrees. For example, C{int(1230)} is returned as 1230.0 I{and not as 12.5} degrees and C{float(345)} as 345.0 I{and not as 3.75} degrees! @see: Functions L{pygeodesy.parseDDDMMSS}, L{pygeodesy.parseDMS2}, L{pygeodesy.parse3llh} and L{pygeodesy.toDMS}. ''' return _parseX(_DMS2deg, strDMS, suffix, sep, clip, s_D_M_S, strDMS=strDMS, suffix=suffix) def parseDMS2(strLat, strLon, sep=S_SEP, clipLat=90, clipLon=180, **s_D_M_S): '''Parse a lat- and a longitude representions C{"lat, lon"} in C{degrees}. @arg strLat: Latitude in any of several forms (C{str} or C{degrees}). @arg strLon: Longitude in any of several forms (C{str} or C{degrees}). @kwarg sep: Optional separator between deg°, min′, sec″, suffix (C{''}). @kwarg clipLat: Limit latitude to range C{-/+B{clipLat}} (C{degrees}). @kwarg clipLon: Limit longitude to range C{-/+B{clipLon}} (C{degrees}). @kwarg s_D_M_S: Optional, alternate symbol for degrees C{B{s_D}=str}, minutes, C{B{s_M}=str} and/or seconds C{B{s_S}=str}. @return: A L{LatLon2Tuple}C{(lat, lon)} in C{degrees}. @raise ParseError: Invalid B{C{strLat}} or B{C{strLon}}. @raise RangeError: Value of B{C{strLat}} or B{C{strLon}} outside the valid C{-/+B{clipLat}} or C{-/+B{clipLon}} range and L{pygeodesy.rangerrors} set to C{True}. @note: See the B{Notes} at function L{parseDMS}. @see: Functions L{pygeodesy.parseDDDMMSS}, L{pygeodesy.parseDMS}, L{pygeodesy.parse3llh} and L{pygeodesy.toDMS}. ''' return _MODS.namedTuples.LatLon2Tuple( parseDMS(strLat, suffix=_NS_, sep=sep, clip=clipLat, **s_D_M_S), parseDMS(strLon, suffix=_EW_, sep=sep, clip=clipLon, **s_D_M_S)) def parse3llh(strllh, height=0, sep=_COMMA_, clipLat=90, clipLon=180, **s_D_M_S): '''Parse a string C{"lat, lon [, h]"} representing lat-, longitude in C{degrees} and optional height in C{meter}. The lat- and longitude value must be separated by a separator character. If height is present it must follow, separated by another separator. The lat- and longitude values may be swapped, provided at least one ends with the proper compass point. @arg strllh: Latitude, longitude[, height] (C{str}, ...). @kwarg height: Optional, default height (C{meter}) or C{None}. @kwarg sep: Optional separator between C{"lat lon [h] suffix"} (C{str}). @kwarg clipLat: Limit latitude to range C{-/+B{clipLat}} (C{degrees}). @kwarg clipLon: Limit longitude to range C{-/+B{clipLon}} (C{degrees}). @kwarg s_D_M_S: Optional, alternate symbol for degrees C{B{s_D}=str}, minutes, C{B{s_M}=str} and/or seconds C{B{s_S}=str}. @return: A L{LatLon3Tuple}C{(lat, lon, height)} in C{degrees}, C{degrees} and C{float}. @raise RangeError: Lat- or longitude value of B{C{strllh}} outside the valid C{-/+B{clipLat}} or C{-/+B{clipLon}} range and L{pygeodesy.rangerrors} set to C{True}. @raise ValueError: Invalid B{C{strllh}} or B{C{height}}. @note: See the B{Notes} at function L{parseDMS}. @see: Functions L{pygeodesy.parseDDDMMSS}, L{pygeodesy.parseDMS}, L{pygeodesy.parseDMS2} and L{pygeodesy.toDMS}. @example: >>> parse3llh('000°00′05.31″W, 51° 28′ 40.12″ N') (51.4778°N, 000.0015°W, 0) ''' def _3llh(strllh, height, sep): ll = strllh.strip().split(sep) if len(ll) > 2: # XXX interpret height unit h = float(ll.pop(2).rstrip(_LETTERS).strip()) else: h = height # None from wgrs.Georef.__new__ if len(ll) != 2: raise ValueError a, b = [_.strip() for _ in ll] # PYCHOK false if a[-1:] in _EW_ or b[-1:] in _NS_: a, b = b, a return _MODS.namedTuples.LatLon3Tuple( parseDMS(a, suffix=_NS_, clip=clipLat, **s_D_M_S), parseDMS(b, suffix=_EW_, clip=clipLon, **s_D_M_S), h) return _parseX(_3llh, strllh, height, sep, strllh=strllh) def parseRad(strRad, suffix=_NSEW_, clip=0): '''Parse a string representing angle in C{radians}. @arg strRad: Degrees in any of several forms (C{str} or C{radians}). @kwarg suffix: Optional, valid compass points (C{str}, C{tuple}). @kwarg clip: Optionally, limit value to range C{-/+B{clip}} (C{radians}). @return: Radians (C{float}). @raise ParseError: Invalid B{C{strRad}} or B{C{clip}}. @raise RangeError: Value of B{C{strRad}} outside the valid C{-/+B{clip}} range and L{pygeodesy.rangerrors} set to C{True}. ''' def _Rad(strRad, suffix, clip): try: r = float(strRad) except (TypeError, ValueError): s, t, P = _split3(strRad, suffix.upper()) r = _dms2deg(s, P, float(t)) return clipRadians(r, float(clip)) if clip else r return _parseX(_Rad, strRad, suffix, clip, strRad=strRad, suffix=suffix) def precision(form, prec=None): '''Set the default precison for a given F_ form. @arg form: L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, L{F_D60}, L{F__E}, L{F__F}, L{F__G} or L{F_RAD} (C{str}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @return: Previous precision for the B{C{form}} (C{int}). @raise ValueError: Invalid B{C{form}} or B{C{prec}} or B{C{prec}} outside the valid range C{-/+9}. ''' try: p = _F_prec[form] except KeyError: raise _ValueError(form=form) if prec is not None: # set as default _F_prec[form] = _MODS.units.Precision_(prec=prec, low=-9, high=9) return p def toDMS(deg, form=F_DMS, prec=2, sep=S_SEP, ddd=2, neg=_MINUS_, pos=_PLUS_, **s_D_M_S): '''Convert I{signed} C{degrees} to string, without suffix. @arg deg: Degrees to be formatted (C{scalar degrees}). @kwarg form: Format specifier for B{C{deg}} (C{str} or L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, L{F_D60}, L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, L{F_SEC_}, L{F_D60_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, L{F_MIN__}, L{F_SEC__}, L{F_D60__}, L{F__E__}, L{F__F__}, L{F__G__} or L{F_RAD__}). @kwarg prec: Number of decimal digits (0..9 or C{None} for default). Trailing zero decimals are stripped for B{C{prec}} values of 1 and above, but kept for negative B{C{prec}}. @kwarg sep: Separator between degrees, minutes, seconds, suffix (C{str}). @kwarg ddd: Number of digits for B{C{deg}°} (2 or 3). @kwarg neg: Prefix for negative B{C{deg}} (C{'-'}). @kwarg pos: Prefix for positive B{C{deg}} and signed B{C{form}} (C{'+'}). @kwarg s_D_M_S: Optional keyword arguments C{B{s_D}=str}, C{B{s_M}=str} C{B{s_S}=str} and C{B{s_DMS}=True} to override any or cancel all DMS symbols, defaults L{S_DEG}, L{S_MIN} respectively L{S_SEC}. See B{Notes} below. @return: Degrees in the specified form (C{str}). @note: The degrees, minutes and seconds (DMS) symbol can be overridden in this and other C{*DMS} functions by using optional keyword argments C{B{s_D}="d"}, C{B{s_M}="'"} respectively C{B{s_S}='"'}. Using keyword argument B{C{s_DMS}=None} cancels all C{DMS} symbols to C{B{S_NUL}=NN}. @note: Sexagecimal format B{C{F_D60}} supports overridable pseudo-DMS symbols positioned at C{"[D]DD<B{s_D}>MM<B{s_M}>SS<B{s_S}>"} with defaults C{B{s_D}="."}, C{B{s_M}=B{sep}} and C{B{s_S}=}L{pygeodesy.NN}. @note: Formats B{C{F__E}}, B{C{F__F}} and B{C{F__G}} can be extended with a C{D}-only symbol if defined with keyword argument C{B{s_D}=str}. Likewise for B{C{F_RAD}} formats with keyword argument C{B{s_R}=str}. @see: Function L{pygeodesy.degDMS} ''' s = form[:1] f = form[1:] if s in _PLUSMINUS_ else form t = _toDMS(deg, f, prec, sep, ddd, NN, s_D_M_S) # unsigned and -suffixed if deg < 0 and neg: t = neg + t elif deg > 0 and s == _PLUS_ and pos: t = pos + t return t # **) MIT License # # Copyright (C) 2016-2023 -- 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.