Qf9zddlZddlZ ddlZn#e$r ddlmZYnwxYwddlmZmZmZm Z m Z ddl Z ddl Z ddl mZmZmZmZmZmZmZGddZdS)N)zoneinfo)AnyDictOptionalTupleUnion) Depression Elevation LocationInfoObserver SunDirection dms_to_floattodayc eZdZdZd:deefdZdedefdZ de fdZ e defd Z e defd Ze de fd Zejd e ddfd Ze de fdZejde ddfdZe defdZejdeee fddfdZe defdZejdeee fddfdZe de fdZejd e ddfdZe dejfdZeZe defdZejdeee efddfdZd;dedejfdZ dd5eejd"e!defd6Z7 d>d5eejd"e!defd7Z8 d>d5eejd"e!defd8Z9d=d!eejdefd9Z:dS)?Locationz3Provides access to information for single location.Ninfoc||tjj|_|st ddddd|_dS||_dS)a Initializes the Location with a LocationInfo object. The tuple should contain items in the following order ================ ============= Field Default ================ ============= name Greenwich region England time zone name Europe/London latitude 51.4733 longitude -0.0008333 ================ ============= See the :attr:`timezone` property for a method of obtaining time zone names GreenwichEnglandz Europe/Londong1*I@g~:NKN)r CIVILvalue_solar_depressionr _location_info)selfrs N/var/www/surfInsights/venv3-11/lib/python3.11/site-packages/astral/location.py__init__zLocation.__init__sS& )(2(8(> '".Y*##D   #'D   otherreturnc\t|tur|j|jkStSN)typerrNotImplemented)rrs r__eq__zLocation.__eq__8s* ;;( " "&%*>> >rc~|jr|jd|j}n|j}|d|jd|jdd|jdS)N/z, tz=z, lat=z0.02fz, lon=)regionnametimezonelatitude longitude)r_reprs r__repr__zLocation.__repr__=sm ; #yyy$++6EEIE * *4= * *= * * *> ) * * rcZt|j|j|j|j|jSr!)r r(r'r)r*r+rs rrz Location.infoHs- I K M M N    rc8t|j|jdSN)r r*r+r/s robserverzLocation.observerRs t~s;;;rc|jjSr!)rr(r/s rr(z Location.nameVs"''rr(cFtj|j||_dS)N)r( dataclassesreplacerrr(s rr(z Location.nameZs#)1$2EDQQQrc|jjSr!)rr'r/s rr'zLocation.region^s"))rr'cFtj|j||_dS)N)r'r6)rr's rr'zLocation.regionbs#)1$2EfUUUrc|jjS)u The location's latitude ``latitude`` can be set either as a string or as a number For strings they must be of the form degrees°minutes'[N|S] e.g. 51°31'N For numbers, positive numbers signify latitudes to the North. )rr*r/s rr*zLocation.latitudefs"++rr*cbtj|jt|d|_dS)NV@)r*r7r8rr)rr*s rr*zLocation.latitudeus4)1  ,x*F*F   rc|jjS)u The location's longitude. ``longitude`` can be set either as a string or as a number For strings they must be of the form degrees°minutes'[E|W] e.g. 51°31'W For numbers, positive numbers signify longitudes to the East. )rr+r/s rr+zLocation.longitude{s",,rr+cbtj|jt|d|_dS)Nf@)r+r?)rr+s rr+zLocation.longitudes4)1  < 5+I+I   rc|jjS)zThe name of the time zone for the location. A list of time zone names can be obtained from the zoneinfo module. For example. >>> import zoneinfo >>> assert "CET" in zoneinfo.available_timezones() )rr)r/s rr)zLocation.timezones"++rc|tjvrtd|ztj|j||_dS)NzTimezone '%s' not recognized)r))ravailable_timezones ValueErrorr7r8rr9s rr)zLocation.timezonesL x355 5 5;dBCC C)1$2EPTUUUrc tj|jj}|S#tj$r"}t d|jjz|d}~wwxYw)zTime zone information.zUnknown timezone '%s'N)rZoneInforr)ZoneInfoNotFoundErrorrF)rtzexcs rtzinfozLocation.tzinfosg "4#6#?@@BI-   '$*=*FF  s"AAAc|jS)aThe number of degrees the sun must be below the horizon for the dawn/dusk calculation. Can either be set as a number of degrees below the horizon or as one of the following strings ============= ======= String Degrees ============= ======= civil 6.0 nautical 12.0 astronomical 18.0 ============= ======= )rr/s rsolar_depressionzLocation.solar_depressions "%%r depressionct|tr1 dddd||_dS#t$rtdwxYwt|tr|j|_dSt ||_dS)Ng@g(@g2@)civilnautical astronomicalzXsolar_depression must be either a number or one of 'civil', 'nautical' or 'astronomical') isinstancestrrKeyErrorr rfloat)rrOs rrNzLocation.solar_depressions j# & & 7  $$(** *&&&    )  J / / 7%/%5D " " "%*:%6%6D " " "s *ATlocalcJ|rt|jStSr!)rrL)rrXs rrzLocation.todays#  %% %77Nrr2dateobserver_elevationc>|r|jtd|||}t|j|j|}|r,t j|||j|j St j|||jS)aReturns dawn, sunrise, noon, sunset and dusk as a dictionary. :param date: The date for which to calculate the times. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: Dictionary with keys ``dawn``, ``sunrise``, ``noon``, ``sunset`` and ``dusk`` whose values are the results of the corresponding methods. N6Local time requested but Location has no timezone set.) r)rFrr r*r+astralsunrNrLrrZrXr[r3s rr_z Location.suns.  WT]*UVV V <::e$$DDM4>;MNN  I:>>(D$2GUU U:>>(D$2GHH Hrc>|r|jtd|||}t|j|j|}|r,t j|||j |j St j|||j S)a Calculates the time in the morning when the sun is a certain number of degrees below the horizon. By default this is 6 degrees but can be changed by setting the :attr:`Astral.solar_depression` property. :param date: The date for which to calculate the dawn time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: The date and time at which dawn occurs. Nr]) r)rFrr r*r+r^r_dawnrNrLr`s rrbz Location.dawns.  WT]*UVV V <::e$$DDM4>;MNN  J:??8T43H$+VV V:??8T43HII Irc&|r|jtd|||}t|j|j|}|r&t j|||j St j||S)aReturn sunrise time. Calculates the time in the morning when the sun is a 0.833 degrees below the horizon. This is to account for refraction. :param date: The date for which to calculate the sunrise time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: The date and time at which sunrise occurs. Nr]) r)rFrr r*r+r^r_sunriserLr`s rrdzLocation.sunrise)s0  WT]*UVV V <::e$$DDM4>;MNN  6:%%hdkBB B:%%h55 5rc$|r|jtd|||}t|j|j}|r&t j|||j St j||S)aCalculates the solar noon (the time when the sun is at its highest point.) :param date: The date for which to calculate the noon time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :returns: The date and time at which the solar noon occurs. Nr]) r)rFrr r*r+r^r_noonrLrrZrXr3s rrfz Location.noonNs  WT]*UVV V <::e$$DDM4>::  3:??8T4;?? ?:??8T22 2rc&|r|jtd|||}t|j|j|}|r&t j|||j St j||S)aCalculates sunset time (the time in the evening when the sun is a 0.833 degrees below the horizon. This is to account for refraction.) :param date: The date for which to calculate the sunset time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: The date and time at which sunset occurs. Nr]) r)rFrr r*r+r^r_sunsetrLr`s rrizLocation.sunsetjs,  WT]*UVV V <::e$$DDM4>;MNN  5:$$XtT[AA A:$$Xt44 4rc>|r|jtd|||}t|j|j|}|r,t j|||j |j St j|||j S)aCalculates the dusk time (the time in the evening when the sun is a certain number of degrees below the horizon. By default this is 6 degrees but can be changed by setting the :attr:`solar_depression` property.) :param date: The date for which to calculate the dusk time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: The date and time at which dusk occurs. Nr]) r)rFrr r*r+r^r_duskrNrLr`s rrkz Location.dusks0  WT]*UVV V <::e$$DDM4>;MNN  J:??8T43H$+VV V:??8T43HII Irc$|r|jtd|||}t|j|j}|r&t j|||j St j||S)aCalculates the solar midnight (the time when the sun is at its lowest point.) :param date: The date for which to calculate the midnight time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :returns: The date and time at which the solar midnight occurs. Nr]) r)rFrr r*r+r^r_midnightrLrgs rrmzLocation.midnights  WT]*UVV V <::e$$DDM4>::  7:&&xt{CC C:&&x66 6rc&|r|jtd|||}t|j|j|}|r&t j|||j St j||S)asCalculates the daylight time (the time between sunrise and sunset) :param date: The date for which to calculate daylight. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: A tuple containing the start and end times Nr]) r)rFrr r*r+r^r_daylightrLr`s rrozLocation.daylights*  WT]*UVV V <::e$$DDM4>;MNN  7:&&xt{CC C:&&x66 6rc&|r|jtd|||}t|j|j|}|r&t j|||j St j||S)aCalculates the night time (the time between astronomical dusk and astronomical dawn of the next day) :param date: The date for which to calculate the start of the night time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :returns: A tuple containing the start and end times Nr]) r)rFrr r*r+r^r_nightrLr`s rrqzLocation.nights,  WT]*UVV V <::e$$DDM4>;MNN  4:##HdDK@@ @:##Hd33 3r directionc*|r|jtd|||}t|j|j|}|r't j||||j St j|||S)aReturns the start and end times of Twilight in the UTC timezone when the sun is traversing in the specified direction. This method defines twilight as being between the time when the sun is at -6 degrees and sunrise/sunset. :param direction: Determines whether the time is for the sun rising or setting. Use ``astral.SUN_RISING`` or ``astral.SunDirection.SETTING``. :param date: The date for which to calculate the times. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :return: A tuple of the UTC date and time at which twilight starts and ends. Nr]) r)rFrr r*r+r^r_twilightrL)rrZrrrXr[r3s rrtzLocation.twilights8  WT]*UVV V <::e$$DDM4>;MNN  B:&&xy$+NN N:&&xyAA Arc&|r|jtd|||}t|j|jd}|r&t j|||j St j||S)aCalculates the time when the moon rises. :param date: The date for which to calculate the moonrise time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :returns: The date and time at which moonrise occurs. Nr]r) r)rFrr r*r+r^moonmoonriserLrgs rrwzLocation.moonrise=s"  WT]*UVV V <::e$$DDM4>1==  8;''$ DD D;''$77 7rc&|r|jtd|||}t|j|jd}|r&t j|||j St j||S)aCalculates the time when the moon sets. :param date: The date for which to calculate the moonset time. If no date is specified then the current date will be used. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :returns: The date and time at which moonset occurs. Nr]r) r)rFrr r*r+r^rvmoonsetrLrgs rryzLocation.moonset[s"  WT]*UVV V <::e$$DDM4>1==  7;&&xt{CC C;&&x66 6r elevationc\|r|jtd|||}|dkrd|z }tj}t |j|jd}|r(tj |||||j Stj ||||S)a%Calculate the time when the sun is at the specified elevation. Note: This method uses positive elevations for those above the horizon. Elevations greater than 90 degrees are converted to a setting sun i.e. an elevation of 110 will calculate a setting sun at 70 degrees. :param elevation: Elevation in degrees above the horizon to calculate for. :param date: The date for which to calculate the elevation time. If no date is specified then the current date will be used. :param direction: Determines whether the time is for the sun rising or setting. Use ``SunDirection.RISING`` or ``SunDirection.SETTING``. Default is rising. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. If not specified then the time will be returned in local time :returns: The date and time at which dusk occurs. Nr]r>rBr2) r)rFrr SETTINGr r*r+r^r_time_at_elevationrL)rrzrZrrrXr3s rr}zLocation.time_at_elevationys>  WT]*UVV V <::e$$D t   )I$,IDM4>3??  V://)T9dk ://)T9UU Urc(|r|jtd|||}t|j|j|}|r't j|||j St j||S)a Calculates the period of rahukaalam. :param date: The date for which to calculate the rahukaalam period. A value of ``None`` uses the current date. :param local: True = Time to be returned in location's time zone; False = Time to be returned in UTC. :param observer_elevation: Elevation of the observer in metres above the location. :return: Tuple containing the start and end times for Rahukaalam. Nr]rL) r)rFrr r*r+r^r_ rahukaalamrLr`s rrzLocation.rahukaalams(  WT]*UVV V <::e$$DDM4>;MNN  9:((4 (LL L:((488 8rc*|r|jtd|||}t|j|j|}|r't j||||j St j|||S)aReturns the start and end times of the Golden Hour when the sun is traversing in the specified direction. This method uses the definition from PhotoPills i.e. the golden hour is when the sun is between 4 degrees below the horizon and 6 degrees above. :param direction: Determines whether the time is for the sun rising or setting. Use ``SunDirection.RISING`` or ``SunDirection.SETTING``. Default is rising. :param date: The date for which to calculate the times. :param local: True = Times to be returned in location's time zone; False = Times to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :return: A tuple of the date and time at which the Golden Hour starts and ends. Nr]) r)rFrr r*r+r^r_ golden_hourrLrrrrZrXr[r3s rrzLocation.golden_hours<  WT]*UVV V <::e$$DDM4>;MNN  E:))(D)T[QQ Q:))(D)DD Drc*|r|jtd|||}t|j|j|}|r't j||||j St j|||S)a*Returns the start and end times of the Blue Hour when the sun is traversing in the specified direction. This method uses the definition from PhotoPills i.e. the blue hour is when the sun is between 6 and 4 degrees below the horizon. :param direction: Determines whether the time is for the sun rising or setting. Use ``SunDirection.RISING`` or ``SunDirection.SETTING``. Default is rising. :param date: The date for which to calculate the times. If no date is specified then the current date will be used. :param local: True = Times to be returned in location's time zone; False = Times to be returned in UTC. If not specified then the time will be returned in local time :param observer_elevation: Elevation of the observer in metres above the location. :return: A tuple of the date and time at which the Blue Hour starts and ends. Nr]) r)rFrr r*r+r^r_ blue_hourrLrs rrzLocation.blue_hours<  WT]*UVV V <::e$$DDM4>;MNN  C:''$ 4;OO O:''$ BB Br dateandtimecR|%tj|j}n"|js||j}t |j|j|}|tj j }tj ||S)zCalculates the solar azimuth angle for a specific date/time. :param dateandtime: The date and time for which to calculate the angle. :returns: The azimuth angle in degrees clockwise from North. Nr) r^r_nowrLr8r r*r+ astimezonedatetimer)utcazimuthrrr[r3s r solar_azimuthzLocation.solar_azimuth"s   *..55KK# B%--T[-AAKDM4>;MNN!,,X->-BCC z!!(K888rcR|%tj|j}n"|js||j}t |j|j|}|tj j }tj ||S)zCalculates the solar elevation angle for a specific time. :param dateandtime: The date and time for which to calculate the angle. :returns: The elevation angle in degrees above the horizon. Nr) r^r_rrLr8r r*r+rrr)rrzrs rsolar_elevationzLocation.solar_elevation7s   *..55KK# B%--T[-AAKDM4>;MNN!,,X->-BCC z##Hk:::rc4d|||z S)zCalculates the solar zenith angle for a specific time. :param dateandtime: The date and time for which to calculate the angle. :returns: The zenith angle in degrees from vertical. r>)r)rrr[s r solar_zenithzLocation.solar_zenithMs d**;8JKKKKrcn|||}tj|S)aCalculates the moon phase for a specific date. :param date: The date to calculate the phase for. If ommitted the current date is used. :returns: A number designating the phase ============ ============== 0 .. 6.99 New moon 7 .. 13.99 First quarter 14 .. 20.99 Full moon 21 .. 27.99 Last quarter ============ ============== )rr^rvphase)rrZrXs r moon_phasezLocation.moon_phaseZs0" <::e$$D{  &&&rr!)T)NTr2)NTr1);__name__ __module__ __qualname____doc__rr robjectboolr$rUr-propertyrr r3r(setterr'rWr*rr+r)rrHrLrJrNr rrZrr rrr_rbrdrfrirkrmrrorqr RISINGrtrwryr}rrrrrrrrrrrs7 ==''Xl3'''':Ft  #      l   X <(<<<X<(c(((X( [RRRRR[R****X* ]VSVTVVV]V ,% , , ,X ,_ ucz!2 t   _  -5 - - -X - 5#4      ,# , , ,X ,_VSVTVVV_V  )   X  B &%&&&X&$75Z1G+H7T7777*48=)-(+ "I"Ix}%"I"I& "I c3h "I"I"I"IL)-(+ "J"Jx}%"J"J& "J   "J"J"J"JL)-(+ #6#6x}%#6#6& #6   #6#6#6#6LCG33X]+3;?3  3333<)-(+ !5!5x}%!5!5& !5   !5!5!5!5J)-(+ #J#Jx}%#J#J& #J   #J#J#J#JLCG77X]+7;?7  7777>)-(+ 7 7x}% 7 7& 7 x ("33 4 7 7 7 7H)-(+ !4!4x}%!4!4& !4 x ("33 4 !4!4!4!4J)-"."5(+ 'B'Bx}%'B 'B 'B & 'B'B'B'BV)-88x}%88 (# $ 8888@)-77x}%77 (# $ 7777B)-"."5 0V0V0Vx}%0V 0V  0V   0V0V0V0Vh)-(+ 99x}%99& 9 x ("33 4 9999F#/"5(,(+ )E)E)Ex}%)E )E & )E x ("33 4 )E)E)E)EZ#/"5(,(+ )C)C)Cx}%)C )C & )C x ("33 4 )C)C)C)CZ48(+99h/09&9  9999.48(+;;h/0;&;  ;;;;048(+ L Lh/0 L& L  L L L L''x 6'd''''''rr)r7rr ImportError backportstypingrrrrr astral.moonr^ astral.sunr r r r r rrrrrrrs7#OOOO###""""""""#54444444444444V 'V 'V 'V 'V 'V 'V 'V 'V 'V 's