diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index d6fc2a6..0000000 --- a/.editorconfig +++ /dev/null @@ -1,18 +0,0 @@ -[*] -charset = utf-8 -end_of_line = lf -indent_style = space -insert_final_newline = true -trim_trailing_whitespace = true - -[*.py] -indent_size = 4 - -[*.rst] -indent_size = 3 - -[*.{json,yml}] -indent_size = 2 - -[.api_key] -insert_final_newline = false diff --git a/.env b/.env deleted file mode 100644 index 56a282d..0000000 --- a/.env +++ /dev/null @@ -1 +0,0 @@ -PYTHONPATH=src diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index e69de29..0000000 diff --git a/.github/workflows/go.yaml b/.github/workflows/go.yaml new file mode 100644 index 0000000..a2ac462 --- /dev/null +++ b/.github/workflows/go.yaml @@ -0,0 +1,25 @@ +name: Go +on: + - push + - pull_request +jobs: + build: + name: Test + runs-on: ubuntu-latest + # We want to run on external PRs, but not on our own internal PRs as they'll be run by the push to the branch. + if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository + steps: + - name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: '^1.15' + id: go + - name: Check out code into the Go module directory + uses: actions/checkout@v2 + - name: Get dependencies + run: | + go get -v -t -d ./... + - name: Build + run: go build -v ./cmd/astral/ + - name: Test + run: go test -race ./... diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 969beeb..0000000 --- a/.travis.yml +++ /dev/null @@ -1,13 +0,0 @@ -language: python -python: - - "3.6" - - "3.7" -script: - - tox -c tox.travis.ini -install: - - pip install -r requirements.txt - - pip install -r requirements-dev.txt - - pip install tox-travis -env: - global: - secure: YMwnRT0ySBmEq2zFbsd341l+1l6Vm35buq2SqkZozPCkNLnJshfUltb3EevYEz/ICOIKraGkms4iIjTHuBeASlSj976qHzcupY7SupVVMonCqbE44gholPX1/wh/MRR8zKvj8kx+vHIREchQjD7EgTaHbYK77bBztgNl679setKrIWNIk5HxjpiskvD8BGRPl6q8X0GLav5K5Jl/zT0Dgc+XKWsmSIoUZcAE16GFjzqQOB+L5KZcF/eu5slNyUf07Rpun/BWQ/kVEC9h2SEl1XBxGRBYoVnVQuVB5A6NZKPATT4eJm0nFwrEjSHHnCrhbaFz7y0I7NsljKTAnFVoMvFUy7YByrcfid8CIvLgpfqdIVP6asn/rnXSuh+oxQ3qLn3aYzY9lXPsKqX7RnWdgmJhqEocHRj2TE6/8lMw3ucAb6HIs2Ol48lULP2RA1oaak6Mhu0ZZ71wcIhDF+e/vGKaUdikaP9ZBPfb9Vzr6CS/uarL9kFBOU2mX8/wKpMjv4PtESjOxv6/y/XziO4Jju6xMVxc1a66zoToJBTUM6UjJXmyMEDVulAEQ9NsUUSWc3zSd+jpGoBQF6Q0B2m/IWiYBZtCoPQX41LN7jEH99Co/5D2P5Y/BpNeWDVgaRMIwiF4jT/IrDp1ZeJCddHPGkgF6GGniP5WLh5yLnhSahE= diff --git a/AUTHORS b/AUTHORS index d53c163..606dbc4 100644 --- a/AUTHORS +++ b/AUTHORS @@ -5,3 +5,4 @@ Simon Kennedy Wojciech Pietruszeski Zachary Priddy Michael Marx +Simon Jürgensmeyer diff --git a/ChangeLog.md b/ChangeLog.md deleted file mode 100644 index 96ba809..0000000 --- a/ChangeLog.md +++ /dev/null @@ -1,106 +0,0 @@ -# CHANGELOG - -## 2.2 - 2020-05-20 - -### Changed - -- Fix for [bug #48](https://github.com/sffjunkie/astral/issues/48). As per the bug report the angle to adjust for the effect of elevation should have been θ (not α). -- The sun functions can now also be passed the timezone as a string. Previously only a pytz timezone was accepted. - -## 2.1 - 2020-02-12 - -### Bug Fix - -- Fix for bug #44 - Incorrectly raised exception when UTC sun times were on the day previous to the day asked for. This only manifested itself for timezones with a large positive offset. - -## 2.0 - 2020-02-11 - -### Refactor - -- This is a code refactor as well as an update so it is highly likely that you will need to adapt your code to suit. -- Astral, AstralGeocoder & GoogleGeocoder classes removed -- Requires python 3.6+ due to the use of dataclasses -- New LocationInfo class to store a location name, region, timezone, latitude & longitude -- New Observer class to store a latitude, longitude & elevation -- Geocoder database now returns a LocationInfo instead of a Location - -## 1.10.1 - 2019-02-06 - -### Changed - -Keywords arguments to Astral **init** are now passed to the geocoder to allow for passing -the `api_key` to GoogleGeocoder. - -## 1.10 - 2019-02-04 - -### Added - -Added method to AstralGeocoder to add locations to the database - -## 1.9.2 - 2019-01-31 - -### Changed - -Version 1.9 broke the sun_utc method. Sun UTC calculation passed incorrect -parameter to more specific methods e.g. sunrise, sunset etc. - -## 1.9.1 - 2019-01-28 - -### Changed - -Corrected version number in module source code. - -## 1.9 - 2019-01-28 - -### Added - -Sun calculations now take into account the elevation of the location. - -## 1.8 - 2018-12-06 - -### Added - -Added command line interface to return sun information as json. -Added support for no timezone in Location methods. - -## 1.7.1 - 2018-10-25 - -### Changed - -Changed GoogleGeocoder test to not use raise...from as this is not valid for Python 2 - -## 1.7 - 2018-10-24 - -### Changed - -- Requests is now only needed when using GoogleGeocoder -- GoogleGeocoder now requires the `api_key` parameter to be passed to the constructor - -## 1.6.1 - 2018-05-02 - -### Changed - -- Updated Travis CI configuration - -### Added - -- requirements-dev.txt - -## 1.6 - 2018-02-22 - -### Changed - -- Added api_key parameter to GoogleGeocoder **init** method. Idea from - wpietruszewski https://github.com/sffjunkie/astral/pull/12 - -## 1.5 - 2017-12-07 - -### Added - -- this file - -### Changed - -- dawn_utc, sunrise_utc, sunset_utc and dusk_utc now only raise AstralError for a math domain - exception all other exceptions are passed through. -- moon_phase now takes another parameter if the type to return either int (the default) or float diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 23f12a8..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,6 +0,0 @@ -global-exclude *.pyc -include setup.cfg -include monkeypatch.py -include LICENSE -recursive-include docs * -recursive-include src/test *.py diff --git a/Makefile b/Makefile deleted file mode 100644 index c2d4b52..0000000 --- a/Makefile +++ /dev/null @@ -1,44 +0,0 @@ -.PHONY: clean test test-docs test-all html report build-docs repl show-docs show-cov typecheck - -all: clean test report html - -BUILDDIR=$(DEV_HOME)/build/astral - -clean: - @COVERAGE_FILE=$(BUILDDIR)/.coverage coverage erase - @rm -rf $(BUILDDIR)/doctrees - -test: - tox - -test-docs: - tox -e doc - -test-all: - tox -e py36,py37,nopytz,doc - -html: - @COVERAGE_FILE=$(BUILDDIR)/.coverage coverage html -d $(BUILDDIR)/htmlcov/ - -report: - @COVERAGE_FILE=$(BUILDDIR)/.coverage coverage report - -build-docs: - sphinx-build -a -b html -d $(BUILDDIR)/doctrees ./src/docs ./docs - -repl: - @PYTHONPATH=src python - -show-docs: - /usr/bin/start ./doc/index.html - -publish-docs: - git subtree push --prefix docs origin gh-pages - -show-cov: - /usr/bin/start $(BUILDDIR)/htmlcov/index.html - -typecheck: - @cd src - mypy astral - @cd .. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1a1666 --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ +# Astral + +![Action](https://github.com/sj14/astral/workflows/Go/badge.svg) +[![GoDoc](https://godoc.org/github.com/sj14/astral?status.png)](https://godoc.org/github.com/sj14/astral) + +Calculations for the position of the sun and moon. + +This is a Go port of the Python [astral](https://github.com/sffjunkie/astral) package. + +The `astral` package provides the means to calculate the following times of the sun: + +* dawn +* sunrise +* noon +* midnight +* sunset +* dusk +* daylight +* night +* twilight +* blue hour +* golden hour +* ~~rahukaalam~~ TODO + +plus solar azimuth and elevation at a specific latitude/longitude. +It can also calculate the moon phase for a specific date. + +## CLI + +Besides the package for usage in you own programs, we also provide a tool for showing the data. + +### Installation + +```text +go get github.com/sj14/astral/cmd/astral +``` + +### Usage + +```text +Usage of astral: + -elev float + elevation of the observer + -format string + time output format according to Go parsing (default "Jan _2 15:04:05") + -lat float + latitude of the observer + -long float + longitude of the observer + -time string + day/time used for the calculation (defaults to current time) +``` + +### Example + +```text +$ astral -lat 51.58 -long 6.52 +Sun Apr 18 11:12:45 CEST 2021 +Latitude 51.58 Longitude 6.52 Elevation 0 +Apr 18 05:55:07 Dawn +Apr 18 05:55:07 Blue Hour Start +Apr 18 06:09:04 Blue Hour End +Apr 18 06:09:04 Golden Hour Start +Apr 18 06:31:44 Sunrise +Apr 18 07:15:56 Golden Hour End +Apr 18 13:33:18 Noon +Apr 18 19:51:24 Golden Hour Start +Apr 18 20:35:45 Sunset +Apr 18 20:58:33 Golden Hour End +Apr 18 20:58:33 Blue Hour Start +Apr 18 21:12:35 Blue Hour End +Apr 18 21:12:35 Dusk +Apr 19 01:33:13 Midnight +Moon Phase: New Moon (5.47788888888889) +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 2f77fdf..0000000 --- a/README.rst +++ /dev/null @@ -1,18 +0,0 @@ -Astral -====== - -|travis_status| |pypi_ver| - -.. |travis_status| image:: https://travis-ci.org/sffjunkie/astral.svg?branch=master - :target: https://travis-ci.org/sffjunkie/astral - -.. |pypi_ver| image:: https://img.shields.io/pypi/v/astral.svg - :target: https://pypi.org/project/astral/ - -This is 'astral' a Python module which calculates - - * Times for various positions of the sun: dawn, sunrise, solar noon, - sunset, dusk, solar elevation, solar azimuth and rahukaalam. - * The phase of the moon. - -For documentation see the https://astral.readthedocs.io/en/latest/index.html diff --git a/cmd/astral/main.go b/cmd/astral/main.go new file mode 100644 index 0000000..3004001 --- /dev/null +++ b/cmd/astral/main.go @@ -0,0 +1,132 @@ +package main + +import ( + "flag" + "fmt" + "log" + "time" + + "github.com/sj14/astral" +) + +func main() { + var ( + timeFlag = flag.String("time", time.Now().Format(time.RFC3339), "day/time used for the calculation") + formatFlag = flag.String("format", "Jan _2 15:04:05", "time output format according to Go parsing") + latFlag = flag.Float64("lat", 0, "latitude of the observer") + longFlag = flag.Float64("long", 0, "longitude of the observer") + elevationFlag = flag.Float64("elev", 0, "elevation of the observer") + ) + flag.Parse() + + observer := astral.Observer{Latitude: *latFlag, Longitude: *longFlag, Elevation: *elevationFlag} + + t, err := time.Parse(time.RFC3339, *timeFlag) + if err != nil { + log.Fatalf("failed parsing time: %v\n", err) + } + + fmt.Printf("%v\n", t.Format(time.UnixDate)) + fmt.Printf("Latitude %v Longitude %v Elevation %v\n", *latFlag, *longFlag, *elevationFlag) + + // sun := astral.Sun(observer, now, astral.DepressionCivil) + // fmt.Printf("sun at %+v\n", sun) + + dawn, err := astral.Dawn(observer, t, astral.DepressionCivil) + if err != nil { + log.Println(err) + } + fmt.Printf("%v Dawn\n", dawn.Format(*formatFlag)) + + blueStart, blueEnd, err := astral.BlueHour(observer, t, astral.SunDirectionRising) + if err != nil { + log.Println(err) + } + fmt.Printf("%v Blue Hour Start\n", blueStart.Format(*formatFlag)) + fmt.Printf("%v Blue Hour End\n", blueEnd.Format(*formatFlag)) + + goldenRisingStart, goldenRisingEnd, err := astral.GoldenHour(observer, t, astral.SunDirectionRising) + if err != nil { + log.Println(err) + } + + sunrise, err := astral.Sunrise(observer, t) + if err != nil { + log.Println(err) + } + + fmt.Printf("%v Golden Hour Start\n", goldenRisingStart.Format(*formatFlag)) + fmt.Printf("%v Sunrise\n", sunrise.Format(*formatFlag)) + fmt.Printf("%v Golden Hour End\n", goldenRisingEnd.Format(*formatFlag)) + + noon := astral.Noon(observer, t) + fmt.Printf("%v Noon\n", noon.Format(*formatFlag)) + + goldenSettingStart, goldenSettingEnd, err := astral.GoldenHour(observer, t, astral.SunDirectionSetting) + if err != nil { + log.Println(err) + } + + sunset, err := astral.Sunset(observer, t) + if err != nil { + log.Println(err) + } + + fmt.Printf("%v Golden Hour Start\n", goldenSettingStart.Format(*formatFlag)) + fmt.Printf("%v Sunset\n", sunset.Format(*formatFlag)) + fmt.Printf("%v Golden Hour End\n", goldenSettingEnd.Format(*formatFlag)) + + blueSettingStart, blueSettingEnd, err := astral.BlueHour(observer, t, astral.SunDirectionSetting) + if err != nil { + log.Println(err) + } + fmt.Printf("%v Blue Hour Start\n", blueSettingStart.Format(*formatFlag)) + fmt.Printf("%v Blue Hour End\n", blueSettingEnd.Format(*formatFlag)) + + dusk, err := astral.Dusk(observer, t, astral.DepressionCivil) + if err != nil { + log.Println(err) + } + fmt.Printf("%v Dusk\n", dusk.Format(*formatFlag)) + + // daylightStart, daylightEnd, err := astral.Daylight(observer, now) + // if err != nil { + // log.Println(err) + // } + // fmt.Printf("daylight start: %v daylight end: %v\n", daylightStart, daylightEnd) + + // nightStart, nightEnd, err := astral.Night(observer, now) + // if err != nil { + // log.Println(err) + // } + // fmt.Printf("night start: %v night end: %v\n", nightStart, nightEnd) + + // rahukaalamStart, rahukaalamEnd := astral.Rahukaalam(observer, now, true) + // fmt.Printf("rahukaalam start: %v rahukaalam end: %v\n", rahukaalamStart, rahukaalamEnd) + + // elevation := astral.Elevation(observer, t, true) + // elevationTime, err := astral.TimeAtElevation(observer, elevation, t, astral.SunDirectionSetting) + // if err != nil { + // log.Println(err) + // } + // fmt.Printf("%v Elevation\n", elevationTime.Format(*formatFlag)) + + midnight := astral.Midnight(observer, t) + fmt.Printf("%v Midnight\n", midnight.Format(*formatFlag)) + + // twilightStart, twilightEnd, err := astral.Twilight(observer, now, astral.SunDirectionSetting) // same as sunset and dusk + // if err != nil { + // log.Println(err) + // } + // fmt.Printf("twilight start: %v twilight end: %v\n", twilightStart, twilightEnd) + + // zenith, azimuth := astral.ZenithAndAzimuth(observer, now, true) + // fmt.Printf("zenith: %v azimuth: %v\n", zenith, azimuth) + + moonPhase := astral.MoonPhase(t) + moonDesc, err := astral.MoonPhaseDescription(moonPhase) + if err != nil { + log.Fatalf("failed parsing moon phase: %v", err) + } + fmt.Printf("Moon Phase: %v (%v)\n", moonDesc, moonPhase) +} diff --git a/docs/.buildinfo b/docs/.buildinfo deleted file mode 100644 index bc8c01a..0000000 --- a/docs/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: bea1f8fadef5270aa54650c3d653dd1d -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_images/elevation_horizon.svg b/docs/_images/elevation_horizon.svg deleted file mode 100644 index 256a4a1..0000000 --- a/docs/_images/elevation_horizon.svg +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - c=r+elevation - θ - - A - b=r - - θ = arccos(r/(r+elevation)) - B - - C - - θ - - - diff --git a/docs/_images/elevation_sun.svg b/docs/_images/elevation_sun.svg deleted file mode 100644 index 9fbb8bd..0000000 --- a/docs/_images/elevation_sun.svg +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - ISS elevation = 408 kmdistance to sun = 149,600,000 km - Θ1 - - - - Θ2 - - - Sun - ground - X - Y2 - Y1 - - - - - X = distance to sun * sin(Θ1)Y1 = distance to sun * cos(Θ1)Y2 = Y1 - ISS elevationΘ2 = tan-1(Y2 / X)Θ1=1, Θ2=0.8437, Δ=0.1562Θ1=45, Θ2=44.8892, Δ=0.1107 - ISS - - diff --git a/docs/_sources/astral.rst.txt b/docs/_sources/astral.rst.txt deleted file mode 100644 index e285750..0000000 --- a/docs/_sources/astral.rst.txt +++ /dev/null @@ -1,5 +0,0 @@ -astral -====== - -.. automodule:: astral - :members: diff --git a/docs/_sources/examples.rst.txt b/docs/_sources/examples.rst.txt deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_sources/geocoder.rst.txt b/docs/_sources/geocoder.rst.txt deleted file mode 100644 index 0116184..0000000 --- a/docs/_sources/geocoder.rst.txt +++ /dev/null @@ -1,5 +0,0 @@ -astral.geocoder -=============== - -.. automodule:: astral.geocoder - :members: diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt deleted file mode 100644 index 89be5f1..0000000 --- a/docs/_sources/index.rst.txt +++ /dev/null @@ -1,735 +0,0 @@ -.. Copyright 2009-2019, Simon Kennedy, sffjunkie+code@gmail.com - -.. Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - -.. http://www.apache.org/licenses/LICENSE-2.0 - -.. Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -.. TODO: Spatial reference system - WGS-84? - -.. TODO: Add note about accuracy - -.. TODO: Add note that 0.833 is half sun's disc + refraction adjustment - -Astral v\ |release| -=================== - -| |travis_status| |pypi_ver| - -Astral is a python package for calculating the times of various aspects of -the sun and phases of the moon. - -It can calculate the following - -Dawn - The time in the morning when the sun is a specific number of degrees - below the horizon. - -Sunrise - The time in the morning when the top of the sun breaks the horizon - (asuming a location with no obscuring features.) - -Noon - The time when the sun is at its highest point directly above the observer. - -Midnight - The time when the sun is at its lowest point. - -Sunset - The time in the evening when the sun is about to disappear below the - horizon (asuming a location with no obscuring features.) - -Dusk - The time in the evening when the sun is a specific number of degrees - below the horizon. - -Daylight - The time when the sun is up i.e. between sunrise and sunset - -Night - The time between astronomical dusk of one day and astronomical dawn of the - next - -Twilight - The time between dawn and sunrise or between sunset and dusk - -The Golden Hour - The time when the sun is between 4 degrees below the horizon and 6 degrees - above. - -The Blue Hour - The time when the sun is between 6 and 4 degrees below the horizon. - -Time At Elevation - the time when the sun is at a specific elevation for either a rising or a - setting sun. - -Solar Azimuth - The number of degrees clockwise from North at which the sun can be seen - -Solar Zenith - The angle of the sun down from directly above the observer - -Solar Elevation - The number of degrees up from the horizon at which the sun can be seen - -`Rahukaalam`_ - "Rahukaalam or the period of Rahu is a certain amount of time every day - that is considered inauspicious for any new venture according to Indian - Vedic astrology". - -Moon Phase - The phase of the moon for a specified date. - -Astral also comes with a geocoder containing a local database that allows you -to look up information for a small set of locations (`new locations can be -added `__). - -.. note:: - - The Google Geocoder has been removed. Instead you should use the - Google Client for Google Maps Services - https://github.com/googlemaps/google-maps-services-python - -Examples -======== - -The following examples demonstrates some of the functionality available in the -module - -Sun ----- - -.. code-block:: python - - >>> from astral import LocationInfo - >>> city = LocationInfo("London", "England", "Europe/London", 51.5, -0.116) - >>> print(( - f"Information for {city.name}/{city.region}\n" - f"Timezone: {city.timezone}\n" - f"Latitude: {city.latitude:.02f}; Longitude: {city.longitude:.02f}\n" - )) - - Information for London/England - Timezone: Europe/London - Latitude: 51.50; Longitude: -0.12 - - >>> import datetime - >>> from astral.sun import sun - >>> s = sun(city.observer, date=datetime.date(2009, 4, 22)) - >>> print(( - f'Dawn: {s["dawn"]}\n' - f'Sunrise: {s["sunrise"]}\n' - f'Noon: {s["noon"]}\n' - f'Sunset: {s["sunset"]}\n' - f'Dusk: {s["dusk"]}\n' - )) - Dawn: 2009-04-22 04:13:04.923309+00:00 - Sunrise: 2009-04-22 04:50:16.515411+00:00 - Noon: 2009-04-22 11:59:02+00:00 - Sunset: 2009-04-22 19:08:41.215821+00:00 - Dusk: 2009-04-22 19:46:06.362457+00:00 - -.. note:: - - The example above calculates the times of the sun in the UTC timezone. - If you want to return times in a different timezone you can pass the - tzinfo parameter to the function. - - .. code-block:: python - - s = sun(city.observer, date=datetime.date(2009, 4, 22), tzinfo=city.timezone) - - In versions prior to 2.2 you'll need to pass a pytz timezone as tzinfo e.g. - - .. code-block:: python - - s = sun(city.observer, - date=datetime.date(2009, 4, 22), - tzinfo=pytz.timezone(city.timezone)) - -Moon ----- - -.. code-block:: python - - >>> import datetime - >>> from astral import moon - >>> moon.phase(datetime.date(2018, 1, 1)) - 13.255666666666668 - -The moon phase method returns an number describing the phase, where the value -is between 0 and 27.99. The following lists the mapping of various values to -the description of the phase of the moon. - -============ ============== -0 .. 6.99 New moon -7 .. 13.99 First quarter -14 .. 20.99 Full moon -21 .. 27.99 Last quarter -============ ============== - -If for example the number returned was 27.99 then the moon would be almost at -the New Moon phase, and if it was 24.00 it would be half way between the Last -Quarter and a New Moon. - -.. note :: - - The moon phase does not depend on your location. However what the moon - actually looks like to you does depend on your location. If you're in the - southern hemisphere it looks different than if you were in the northern - hemisphere. - - See http://moongazer.x10.mx/website/astronomy/moon-phases/ for an example. - - For an example of using this library to generate moon phases including the - names in various languages and the correct Unicode glyphs see the - `project by PanderMusubi `_ - on Github. - -Geocoder --------- - -.. code-block:: python - - >>> from astral.geocoder import database, lookup - >>> lookup("London", database()) - LocationInfo(name='London', region='England', timezone='Europe/London', - latitude=51.473333333333336, longitude=-0.0008333333333333334) - -.. note:: - - Location elevations have been removed from the database. These were added - due to a misunderstanding of the affect of elevation on the times of the - sun. These are not required for the calculations, only the elevation of the - observer above/below the location is needed. - - See `Effect of Elevation`_ below. - -Custom Location -~~~~~~~~~~~~~~~ - -If you only need a single location that is not in the database then you can -construct a :class:`~astral.LocationInfo` and fill in the values, either on -initialization - -.. code-block:: python - - from astral import LocationInfo - l = LocationInfo('name', 'region', 'timezone/name', 0.1, 1.2) - -or set the attributes after initialization:: - - from astral import LocationInfo - l = LocationInfo() - l.name = 'name' - l.region = 'region' - l.timezone = 'US/Central' - l.latitude = 0.1 - l.longitude = 1.2 - -.. note:: - - `name` and `region` can be anything you like. - -.. _additional_locations: - -Additional Locations -~~~~~~~~~~~~~~~~~~~~ - -You can add to the list of available locations using the -:func:`~astral.geocoder.add_locations` function and passing either a string -with one line per location or by passing a list containing strings, lists or -tuples (lists and tuples are passed directly to the LocationInfo constructor). - -.. code-block:: python - - >>> from astral.geocoder import add_locations, database, lookup - >>> db = database() - >>> try: - ... lookup("Somewhere", db) - ... except KeyError: - ... print("Somewhere not found") - ... - Somewhere not found - >>> add_locations("Somewhere,Secret Location,UTC,24°28'N,39°36'E", db) - >>> lookup("Somewhere", db) - LocationInfo(name='Somewhere', region='Secret Location', timezone='UTC', - latitude=24.466666666666665, longitude=39.6) - -Timezone Groups -~~~~~~~~~~~~~~~ - -Timezone groups such as Europe can be accessed via the :func:`group` function -in the :mod:`~astral.geocoder` module - -.. code-block:: python - - >>> from astral.geocoder import group - >>> europe = group("europe") - >>> sorted(europe.keys()) - ['aberdeen', 'amsterdam', 'andorra_la_vella', 'ankara', 'athens', ...] - - -Effect of Elevation -=================== - -Times Of The Sun ----------------- - -The times of the sun that you experience depend on what obscurs your view of -it. It may either be obscured by the horizon or some other geographical -feature (e.g. mountains) - -1. If what obscures you at ground level is the horizon and you are at a - elevation above ground level then the times of the sun depends on how far - further round the earth you can see due to your elevation (the sun rises - earlier and sets later). - - The extra angle you can see round the earth is determined by calculating the - angle α in the image below based on your elevation above ground level, - and adding this to the depression angle for the sun calculations. - - .. image:: static/elevation_horizon.svg - :class: adjustment - -2. If your view is obscured by some other geographical feature than the - horizon, then the adjustment angle is based on how far you are above or - below the feature and your distance to it. - -For the first case i.e. obscured by the horizon you need to pass a single float -to the Observer as its elevation. For the second case pass a tuple of 2 -floats. The first being the vertical distance to the top of the feature and -the second the horizontal distance to the feature. - -Elevation Of The Sun --------------------- - -Even though an observer's elevation can significantly affect the times of the -sun the same is not true for the elevation angle from the observer to the sun. - -As an example the diagram below shows the difference in angle between an -observer at ground level and one on the ISS orbiting 408 km above the earth. - -.. image:: static/elevation_sun.svg - :class: adjustment - -The largest difference between the two angles is when the angle at ground -level is 1 degree. The difference then is approximately 0.15 degrees. - -At the summit of mount Everest (8,848 m) the maximum difference is -0.00338821 degrees. - -Due to the very small difference the astral package does not currently adjust -the solar elevation for changes in observer elevation. - -Effect of Refraction -==================== - -When viewing the sun the position you see it at is different from its actual -position due to the effect of atmospheric `refraction`_ which -makes the sun appear to be higher in the sky. The calculations in the -package take this refraction into account. - -The :func:`~astral.sun.sunrise` and :func:`~astral.sun.sunset` functions -use the refraction at an angle when the sun is half of its apparent diameter -below the horizon. This is between about 30 and 32 arcminutes and for the -astral package a value of 32" is used. - -.. note:: - - The refraction calculation does not take into account - temperature and pressure which can affect the angle of refraction. - -Note on Localized Timezones -=========================== - -When creating a datetime object in a specific timezone do not use the -`tzinfo` parameter to the datetime constructor. Instead use the -:meth:`~pytz.tzinfo.localize` method provided by pytz on the correct pytz -timezone:: - - >>> dt = datetime.datetime(2015, 1, 1, 9, 0, 0) - >>> pytz.timezone('Europe/London').localize(dt) - datetime.datetime(2015, 1, 1, 9, 0, tzinfo=) - - -License -======= - -This module is licensed under the terms of the `Apache`_ V2.0 license. - -Dependencies -============ - -Astral has one required external Python dependency on `pytz`. - -Installation -============ - -To install Astral you should use the `pip`_ tool:: - - pip3 install astral - -.. note:: - - Now that we are Python 3 only and pip provides a versioned executable on - Windows you should use the `pip3` command on all operating systems - to ensure you are targetting the right Python version. - -Cities -====== - -The module includes location and time zone data for the following cities. -The list includes all capital cities plus some from the UK. The list also -includes the US state capitals and some other US cities. - -Aberdeen, Abu Dhabi, Abu Dhabi, Abuja, Accra, Addis Ababa, Adelaide, Al Jubail, -Albany, Albuquerque, Algiers, Amman, Amsterdam, Anchorage, Andorra la Vella, -Ankara, Annapolis, Antananarivo, Apia, Ashgabat, Asmara, Astana, Asuncion, -Athens, Atlanta, Augusta, Austin, Avarua, Baghdad, Baku, Baltimore, Bamako, -Bandar Seri Begawan, Bangkok, Bangui, Banjul, Barrow-In-Furness, Basse-Terre, -Basseterre, Baton Rouge, Beijing, Beirut, Belfast, Belgrade, Belmopan, Berlin, -Bern, Billings, Birmingham, Birmingham, Bishkek, Bismarck, Bissau, -Bloemfontein, Bogota, Boise, Bolton, Boston, Bradford, Brasilia, Bratislava, -Brazzaville, Bridgeport, Bridgetown, Brisbane, Bristol, Brussels, Bucharest, -Bucuresti, Budapest, Buenos Aires, Buffalo, Bujumbura, Burlington, Cairo, -Canberra, Cape Town, Caracas, Cardiff, Carson City, Castries, Cayenne, -Charleston, Charlotte, Charlotte Amalie, Cheyenne, Chicago, Chisinau, -Cleveland, Columbia, Columbus, Conakry, Concord, Copenhagen, Cotonou, Crawley, -Dakar, Dallas, Damascus, Dammam, Denver, Des Moines, Detroit, Dhaka, Dili, -Djibouti, Dodoma, Doha, Douglas, Dover, Dublin, Dushanbe, Edinburgh, El Aaiun, -Fargo, Fort-de-France, Frankfort, Freetown, Funafuti, Gaborone, George Town, -Georgetown, Gibraltar, Glasgow, Greenwich, Guatemala, Hanoi, Harare, -Harrisburg, Hartford, Havana, Helena, Helsinki, Hobart, Hong Kong, Honiara, -Honolulu, Houston, Indianapolis, Islamabad, Jackson, Jacksonville, Jakarta, -Jefferson City, Jerusalem, Juba, Jubail, Juneau, Kabul, Kampala, Kansas City, -Kathmandu, Khartoum, Kiev, Kigali, Kingston, Kingston, Kingstown, Kinshasa, -Koror, Kuala Lumpur, Kuwait, La Paz, Lansing, Las Vegas, Leeds, Leicester, -Libreville, Lilongwe, Lima, Lincoln, Lisbon, Little Rock, Liverpool, Ljubljana, -Lome, London, Los Angeles, Louisville, Luanda, Lusaka, Luxembourg, Macau, -Madinah, Madison, Madrid, Majuro, Makkah, Malabo, Male, Mamoudzou, Managua, -Manama, Manchester, Manchester, Manila, Maputo, Maseru, Masqat, Mbabane, Mecca, -Medina, Melbourne, Memphis, Mexico, Miami, Milwaukee, Minneapolis, Minsk, -Mogadishu, Monaco, Monrovia, Montevideo, Montgomery, Montpelier, Moroni, -Moscow, Moskva, Mumbai, Muscat, N'Djamena, Nairobi, Nashville, Nassau, -Naypyidaw, New Delhi, New Orleans, New York, Newark, Newcastle, Newcastle Upon -Tyne, Ngerulmud, Niamey, Nicosia, Norwich, Nouakchott, Noumea, Nuku'alofa, -Nuuk, Oklahoma City, Olympia, Omaha, Oranjestad, Orlando, Oslo, Ottawa, -Ouagadougou, Oxford, P'yongyang, Pago Pago, Palikir, Panama, Papeete, -Paramaribo, Paris, Perth, Philadelphia, Phnom Penh, Phoenix, Pierre, Plymouth, -Podgorica, Port Louis, Port Moresby, Port of Spain, Port-Vila, Port-au-Prince, -Portland, Portland, Porto-Novo, Portsmouth, Prague, Praia, Pretoria, Pristina, -Providence, Quito, Rabat, Raleigh, Reading, Reykjavik, Richmond, Riga, Riyadh, -Road Town, Rome, Roseau, Sacramento, Saint Helier, Saint Paul, Saint Pierre, -Saipan, Salem, Salt Lake City, San Diego, San Francisco, San Jose, San Juan, -San Marino, San Salvador, Sana, Sana'a, Santa Fe, Santiago, Santo Domingo, Sao -Tome, Sarajevo, Seattle, Seoul, Sheffield, Singapore, Sioux Falls, Skopje, -Sofia, Southampton, Springfield, Sri Jayawardenapura Kotte, St. George's, St. -John's, St. Peter Port, Stanley, Stockholm, Sucre, Suva, Swansea, Swindon, -Sydney, T'bilisi, Taipei, Tallahassee, Tallinn, Tarawa, Tashkent, Tbilisi, -Tegucigalpa, Tehran, Thimphu, Tirana, Tirane, Tokyo, Toledo, Topeka, Torshavn, -Trenton, Tripoli, Tunis, Ulaanbaatar, Ulan Bator, Vaduz, Valletta, Vienna, -Vientiane, Vilnius, Virginia Beach, W. Indies, Warsaw, Washington DC, -Wellington, Wichita, Willemstad, Wilmington, Windhoek, Wolverhampton, -Yamoussoukro, Yangon, Yaounde, Yaren, Yerevan, Zagreb - -US Cities ---------- - -Albany, Albuquerque, Anchorage, Annapolis, Atlanta, Augusta, Austin, Baltimore, -Baton Rouge, Billings, Birmingham, Bismarck, Boise, Boston, Bridgeport, -Buffalo, Burlington, Carson City, Charleston, Charlotte, Cheyenne, Chicago, -Cleveland, Columbia, Columbus, Concord, Dallas, Denver, Des Moines, Detroit, -Dover, Fargo, Frankfort, Harrisburg, Hartford, Helena, Honolulu, Houston, -Indianapolis, Jackson, Jacksonville, Jefferson City, Juneau, Kansas City, -Lansing, Las Vegas, Lincoln, Little Rock, Los Angeles, Louisville, Madison, -Manchester, Memphis, Miami, Milwaukee, Minneapolis, Montgomery, Montpelier, -Nashville, New Orleans, New York, Newark, Oklahoma City, Olympia, Omaha, -Orlando, Philadelphia, Phoenix, Pierre, Portland, Portland, Providence, -Raleigh, Richmond, Sacramento, Saint Paul, Salem, Salt Lake City, San Diego, -San Francisco, Santa Fe, Seattle, Sioux Falls, Springfield, Tallahassee, -Toledo, Topeka, Trenton, Virginia Beach, Wichita, Wilmington - -Thanks -====== - -The sun calculations in this module were adapted, for Python, from the -spreadsheets on the following page. - - | https://www.esrl.noaa.gov/gmd/grad/solcalc/calcdetails.html - -Refraction calculation is taken from - - | Sun-Pointing Programs and Their Accuracy - | John C. Zimmerman Of Sandia National Laboratones - | https://www.osti.gov/servlets/purl/6377969 - -Which cites the following as the original source - - | In Solar Energy Vol 20 No.5-C - | Robert Walraven Of The University Of California, Davis - -The moon phase calculation is based on some javascript code -from Sky and Telescope magazine - - | Moon-phase calculation - | Roger W. Sinnott, Sky & Telescope, June 16, 2006. - | http://www.skyandtelescope.com/wp-content/observing-tools/moonphase/moon.html - -Also to `Sphinx`_ for making doc generation an easy thing (not that the writing -of the docs is any easier.) - -Contact -======= - -Simon Kennedy - -Version History -=============== - -========== ==================================================================== -Version Description -========== ==================================================================== -2.2 Fix for `bug #48`_ - As per the bug report the angle to adjust for - the effect of elevation should have been θ (not α). - - The sun functions can now also be passed a timezone name as a - string. Previously only a pytz timezone was accepted. ----------- -------------------------------------------------------------------- -2.1 Fix for bug #44 - Incorrectly raised exception when UTC sun times - were on the day previous to the day asked for. Only manifested for - timezones with a large positive offset. ----------- -------------------------------------------------------------------- -2.0 This is a code refactor as well as an update so it is highly likely - that you will need to adapt your code to suit. - - Astral, AstralGeocoder & GoogleGeocoder classes removed - - Now only compatible with Python 3.6 and greater due to the - use of data classes - - New :class:`~astral.Observer` data class to store a latitude, - longitude & elevation - - New :class:`~astral.LocationInfo` data class to store a location - name, region, timezone, latitude & longitude - - Geocoder functions return a :class:`~astral.LocationInfo` instead - of a :class:`~astral.location.Location` - - All calculations now automatically adjust for refraction. - For elevation you can return the true angle by setting the - `with_refraction` parameter to False. - - The solar_noon and solar_midnight functions have been renamed to - :func:`~astral.sun.noon` and :func:`~astral.sun.midnight` - respectively. - - Rahukaalam can now be calculated for night times. ----------- -------------------------------------------------------------------- -1.10.1 Keyword args are now passed to the geocoder class from Astral - __init__ in order to allow the Google Maps API key to be passed to - the GoogleGeocoder. ----------- -------------------------------------------------------------------- -1.10 Added support to AstralGeocoder to add - `additional locations `__ - to the database. ----------- -------------------------------------------------------------------- -1.9.2 1.9 broke the sun_utc method. Sun UTC calculation passed incorrect - parameter to more specific methods e.g. sunrise, sunset etc. ----------- -------------------------------------------------------------------- -1.9.1 Correct version number in astral.py ----------- -------------------------------------------------------------------- -1.9 Now takes elevation into account. ----------- -------------------------------------------------------------------- -1.8 Location methods now allow the timezone to be None which returns all - times as UTC. - - Added command line interface to return 'sun' values ----------- -------------------------------------------------------------------- -1.7.1 Changed GoogleGeocoder test to not use raise...from as this is not - valid for Python 2 ----------- -------------------------------------------------------------------- -1.7 Requests is now only needed when using GoogleGeocoder - - GoogleGeocoder now requires the `api_key` parameter to be passed to - the constructor as Google now require it for their API calls. ----------- -------------------------------------------------------------------- -1.6.1 Updates for Travis CI integration / Github signed release. ----------- -------------------------------------------------------------------- -1.6 Added api_key parameter to the GoogleGeocoder :meth:`__init__` - method ----------- -------------------------------------------------------------------- -1.5 Added parameter `rtype` to :meth:`moon_phase` to determine the - return type of the method. - - Added example for calculating the phase of the moon. ----------- -------------------------------------------------------------------- -1.4.1 Using versioneer to manage version numbers ----------- -------------------------------------------------------------------- -1.4 Changed to use calculations from NOAA spreadsheets - - Changed some exception error messages for when sun does not reach - a requested elevation. - - Added more tests ----------- -------------------------------------------------------------------- -1.3.4 Changes to project configuration files. No user facing changes. ----------- -------------------------------------------------------------------- -1.3.3 Fixed call to twilight_utc as date and direction parameters - were reversed. ----------- -------------------------------------------------------------------- -1.3.2 Updated URL to point to gitgub.com - - Added Apache 2.0 boilerplate to source file ----------- -------------------------------------------------------------------- -1.3.1 Added LICENSE file to sdist ----------- -------------------------------------------------------------------- -1.3 Corrected solar zenith to return the angle from the vertical. - - Added solar midnight calculation. ----------- -------------------------------------------------------------------- -1.2 Added handling for when unicode literals are used. This may possibly - affect your code if you're using Python 2 (there are tests for this - but they may not catch all uses.) (Bug `1588198`_\) - - Changed timezone for Phoenix, AZ to America/Phoenix - (Bug `1561258`_\) ----------- -------------------------------------------------------------------- -1.1 Added methods to calculate Twilight, the Golden Hour and the Blue - Hour. ----------- -------------------------------------------------------------------- -1.0 It's time for a version 1.0 - - Added examples where the location you want is not in the Astral - geocoder. ----------- -------------------------------------------------------------------- -0.9 Added a method to calculate the date and time when the sun is at a - specific elevation, for either a rising or a setting sun. - - Added daylight and night methods to Location and Astral classes. - - Rahukaalam methods now return a tuple. ----------- -------------------------------------------------------------------- -0.8.2 Fix for moon phase calcualtions which were off by 1. - - Use pytz.timezone().localize method instead of passing tzinfo - parameter to datetime.datetime. See the `pytz docs`_ for info ----------- -------------------------------------------------------------------- -0.8.1 Fix for bug `1417641`_\: :meth:`~astral.Astral.solar_elevation` and - :meth:`~astral.Astral.solar_azimuth` fail when a naive - :class:`~datetime.datetime` object is used. - - Added :meth:`solar_zenith` methods to :class:`~astral.Astral` - and :class:`~astral.Location` as an - alias for :meth:`solar_elevation` - - Added `tzinfo` as an alias for `tz` ----------- -------------------------------------------------------------------- -0.8 Fix for bug `1407773`_\: Moon phase calculation changed to remove - time zone parameter (tz) as it is not required for the calculation. ----------- -------------------------------------------------------------------- -0.7.5 Fix for bug `1402103`_\: Buenos Aires incorrect timezone ----------- -------------------------------------------------------------------- -0.7.4 Added Canadian cities from Yip Shing Ho ----------- -------------------------------------------------------------------- -0.7.3 Fix for bug `1239387`_ submitted by Torbjörn Lönnemark ----------- -------------------------------------------------------------------- -0.7.2 Minor bug fix in :class:`~astral.GoogleGeocoder`. location name and - region are now stripped of whitespace ----------- -------------------------------------------------------------------- -0.7.1 Bug fix. Missed a vital return statement in the - :class:`~astral.GoogleGeocoder` ----------- -------------------------------------------------------------------- -0.7 Added ability to lookup location information from - Google's mapping APIs (see :class:`~astral.GoogleGeocoder`) - - Renamed :class:`City` class to :class:`~astral.Location` - - Renamed :class:`CityDB` to :class:`~astral.AstralGeocoder` - - Added elevations of cities to database and property to - obtain elevation from :class:`~astral.Location` class ----------- -------------------------------------------------------------------- -0.6.2 Added various cities to database as per - https://bugs.launchpad.net/astral/+bug/1040936 ----------- -------------------------------------------------------------------- -0.6.1 Docstrings were not updated to match changes to code. - - Other minor docstring changes made ----------- -------------------------------------------------------------------- -0.6 Fix for bug `884716`_ submitted by Martin Heemskerk - regarding moon phase calculations - - Fixes for bug report `944754`_ submitted by Hajo Werder - - - Changed co-ordinate system so that eastern longitudes - are now positive - - Added solar_depression property to City class ----------- -------------------------------------------------------------------- -0.5 Changed :class:`City` to accept unicode name and country. - - Moved city information into a database class :class:`CityDB` - - Added attribute access to database for timezone groups ----------- -------------------------------------------------------------------- -0.4 Duplicate city names could not be accessed. - - Sun calculations for some cities failed with times - outside valid ranges. - - Fixes for city data. - - Added calculation for moon phase. ----------- -------------------------------------------------------------------- -0.3 Changed to `Apache`_ V2.0 license. - - Fix for bug `555508`_ submitted by me. - - US state capitals and other cities added. ----------- -------------------------------------------------------------------- -0.2 Fix for bug `554041`_ submitted by Derek\_ / John Dimatos ----------- -------------------------------------------------------------------- -0.1 First release -========== ==================================================================== - -.. _Rahukaalam: http://en.wikipedia.org/wiki/Rahukaalam -.. _Sourceforge: http://pytz.sourceforge.net/ -.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall -.. _Apache: http://www.opensource.org/licenses/apache2.0.php -.. _Sphinx: http://sphinx.pocoo.org/ -.. _554041: https://bugs.launchpad.net/astral/+bug/554041 -.. _555508: https://bugs.launchpad.net/astral/+bug/555508 -.. _884716: https://bugs.launchpad.net/astral/+bug/884716 -.. _944754: https://bugs.launchpad.net/astral/+bug/944754 -.. _1239387: https://bugs.launchpad.net/astral/+bug/1239387 -.. _1402103: https://bugs.launchpad.net/astral/+bug/1402103 -.. _1407773: https://bugs.launchpad.net/astral/+bug/1407773 -.. _1417641: https://bugs.launchpad.net/astral/+bug/1417641 -.. _1561258: https://bugs.launchpad.net/astral/+bug/1561258 -.. _1588198: https://bugs.launchpad.net/astral/+bug/1588198 -.. _pytz docs: http://pytz.sourceforge.net/#localized-times-and-date-arithmetic -.. _issue: https://github.com/sffjunkie/astral/issues -.. _refraction: https://en.wikipedia.org/wiki/Refraction -.. _pip: https://pip.pypa.io/en/stable/ -.. _bug #48: https://github.com/sffjunkie/astral/issues/48 - -.. |travis_status| image:: https://travis-ci.org/sffjunkie/astral.svg?branch=master - :target: https://travis-ci.org/sffjunkie/astral - -.. |pypi_ver| image:: https://img.shields.io/pypi/v/astral.svg - :target: https://pypi.org/project/astral/ - -.. toctree:: - :maxdepth: 2 - :hidden: - - package diff --git a/docs/_sources/location.rst.txt b/docs/_sources/location.rst.txt deleted file mode 100644 index c650d58..0000000 --- a/docs/_sources/location.rst.txt +++ /dev/null @@ -1,5 +0,0 @@ -astral.location -=============== - -.. autoclass:: astral.location.Location - :members: diff --git a/docs/_sources/moon.rst.txt b/docs/_sources/moon.rst.txt deleted file mode 100644 index 973a50f..0000000 --- a/docs/_sources/moon.rst.txt +++ /dev/null @@ -1,5 +0,0 @@ -astral.moon -=========== - -.. automodule:: astral.moon - :members: diff --git a/docs/_sources/package.rst.txt b/docs/_sources/package.rst.txt deleted file mode 100644 index 269a5ca..0000000 --- a/docs/_sources/package.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -.. Copyright 2009-2019, Simon Kennedy, sffjunkie+code@gmail.com - -.. Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - -.. http://www.apache.org/licenses/LICENSE-2.0 - -.. Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -The :mod:`astral` Package -========================= - -.. automodule:: astral - :members: - -astral.sun -~~~~~~~~~~~ - -.. automodule:: astral.sun - :members: - -astral.moon -~~~~~~~~~~~ - -.. automodule:: astral.moon - :members: - -astral.geocoder -~~~~~~~~~~~~~~~ - -.. automodule:: astral.geocoder - :members: - -astral.location -~~~~~~~~~~~~~~~ - -.. autoclass:: astral.location.Location - :members: diff --git a/docs/_sources/sun.rst.txt b/docs/_sources/sun.rst.txt deleted file mode 100644 index c09b8bb..0000000 --- a/docs/_sources/sun.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -astral.sun -========== - -.. automodule:: astral.sun - :members: - diff --git a/docs/_static/astral.css b/docs/_static/astral.css deleted file mode 100644 index 80bfbb0..0000000 --- a/docs/_static/astral.css +++ /dev/null @@ -1,3 +0,0 @@ -img.adjustment { - margin: 1rem 1.5rem; -} diff --git a/docs/_static/basic.css b/docs/_static/basic.css deleted file mode 100644 index 0eacf21..0000000 --- a/docs/_static/basic.css +++ /dev/null @@ -1,535 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; -} - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlighted { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/docs/_static/bootstrap-scrollspy.js b/docs/_static/bootstrap-scrollspy.js deleted file mode 100644 index dce3718..0000000 --- a/docs/_static/bootstrap-scrollspy.js +++ /dev/null @@ -1,151 +0,0 @@ -/* ============================================================= - * bootstrap-scrollspy.js v2.0.4 - * http://twitter.github.com/bootstrap/javascript.html#scrollspy - * ============================================================= - * Copyright 2012 Twitter, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============================================================== */ - - -!function ($) { - - "use strict"; // jshint ;_; - - - /* SCROLLSPY CLASS DEFINITION - * ========================== */ - - function ScrollSpy( element, options) { - var process = $.proxy(this.process, this) - , $element = $(element).is('body') ? $(window) : $(element) - , href - this.options = $.extend({}, $.fn.scrollspy.defaults, options) - this.$scrollElement = $element.on('scroll.scroll.data-api', process) - this.selector = (this.options.target - || ((href = $(element).attr('href')) && href.replace(/.*(?=#[^\s]+$)/, '')) //strip for ie7 - || '') + ' .nav li > a' - this.$body = $('body') - this.refresh() - this.process() - } - - ScrollSpy.prototype = { - - constructor: ScrollSpy - - , refresh: function () { - var self = this - , $targets - - this.offsets = $([]) - this.targets = $([]) - - $targets = this.$body - .find(this.selector) - .map(function () { - var $el = $(this) - , href = $el.data('target') || $el.attr('href') - , $href = /^#\w/.test(href) && $(href) - return ( $href - && href.length - && [[ $href.position().top, href ]] ) || null - }) - .sort(function (a, b) { return a[0] - b[0] }) - .each(function () { - self.offsets.push(this[0]) - self.targets.push(this[1]) - }) - } - - , process: function () { - var scrollTop = this.$scrollElement.scrollTop() + this.options.offset - , scrollHeight = this.$scrollElement[0].scrollHeight || this.$body[0].scrollHeight - , maxScroll = scrollHeight - this.$scrollElement.height() - , offsets = this.offsets - , targets = this.targets - , activeTarget = this.activeTarget - , i - - if (scrollTop >= maxScroll) { - return activeTarget != (i = targets.last()[0]) - && this.activate ( i ) - } - - for (i = offsets.length; i--;) { - activeTarget != targets[i] - && scrollTop >= offsets[i] - && (!offsets[i + 1] || scrollTop <= offsets[i + 1]) - && this.activate( targets[i] ) - } - } - - , activate: function (target) { - var active - , selector - - this.activeTarget = target - - $(this.selector) - .parent('.active') - .removeClass('active') - - selector = this.selector - + '[data-target="' + target + '"],' - + this.selector + '[href="' + target + '"]' - - active = $(selector) - .parent('li') - .addClass('active') - - if (active.parent('.dropdown-menu')) { - active = active.closest('li.dropdown').addClass('active') - } - - active.trigger('activate') - } - - } - - - /* SCROLLSPY PLUGIN DEFINITION - * =========================== */ - - $.fn.scrollspy = function ( option ) { - return this.each(function () { - var $this = $(this) - , data = $this.data('scrollspy') - , options = typeof option == 'object' && option - if (!data) $this.data('scrollspy', (data = new ScrollSpy(this, options))) - if (typeof option == 'string') data[option]() - }) - } - - $.fn.scrollspy.Constructor = ScrollSpy - - $.fn.scrollspy.defaults = { - offset: 10 - } - - - /* SCROLLSPY DATA-API - * ================== */ - - $(function () { - $('[data-spy="scroll"]').each(function () { - var $spy = $(this) - $spy.scrollspy($spy.data()) - }) - }) - -}(window.jQuery); \ No newline at end of file diff --git a/docs/_static/classic.css b/docs/_static/classic.css deleted file mode 100644 index b4fd80f..0000000 --- a/docs/_static/classic.css +++ /dev/null @@ -1,266 +0,0 @@ -/* - * classic.css_t - * ~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- classic theme. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -html { - /* CSS hack for macOS's scrollbar (see #1125) */ - background-color: #FFFFFF; -} - -body { - font-family: sans-serif; - font-size: 100%; - background-color: #11303d; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: #1c4e63; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: #ffffff; - color: #000000; - padding: 0 20px 30px 20px; -} - -div.footer { - color: #ffffff; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #ffffff; - text-decoration: underline; -} - -div.related { - background-color: #133f52; - line-height: 30px; - color: #ffffff; -} - -div.related a { - color: #ffffff; -} - -div.sphinxsidebar { -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: #ffffff; -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: #ffffff; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: #ffffff; -} - -div.sphinxsidebar a { - color: #98dbcc; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - - - -/* -- hyperlink styles ------------------------------------------------------ */ - -a { - color: #355f7c; - text-decoration: none; -} - -a:visited { - color: #355f7c; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - - - -/* -- body styles ----------------------------------------------------------- */ - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: 'Trebuchet MS', sans-serif; - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: #eeffcc; - color: #333333; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -code { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -th, dl.field-list > dt { - background-color: #ede; -} - -.warning code { - background: #efc2c2; -} - -.note code { - background: #d6d6d6; -} - -.viewcode-back { - font-family: sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; -} - -div.code-block-caption { - color: #efefef; - background-color: #1c4e63; -} \ No newline at end of file diff --git a/docs/_static/default.css b/docs/_static/default.css deleted file mode 100644 index 81b9363..0000000 --- a/docs/_static/default.css +++ /dev/null @@ -1 +0,0 @@ -@import url("classic.css"); diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js deleted file mode 100644 index daccd20..0000000 --- a/docs/_static/doctools.js +++ /dev/null @@ -1,315 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - }, - - initOnKeyListeners: function() { - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js deleted file mode 100644 index 8578b75..0000000 --- a/docs/_static/documentation_options.js +++ /dev/null @@ -1,12 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '2.2', - LANGUAGE: 'None', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file diff --git a/docs/_static/earth_sun.png b/docs/_static/earth_sun.png deleted file mode 100644 index 4443720..0000000 Binary files a/docs/_static/earth_sun.png and /dev/null differ diff --git a/docs/_static/elevation_horizon.svg b/docs/_static/elevation_horizon.svg deleted file mode 100644 index 256a4a1..0000000 --- a/docs/_static/elevation_horizon.svg +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - c=r+elevation - θ - - A - b=r - - θ = arccos(r/(r+elevation)) - B - - C - - θ - - - diff --git a/docs/_static/elevation_sun.svg b/docs/_static/elevation_sun.svg deleted file mode 100644 index 9fbb8bd..0000000 --- a/docs/_static/elevation_sun.svg +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - ISS elevation = 408 kmdistance to sun = 149,600,000 km - Θ1 - - - - Θ2 - - - Sun - ground - X - Y2 - Y1 - - - - - X = distance to sun * sin(Θ1)Y1 = distance to sun * cos(Θ1)Y2 = Y1 - ISS elevationΘ2 = tan-1(Y2 / X)Θ1=1, Θ2=0.8437, Δ=0.1562Θ1=45, Θ2=44.8892, Δ=0.1107 - ISS - - diff --git a/docs/_static/favicon.png b/docs/_static/favicon.png deleted file mode 100644 index 72d427b..0000000 Binary files a/docs/_static/favicon.png and /dev/null differ diff --git a/docs/_static/file.png b/docs/_static/file.png deleted file mode 100644 index a858a41..0000000 Binary files a/docs/_static/file.png and /dev/null differ diff --git a/docs/_static/home.png b/docs/_static/home.png deleted file mode 100644 index 5f6b305..0000000 Binary files a/docs/_static/home.png and /dev/null differ diff --git a/docs/_static/info_32.png b/docs/_static/info_32.png deleted file mode 100644 index ca14a12..0000000 Binary files a/docs/_static/info_32.png and /dev/null differ diff --git a/docs/_static/jquery-3.4.1.js b/docs/_static/jquery-3.4.1.js deleted file mode 100644 index 773ad95..0000000 --- a/docs/_static/jquery-3.4.1.js +++ /dev/null @@ -1,10598 +0,0 @@ -/*! - * jQuery JavaScript Library v3.4.1 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2019-05-01T21:04Z - */ -( function( global, factory ) { - - "use strict"; - - if ( typeof module === "object" && typeof module.exports === "object" ) { - - // For CommonJS and CommonJS-like environments where a proper `window` - // is present, execute the factory and get jQuery. - // For environments that do not have a `window` with a `document` - // (such as Node.js), expose a factory as module.exports. - // This accentuates the need for the creation of a real `window`. - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info. - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 -// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode -// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common -// enough that all such attempts are guarded in a try block. -"use strict"; - -var arr = []; - -var document = window.document; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var concat = arr.concat; - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var fnToString = hasOwn.toString; - -var ObjectFunctionString = fnToString.call( Object ); - -var support = {}; - -var isFunction = function isFunction( obj ) { - - // Support: Chrome <=57, Firefox <=52 - // In some browsers, typeof returns "function" for HTML elements - // (i.e., `typeof document.createElement( "object" ) === "function"`). - // We don't want to classify *any* DOM node as a function. - return typeof obj === "function" && typeof obj.nodeType !== "number"; - }; - - -var isWindow = function isWindow( obj ) { - return obj != null && obj === obj.window; - }; - - - - - var preservedScriptAttributes = { - type: true, - src: true, - nonce: true, - noModule: true - }; - - function DOMEval( code, node, doc ) { - doc = doc || document; - - var i, val, - script = doc.createElement( "script" ); - - script.text = code; - if ( node ) { - for ( i in preservedScriptAttributes ) { - - // Support: Firefox 64+, Edge 18+ - // Some browsers don't support the "nonce" property on scripts. - // On the other hand, just using `getAttribute` is not enough as - // the `nonce` attribute is reset to an empty string whenever it - // becomes browsing-context connected. - // See https://github.com/whatwg/html/issues/2369 - // See https://html.spec.whatwg.org/#nonce-attributes - // The `node.getAttribute` check was added for the sake of - // `jQuery.globalEval` so that it can fake a nonce-containing node - // via an object. - val = node[ i ] || node.getAttribute && node.getAttribute( i ); - if ( val ) { - script.setAttribute( i, val ); - } - } - } - doc.head.appendChild( script ).parentNode.removeChild( script ); - } - - -function toType( obj ) { - if ( obj == null ) { - return obj + ""; - } - - // Support: Android <=2.3 only (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call( obj ) ] || "object" : - typeof obj; -} -/* global Symbol */ -// Defining this global in .eslintrc.json would create a danger of using the global -// unguarded in another place, it seems safer to define global only for this module - - - -var - version = "3.4.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }, - - // Support: Android <=4.0 only - // Make sure we trim BOM and NBSP - rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; - -jQuery.fn = jQuery.prototype = { - - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - - // Return all the elements in a clean array - if ( num == null ) { - return slice.call( this ); - } - - // Return just the one element from the set - return num < 0 ? this[ num + this.length ] : this[ num ]; - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - each: function( callback ) { - return jQuery.each( this, callback ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map( this, function( elem, i ) { - return callback.call( elem, i, elem ); - } ) ); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: arr.sort, - splice: arr.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[ 0 ] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // Skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !isFunction( target ) ) { - target = {}; - } - - // Extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - - // Only deal with non-null/undefined values - if ( ( options = arguments[ i ] ) != null ) { - - // Extend the base object - for ( name in options ) { - copy = options[ name ]; - - // Prevent Object.prototype pollution - // Prevent never-ending loop - if ( name === "__proto__" || target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject( copy ) || - ( copyIsArray = Array.isArray( copy ) ) ) ) { - src = target[ name ]; - - // Ensure proper type for the source value - if ( copyIsArray && !Array.isArray( src ) ) { - clone = []; - } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { - clone = {}; - } else { - clone = src; - } - copyIsArray = false; - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend( { - - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - isPlainObject: function( obj ) { - var proto, Ctor; - - // Detect obvious negatives - // Use toString instead of jQuery.type to catch host objects - if ( !obj || toString.call( obj ) !== "[object Object]" ) { - return false; - } - - proto = getProto( obj ); - - // Objects with no prototype (e.g., `Object.create( null )`) are plain - if ( !proto ) { - return true; - } - - // Objects with prototype are plain iff they were constructed by a global Object function - Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; - return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; - }, - - isEmptyObject: function( obj ) { - var name; - - for ( name in obj ) { - return false; - } - return true; - }, - - // Evaluates a script in a global context - globalEval: function( code, options ) { - DOMEval( code, { nonce: options && options.nonce } ); - }, - - each: function( obj, callback ) { - var length, i = 0; - - if ( isArrayLike( obj ) ) { - length = obj.length; - for ( ; i < length; i++ ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } else { - for ( i in obj ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } - - return obj; - }, - - // Support: Android <=4.0 only - trim: function( text ) { - return text == null ? - "" : - ( text + "" ).replace( rtrim, "" ); - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArrayLike( Object( arr ) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - return arr == null ? -1 : indexOf.call( arr, elem, i ); - }, - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - for ( ; j < len; j++ ) { - first[ i++ ] = second[ j ]; - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var length, value, - i = 0, - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArrayLike( elems ) ) { - length = elems.length; - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return concat.apply( [], ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -} ); - -if ( typeof Symbol === "function" ) { - jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; -} - -// Populate the class2type map -jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), -function( i, name ) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -} ); - -function isArrayLike( obj ) { - - // Support: real iOS 8.2 only (not reproducible in simulator) - // `in` check used to prevent JIT error (gh-2145) - // hasOwn isn't used here due to false negatives - // regarding Nodelist length in IE - var length = !!obj && "length" in obj && obj.length, - type = toType( obj ); - - if ( isFunction( obj ) || isWindow( obj ) ) { - return false; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v2.3.4 - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://js.foundation/ - * - * Date: 2019-04-08 - */ -(function( window ) { - -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + 1 * new Date(), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - nonnativeSelectorCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // Instance methods - hasOwn = ({}).hasOwnProperty, - arr = [], - pop = arr.pop, - push_native = arr.push, - push = arr.push, - slice = arr.slice, - // Use a stripped-down indexOf as it's faster than native - // https://jsperf.com/thor-indexof-vs-for/5 - indexOf = function( list, elem ) { - var i = 0, - len = list.length; - for ( ; i < len; i++ ) { - if ( list[i] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - - // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier - identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + - "*\\]", - - pseudos = ":(" + identifier + ")(?:\\((" + - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rwhitespace = new RegExp( whitespace + "+", "g" ), - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), - rdescend = new RegExp( whitespace + "|>" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + identifier + ")" ), - "CLASS": new RegExp( "^\\.(" + identifier + ")" ), - "TAG": new RegExp( "^(" + identifier + "|[*])" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + - "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + - "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + - whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rhtml = /HTML$/i, - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - - // CSS escapes - // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), - funescape = function( _, escaped, escapedWhitespace ) { - var high = "0x" + escaped - 0x10000; - // NaN means non-codepoint - // Support: Firefox<24 - // Workaround erroneous numeric interpretation of +"0x" - return high !== high || escapedWhitespace ? - escaped : - high < 0 ? - // BMP codepoint - String.fromCharCode( high + 0x10000 ) : - // Supplemental Plane codepoint (surrogate pair) - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }, - - // CSS string/identifier serialization - // https://drafts.csswg.org/cssom/#common-serializing-idioms - rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, - fcssescape = function( ch, asCodePoint ) { - if ( asCodePoint ) { - - // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER - if ( ch === "\0" ) { - return "\uFFFD"; - } - - // Control characters and (dependent upon position) numbers get escaped as code points - return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; - } - - // Other potentially-special ASCII characters get backslash-escaped - return "\\" + ch; - }, - - // Used for iframes - // See setDocument() - // Removing the function wrapper causes a "Permission Denied" - // error in IE - unloadHandler = function() { - setDocument(); - }, - - inDisabledFieldset = addCombinator( - function( elem ) { - return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; - }, - { dir: "parentNode", next: "legend" } - ); - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - (arr = slice.call( preferredDoc.childNodes )), - preferredDoc.childNodes - ); - // Support: Android<4.0 - // Detect silently failing push.apply - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - push_native.apply( target, slice.call(els) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - // Can't trust NodeList.length - while ( (target[j++] = els[i++]) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var m, i, elem, nid, match, groups, newSelector, - newContext = context && context.ownerDocument, - - // nodeType defaults to 9, since context defaults to document - nodeType = context ? context.nodeType : 9; - - results = results || []; - - // Return early from calls with invalid selector or context - if ( typeof selector !== "string" || !selector || - nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { - - return results; - } - - // Try to shortcut find operations (as opposed to filters) in HTML documents - if ( !seed ) { - - if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { - setDocument( context ); - } - context = context || document; - - if ( documentIsHTML ) { - - // If the selector is sufficiently simple, try using a "get*By*" DOM method - // (excepting DocumentFragment context, where the methods don't exist) - if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { - - // ID selector - if ( (m = match[1]) ) { - - // Document context - if ( nodeType === 9 ) { - if ( (elem = context.getElementById( m )) ) { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - - // Element context - } else { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( newContext && (elem = newContext.getElementById( m )) && - contains( context, elem ) && - elem.id === m ) { - - results.push( elem ); - return results; - } - } - - // Type selector - } else if ( match[2] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Class selector - } else if ( (m = match[3]) && support.getElementsByClassName && - context.getElementsByClassName ) { - - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // Take advantage of querySelectorAll - if ( support.qsa && - !nonnativeSelectorCache[ selector + " " ] && - (!rbuggyQSA || !rbuggyQSA.test( selector )) && - - // Support: IE 8 only - // Exclude object elements - (nodeType !== 1 || context.nodeName.toLowerCase() !== "object") ) { - - newSelector = selector; - newContext = context; - - // qSA considers elements outside a scoping root when evaluating child or - // descendant combinators, which is not what we want. - // In such cases, we work around the behavior by prefixing every selector in the - // list with an ID selector referencing the scope context. - // Thanks to Andrew Dupont for this technique. - if ( nodeType === 1 && rdescend.test( selector ) ) { - - // Capture the context ID, setting it first if necessary - if ( (nid = context.getAttribute( "id" )) ) { - nid = nid.replace( rcssescape, fcssescape ); - } else { - context.setAttribute( "id", (nid = expando) ); - } - - // Prefix every selector in the list - groups = tokenize( selector ); - i = groups.length; - while ( i-- ) { - groups[i] = "#" + nid + " " + toSelector( groups[i] ); - } - newSelector = groups.join( "," ); - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; - } - - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch ( qsaError ) { - nonnativeSelectorCache( selector, true ); - } finally { - if ( nid === expando ) { - context.removeAttribute( "id" ); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {function(string, object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return (cache[ key + " " ] = value); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created element and returns a boolean result - */ -function assert( fn ) { - var el = document.createElement("fieldset"); - - try { - return !!fn( el ); - } catch (e) { - return false; - } finally { - // Remove from its parent by default - if ( el.parentNode ) { - el.parentNode.removeChild( el ); - } - // release memory in IE - el = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split("|"), - i = arr.length; - - while ( i-- ) { - Expr.attrHandle[ arr[i] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - a.sourceIndex - b.sourceIndex; - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( (cur = cur.nextSibling) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return (name === "input" || name === "button") && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for :enabled/:disabled - * @param {Boolean} disabled true for :disabled; false for :enabled - */ -function createDisabledPseudo( disabled ) { - - // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable - return function( elem ) { - - // Only certain elements can match :enabled or :disabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled - if ( "form" in elem ) { - - // Check for inherited disabledness on relevant non-disabled elements: - // * listed form-associated elements in a disabled fieldset - // https://html.spec.whatwg.org/multipage/forms.html#category-listed - // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled - // * option elements in a disabled optgroup - // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled - // All such elements have a "form" property. - if ( elem.parentNode && elem.disabled === false ) { - - // Option elements defer to a parent optgroup if present - if ( "label" in elem ) { - if ( "label" in elem.parentNode ) { - return elem.parentNode.disabled === disabled; - } else { - return elem.disabled === disabled; - } - } - - // Support: IE 6 - 11 - // Use the isDisabled shortcut property to check for disabled fieldset ancestors - return elem.isDisabled === disabled || - - // Where there is no isDisabled, check manually - /* jshint -W018 */ - elem.isDisabled !== !disabled && - inDisabledFieldset( elem ) === disabled; - } - - return elem.disabled === disabled; - - // Try to winnow out elements that can't be disabled before trusting the disabled property. - // Some victims get caught in our net (label, legend, menu, track), but it shouldn't - // even exist on them, let alone have a boolean value. - } else if ( "label" in elem ) { - return elem.disabled === disabled; - } - - // Remaining elements are neither :enabled nor :disabled - return false; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction(function( argument ) { - argument = +argument; - return markFunction(function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ (j = matchIndexes[i]) ] ) { - seed[j] = !(matches[j] = seed[j]); - } - } - }); - }); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== "undefined" && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - var namespace = elem.namespaceURI, - docElem = (elem.ownerDocument || elem).documentElement; - - // Support: IE <=8 - // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes - // https://bugs.jquery.com/ticket/4833 - return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, subWindow, - doc = node ? node.ownerDocument || node : preferredDoc; - - // Return early if doc is invalid or already selected - if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Update global variables - document = doc; - docElem = document.documentElement; - documentIsHTML = !isXML( document ); - - // Support: IE 9-11, Edge - // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - if ( preferredDoc !== document && - (subWindow = document.defaultView) && subWindow.top !== subWindow ) { - - // Support: IE 11, Edge - if ( subWindow.addEventListener ) { - subWindow.addEventListener( "unload", unloadHandler, false ); - - // Support: IE 9 - 10 only - } else if ( subWindow.attachEvent ) { - subWindow.attachEvent( "onunload", unloadHandler ); - } - } - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties - // (excepting IE8 booleans) - support.attributes = assert(function( el ) { - el.className = "i"; - return !el.getAttribute("className"); - }); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert(function( el ) { - el.appendChild( document.createComment("") ); - return !el.getElementsByTagName("*").length; - }); - - // Support: IE<9 - support.getElementsByClassName = rnative.test( document.getElementsByClassName ); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programmatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert(function( el ) { - docElem.appendChild( el ).id = expando; - return !document.getElementsByName || !document.getElementsByName( expando ).length; - }); - - // ID filter and find - if ( support.getById ) { - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute("id") === attrId; - }; - }; - Expr.find["ID"] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var elem = context.getElementById( id ); - return elem ? [ elem ] : []; - } - }; - } else { - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== "undefined" && - elem.getAttributeNode("id"); - return node && node.value === attrId; - }; - }; - - // Support: IE 6 - 7 only - // getElementById is not reliable as a find shortcut - Expr.find["ID"] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var node, i, elems, - elem = context.getElementById( id ); - - if ( elem ) { - - // Verify the id attribute - node = elem.getAttributeNode("id"); - if ( node && node.value === id ) { - return [ elem ]; - } - - // Fall back on getElementsByName - elems = context.getElementsByName( id ); - i = 0; - while ( (elem = elems[i++]) ) { - node = elem.getAttributeNode("id"); - if ( node && node.value === id ) { - return [ elem ]; - } - } - } - - return []; - } - }; - } - - // Tag - Expr.find["TAG"] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== "undefined" ) { - return context.getElementsByTagName( tag ); - - // DocumentFragment nodes don't have gEBTN - } else if ( support.qsa ) { - return context.querySelectorAll( tag ); - } - } : - - function( tag, context ) { - var elem, - tmp = [], - i = 0, - // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( (elem = results[i++]) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See https://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert(function( el ) { - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // https://bugs.jquery.com/ticket/12359 - docElem.appendChild( el ).innerHTML = "" + - ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( el.querySelectorAll("[msallowcapture^='']").length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !el.querySelectorAll("[selected]").length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ - if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { - rbuggyQSA.push("~="); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !el.querySelectorAll(":checked").length ) { - rbuggyQSA.push(":checked"); - } - - // Support: Safari 8+, iOS 8+ - // https://bugs.webkit.org/show_bug.cgi?id=136851 - // In-page `selector#id sibling-combinator selector` fails - if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { - rbuggyQSA.push(".#.+[+~]"); - } - }); - - assert(function( el ) { - el.innerHTML = "" + - ""; - - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = document.createElement("input"); - input.setAttribute( "type", "hidden" ); - el.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( el.querySelectorAll("[name=d]").length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( el.querySelectorAll(":enabled").length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: IE9-11+ - // IE's :disabled selector does not pick up the children of disabled fieldsets - docElem.appendChild( el ).disabled = true; - if ( el.querySelectorAll(":disabled").length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Opera 10-11 does not throw on post-comma invalid pseudos - el.querySelectorAll("*,:x"); - rbuggyQSA.push(",.*:"); - }); - } - - if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector) )) ) { - - assert(function( el ) { - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( el, "*" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( el, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - }); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully self-exclusive - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - )); - } : - function( a, b ) { - if ( b ) { - while ( (b = b.parentNode) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { - - // Choose the first element that is related to our preferred document - if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { - return -1; - } - if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - return a === document ? -1 : - b === document ? 1 : - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( (cur = cur.parentNode) ) { - ap.unshift( cur ); - } - cur = b; - while ( (cur = cur.parentNode) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[i] === bp[i] ) { - i++; - } - - return i ? - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[i], bp[i] ) : - - // Otherwise nodes in our document sort first - ap[i] === preferredDoc ? -1 : - bp[i] === preferredDoc ? 1 : - 0; - }; - - return document; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - if ( support.matchesSelector && documentIsHTML && - !nonnativeSelectorCache[ expr + " " ] && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch (e) { - nonnativeSelectorCache( expr, true ); - } - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - // Set document vars if needed - if ( ( context.ownerDocument || context ) !== document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - (val = elem.getAttributeNode(name)) && val.specified ? - val.value : - null; -}; - -Sizzle.escape = function( sel ) { - return (sel + "").replace( rcssescape, fcssescape ); -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( (elem = results[i++]) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - // If no nodeType, this is expected to be an array - while ( (node = elem[i++]) ) { - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[1] = match[1].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); - - if ( match[2] === "~=" ) { - match[3] = " " + match[3] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[1] = match[1].toLowerCase(); - - if ( match[1].slice( 0, 3 ) === "nth" ) { - // nth-* requires argument - if ( !match[3] ) { - Sizzle.error( match[0] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); - match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); - - // other types prohibit arguments - } else if ( match[3] ) { - Sizzle.error( match[0] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[6] && match[2]; - - if ( matchExpr["CHILD"].test( match[0] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[3] ) { - match[2] = match[4] || match[5] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - // Get excess from tokenize (recursively) - (excess = tokenize( unquoted, true )) && - // advance to the next closing parenthesis - (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { - - // excess is a negative index - match[0] = match[0].slice( 0, excess ); - match[2] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { return true; } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && - classCache( className, function( elem ) { - return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); - }); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - }; - }, - - "CHILD": function( type, what, argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, context, xml ) { - var cache, uniqueCache, outerCache, node, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType, - diff = false; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( (node = node[ dir ]) ) { - if ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) { - - return false; - } - } - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - - // Seek `elem` from a previously-cached index - - // ...in a gzip-friendly way - node = parent; - outerCache = node[ expando ] || (node[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex && cache[ 2 ]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( (node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - (diff = nodeIndex = 0) || start.pop()) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - } else { - // Use previously-cached element index if available - if ( useCache ) { - // ...in a gzip-friendly way - node = elem; - outerCache = node[ expando ] || (node[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex; - } - - // xml :nth-child(...) - // or :nth-last-child(...) or :nth(-last)?-of-type(...) - if ( diff === false ) { - // Use the same loop as above to seek `elem` from the start - while ( (node = ++nodeIndex && node && node[ dir ] || - (diff = nodeIndex = 0) || start.pop()) ) { - - if ( ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) && - ++diff ) { - - // Cache the index of each encountered element - if ( useCache ) { - outerCache = node[ expando ] || (node[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); - - uniqueCache[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction(function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf( seed, matched[i] ); - seed[ idx ] = !( matches[ idx ] = matched[i] ); - } - }) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - // Potentially complex pseudos - "not": markFunction(function( selector ) { - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction(function( seed, matches, context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( (elem = unmatched[i]) ) { - seed[i] = !(matches[i] = elem); - } - } - }) : - function( elem, context, xml ) { - input[0] = elem; - matcher( input, null, xml, results ); - // Don't keep the element (issue #299) - input[0] = null; - return !results.pop(); - }; - }), - - "has": markFunction(function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - }), - - "contains": markFunction(function( text ) { - text = text.replace( runescape, funescape ); - return function( elem ) { - return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; - }; - }), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - // lang value must be a valid identifier - if ( !ridentifier.test(lang || "") ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( (elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); - return false; - }; - }), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); - }, - - // Boolean properties - "enabled": createDisabledPseudo( false ), - "disabled": createDisabledPseudo( true ), - - "checked": function( elem ) { - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); - }, - - "selected": function( elem ) { - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos["empty"]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo(function() { - return [ 0 ]; - }), - - "last": createPositionalPseudo(function( matchIndexes, length ) { - return [ length - 1 ]; - }), - - "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - }), - - "even": createPositionalPseudo(function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "odd": createPositionalPseudo(function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? - argument + length : - argument > length ? - length : - argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }) - } -}; - -Expr.pseudos["nth"] = Expr.pseudos["eq"]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || (match = rcomma.exec( soFar )) ) { - if ( match ) { - // Don't consume trailing commas as valid - soFar = soFar.slice( match[0].length ) || soFar; - } - groups.push( (tokens = []) ); - } - - matched = false; - - // Combinators - if ( (match = rcombinators.exec( soFar )) ) { - matched = match.shift(); - tokens.push({ - value: matched, - // Cast descendant combinators to space - type: match[0].replace( rtrim, " " ) - }); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || - (match = preFilters[ type ]( match ))) ) { - matched = match.shift(); - tokens.push({ - value: matched, - type: type, - matches: match - }); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[i].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - skip = combinator.next, - key = skip || dir, - checkNonElements = base && key === "parentNode", - doneName = done++; - - return combinator.first ? - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - return false; - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, uniqueCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching - if ( xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || (elem[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); - - if ( skip && skip === elem.nodeName.toLowerCase() ) { - elem = elem[ dir ] || elem; - } else if ( (oldCache = uniqueCache[ key ]) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return (newCache[ 2 ] = oldCache[ 2 ]); - } else { - // Reuse newcache so results back-propagate to previous elements - uniqueCache[ key ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { - return true; - } - } - } - } - } - return false; - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[i]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[0]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[i], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( (elem = unmatched[i]) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction(function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( (elem = temp[i]) ) { - matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) ) { - // Restore matcherIn since elem is not yet a final match - temp.push( (matcherIn[i] = elem) ); - } - } - postFinder( null, (matcherOut = []), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) && - (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { - - seed[temp] = !(results[temp] = elem); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - }); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[0].type ], - implicitRelative = leadingRelative || Expr.relative[" "], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - (checkContext = context).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - // Avoid hanging onto element (issue #299) - checkContext = null; - return ret; - } ]; - - for ( ; i < len; i++ ) { - if ( (matcher = Expr.relative[ tokens[i].type ]) ) { - matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; - } else { - matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[j].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), - len = elems.length; - - if ( outermost ) { - outermostContext = context === document || context || outermost; - } - - // Add elements passing elementMatchers directly to results - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && (elem = elems[i]) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - if ( !context && elem.ownerDocument !== document ) { - setDocument( elem ); - xml = !documentIsHTML; - } - while ( (matcher = elementMatchers[j++]) ) { - if ( matcher( elem, context || document, xml) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - // They will have gone through all possible matchers - if ( (elem = !matcher && elem) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // `i` is now the count of elements visited above, and adding it to `matchedCount` - // makes the latter nonnegative. - matchedCount += i; - - // Apply set filters to unmatched elements - // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` - // equals `i`), unless we didn't visit _any_ elements in the above loop because we have - // no element matchers and no seed. - // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that - // case, which will result in a "00" `matchedCount` that differs from `i` but is also - // numerically zero. - if ( bySet && i !== matchedCount ) { - j = 0; - while ( (matcher = setMatchers[j++]) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !(unmatched[i] || setMatched[i]) ) { - setMatched[i] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[i] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( (selector = compiled.selector || selector) ); - - results = results || []; - - // Try to minimize operations if there is only one selector in the list and no seed - // (the latter of which guarantees us context) - if ( match.length === 1 ) { - - // Reduce context if the leading compound selector is an ID - tokens = match[0] = match[0].slice( 0 ); - if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && - context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { - - context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[i]; - - // Abort if we hit a combinator - if ( Expr.relative[ (type = token.type) ] ) { - break; - } - if ( (find = Expr.find[ type ]) ) { - // Search, expanding context for leading sibling combinators - if ( (seed = find( - token.matches[0].replace( runescape, funescape ), - rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context - )) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - !context || rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; - -// Support: Chrome 14-35+ -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert(function( el ) { - // Should return 1, but returns 4 (following) - return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; -}); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert(function( el ) { - el.innerHTML = ""; - return el.firstChild.getAttribute("href") === "#" ; -}) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - }); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert(function( el ) { - el.innerHTML = ""; - el.firstChild.setAttribute( "value", "" ); - return el.firstChild.getAttribute( "value" ) === ""; -}) ) { - addHandle( "value", function( elem, name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - }); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert(function( el ) { - return el.getAttribute("disabled") == null; -}) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - (val = elem.getAttributeNode( name )) && val.specified ? - val.value : - null; - } - }); -} - -return Sizzle; - -})( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; - -// Deprecated -jQuery.expr[ ":" ] = jQuery.expr.pseudos; -jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; -jQuery.escapeSelector = Sizzle.escape; - - - - -var dir = function( elem, dir, until ) { - var matched = [], - truncate = until !== undefined; - - while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { - if ( elem.nodeType === 1 ) { - if ( truncate && jQuery( elem ).is( until ) ) { - break; - } - matched.push( elem ); - } - } - return matched; -}; - - -var siblings = function( n, elem ) { - var matched = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - matched.push( n ); - } - } - - return matched; -}; - - -var rneedsContext = jQuery.expr.match.needsContext; - - - -function nodeName( elem, name ) { - - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - -}; -var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); - - - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - return !!qualifier.call( elem, i, elem ) !== not; - } ); - } - - // Single element - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - } ); - } - - // Arraylike of elements (jQuery, arguments, Array) - if ( typeof qualifier !== "string" ) { - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) > -1 ) !== not; - } ); - } - - // Filtered directly for both simple and complex selectors - return jQuery.filter( qualifier, elements, not ); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - if ( elems.length === 1 && elem.nodeType === 1 ) { - return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; - } - - return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - } ) ); -}; - -jQuery.fn.extend( { - find: function( selector ) { - var i, ret, - len = this.length, - self = this; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter( function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - } ) ); - } - - ret = this.pushStack( [] ); - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - return len > 1 ? jQuery.uniqueSort( ret ) : ret; - }, - filter: function( selector ) { - return this.pushStack( winnow( this, selector || [], false ) ); - }, - not: function( selector ) { - return this.pushStack( winnow( this, selector || [], true ) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -} ); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - // Shortcut simple #id case for speed - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, - - init = jQuery.fn.init = function( selector, context, root ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Method init() accepts an alternate rootjQuery - // so migrate can support jQuery.sub (gh-2101) - root = root || rootjQuery; - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector[ 0 ] === "<" && - selector[ selector.length - 1 ] === ">" && - selector.length >= 3 ) { - - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && ( match[ 1 ] || !context ) ) { - - // HANDLE: $(html) -> $(array) - if ( match[ 1 ] ) { - context = context instanceof jQuery ? context[ 0 ] : context; - - // Option to run scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[ 1 ], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - - // Properties of context are called as methods if possible - if ( isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[ 2 ] ); - - if ( elem ) { - - // Inject the element directly into the jQuery object - this[ 0 ] = elem; - this.length = 1; - } - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || root ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this[ 0 ] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( isFunction( selector ) ) { - return root.ready !== undefined ? - root.ready( selector ) : - - // Execute immediately if ready is not present - selector( jQuery ); - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - - // Methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.fn.extend( { - has: function( target ) { - var targets = jQuery( target, this ), - l = targets.length; - - return this.filter( function() { - var i = 0; - for ( ; i < l; i++ ) { - if ( jQuery.contains( this, targets[ i ] ) ) { - return true; - } - } - } ); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - targets = typeof selectors !== "string" && jQuery( selectors ); - - // Positional selectors never match, since there's no _selection_ context - if ( !rneedsContext.test( selectors ) ) { - for ( ; i < l; i++ ) { - for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { - - // Always skip document fragments - if ( cur.nodeType < 11 && ( targets ? - targets.index( cur ) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector( cur, selectors ) ) ) { - - matched.push( cur ); - break; - } - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); - }, - - // Determine the position of an element within the set - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; - } - - // Index in selector - if ( typeof elem === "string" ) { - return indexOf.call( jQuery( elem ), this[ 0 ] ); - } - - // Locate the position of the desired element - return indexOf.call( this, - - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[ 0 ] : elem - ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.uniqueSort( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter( selector ) - ); - } -} ); - -function sibling( cur, dir ) { - while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} - return cur; -} - -jQuery.each( { - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, i, until ) { - return dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, i, until ) { - return dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, i, until ) { - return dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return siblings( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return siblings( elem.firstChild ); - }, - contents: function( elem ) { - if ( typeof elem.contentDocument !== "undefined" ) { - return elem.contentDocument; - } - - // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only - // Treat the template element as a regular one in browsers that - // don't support it. - if ( nodeName( elem, "template" ) ) { - elem = elem.content || elem; - } - - return jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var matched = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - matched = jQuery.filter( selector, matched ); - } - - if ( this.length > 1 ) { - - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - jQuery.uniqueSort( matched ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - matched.reverse(); - } - } - - return this.pushStack( matched ); - }; -} ); -var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); - - - -// Convert String-formatted options into Object-formatted ones -function createOptions( options ) { - var object = {}; - jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { - object[ flag ] = true; - } ); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - createOptions( options ) : - jQuery.extend( {}, options ); - - var // Flag to know if list is currently firing - firing, - - // Last fire value for non-forgettable lists - memory, - - // Flag to know if list was already fired - fired, - - // Flag to prevent firing - locked, - - // Actual callback list - list = [], - - // Queue of execution data for repeatable lists - queue = [], - - // Index of currently firing callback (modified by add/remove as needed) - firingIndex = -1, - - // Fire callbacks - fire = function() { - - // Enforce single-firing - locked = locked || options.once; - - // Execute callbacks for all pending executions, - // respecting firingIndex overrides and runtime changes - fired = firing = true; - for ( ; queue.length; firingIndex = -1 ) { - memory = queue.shift(); - while ( ++firingIndex < list.length ) { - - // Run callback and check for early termination - if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && - options.stopOnFalse ) { - - // Jump to end and forget the data so .add doesn't re-fire - firingIndex = list.length; - memory = false; - } - } - } - - // Forget the data if we're done with it - if ( !options.memory ) { - memory = false; - } - - firing = false; - - // Clean up if we're done firing for good - if ( locked ) { - - // Keep an empty list if we have data for future add calls - if ( memory ) { - list = []; - - // Otherwise, this object is spent - } else { - list = ""; - } - } - }, - - // Actual Callbacks object - self = { - - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - - // If we have memory from a past run, we should fire after adding - if ( memory && !firing ) { - firingIndex = list.length - 1; - queue.push( memory ); - } - - ( function add( args ) { - jQuery.each( args, function( _, arg ) { - if ( isFunction( arg ) ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && toType( arg ) !== "string" ) { - - // Inspect recursively - add( arg ); - } - } ); - } )( arguments ); - - if ( memory && !firing ) { - fire(); - } - } - return this; - }, - - // Remove a callback from the list - remove: function() { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - - // Handle firing indexes - if ( index <= firingIndex ) { - firingIndex--; - } - } - } ); - return this; - }, - - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? - jQuery.inArray( fn, list ) > -1 : - list.length > 0; - }, - - // Remove all callbacks from the list - empty: function() { - if ( list ) { - list = []; - } - return this; - }, - - // Disable .fire and .add - // Abort any current/pending executions - // Clear all callbacks and values - disable: function() { - locked = queue = []; - list = memory = ""; - return this; - }, - disabled: function() { - return !list; - }, - - // Disable .fire - // Also disable .add unless we have memory (since it would have no effect) - // Abort any pending executions - lock: function() { - locked = queue = []; - if ( !memory && !firing ) { - list = memory = ""; - } - return this; - }, - locked: function() { - return !!locked; - }, - - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( !locked ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - queue.push( args ); - if ( !firing ) { - fire(); - } - } - return this; - }, - - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -function Identity( v ) { - return v; -} -function Thrower( ex ) { - throw ex; -} - -function adoptValue( value, resolve, reject, noValue ) { - var method; - - try { - - // Check for promise aspect first to privilege synchronous behavior - if ( value && isFunction( ( method = value.promise ) ) ) { - method.call( value ).done( resolve ).fail( reject ); - - // Other thenables - } else if ( value && isFunction( ( method = value.then ) ) ) { - method.call( value, resolve, reject ); - - // Other non-thenables - } else { - - // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: - // * false: [ value ].slice( 0 ) => resolve( value ) - // * true: [ value ].slice( 1 ) => resolve() - resolve.apply( undefined, [ value ].slice( noValue ) ); - } - - // For Promises/A+, convert exceptions into rejections - // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in - // Deferred#then to conditionally suppress rejection. - } catch ( value ) { - - // Support: Android 4.0 only - // Strict mode functions invoked without .call/.apply get global-object context - reject.apply( undefined, [ value ] ); - } -} - -jQuery.extend( { - - Deferred: function( func ) { - var tuples = [ - - // action, add listener, callbacks, - // ... .then handlers, argument index, [final state] - [ "notify", "progress", jQuery.Callbacks( "memory" ), - jQuery.Callbacks( "memory" ), 2 ], - [ "resolve", "done", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 0, "resolved" ], - [ "reject", "fail", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 1, "rejected" ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - "catch": function( fn ) { - return promise.then( null, fn ); - }, - - // Keep pipe for back-compat - pipe: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - - return jQuery.Deferred( function( newDefer ) { - jQuery.each( tuples, function( i, tuple ) { - - // Map tuples (progress, done, fail) to arguments (done, fail, progress) - var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; - - // deferred.progress(function() { bind to newDefer or newDefer.notify }) - // deferred.done(function() { bind to newDefer or newDefer.resolve }) - // deferred.fail(function() { bind to newDefer or newDefer.reject }) - deferred[ tuple[ 1 ] ]( function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && isFunction( returned.promise ) ) { - returned.promise() - .progress( newDefer.notify ) - .done( newDefer.resolve ) - .fail( newDefer.reject ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( - this, - fn ? [ returned ] : arguments - ); - } - } ); - } ); - fns = null; - } ).promise(); - }, - then: function( onFulfilled, onRejected, onProgress ) { - var maxDepth = 0; - function resolve( depth, deferred, handler, special ) { - return function() { - var that = this, - args = arguments, - mightThrow = function() { - var returned, then; - - // Support: Promises/A+ section 2.3.3.3.3 - // https://promisesaplus.com/#point-59 - // Ignore double-resolution attempts - if ( depth < maxDepth ) { - return; - } - - returned = handler.apply( that, args ); - - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError( "Thenable self-resolution" ); - } - - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && - - // Support: Promises/A+ section 2.3.4 - // https://promisesaplus.com/#point-64 - // Only check objects and functions for thenability - ( typeof returned === "object" || - typeof returned === "function" ) && - returned.then; - - // Handle a returned thenable - if ( isFunction( then ) ) { - - // Special processors (notify) just wait for resolution - if ( special ) { - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ) - ); - - // Normal processors (resolve) also hook into progress - } else { - - // ...and disregard older resolution values - maxDepth++; - - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ), - resolve( maxDepth, deferred, Identity, - deferred.notifyWith ) - ); - } - - // Handle all other returned values - } else { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Identity ) { - that = undefined; - args = [ returned ]; - } - - // Process the value(s) - // Default process is resolve - ( special || deferred.resolveWith )( that, args ); - } - }, - - // Only normal processors (resolve) catch and reject exceptions - process = special ? - mightThrow : - function() { - try { - mightThrow(); - } catch ( e ) { - - if ( jQuery.Deferred.exceptionHook ) { - jQuery.Deferred.exceptionHook( e, - process.stackTrace ); - } - - // Support: Promises/A+ section 2.3.3.3.4.1 - // https://promisesaplus.com/#point-61 - // Ignore post-resolution exceptions - if ( depth + 1 >= maxDepth ) { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Thrower ) { - that = undefined; - args = [ e ]; - } - - deferred.rejectWith( that, args ); - } - } - }; - - // Support: Promises/A+ section 2.3.3.3.1 - // https://promisesaplus.com/#point-57 - // Re-resolve promises immediately to dodge false rejection from - // subsequent errors - if ( depth ) { - process(); - } else { - - // Call an optional hook to record the stack, in case of exception - // since it's otherwise lost when execution goes async - if ( jQuery.Deferred.getStackHook ) { - process.stackTrace = jQuery.Deferred.getStackHook(); - } - window.setTimeout( process ); - } - }; - } - - return jQuery.Deferred( function( newDefer ) { - - // progress_handlers.add( ... ) - tuples[ 0 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onProgress ) ? - onProgress : - Identity, - newDefer.notifyWith - ) - ); - - // fulfilled_handlers.add( ... ) - tuples[ 1 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onFulfilled ) ? - onFulfilled : - Identity - ) - ); - - // rejected_handlers.add( ... ) - tuples[ 2 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onRejected ) ? - onRejected : - Thrower - ) - ); - } ).promise(); - }, - - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 5 ]; - - // promise.progress = list.add - // promise.done = list.add - // promise.fail = list.add - promise[ tuple[ 1 ] ] = list.add; - - // Handle state - if ( stateString ) { - list.add( - function() { - - // state = "resolved" (i.e., fulfilled) - // state = "rejected" - state = stateString; - }, - - // rejected_callbacks.disable - // fulfilled_callbacks.disable - tuples[ 3 - i ][ 2 ].disable, - - // rejected_handlers.disable - // fulfilled_handlers.disable - tuples[ 3 - i ][ 3 ].disable, - - // progress_callbacks.lock - tuples[ 0 ][ 2 ].lock, - - // progress_handlers.lock - tuples[ 0 ][ 3 ].lock - ); - } - - // progress_handlers.fire - // fulfilled_handlers.fire - // rejected_handlers.fire - list.add( tuple[ 3 ].fire ); - - // deferred.notify = function() { deferred.notifyWith(...) } - // deferred.resolve = function() { deferred.resolveWith(...) } - // deferred.reject = function() { deferred.rejectWith(...) } - deferred[ tuple[ 0 ] ] = function() { - deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); - return this; - }; - - // deferred.notifyWith = list.fireWith - // deferred.resolveWith = list.fireWith - // deferred.rejectWith = list.fireWith - deferred[ tuple[ 0 ] + "With" ] = list.fireWith; - } ); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( singleValue ) { - var - - // count of uncompleted subordinates - remaining = arguments.length, - - // count of unprocessed arguments - i = remaining, - - // subordinate fulfillment data - resolveContexts = Array( i ), - resolveValues = slice.call( arguments ), - - // the master Deferred - master = jQuery.Deferred(), - - // subordinate callback factory - updateFunc = function( i ) { - return function( value ) { - resolveContexts[ i ] = this; - resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( !( --remaining ) ) { - master.resolveWith( resolveContexts, resolveValues ); - } - }; - }; - - // Single- and empty arguments are adopted like Promise.resolve - if ( remaining <= 1 ) { - adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, - !remaining ); - - // Use .then() to unwrap secondary thenables (cf. gh-3000) - if ( master.state() === "pending" || - isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { - - return master.then(); - } - } - - // Multiple arguments are aggregated like Promise.all array elements - while ( i-- ) { - adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); - } - - return master.promise(); - } -} ); - - -// These usually indicate a programmer mistake during development, -// warn about them ASAP rather than swallowing them by default. -var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; - -jQuery.Deferred.exceptionHook = function( error, stack ) { - - // Support: IE 8 - 9 only - // Console exists when dev tools are open, which can happen at any time - if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { - window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); - } -}; - - - - -jQuery.readyException = function( error ) { - window.setTimeout( function() { - throw error; - } ); -}; - - - - -// The deferred used on DOM ready -var readyList = jQuery.Deferred(); - -jQuery.fn.ready = function( fn ) { - - readyList - .then( fn ) - - // Wrap jQuery.readyException in a function so that the lookup - // happens at the time of error handling instead of callback - // registration. - .catch( function( error ) { - jQuery.readyException( error ); - } ); - - return this; -}; - -jQuery.extend( { - - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - } -} ); - -jQuery.ready.then = readyList.then; - -// The ready event handler and self cleanup method -function completed() { - document.removeEventListener( "DOMContentLoaded", completed ); - window.removeEventListener( "load", completed ); - jQuery.ready(); -} - -// Catch cases where $(document).ready() is called -// after the browser event has already occurred. -// Support: IE <=9 - 10 only -// Older IE sometimes signals "interactive" too soon -if ( document.readyState === "complete" || - ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { - - // Handle it asynchronously to allow scripts the opportunity to delay ready - window.setTimeout( jQuery.ready ); - -} else { - - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed ); -} - - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - len = elems.length, - bulk = key == null; - - // Sets many values - if ( toType( key ) === "object" ) { - chainable = true; - for ( i in key ) { - access( elems, fn, i, key[ i ], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < len; i++ ) { - fn( - elems[ i ], key, raw ? - value : - value.call( elems[ i ], i, fn( elems[ i ], key ) ) - ); - } - } - } - - if ( chainable ) { - return elems; - } - - // Gets - if ( bulk ) { - return fn.call( elems ); - } - - return len ? fn( elems[ 0 ], key ) : emptyGet; -}; - - -// Matches dashed string for camelizing -var rmsPrefix = /^-ms-/, - rdashAlpha = /-([a-z])/g; - -// Used by camelCase as callback to replace() -function fcamelCase( all, letter ) { - return letter.toUpperCase(); -} - -// Convert dashed to camelCase; used by the css and data modules -// Support: IE <=9 - 11, Edge 12 - 15 -// Microsoft forgot to hump their vendor prefix (#9572) -function camelCase( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); -} -var acceptData = function( owner ) { - - // Accepts only: - // - Node - // - Node.ELEMENT_NODE - // - Node.DOCUMENT_NODE - // - Object - // - Any - return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); -}; - - - - -function Data() { - this.expando = jQuery.expando + Data.uid++; -} - -Data.uid = 1; - -Data.prototype = { - - cache: function( owner ) { - - // Check if the owner object already has a cache - var value = owner[ this.expando ]; - - // If not, create one - if ( !value ) { - value = {}; - - // We can accept data for non-element nodes in modern browsers, - // but we should not, see #8335. - // Always return an empty object. - if ( acceptData( owner ) ) { - - // If it is a node unlikely to be stringify-ed or looped over - // use plain assignment - if ( owner.nodeType ) { - owner[ this.expando ] = value; - - // Otherwise secure it in a non-enumerable property - // configurable must be true to allow the property to be - // deleted when data is removed - } else { - Object.defineProperty( owner, this.expando, { - value: value, - configurable: true - } ); - } - } - } - - return value; - }, - set: function( owner, data, value ) { - var prop, - cache = this.cache( owner ); - - // Handle: [ owner, key, value ] args - // Always use camelCase key (gh-2257) - if ( typeof data === "string" ) { - cache[ camelCase( data ) ] = value; - - // Handle: [ owner, { properties } ] args - } else { - - // Copy the properties one-by-one to the cache object - for ( prop in data ) { - cache[ camelCase( prop ) ] = data[ prop ]; - } - } - return cache; - }, - get: function( owner, key ) { - return key === undefined ? - this.cache( owner ) : - - // Always use camelCase key (gh-2257) - owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; - }, - access: function( owner, key, value ) { - - // In cases where either: - // - // 1. No key was specified - // 2. A string key was specified, but no value provided - // - // Take the "read" path and allow the get method to determine - // which value to return, respectively either: - // - // 1. The entire cache object - // 2. The data stored at the key - // - if ( key === undefined || - ( ( key && typeof key === "string" ) && value === undefined ) ) { - - return this.get( owner, key ); - } - - // When the key is not a string, or both a key and value - // are specified, set or extend (existing objects) with either: - // - // 1. An object of properties - // 2. A key and value - // - this.set( owner, key, value ); - - // Since the "set" path can have two possible entry points - // return the expected data based on which path was taken[*] - return value !== undefined ? value : key; - }, - remove: function( owner, key ) { - var i, - cache = owner[ this.expando ]; - - if ( cache === undefined ) { - return; - } - - if ( key !== undefined ) { - - // Support array or space separated string of keys - if ( Array.isArray( key ) ) { - - // If key is an array of keys... - // We always set camelCase keys, so remove that. - key = key.map( camelCase ); - } else { - key = camelCase( key ); - - // If a key with the spaces exists, use it. - // Otherwise, create an array by matching non-whitespace - key = key in cache ? - [ key ] : - ( key.match( rnothtmlwhite ) || [] ); - } - - i = key.length; - - while ( i-- ) { - delete cache[ key[ i ] ]; - } - } - - // Remove the expando if there's no more data - if ( key === undefined || jQuery.isEmptyObject( cache ) ) { - - // Support: Chrome <=35 - 45 - // Webkit & Blink performance suffers when deleting properties - // from DOM nodes, so set to undefined instead - // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) - if ( owner.nodeType ) { - owner[ this.expando ] = undefined; - } else { - delete owner[ this.expando ]; - } - } - }, - hasData: function( owner ) { - var cache = owner[ this.expando ]; - return cache !== undefined && !jQuery.isEmptyObject( cache ); - } -}; -var dataPriv = new Data(); - -var dataUser = new Data(); - - - -// Implementation Summary -// -// 1. Enforce API surface and semantic compatibility with 1.9.x branch -// 2. Improve the module's maintainability by reducing the storage -// paths to a single mechanism. -// 3. Use the same single mechanism to support "private" and "user" data. -// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) -// 5. Avoid exposing implementation details on user objects (eg. expando properties) -// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 - -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /[A-Z]/g; - -function getData( data ) { - if ( data === "true" ) { - return true; - } - - if ( data === "false" ) { - return false; - } - - if ( data === "null" ) { - return null; - } - - // Only convert to a number if it doesn't change the string - if ( data === +data + "" ) { - return +data; - } - - if ( rbrace.test( data ) ) { - return JSON.parse( data ); - } - - return data; -} - -function dataAttr( elem, key, data ) { - var name; - - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = getData( data ); - } catch ( e ) {} - - // Make sure we set the data so it isn't changed later - dataUser.set( elem, key, data ); - } else { - data = undefined; - } - } - return data; -} - -jQuery.extend( { - hasData: function( elem ) { - return dataUser.hasData( elem ) || dataPriv.hasData( elem ); - }, - - data: function( elem, name, data ) { - return dataUser.access( elem, name, data ); - }, - - removeData: function( elem, name ) { - dataUser.remove( elem, name ); - }, - - // TODO: Now that all calls to _data and _removeData have been replaced - // with direct calls to dataPriv methods, these can be deprecated. - _data: function( elem, name, data ) { - return dataPriv.access( elem, name, data ); - }, - - _removeData: function( elem, name ) { - dataPriv.remove( elem, name ); - } -} ); - -jQuery.fn.extend( { - data: function( key, value ) { - var i, name, data, - elem = this[ 0 ], - attrs = elem && elem.attributes; - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = dataUser.get( elem ); - - if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE 11 only - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = camelCase( name.slice( 5 ) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - dataPriv.set( elem, "hasDataAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each( function() { - dataUser.set( this, key ); - } ); - } - - return access( this, function( value ) { - var data; - - // The calling jQuery object (element matches) is not empty - // (and therefore has an element appears at this[ 0 ]) and the - // `value` parameter was not undefined. An empty jQuery object - // will result in `undefined` for elem = this[ 0 ] which will - // throw an exception if an attempt to read a data cache is made. - if ( elem && value === undefined ) { - - // Attempt to get data from the cache - // The key will always be camelCased in Data - data = dataUser.get( elem, key ); - if ( data !== undefined ) { - return data; - } - - // Attempt to "discover" the data in - // HTML5 custom data-* attrs - data = dataAttr( elem, key ); - if ( data !== undefined ) { - return data; - } - - // We tried really hard, but the data doesn't exist. - return; - } - - // Set the data... - this.each( function() { - - // We always store the camelCased key - dataUser.set( this, key, value ); - } ); - }, null, value, arguments.length > 1, null, true ); - }, - - removeData: function( key ) { - return this.each( function() { - dataUser.remove( this, key ); - } ); - } -} ); - - -jQuery.extend( { - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = dataPriv.get( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || Array.isArray( data ) ) { - queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // Clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // Not public - generate a queueHooks object, or return the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { - empty: jQuery.Callbacks( "once memory" ).add( function() { - dataPriv.remove( elem, [ type + "queue", key ] ); - } ) - } ); - } -} ); - -jQuery.fn.extend( { - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[ 0 ], type ); - } - - return data === undefined ? - this : - this.each( function() { - var queue = jQuery.queue( this, type, data ); - - // Ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - } ); - }, - dequeue: function( type ) { - return this.each( function() { - jQuery.dequeue( this, type ); - } ); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -} ); -var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; - -var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); - - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var documentElement = document.documentElement; - - - - var isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ); - }, - composed = { composed: true }; - - // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only - // Check attachment across shadow DOM boundaries when possible (gh-3504) - // Support: iOS 10.0-10.2 only - // Early iOS 10 versions support `attachShadow` but not `getRootNode`, - // leading to errors. We need to check for `getRootNode`. - if ( documentElement.getRootNode ) { - isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ) || - elem.getRootNode( composed ) === elem.ownerDocument; - }; - } -var isHiddenWithinTree = function( elem, el ) { - - // isHiddenWithinTree might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - - // Inline style trumps all - return elem.style.display === "none" || - elem.style.display === "" && - - // Otherwise, check computed style - // Support: Firefox <=43 - 45 - // Disconnected elements can have computed display: none, so first confirm that elem is - // in the document. - isAttached( elem ) && - - jQuery.css( elem, "display" ) === "none"; - }; - -var swap = function( elem, options, callback, args ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.apply( elem, args || [] ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - - - -function adjustCSS( elem, prop, valueParts, tween ) { - var adjusted, scale, - maxIterations = 20, - currentValue = tween ? - function() { - return tween.cur(); - } : - function() { - return jQuery.css( elem, prop, "" ); - }, - initial = currentValue(), - unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), - - // Starting value computation is required for potential unit mismatches - initialInUnit = elem.nodeType && - ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && - rcssNum.exec( jQuery.css( elem, prop ) ); - - if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { - - // Support: Firefox <=54 - // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) - initial = initial / 2; - - // Trust units reported by jQuery.css - unit = unit || initialInUnit[ 3 ]; - - // Iteratively approximate from a nonzero starting point - initialInUnit = +initial || 1; - - while ( maxIterations-- ) { - - // Evaluate and update our best guess (doubling guesses that zero out). - // Finish if the scale equals or crosses 1 (making the old*new product non-positive). - jQuery.style( elem, prop, initialInUnit + unit ); - if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { - maxIterations = 0; - } - initialInUnit = initialInUnit / scale; - - } - - initialInUnit = initialInUnit * 2; - jQuery.style( elem, prop, initialInUnit + unit ); - - // Make sure we update the tween properties later on - valueParts = valueParts || []; - } - - if ( valueParts ) { - initialInUnit = +initialInUnit || +initial || 0; - - // Apply relative offset (+=/-=) if specified - adjusted = valueParts[ 1 ] ? - initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : - +valueParts[ 2 ]; - if ( tween ) { - tween.unit = unit; - tween.start = initialInUnit; - tween.end = adjusted; - } - } - return adjusted; -} - - -var defaultDisplayMap = {}; - -function getDefaultDisplay( elem ) { - var temp, - doc = elem.ownerDocument, - nodeName = elem.nodeName, - display = defaultDisplayMap[ nodeName ]; - - if ( display ) { - return display; - } - - temp = doc.body.appendChild( doc.createElement( nodeName ) ); - display = jQuery.css( temp, "display" ); - - temp.parentNode.removeChild( temp ); - - if ( display === "none" ) { - display = "block"; - } - defaultDisplayMap[ nodeName ] = display; - - return display; -} - -function showHide( elements, show ) { - var display, elem, - values = [], - index = 0, - length = elements.length; - - // Determine new display value for elements that need to change - for ( ; index < length; index++ ) { - elem = elements[ index ]; - if ( !elem.style ) { - continue; - } - - display = elem.style.display; - if ( show ) { - - // Since we force visibility upon cascade-hidden elements, an immediate (and slow) - // check is required in this first loop unless we have a nonempty display value (either - // inline or about-to-be-restored) - if ( display === "none" ) { - values[ index ] = dataPriv.get( elem, "display" ) || null; - if ( !values[ index ] ) { - elem.style.display = ""; - } - } - if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { - values[ index ] = getDefaultDisplay( elem ); - } - } else { - if ( display !== "none" ) { - values[ index ] = "none"; - - // Remember what we're overwriting - dataPriv.set( elem, "display", display ); - } - } - } - - // Set the display of the elements in a second loop to avoid constant reflow - for ( index = 0; index < length; index++ ) { - if ( values[ index ] != null ) { - elements[ index ].style.display = values[ index ]; - } - } - - return elements; -} - -jQuery.fn.extend( { - show: function() { - return showHide( this, true ); - }, - hide: function() { - return showHide( this ); - }, - toggle: function( state ) { - if ( typeof state === "boolean" ) { - return state ? this.show() : this.hide(); - } - - return this.each( function() { - if ( isHiddenWithinTree( this ) ) { - jQuery( this ).show(); - } else { - jQuery( this ).hide(); - } - } ); - } -} ); -var rcheckableType = ( /^(?:checkbox|radio)$/i ); - -var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); - -var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); - - - -// We have to close these tags to support XHTML (#13200) -var wrapMap = { - - // Support: IE <=9 only - option: [ 1, "" ], - - // XHTML parsers do not magically insert elements in the - // same way that tag soup parsers do. So we cannot shorten - // this by omitting or other required elements. - thead: [ 1, "", "
" ], - col: [ 2, "", "
" ], - tr: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - _default: [ 0, "", "" ] -}; - -// Support: IE <=9 only -wrapMap.optgroup = wrapMap.option; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - - -function getAll( context, tag ) { - - // Support: IE <=9 - 11 only - // Use typeof to avoid zero-argument method invocation on host objects (#15151) - var ret; - - if ( typeof context.getElementsByTagName !== "undefined" ) { - ret = context.getElementsByTagName( tag || "*" ); - - } else if ( typeof context.querySelectorAll !== "undefined" ) { - ret = context.querySelectorAll( tag || "*" ); - - } else { - ret = []; - } - - if ( tag === undefined || tag && nodeName( context, tag ) ) { - return jQuery.merge( [ context ], ret ); - } - - return ret; -} - - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - dataPriv.set( - elems[ i ], - "globalEval", - !refElements || dataPriv.get( refElements[ i ], "globalEval" ) - ); - } -} - - -var rhtml = /<|&#?\w+;/; - -function buildFragment( elems, context, scripts, selection, ignored ) { - var elem, tmp, tag, wrap, attached, j, - fragment = context.createDocumentFragment(), - nodes = [], - i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( toType( elem ) === "object" ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); - - // Deserialize a standard representation - tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; - - // Descend through wrappers to the right content - j = wrap[ 0 ]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, tmp.childNodes ); - - // Remember the top-level container - tmp = fragment.firstChild; - - // Ensure the created nodes are orphaned (#12392) - tmp.textContent = ""; - } - } - } - - // Remove wrapper from fragment - fragment.textContent = ""; - - i = 0; - while ( ( elem = nodes[ i++ ] ) ) { - - // Skip elements already in the context collection (trac-4087) - if ( selection && jQuery.inArray( elem, selection ) > -1 ) { - if ( ignored ) { - ignored.push( elem ); - } - continue; - } - - attached = isAttached( elem ); - - // Append to fragment - tmp = getAll( fragment.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( attached ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( ( elem = tmp[ j++ ] ) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - return fragment; -} - - -( function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // Support: Android 4.0 - 4.3 only - // Check state lost if the name is set (#11217) - // Support: Windows Web Apps (WWA) - // `name` and `type` must use .setAttribute for WWA (#14901) - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Android <=4.1 only - // Older WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE <=11 only - // Make sure textarea (and checkbox) defaultValue is properly cloned - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; -} )(); - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -// Support: IE <=9 - 11+ -// focus() and blur() are asynchronous, except when they are no-op. -// So expect focus to be synchronous when the element is already active, -// and blur to be synchronous when the element is not already active. -// (focus and blur are always synchronous in other supported browsers, -// this just defines when we can count on it). -function expectSync( elem, type ) { - return ( elem === safeActiveElement() ) === ( type === "focus" ); -} - -// Support: IE <=9 only -// Accessing document.activeElement can throw unexpectedly -// https://bugs.jquery.com/ticket/13393 -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -function on( elem, types, selector, data, fn, one ) { - var origFn, type; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - on( elem, type, selector, data, types[ type ], one ); - } - return elem; - } - - if ( data == null && fn == null ) { - - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return elem; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return elem.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - } ); -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - - var handleObjIn, eventHandle, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.get( elem ); - - // Don't attach events to noData or text/comment nodes (but allow plain objects) - if ( !elemData ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Ensure that invalid selectors throw exceptions at attach time - // Evaluate against documentElement in case elem is a non-element node (e.g., document) - if ( selector ) { - jQuery.find.matchesSelector( documentElement, selector ); - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !( events = elemData.events ) ) { - events = elemData.events = {}; - } - if ( !( eventHandle = elemData.handle ) ) { - eventHandle = elemData.handle = function( e ) { - - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? - jQuery.event.dispatch.apply( elem, arguments ) : undefined; - }; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend( { - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join( "." ) - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !( handlers = events[ type ] ) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener if the special events handler returns false - if ( !special.setup || - special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - - var j, origCount, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); - - if ( !elemData || !( events = elemData.events ) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[ 2 ] && - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || - selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || - special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove data and the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - dataPriv.remove( elem, "handle events" ); - } - }, - - dispatch: function( nativeEvent ) { - - // Make a writable jQuery.Event from the native event object - var event = jQuery.event.fix( nativeEvent ); - - var i, j, ret, matched, handleObj, handlerQueue, - args = new Array( arguments.length ), - handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[ 0 ] = event; - - for ( i = 1; i < arguments.length; i++ ) { - args[ i ] = arguments[ i ]; - } - - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( ( handleObj = matched.handlers[ j++ ] ) && - !event.isImmediatePropagationStopped() ) { - - // If the event is namespaced, then each handler is only invoked if it is - // specially universal or its namespaces are a superset of the event's. - if ( !event.rnamespace || handleObj.namespace === false || - event.rnamespace.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || - handleObj.handler ).apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( ( event.result = ret ) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var i, handleObj, sel, matchedHandlers, matchedSelectors, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - if ( delegateCount && - - // Support: IE <=9 - // Black-hole SVG instance trees (trac-13180) - cur.nodeType && - - // Support: Firefox <=42 - // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) - // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click - // Support: IE 11 only - // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) - !( event.type === "click" && event.button >= 1 ) ) { - - for ( ; cur !== this; cur = cur.parentNode || this ) { - - // Don't check non-elements (#13208) - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { - matchedHandlers = []; - matchedSelectors = {}; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matchedSelectors[ sel ] === undefined ) { - matchedSelectors[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) > -1 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matchedSelectors[ sel ] ) { - matchedHandlers.push( handleObj ); - } - } - if ( matchedHandlers.length ) { - handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); - } - } - } - } - - // Add the remaining (directly-bound) handlers - cur = this; - if ( delegateCount < handlers.length ) { - handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); - } - - return handlerQueue; - }, - - addProp: function( name, hook ) { - Object.defineProperty( jQuery.Event.prototype, name, { - enumerable: true, - configurable: true, - - get: isFunction( hook ) ? - function() { - if ( this.originalEvent ) { - return hook( this.originalEvent ); - } - } : - function() { - if ( this.originalEvent ) { - return this.originalEvent[ name ]; - } - }, - - set: function( value ) { - Object.defineProperty( this, name, { - enumerable: true, - configurable: true, - writable: true, - value: value - } ); - } - } ); - }, - - fix: function( originalEvent ) { - return originalEvent[ jQuery.expando ] ? - originalEvent : - new jQuery.Event( originalEvent ); - }, - - special: { - load: { - - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - click: { - - // Utilize native event to ensure correct state for checkable inputs - setup: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Claim the first handler - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - // dataPriv.set( el, "click", ... ) - leverageNative( el, "click", returnTrue ); - } - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Force setup before triggering a click - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - leverageNative( el, "click" ); - } - - // Return non-false to allow normal event-path propagation - return true; - }, - - // For cross-browser consistency, suppress native .click() on links - // Also prevent it if we're currently inside a leveraged native-event stack - _default: function( event ) { - var target = event.target; - return rcheckableType.test( target.type ) && - target.click && nodeName( target, "input" ) && - dataPriv.get( target, "click" ) || - nodeName( target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - } -}; - -// Ensure the presence of an event listener that handles manually-triggered -// synthetic events by interrupting progress until reinvoked in response to -// *native* events that it fires directly, ensuring that state changes have -// already occurred before other listeners are invoked. -function leverageNative( el, type, expectSync ) { - - // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add - if ( !expectSync ) { - if ( dataPriv.get( el, type ) === undefined ) { - jQuery.event.add( el, type, returnTrue ); - } - return; - } - - // Register the controller as a special universal handler for all event namespaces - dataPriv.set( el, type, false ); - jQuery.event.add( el, type, { - namespace: false, - handler: function( event ) { - var notAsync, result, - saved = dataPriv.get( this, type ); - - if ( ( event.isTrigger & 1 ) && this[ type ] ) { - - // Interrupt processing of the outer synthetic .trigger()ed event - // Saved data should be false in such cases, but might be a leftover capture object - // from an async native handler (gh-4350) - if ( !saved.length ) { - - // Store arguments for use when handling the inner native event - // There will always be at least one argument (an event object), so this array - // will not be confused with a leftover capture object. - saved = slice.call( arguments ); - dataPriv.set( this, type, saved ); - - // Trigger the native event and capture its result - // Support: IE <=9 - 11+ - // focus() and blur() are asynchronous - notAsync = expectSync( this, type ); - this[ type ](); - result = dataPriv.get( this, type ); - if ( saved !== result || notAsync ) { - dataPriv.set( this, type, false ); - } else { - result = {}; - } - if ( saved !== result ) { - - // Cancel the outer synthetic event - event.stopImmediatePropagation(); - event.preventDefault(); - return result.value; - } - - // If this is an inner synthetic event for an event with a bubbling surrogate - // (focus or blur), assume that the surrogate already propagated from triggering the - // native event and prevent that from happening again here. - // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the - // bubbling surrogate propagates *after* the non-bubbling base), but that seems - // less bad than duplication. - } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { - event.stopPropagation(); - } - - // If this is a native event triggered above, everything is now in order - // Fire an inner synthetic event with the original arguments - } else if ( saved.length ) { - - // ...and capture the result - dataPriv.set( this, type, { - value: jQuery.event.trigger( - - // Support: IE <=9 - 11+ - // Extend with the prototype to reset the above stopImmediatePropagation() - jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), - saved.slice( 1 ), - this - ) - } ); - - // Abort handling of the native event - event.stopImmediatePropagation(); - } - } - } ); -} - -jQuery.removeEvent = function( elem, type, handle ) { - - // This "if" is needed for plain objects - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle ); - } -}; - -jQuery.Event = function( src, props ) { - - // Allow instantiation without the 'new' keyword - if ( !( this instanceof jQuery.Event ) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - - // Support: Android <=2.3 only - src.returnValue === false ? - returnTrue : - returnFalse; - - // Create target properties - // Support: Safari <=6 - 7 only - // Target should not be a text node (#504, #13143) - this.target = ( src.target && src.target.nodeType === 3 ) ? - src.target.parentNode : - src.target; - - this.currentTarget = src.currentTarget; - this.relatedTarget = src.relatedTarget; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || Date.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - constructor: jQuery.Event, - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - isSimulated: false, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - - if ( e && !this.isSimulated ) { - e.preventDefault(); - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopPropagation(); - } - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Includes all common event props including KeyEvent and MouseEvent specific props -jQuery.each( { - altKey: true, - bubbles: true, - cancelable: true, - changedTouches: true, - ctrlKey: true, - detail: true, - eventPhase: true, - metaKey: true, - pageX: true, - pageY: true, - shiftKey: true, - view: true, - "char": true, - code: true, - charCode: true, - key: true, - keyCode: true, - button: true, - buttons: true, - clientX: true, - clientY: true, - offsetX: true, - offsetY: true, - pointerId: true, - pointerType: true, - screenX: true, - screenY: true, - targetTouches: true, - toElement: true, - touches: true, - - which: function( event ) { - var button = event.button; - - // Add which for key events - if ( event.which == null && rkeyEvent.test( event.type ) ) { - return event.charCode != null ? event.charCode : event.keyCode; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { - if ( button & 1 ) { - return 1; - } - - if ( button & 2 ) { - return 3; - } - - if ( button & 4 ) { - return 2; - } - - return 0; - } - - return event.which; - } -}, jQuery.event.addProp ); - -jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { - jQuery.event.special[ type ] = { - - // Utilize native event if possible so blur/focus sequence is correct - setup: function() { - - // Claim the first handler - // dataPriv.set( this, "focus", ... ) - // dataPriv.set( this, "blur", ... ) - leverageNative( this, type, expectSync ); - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function() { - - // Force setup before trigger - leverageNative( this, type ); - - // Return non-false to allow normal event-path propagation - return true; - }, - - delegateType: delegateType - }; -} ); - -// Create mouseenter/leave events using mouseover/out and event-time checks -// so that event delegation works in jQuery. -// Do the same for pointerenter/pointerleave and pointerover/pointerout -// -// Support: Safari 7 only -// Safari sends mouseenter too often; see: -// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 -// for the description of the bug (it existed in older Chrome versions as well). -jQuery.each( { - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // For mouseenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -} ); - -jQuery.fn.extend( { - - on: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn ); - }, - one: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? - handleObj.origType + "." + handleObj.namespace : - handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each( function() { - jQuery.event.remove( this, types, fn, selector ); - } ); - } -} ); - - -var - - /* eslint-disable max-len */ - - // See https://github.com/eslint/eslint/issues/3229 - rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, - - /* eslint-enable */ - - // Support: IE <=10 - 11, Edge 12 - 13 only - // In IE/Edge using regex groups here causes severe slowdowns. - // See https://connect.microsoft.com/IE/feedback/details/1736512/ - rnoInnerhtml = /\s*$/g; - -// Prefer a tbody over its parent table for containing new rows -function manipulationTarget( elem, content ) { - if ( nodeName( elem, "table" ) && - nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { - - return jQuery( elem ).children( "tbody" )[ 0 ] || elem; - } - - return elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { - elem.type = elem.type.slice( 5 ); - } else { - elem.removeAttribute( "type" ); - } - - return elem; -} - -function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.access( src ); - pdataCur = dataPriv.set( dest, pdataOld ); - events = pdataOld.events; - - if ( events ) { - delete pdataCur.handle; - pdataCur.events = {}; - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( dataUser.hasData( src ) ) { - udataOld = dataUser.access( src ); - udataCur = jQuery.extend( {}, udataOld ); - - dataUser.set( dest, udataCur ); - } -} - -// Fix IE bugs, see support tests -function fixInput( src, dest ) { - var nodeName = dest.nodeName.toLowerCase(); - - // Fails to persist the checked state of a cloned checkbox or radio button. - if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - dest.checked = src.checked; - - // Fails to return the selected option to the default selected state when cloning options - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -function domManip( collection, args, callback, ignored ) { - - // Flatten any nested arrays - args = concat.apply( [], args ); - - var fragment, first, scripts, hasScripts, node, doc, - i = 0, - l = collection.length, - iNoClone = l - 1, - value = args[ 0 ], - valueIsFunction = isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( valueIsFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return collection.each( function( index ) { - var self = collection.eq( index ); - if ( valueIsFunction ) { - args[ 0 ] = value.call( this, index, self.html() ); - } - domManip( self, args, callback, ignored ); - } ); - } - - if ( l ) { - fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - // Require either new content or an interest in ignored elements to invoke the callback - if ( first || ignored ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item - // instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( collection[ i ], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !dataPriv.access( node, "globalEval" ) && - jQuery.contains( doc, node ) ) { - - if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { - - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl && !node.noModule ) { - jQuery._evalUrl( node.src, { - nonce: node.nonce || node.getAttribute( "nonce" ) - } ); - } - } else { - DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); - } - } - } - } - } - } - - return collection; -} - -function remove( elem, selector, keepData ) { - var node, - nodes = selector ? jQuery.filter( selector, elem ) : elem, - i = 0; - - for ( ; ( node = nodes[ i ] ) != null; i++ ) { - if ( !keepData && node.nodeType === 1 ) { - jQuery.cleanData( getAll( node ) ); - } - - if ( node.parentNode ) { - if ( keepData && isAttached( node ) ) { - setGlobalEval( getAll( node, "script" ) ); - } - node.parentNode.removeChild( node ); - } - } - - return elem; -} - -jQuery.extend( { - htmlPrefilter: function( html ) { - return html.replace( rxhtmlTag, "<$1>" ); - }, - - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var i, l, srcElements, destElements, - clone = elem.cloneNode( true ), - inPage = isAttached( elem ); - - // Fix IE cloning issues - if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && - !jQuery.isXMLDoc( elem ) ) { - - // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - fixInput( srcElements[ i ], destElements[ i ] ); - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - cloneCopyEvent( srcElements[ i ], destElements[ i ] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - // Return the cloned set - return clone; - }, - - cleanData: function( elems ) { - var data, elem, type, - special = jQuery.event.special, - i = 0; - - for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { - if ( acceptData( elem ) ) { - if ( ( data = elem[ dataPriv.expando ] ) ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataPriv.expando ] = undefined; - } - if ( elem[ dataUser.expando ] ) { - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataUser.expando ] = undefined; - } - } - } - } -} ); - -jQuery.fn.extend( { - detach: function( selector ) { - return remove( this, selector, true ); - }, - - remove: function( selector ) { - return remove( this, selector ); - }, - - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().each( function() { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - this.textContent = value; - } - } ); - }, null, value, arguments.length ); - }, - - append: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - } ); - }, - - prepend: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - } ); - }, - - before: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - } ); - }, - - after: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - } ); - }, - - empty: function() { - var elem, - i = 0; - - for ( ; ( elem = this[ i ] ) != null; i++ ) { - if ( elem.nodeType === 1 ) { - - // Prevent memory leaks - jQuery.cleanData( getAll( elem, false ) ); - - // Remove any remaining nodes - elem.textContent = ""; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map( function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - } ); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined && elem.nodeType === 1 ) { - return elem.innerHTML; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { - - value = jQuery.htmlPrefilter( value ); - - try { - for ( ; i < l; i++ ) { - elem = this[ i ] || {}; - - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch ( e ) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var ignored = []; - - // Make the changes, replacing each non-ignored context element with the new content - return domManip( this, arguments, function( elem ) { - var parent = this.parentNode; - - if ( jQuery.inArray( this, ignored ) < 0 ) { - jQuery.cleanData( getAll( this ) ); - if ( parent ) { - parent.replaceChild( elem, this ); - } - } - - // Force callback invocation - }, ignored ); - } -} ); - -jQuery.each( { - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1, - i = 0; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone( true ); - jQuery( insert[ i ] )[ original ]( elems ); - - // Support: Android <=4.0 only, PhantomJS 1 only - // .get() because push.apply(_, arraylike) throws on ancient WebKit - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -} ); -var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); - -var getStyles = function( elem ) { - - // Support: IE <=11 only, Firefox <=30 (#15098, #14150) - // IE throws on elements created in popups - // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" - var view = elem.ownerDocument.defaultView; - - if ( !view || !view.opener ) { - view = window; - } - - return view.getComputedStyle( elem ); - }; - -var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); - - - -( function() { - - // Executing both pixelPosition & boxSizingReliable tests require only one layout - // so they're executed at the same time to save the second computation. - function computeStyleTests() { - - // This is a singleton, we need to execute it only once - if ( !div ) { - return; - } - - container.style.cssText = "position:absolute;left:-11111px;width:60px;" + - "margin-top:1px;padding:0;border:0"; - div.style.cssText = - "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + - "margin:auto;border:1px;padding:1px;" + - "width:60%;top:1%"; - documentElement.appendChild( container ).appendChild( div ); - - var divStyle = window.getComputedStyle( div ); - pixelPositionVal = divStyle.top !== "1%"; - - // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 - reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; - - // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 - // Some styles come back with percentage values, even though they shouldn't - div.style.right = "60%"; - pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; - - // Support: IE 9 - 11 only - // Detect misreporting of content dimensions for box-sizing:border-box elements - boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; - - // Support: IE 9 only - // Detect overflow:scroll screwiness (gh-3699) - // Support: Chrome <=64 - // Don't get tricked when zoom affects offsetWidth (gh-4029) - div.style.position = "absolute"; - scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; - - documentElement.removeChild( container ); - - // Nullify the div so it wouldn't be stored in the memory and - // it will also be a sign that checks already performed - div = null; - } - - function roundPixelMeasures( measure ) { - return Math.round( parseFloat( measure ) ); - } - - var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, - reliableMarginLeftVal, - container = document.createElement( "div" ), - div = document.createElement( "div" ); - - // Finish early in limited (non-browser) environments - if ( !div.style ) { - return; - } - - // Support: IE <=9 - 11 only - // Style of cloned element affects source element cloned (#8908) - div.style.backgroundClip = "content-box"; - div.cloneNode( true ).style.backgroundClip = ""; - support.clearCloneStyle = div.style.backgroundClip === "content-box"; - - jQuery.extend( support, { - boxSizingReliable: function() { - computeStyleTests(); - return boxSizingReliableVal; - }, - pixelBoxStyles: function() { - computeStyleTests(); - return pixelBoxStylesVal; - }, - pixelPosition: function() { - computeStyleTests(); - return pixelPositionVal; - }, - reliableMarginLeft: function() { - computeStyleTests(); - return reliableMarginLeftVal; - }, - scrollboxSize: function() { - computeStyleTests(); - return scrollboxSizeVal; - } - } ); -} )(); - - -function curCSS( elem, name, computed ) { - var width, minWidth, maxWidth, ret, - - // Support: Firefox 51+ - // Retrieving style before computed somehow - // fixes an issue with getting wrong values - // on detached elements - style = elem.style; - - computed = computed || getStyles( elem ); - - // getPropertyValue is needed for: - // .css('filter') (IE 9 only, #12537) - // .css('--customProperty) (#3144) - if ( computed ) { - ret = computed.getPropertyValue( name ) || computed[ name ]; - - if ( ret === "" && !isAttached( elem ) ) { - ret = jQuery.style( elem, name ); - } - - // A tribute to the "awesome hack by Dean Edwards" - // Android Browser returns percentage for some values, - // but width seems to be reliably pixels. - // This is against the CSSOM draft spec: - // https://drafts.csswg.org/cssom/#resolved-values - if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { - - // Remember the original values - width = style.width; - minWidth = style.minWidth; - maxWidth = style.maxWidth; - - // Put in the new values to get a computed value out - style.minWidth = style.maxWidth = style.width = ret; - ret = computed.width; - - // Revert the changed values - style.width = width; - style.minWidth = minWidth; - style.maxWidth = maxWidth; - } - } - - return ret !== undefined ? - - // Support: IE <=9 - 11 only - // IE returns zIndex value as an integer. - ret + "" : - ret; -} - - -function addGetHookIf( conditionFn, hookFn ) { - - // Define the hook, we'll check on the first run if it's really needed. - return { - get: function() { - if ( conditionFn() ) { - - // Hook not needed (or it's not possible to use it due - // to missing dependency), remove it. - delete this.get; - return; - } - - // Hook needed; redefine it so that the support test is not executed again. - return ( this.get = hookFn ).apply( this, arguments ); - } - }; -} - - -var cssPrefixes = [ "Webkit", "Moz", "ms" ], - emptyStyle = document.createElement( "div" ).style, - vendorProps = {}; - -// Return a vendor-prefixed property or undefined -function vendorPropName( name ) { - - // Check for vendor prefixed names - var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), - i = cssPrefixes.length; - - while ( i-- ) { - name = cssPrefixes[ i ] + capName; - if ( name in emptyStyle ) { - return name; - } - } -} - -// Return a potentially-mapped jQuery.cssProps or vendor prefixed property -function finalPropName( name ) { - var final = jQuery.cssProps[ name ] || vendorProps[ name ]; - - if ( final ) { - return final; - } - if ( name in emptyStyle ) { - return name; - } - return vendorProps[ name ] = vendorPropName( name ) || name; -} - - -var - - // Swappable if display is none or starts with table - // except "table", "table-cell", or "table-caption" - // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display - rdisplayswap = /^(none|table(?!-c[ea]).+)/, - rcustomProp = /^--/, - cssShow = { position: "absolute", visibility: "hidden", display: "block" }, - cssNormalTransform = { - letterSpacing: "0", - fontWeight: "400" - }; - -function setPositiveNumber( elem, value, subtract ) { - - // Any relative (+/-) values have already been - // normalized at this point - var matches = rcssNum.exec( value ); - return matches ? - - // Guard against undefined "subtract", e.g., when used as in cssHooks - Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : - value; -} - -function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { - var i = dimension === "width" ? 1 : 0, - extra = 0, - delta = 0; - - // Adjustment may not be necessary - if ( box === ( isBorderBox ? "border" : "content" ) ) { - return 0; - } - - for ( ; i < 4; i += 2 ) { - - // Both box models exclude margin - if ( box === "margin" ) { - delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); - } - - // If we get here with a content-box, we're seeking "padding" or "border" or "margin" - if ( !isBorderBox ) { - - // Add padding - delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - - // For "border" or "margin", add border - if ( box !== "padding" ) { - delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - - // But still keep track of it otherwise - } else { - extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - - // If we get here with a border-box (content + padding + border), we're seeking "content" or - // "padding" or "margin" - } else { - - // For "content", subtract padding - if ( box === "content" ) { - delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - } - - // For "content" or "padding", subtract border - if ( box !== "margin" ) { - delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - } - } - - // Account for positive content-box scroll gutter when requested by providing computedVal - if ( !isBorderBox && computedVal >= 0 ) { - - // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border - // Assuming integer scroll gutter, subtract the rest and round down - delta += Math.max( 0, Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - computedVal - - delta - - extra - - 0.5 - - // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter - // Use an explicit zero to avoid NaN (gh-3964) - ) ) || 0; - } - - return delta; -} - -function getWidthOrHeight( elem, dimension, extra ) { - - // Start with computed style - var styles = getStyles( elem ), - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). - // Fake content-box until we know it's needed to know the true value. - boxSizingNeeded = !support.boxSizingReliable() || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - valueIsBorderBox = isBorderBox, - - val = curCSS( elem, dimension, styles ), - offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); - - // Support: Firefox <=54 - // Return a confounding non-pixel value or feign ignorance, as appropriate. - if ( rnumnonpx.test( val ) ) { - if ( !extra ) { - return val; - } - val = "auto"; - } - - - // Fall back to offsetWidth/offsetHeight when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - // Support: Android <=4.1 - 4.3 only - // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) - // Support: IE 9-11 only - // Also use offsetWidth/offsetHeight for when box sizing is unreliable - // We use getClientRects() to check for hidden/disconnected. - // In those cases, the computed value can be trusted to be border-box - if ( ( !support.boxSizingReliable() && isBorderBox || - val === "auto" || - !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && - elem.getClientRects().length ) { - - isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; - - // Where available, offsetWidth/offsetHeight approximate border box dimensions. - // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the - // retrieved value as a content box dimension. - valueIsBorderBox = offsetProp in elem; - if ( valueIsBorderBox ) { - val = elem[ offsetProp ]; - } - } - - // Normalize "" and auto - val = parseFloat( val ) || 0; - - // Adjust for the element's box model - return ( val + - boxModelAdjustment( - elem, - dimension, - extra || ( isBorderBox ? "border" : "content" ), - valueIsBorderBox, - styles, - - // Provide the current computed size to request scroll gutter calculation (gh-3589) - val - ) - ) + "px"; -} - -jQuery.extend( { - - // Add in style property hooks for overriding the default - // behavior of getting and setting a style property - cssHooks: { - opacity: { - get: function( elem, computed ) { - if ( computed ) { - - // We should always get a number back from opacity - var ret = curCSS( elem, "opacity" ); - return ret === "" ? "1" : ret; - } - } - } - }, - - // Don't automatically add "px" to these possibly-unitless properties - cssNumber: { - "animationIterationCount": true, - "columnCount": true, - "fillOpacity": true, - "flexGrow": true, - "flexShrink": true, - "fontWeight": true, - "gridArea": true, - "gridColumn": true, - "gridColumnEnd": true, - "gridColumnStart": true, - "gridRow": true, - "gridRowEnd": true, - "gridRowStart": true, - "lineHeight": true, - "opacity": true, - "order": true, - "orphans": true, - "widows": true, - "zIndex": true, - "zoom": true - }, - - // Add in properties whose names you wish to fix before - // setting or getting the value - cssProps: {}, - - // Get and set the style property on a DOM Node - style: function( elem, name, value, extra ) { - - // Don't set styles on text and comment nodes - if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { - return; - } - - // Make sure that we're working with the right name - var ret, type, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ), - style = elem.style; - - // Make sure that we're working with the right name. We don't - // want to query the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Gets hook for the prefixed version, then unprefixed version - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // Check if we're setting a value - if ( value !== undefined ) { - type = typeof value; - - // Convert "+=" or "-=" to relative numbers (#7345) - if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { - value = adjustCSS( elem, name, ret ); - - // Fixes bug #9237 - type = "number"; - } - - // Make sure that null and NaN values aren't set (#7116) - if ( value == null || value !== value ) { - return; - } - - // If a number was passed in, add the unit (except for certain CSS properties) - // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append - // "px" to a few hardcoded values. - if ( type === "number" && !isCustomProp ) { - value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); - } - - // background-* props affect original clone's values - if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { - style[ name ] = "inherit"; - } - - // If a hook was provided, use that value, otherwise just set the specified value - if ( !hooks || !( "set" in hooks ) || - ( value = hooks.set( elem, value, extra ) ) !== undefined ) { - - if ( isCustomProp ) { - style.setProperty( name, value ); - } else { - style[ name ] = value; - } - } - - } else { - - // If a hook was provided get the non-computed value from there - if ( hooks && "get" in hooks && - ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { - - return ret; - } - - // Otherwise just get the value from the style object - return style[ name ]; - } - }, - - css: function( elem, name, extra, styles ) { - var val, num, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ); - - // Make sure that we're working with the right name. We don't - // want to modify the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Try prefixed name followed by the unprefixed name - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // If a hook was provided get the computed value from there - if ( hooks && "get" in hooks ) { - val = hooks.get( elem, true, extra ); - } - - // Otherwise, if a way to get the computed value exists, use that - if ( val === undefined ) { - val = curCSS( elem, name, styles ); - } - - // Convert "normal" to computed value - if ( val === "normal" && name in cssNormalTransform ) { - val = cssNormalTransform[ name ]; - } - - // Make numeric if forced or a qualifier was provided and val looks numeric - if ( extra === "" || extra ) { - num = parseFloat( val ); - return extra === true || isFinite( num ) ? num || 0 : val; - } - - return val; - } -} ); - -jQuery.each( [ "height", "width" ], function( i, dimension ) { - jQuery.cssHooks[ dimension ] = { - get: function( elem, computed, extra ) { - if ( computed ) { - - // Certain elements can have dimension info if we invisibly show them - // but it must have a current display style that would benefit - return rdisplayswap.test( jQuery.css( elem, "display" ) ) && - - // Support: Safari 8+ - // Table columns in Safari have non-zero offsetWidth & zero - // getBoundingClientRect().width unless display is changed. - // Support: IE <=11 only - // Running getBoundingClientRect on a disconnected node - // in IE throws an error. - ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? - swap( elem, cssShow, function() { - return getWidthOrHeight( elem, dimension, extra ); - } ) : - getWidthOrHeight( elem, dimension, extra ); - } - }, - - set: function( elem, value, extra ) { - var matches, - styles = getStyles( elem ), - - // Only read styles.position if the test has a chance to fail - // to avoid forcing a reflow. - scrollboxSizeBuggy = !support.scrollboxSize() && - styles.position === "absolute", - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) - boxSizingNeeded = scrollboxSizeBuggy || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - subtract = extra ? - boxModelAdjustment( - elem, - dimension, - extra, - isBorderBox, - styles - ) : - 0; - - // Account for unreliable border-box dimensions by comparing offset* to computed and - // faking a content-box to get border and padding (gh-3699) - if ( isBorderBox && scrollboxSizeBuggy ) { - subtract -= Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - parseFloat( styles[ dimension ] ) - - boxModelAdjustment( elem, dimension, "border", false, styles ) - - 0.5 - ); - } - - // Convert to pixels if value adjustment is needed - if ( subtract && ( matches = rcssNum.exec( value ) ) && - ( matches[ 3 ] || "px" ) !== "px" ) { - - elem.style[ dimension ] = value; - value = jQuery.css( elem, dimension ); - } - - return setPositiveNumber( elem, value, subtract ); - } - }; -} ); - -jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, - function( elem, computed ) { - if ( computed ) { - return ( parseFloat( curCSS( elem, "marginLeft" ) ) || - elem.getBoundingClientRect().left - - swap( elem, { marginLeft: 0 }, function() { - return elem.getBoundingClientRect().left; - } ) - ) + "px"; - } - } -); - -// These hooks are used by animate to expand properties -jQuery.each( { - margin: "", - padding: "", - border: "Width" -}, function( prefix, suffix ) { - jQuery.cssHooks[ prefix + suffix ] = { - expand: function( value ) { - var i = 0, - expanded = {}, - - // Assumes a single number if not a string - parts = typeof value === "string" ? value.split( " " ) : [ value ]; - - for ( ; i < 4; i++ ) { - expanded[ prefix + cssExpand[ i ] + suffix ] = - parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; - } - - return expanded; - } - }; - - if ( prefix !== "margin" ) { - jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; - } -} ); - -jQuery.fn.extend( { - css: function( name, value ) { - return access( this, function( elem, name, value ) { - var styles, len, - map = {}, - i = 0; - - if ( Array.isArray( name ) ) { - styles = getStyles( elem ); - len = name.length; - - for ( ; i < len; i++ ) { - map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); - } - - return map; - } - - return value !== undefined ? - jQuery.style( elem, name, value ) : - jQuery.css( elem, name ); - }, name, value, arguments.length > 1 ); - } -} ); - - -function Tween( elem, options, prop, end, easing ) { - return new Tween.prototype.init( elem, options, prop, end, easing ); -} -jQuery.Tween = Tween; - -Tween.prototype = { - constructor: Tween, - init: function( elem, options, prop, end, easing, unit ) { - this.elem = elem; - this.prop = prop; - this.easing = easing || jQuery.easing._default; - this.options = options; - this.start = this.now = this.cur(); - this.end = end; - this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); - }, - cur: function() { - var hooks = Tween.propHooks[ this.prop ]; - - return hooks && hooks.get ? - hooks.get( this ) : - Tween.propHooks._default.get( this ); - }, - run: function( percent ) { - var eased, - hooks = Tween.propHooks[ this.prop ]; - - if ( this.options.duration ) { - this.pos = eased = jQuery.easing[ this.easing ]( - percent, this.options.duration * percent, 0, 1, this.options.duration - ); - } else { - this.pos = eased = percent; - } - this.now = ( this.end - this.start ) * eased + this.start; - - if ( this.options.step ) { - this.options.step.call( this.elem, this.now, this ); - } - - if ( hooks && hooks.set ) { - hooks.set( this ); - } else { - Tween.propHooks._default.set( this ); - } - return this; - } -}; - -Tween.prototype.init.prototype = Tween.prototype; - -Tween.propHooks = { - _default: { - get: function( tween ) { - var result; - - // Use a property on the element directly when it is not a DOM element, - // or when there is no matching style property that exists. - if ( tween.elem.nodeType !== 1 || - tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { - return tween.elem[ tween.prop ]; - } - - // Passing an empty string as a 3rd parameter to .css will automatically - // attempt a parseFloat and fallback to a string if the parse fails. - // Simple values such as "10px" are parsed to Float; - // complex values such as "rotate(1rad)" are returned as-is. - result = jQuery.css( tween.elem, tween.prop, "" ); - - // Empty strings, null, undefined and "auto" are converted to 0. - return !result || result === "auto" ? 0 : result; - }, - set: function( tween ) { - - // Use step hook for back compat. - // Use cssHook if its there. - // Use .style if available and use plain properties where available. - if ( jQuery.fx.step[ tween.prop ] ) { - jQuery.fx.step[ tween.prop ]( tween ); - } else if ( tween.elem.nodeType === 1 && ( - jQuery.cssHooks[ tween.prop ] || - tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { - jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); - } else { - tween.elem[ tween.prop ] = tween.now; - } - } - } -}; - -// Support: IE <=9 only -// Panic based approach to setting things on disconnected nodes -Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { - set: function( tween ) { - if ( tween.elem.nodeType && tween.elem.parentNode ) { - tween.elem[ tween.prop ] = tween.now; - } - } -}; - -jQuery.easing = { - linear: function( p ) { - return p; - }, - swing: function( p ) { - return 0.5 - Math.cos( p * Math.PI ) / 2; - }, - _default: "swing" -}; - -jQuery.fx = Tween.prototype.init; - -// Back compat <1.8 extension point -jQuery.fx.step = {}; - - - - -var - fxNow, inProgress, - rfxtypes = /^(?:toggle|show|hide)$/, - rrun = /queueHooks$/; - -function schedule() { - if ( inProgress ) { - if ( document.hidden === false && window.requestAnimationFrame ) { - window.requestAnimationFrame( schedule ); - } else { - window.setTimeout( schedule, jQuery.fx.interval ); - } - - jQuery.fx.tick(); - } -} - -// Animations created synchronously will run synchronously -function createFxNow() { - window.setTimeout( function() { - fxNow = undefined; - } ); - return ( fxNow = Date.now() ); -} - -// Generate parameters to create a standard animation -function genFx( type, includeWidth ) { - var which, - i = 0, - attrs = { height: type }; - - // If we include width, step value is 1 to do all cssExpand values, - // otherwise step value is 2 to skip over Left and Right - includeWidth = includeWidth ? 1 : 0; - for ( ; i < 4; i += 2 - includeWidth ) { - which = cssExpand[ i ]; - attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; - } - - if ( includeWidth ) { - attrs.opacity = attrs.width = type; - } - - return attrs; -} - -function createTween( value, prop, animation ) { - var tween, - collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), - index = 0, - length = collection.length; - for ( ; index < length; index++ ) { - if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { - - // We're done with this property - return tween; - } - } -} - -function defaultPrefilter( elem, props, opts ) { - var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, - isBox = "width" in props || "height" in props, - anim = this, - orig = {}, - style = elem.style, - hidden = elem.nodeType && isHiddenWithinTree( elem ), - dataShow = dataPriv.get( elem, "fxshow" ); - - // Queue-skipping animations hijack the fx hooks - if ( !opts.queue ) { - hooks = jQuery._queueHooks( elem, "fx" ); - if ( hooks.unqueued == null ) { - hooks.unqueued = 0; - oldfire = hooks.empty.fire; - hooks.empty.fire = function() { - if ( !hooks.unqueued ) { - oldfire(); - } - }; - } - hooks.unqueued++; - - anim.always( function() { - - // Ensure the complete handler is called before this completes - anim.always( function() { - hooks.unqueued--; - if ( !jQuery.queue( elem, "fx" ).length ) { - hooks.empty.fire(); - } - } ); - } ); - } - - // Detect show/hide animations - for ( prop in props ) { - value = props[ prop ]; - if ( rfxtypes.test( value ) ) { - delete props[ prop ]; - toggle = toggle || value === "toggle"; - if ( value === ( hidden ? "hide" : "show" ) ) { - - // Pretend to be hidden if this is a "show" and - // there is still data from a stopped show/hide - if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { - hidden = true; - - // Ignore all other no-op show/hide data - } else { - continue; - } - } - orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); - } - } - - // Bail out if this is a no-op like .hide().hide() - propTween = !jQuery.isEmptyObject( props ); - if ( !propTween && jQuery.isEmptyObject( orig ) ) { - return; - } - - // Restrict "overflow" and "display" styles during box animations - if ( isBox && elem.nodeType === 1 ) { - - // Support: IE <=9 - 11, Edge 12 - 15 - // Record all 3 overflow attributes because IE does not infer the shorthand - // from identically-valued overflowX and overflowY and Edge just mirrors - // the overflowX value there. - opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; - - // Identify a display type, preferring old show/hide data over the CSS cascade - restoreDisplay = dataShow && dataShow.display; - if ( restoreDisplay == null ) { - restoreDisplay = dataPriv.get( elem, "display" ); - } - display = jQuery.css( elem, "display" ); - if ( display === "none" ) { - if ( restoreDisplay ) { - display = restoreDisplay; - } else { - - // Get nonempty value(s) by temporarily forcing visibility - showHide( [ elem ], true ); - restoreDisplay = elem.style.display || restoreDisplay; - display = jQuery.css( elem, "display" ); - showHide( [ elem ] ); - } - } - - // Animate inline elements as inline-block - if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { - if ( jQuery.css( elem, "float" ) === "none" ) { - - // Restore the original display value at the end of pure show/hide animations - if ( !propTween ) { - anim.done( function() { - style.display = restoreDisplay; - } ); - if ( restoreDisplay == null ) { - display = style.display; - restoreDisplay = display === "none" ? "" : display; - } - } - style.display = "inline-block"; - } - } - } - - if ( opts.overflow ) { - style.overflow = "hidden"; - anim.always( function() { - style.overflow = opts.overflow[ 0 ]; - style.overflowX = opts.overflow[ 1 ]; - style.overflowY = opts.overflow[ 2 ]; - } ); - } - - // Implement show/hide animations - propTween = false; - for ( prop in orig ) { - - // General show/hide setup for this element animation - if ( !propTween ) { - if ( dataShow ) { - if ( "hidden" in dataShow ) { - hidden = dataShow.hidden; - } - } else { - dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); - } - - // Store hidden/visible for toggle so `.stop().toggle()` "reverses" - if ( toggle ) { - dataShow.hidden = !hidden; - } - - // Show elements before animating them - if ( hidden ) { - showHide( [ elem ], true ); - } - - /* eslint-disable no-loop-func */ - - anim.done( function() { - - /* eslint-enable no-loop-func */ - - // The final step of a "hide" animation is actually hiding the element - if ( !hidden ) { - showHide( [ elem ] ); - } - dataPriv.remove( elem, "fxshow" ); - for ( prop in orig ) { - jQuery.style( elem, prop, orig[ prop ] ); - } - } ); - } - - // Per-property setup - propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); - if ( !( prop in dataShow ) ) { - dataShow[ prop ] = propTween.start; - if ( hidden ) { - propTween.end = propTween.start; - propTween.start = 0; - } - } - } -} - -function propFilter( props, specialEasing ) { - var index, name, easing, value, hooks; - - // camelCase, specialEasing and expand cssHook pass - for ( index in props ) { - name = camelCase( index ); - easing = specialEasing[ name ]; - value = props[ index ]; - if ( Array.isArray( value ) ) { - easing = value[ 1 ]; - value = props[ index ] = value[ 0 ]; - } - - if ( index !== name ) { - props[ name ] = value; - delete props[ index ]; - } - - hooks = jQuery.cssHooks[ name ]; - if ( hooks && "expand" in hooks ) { - value = hooks.expand( value ); - delete props[ name ]; - - // Not quite $.extend, this won't overwrite existing keys. - // Reusing 'index' because we have the correct "name" - for ( index in value ) { - if ( !( index in props ) ) { - props[ index ] = value[ index ]; - specialEasing[ index ] = easing; - } - } - } else { - specialEasing[ name ] = easing; - } - } -} - -function Animation( elem, properties, options ) { - var result, - stopped, - index = 0, - length = Animation.prefilters.length, - deferred = jQuery.Deferred().always( function() { - - // Don't match elem in the :animated selector - delete tick.elem; - } ), - tick = function() { - if ( stopped ) { - return false; - } - var currentTime = fxNow || createFxNow(), - remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), - - // Support: Android 2.3 only - // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) - temp = remaining / animation.duration || 0, - percent = 1 - temp, - index = 0, - length = animation.tweens.length; - - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( percent ); - } - - deferred.notifyWith( elem, [ animation, percent, remaining ] ); - - // If there's more to do, yield - if ( percent < 1 && length ) { - return remaining; - } - - // If this was an empty animation, synthesize a final progress notification - if ( !length ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - } - - // Resolve the animation and report its conclusion - deferred.resolveWith( elem, [ animation ] ); - return false; - }, - animation = deferred.promise( { - elem: elem, - props: jQuery.extend( {}, properties ), - opts: jQuery.extend( true, { - specialEasing: {}, - easing: jQuery.easing._default - }, options ), - originalProperties: properties, - originalOptions: options, - startTime: fxNow || createFxNow(), - duration: options.duration, - tweens: [], - createTween: function( prop, end ) { - var tween = jQuery.Tween( elem, animation.opts, prop, end, - animation.opts.specialEasing[ prop ] || animation.opts.easing ); - animation.tweens.push( tween ); - return tween; - }, - stop: function( gotoEnd ) { - var index = 0, - - // If we are going to the end, we want to run all the tweens - // otherwise we skip this part - length = gotoEnd ? animation.tweens.length : 0; - if ( stopped ) { - return this; - } - stopped = true; - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( 1 ); - } - - // Resolve when we played the last frame; otherwise, reject - if ( gotoEnd ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - deferred.resolveWith( elem, [ animation, gotoEnd ] ); - } else { - deferred.rejectWith( elem, [ animation, gotoEnd ] ); - } - return this; - } - } ), - props = animation.props; - - propFilter( props, animation.opts.specialEasing ); - - for ( ; index < length; index++ ) { - result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); - if ( result ) { - if ( isFunction( result.stop ) ) { - jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = - result.stop.bind( result ); - } - return result; - } - } - - jQuery.map( props, createTween, animation ); - - if ( isFunction( animation.opts.start ) ) { - animation.opts.start.call( elem, animation ); - } - - // Attach callbacks from options - animation - .progress( animation.opts.progress ) - .done( animation.opts.done, animation.opts.complete ) - .fail( animation.opts.fail ) - .always( animation.opts.always ); - - jQuery.fx.timer( - jQuery.extend( tick, { - elem: elem, - anim: animation, - queue: animation.opts.queue - } ) - ); - - return animation; -} - -jQuery.Animation = jQuery.extend( Animation, { - - tweeners: { - "*": [ function( prop, value ) { - var tween = this.createTween( prop, value ); - adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); - return tween; - } ] - }, - - tweener: function( props, callback ) { - if ( isFunction( props ) ) { - callback = props; - props = [ "*" ]; - } else { - props = props.match( rnothtmlwhite ); - } - - var prop, - index = 0, - length = props.length; - - for ( ; index < length; index++ ) { - prop = props[ index ]; - Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; - Animation.tweeners[ prop ].unshift( callback ); - } - }, - - prefilters: [ defaultPrefilter ], - - prefilter: function( callback, prepend ) { - if ( prepend ) { - Animation.prefilters.unshift( callback ); - } else { - Animation.prefilters.push( callback ); - } - } -} ); - -jQuery.speed = function( speed, easing, fn ) { - var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { - complete: fn || !fn && easing || - isFunction( speed ) && speed, - duration: speed, - easing: fn && easing || easing && !isFunction( easing ) && easing - }; - - // Go to the end state if fx are off - if ( jQuery.fx.off ) { - opt.duration = 0; - - } else { - if ( typeof opt.duration !== "number" ) { - if ( opt.duration in jQuery.fx.speeds ) { - opt.duration = jQuery.fx.speeds[ opt.duration ]; - - } else { - opt.duration = jQuery.fx.speeds._default; - } - } - } - - // Normalize opt.queue - true/undefined/null -> "fx" - if ( opt.queue == null || opt.queue === true ) { - opt.queue = "fx"; - } - - // Queueing - opt.old = opt.complete; - - opt.complete = function() { - if ( isFunction( opt.old ) ) { - opt.old.call( this ); - } - - if ( opt.queue ) { - jQuery.dequeue( this, opt.queue ); - } - }; - - return opt; -}; - -jQuery.fn.extend( { - fadeTo: function( speed, to, easing, callback ) { - - // Show any hidden elements after setting opacity to 0 - return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() - - // Animate to the value specified - .end().animate( { opacity: to }, speed, easing, callback ); - }, - animate: function( prop, speed, easing, callback ) { - var empty = jQuery.isEmptyObject( prop ), - optall = jQuery.speed( speed, easing, callback ), - doAnimation = function() { - - // Operate on a copy of prop so per-property easing won't be lost - var anim = Animation( this, jQuery.extend( {}, prop ), optall ); - - // Empty animations, or finishing resolves immediately - if ( empty || dataPriv.get( this, "finish" ) ) { - anim.stop( true ); - } - }; - doAnimation.finish = doAnimation; - - return empty || optall.queue === false ? - this.each( doAnimation ) : - this.queue( optall.queue, doAnimation ); - }, - stop: function( type, clearQueue, gotoEnd ) { - var stopQueue = function( hooks ) { - var stop = hooks.stop; - delete hooks.stop; - stop( gotoEnd ); - }; - - if ( typeof type !== "string" ) { - gotoEnd = clearQueue; - clearQueue = type; - type = undefined; - } - if ( clearQueue && type !== false ) { - this.queue( type || "fx", [] ); - } - - return this.each( function() { - var dequeue = true, - index = type != null && type + "queueHooks", - timers = jQuery.timers, - data = dataPriv.get( this ); - - if ( index ) { - if ( data[ index ] && data[ index ].stop ) { - stopQueue( data[ index ] ); - } - } else { - for ( index in data ) { - if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { - stopQueue( data[ index ] ); - } - } - } - - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && - ( type == null || timers[ index ].queue === type ) ) { - - timers[ index ].anim.stop( gotoEnd ); - dequeue = false; - timers.splice( index, 1 ); - } - } - - // Start the next in the queue if the last step wasn't forced. - // Timers currently will call their complete callbacks, which - // will dequeue but only if they were gotoEnd. - if ( dequeue || !gotoEnd ) { - jQuery.dequeue( this, type ); - } - } ); - }, - finish: function( type ) { - if ( type !== false ) { - type = type || "fx"; - } - return this.each( function() { - var index, - data = dataPriv.get( this ), - queue = data[ type + "queue" ], - hooks = data[ type + "queueHooks" ], - timers = jQuery.timers, - length = queue ? queue.length : 0; - - // Enable finishing flag on private data - data.finish = true; - - // Empty the queue first - jQuery.queue( this, type, [] ); - - if ( hooks && hooks.stop ) { - hooks.stop.call( this, true ); - } - - // Look for any active animations, and finish them - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && timers[ index ].queue === type ) { - timers[ index ].anim.stop( true ); - timers.splice( index, 1 ); - } - } - - // Look for any animations in the old queue and finish them - for ( index = 0; index < length; index++ ) { - if ( queue[ index ] && queue[ index ].finish ) { - queue[ index ].finish.call( this ); - } - } - - // Turn off finishing flag - delete data.finish; - } ); - } -} ); - -jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { - var cssFn = jQuery.fn[ name ]; - jQuery.fn[ name ] = function( speed, easing, callback ) { - return speed == null || typeof speed === "boolean" ? - cssFn.apply( this, arguments ) : - this.animate( genFx( name, true ), speed, easing, callback ); - }; -} ); - -// Generate shortcuts for custom animations -jQuery.each( { - slideDown: genFx( "show" ), - slideUp: genFx( "hide" ), - slideToggle: genFx( "toggle" ), - fadeIn: { opacity: "show" }, - fadeOut: { opacity: "hide" }, - fadeToggle: { opacity: "toggle" } -}, function( name, props ) { - jQuery.fn[ name ] = function( speed, easing, callback ) { - return this.animate( props, speed, easing, callback ); - }; -} ); - -jQuery.timers = []; -jQuery.fx.tick = function() { - var timer, - i = 0, - timers = jQuery.timers; - - fxNow = Date.now(); - - for ( ; i < timers.length; i++ ) { - timer = timers[ i ]; - - // Run the timer and safely remove it when done (allowing for external removal) - if ( !timer() && timers[ i ] === timer ) { - timers.splice( i--, 1 ); - } - } - - if ( !timers.length ) { - jQuery.fx.stop(); - } - fxNow = undefined; -}; - -jQuery.fx.timer = function( timer ) { - jQuery.timers.push( timer ); - jQuery.fx.start(); -}; - -jQuery.fx.interval = 13; -jQuery.fx.start = function() { - if ( inProgress ) { - return; - } - - inProgress = true; - schedule(); -}; - -jQuery.fx.stop = function() { - inProgress = null; -}; - -jQuery.fx.speeds = { - slow: 600, - fast: 200, - - // Default speed - _default: 400 -}; - - -// Based off of the plugin by Clint Helfers, with permission. -// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ -jQuery.fn.delay = function( time, type ) { - time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; - type = type || "fx"; - - return this.queue( type, function( next, hooks ) { - var timeout = window.setTimeout( next, time ); - hooks.stop = function() { - window.clearTimeout( timeout ); - }; - } ); -}; - - -( function() { - var input = document.createElement( "input" ), - select = document.createElement( "select" ), - opt = select.appendChild( document.createElement( "option" ) ); - - input.type = "checkbox"; - - // Support: Android <=4.3 only - // Default value for a checkbox should be "on" - support.checkOn = input.value !== ""; - - // Support: IE <=11 only - // Must access selectedIndex to make default options select - support.optSelected = opt.selected; - - // Support: IE <=11 only - // An input loses its value after becoming a radio - input = document.createElement( "input" ); - input.value = "t"; - input.type = "radio"; - support.radioValue = input.value === "t"; -} )(); - - -var boolHook, - attrHandle = jQuery.expr.attrHandle; - -jQuery.fn.extend( { - attr: function( name, value ) { - return access( this, jQuery.attr, name, value, arguments.length > 1 ); - }, - - removeAttr: function( name ) { - return this.each( function() { - jQuery.removeAttr( this, name ); - } ); - } -} ); - -jQuery.extend( { - attr: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set attributes on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - // Fallback to prop when attributes are not supported - if ( typeof elem.getAttribute === "undefined" ) { - return jQuery.prop( elem, name, value ); - } - - // Attribute hooks are determined by the lowercase version - // Grab necessary hook if one is defined - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - hooks = jQuery.attrHooks[ name.toLowerCase() ] || - ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); - } - - if ( value !== undefined ) { - if ( value === null ) { - jQuery.removeAttr( elem, name ); - return; - } - - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - elem.setAttribute( name, value + "" ); - return value; - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - ret = jQuery.find.attr( elem, name ); - - // Non-existent attributes return null, we normalize to undefined - return ret == null ? undefined : ret; - }, - - attrHooks: { - type: { - set: function( elem, value ) { - if ( !support.radioValue && value === "radio" && - nodeName( elem, "input" ) ) { - var val = elem.value; - elem.setAttribute( "type", value ); - if ( val ) { - elem.value = val; - } - return value; - } - } - } - }, - - removeAttr: function( elem, value ) { - var name, - i = 0, - - // Attribute names can contain non-HTML whitespace characters - // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 - attrNames = value && value.match( rnothtmlwhite ); - - if ( attrNames && elem.nodeType === 1 ) { - while ( ( name = attrNames[ i++ ] ) ) { - elem.removeAttribute( name ); - } - } - } -} ); - -// Hooks for boolean attributes -boolHook = { - set: function( elem, value, name ) { - if ( value === false ) { - - // Remove boolean attributes when set to false - jQuery.removeAttr( elem, name ); - } else { - elem.setAttribute( name, name ); - } - return name; - } -}; - -jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { - var getter = attrHandle[ name ] || jQuery.find.attr; - - attrHandle[ name ] = function( elem, name, isXML ) { - var ret, handle, - lowercaseName = name.toLowerCase(); - - if ( !isXML ) { - - // Avoid an infinite loop by temporarily removing this function from the getter - handle = attrHandle[ lowercaseName ]; - attrHandle[ lowercaseName ] = ret; - ret = getter( elem, name, isXML ) != null ? - lowercaseName : - null; - attrHandle[ lowercaseName ] = handle; - } - return ret; - }; -} ); - - - - -var rfocusable = /^(?:input|select|textarea|button)$/i, - rclickable = /^(?:a|area)$/i; - -jQuery.fn.extend( { - prop: function( name, value ) { - return access( this, jQuery.prop, name, value, arguments.length > 1 ); - }, - - removeProp: function( name ) { - return this.each( function() { - delete this[ jQuery.propFix[ name ] || name ]; - } ); - } -} ); - -jQuery.extend( { - prop: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set properties on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - - // Fix name and attach hooks - name = jQuery.propFix[ name ] || name; - hooks = jQuery.propHooks[ name ]; - } - - if ( value !== undefined ) { - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - return ( elem[ name ] = value ); - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - return elem[ name ]; - }, - - propHooks: { - tabIndex: { - get: function( elem ) { - - // Support: IE <=9 - 11 only - // elem.tabIndex doesn't always return the - // correct value when it hasn't been explicitly set - // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ - // Use proper attribute retrieval(#12072) - var tabindex = jQuery.find.attr( elem, "tabindex" ); - - if ( tabindex ) { - return parseInt( tabindex, 10 ); - } - - if ( - rfocusable.test( elem.nodeName ) || - rclickable.test( elem.nodeName ) && - elem.href - ) { - return 0; - } - - return -1; - } - } - }, - - propFix: { - "for": "htmlFor", - "class": "className" - } -} ); - -// Support: IE <=11 only -// Accessing the selectedIndex property -// forces the browser to respect setting selected -// on the option -// The getter ensures a default option is selected -// when in an optgroup -// eslint rule "no-unused-expressions" is disabled for this code -// since it considers such accessions noop -if ( !support.optSelected ) { - jQuery.propHooks.selected = { - get: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent && parent.parentNode ) { - parent.parentNode.selectedIndex; - } - return null; - }, - set: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent ) { - parent.selectedIndex; - - if ( parent.parentNode ) { - parent.parentNode.selectedIndex; - } - } - } - }; -} - -jQuery.each( [ - "tabIndex", - "readOnly", - "maxLength", - "cellSpacing", - "cellPadding", - "rowSpan", - "colSpan", - "useMap", - "frameBorder", - "contentEditable" -], function() { - jQuery.propFix[ this.toLowerCase() ] = this; -} ); - - - - - // Strip and collapse whitespace according to HTML spec - // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace - function stripAndCollapse( value ) { - var tokens = value.match( rnothtmlwhite ) || []; - return tokens.join( " " ); - } - - -function getClass( elem ) { - return elem.getAttribute && elem.getAttribute( "class" ) || ""; -} - -function classesToArray( value ) { - if ( Array.isArray( value ) ) { - return value; - } - if ( typeof value === "string" ) { - return value.match( rnothtmlwhite ) || []; - } - return []; -} - -jQuery.fn.extend( { - addClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - if ( cur.indexOf( " " + clazz + " " ) < 0 ) { - cur += clazz + " "; - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - removeClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - if ( !arguments.length ) { - return this.attr( "class", "" ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - - // This expression is here for better compressibility (see addClass) - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - - // Remove *all* instances - while ( cur.indexOf( " " + clazz + " " ) > -1 ) { - cur = cur.replace( " " + clazz + " ", " " ); - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - toggleClass: function( value, stateVal ) { - var type = typeof value, - isValidValue = type === "string" || Array.isArray( value ); - - if ( typeof stateVal === "boolean" && isValidValue ) { - return stateVal ? this.addClass( value ) : this.removeClass( value ); - } - - if ( isFunction( value ) ) { - return this.each( function( i ) { - jQuery( this ).toggleClass( - value.call( this, i, getClass( this ), stateVal ), - stateVal - ); - } ); - } - - return this.each( function() { - var className, i, self, classNames; - - if ( isValidValue ) { - - // Toggle individual class names - i = 0; - self = jQuery( this ); - classNames = classesToArray( value ); - - while ( ( className = classNames[ i++ ] ) ) { - - // Check each className given, space separated list - if ( self.hasClass( className ) ) { - self.removeClass( className ); - } else { - self.addClass( className ); - } - } - - // Toggle whole class name - } else if ( value === undefined || type === "boolean" ) { - className = getClass( this ); - if ( className ) { - - // Store className if set - dataPriv.set( this, "__className__", className ); - } - - // If the element has a class name or if we're passed `false`, - // then remove the whole classname (if there was one, the above saved it). - // Otherwise bring back whatever was previously saved (if anything), - // falling back to the empty string if nothing was stored. - if ( this.setAttribute ) { - this.setAttribute( "class", - className || value === false ? - "" : - dataPriv.get( this, "__className__" ) || "" - ); - } - } - } ); - }, - - hasClass: function( selector ) { - var className, elem, - i = 0; - - className = " " + selector + " "; - while ( ( elem = this[ i++ ] ) ) { - if ( elem.nodeType === 1 && - ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { - return true; - } - } - - return false; - } -} ); - - - - -var rreturn = /\r/g; - -jQuery.fn.extend( { - val: function( value ) { - var hooks, ret, valueIsFunction, - elem = this[ 0 ]; - - if ( !arguments.length ) { - if ( elem ) { - hooks = jQuery.valHooks[ elem.type ] || - jQuery.valHooks[ elem.nodeName.toLowerCase() ]; - - if ( hooks && - "get" in hooks && - ( ret = hooks.get( elem, "value" ) ) !== undefined - ) { - return ret; - } - - ret = elem.value; - - // Handle most common string cases - if ( typeof ret === "string" ) { - return ret.replace( rreturn, "" ); - } - - // Handle cases where value is null/undef or number - return ret == null ? "" : ret; - } - - return; - } - - valueIsFunction = isFunction( value ); - - return this.each( function( i ) { - var val; - - if ( this.nodeType !== 1 ) { - return; - } - - if ( valueIsFunction ) { - val = value.call( this, i, jQuery( this ).val() ); - } else { - val = value; - } - - // Treat null/undefined as ""; convert numbers to string - if ( val == null ) { - val = ""; - - } else if ( typeof val === "number" ) { - val += ""; - - } else if ( Array.isArray( val ) ) { - val = jQuery.map( val, function( value ) { - return value == null ? "" : value + ""; - } ); - } - - hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; - - // If set returns undefined, fall back to normal setting - if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { - this.value = val; - } - } ); - } -} ); - -jQuery.extend( { - valHooks: { - option: { - get: function( elem ) { - - var val = jQuery.find.attr( elem, "value" ); - return val != null ? - val : - - // Support: IE <=10 - 11 only - // option.text throws exceptions (#14686, #14858) - // Strip and collapse whitespace - // https://html.spec.whatwg.org/#strip-and-collapse-whitespace - stripAndCollapse( jQuery.text( elem ) ); - } - }, - select: { - get: function( elem ) { - var value, option, i, - options = elem.options, - index = elem.selectedIndex, - one = elem.type === "select-one", - values = one ? null : [], - max = one ? index + 1 : options.length; - - if ( index < 0 ) { - i = max; - - } else { - i = one ? index : 0; - } - - // Loop through all the selected options - for ( ; i < max; i++ ) { - option = options[ i ]; - - // Support: IE <=9 only - // IE8-9 doesn't update selected after form reset (#2551) - if ( ( option.selected || i === index ) && - - // Don't return options that are disabled or in a disabled optgroup - !option.disabled && - ( !option.parentNode.disabled || - !nodeName( option.parentNode, "optgroup" ) ) ) { - - // Get the specific value for the option - value = jQuery( option ).val(); - - // We don't need an array for one selects - if ( one ) { - return value; - } - - // Multi-Selects return an array - values.push( value ); - } - } - - return values; - }, - - set: function( elem, value ) { - var optionSet, option, - options = elem.options, - values = jQuery.makeArray( value ), - i = options.length; - - while ( i-- ) { - option = options[ i ]; - - /* eslint-disable no-cond-assign */ - - if ( option.selected = - jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 - ) { - optionSet = true; - } - - /* eslint-enable no-cond-assign */ - } - - // Force browsers to behave consistently when non-matching value is set - if ( !optionSet ) { - elem.selectedIndex = -1; - } - return values; - } - } - } -} ); - -// Radios and checkboxes getter/setter -jQuery.each( [ "radio", "checkbox" ], function() { - jQuery.valHooks[ this ] = { - set: function( elem, value ) { - if ( Array.isArray( value ) ) { - return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); - } - } - }; - if ( !support.checkOn ) { - jQuery.valHooks[ this ].get = function( elem ) { - return elem.getAttribute( "value" ) === null ? "on" : elem.value; - }; - } -} ); - - - - -// Return jQuery for attributes-only inclusion - - -support.focusin = "onfocusin" in window; - - -var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - stopPropagationCallback = function( e ) { - e.stopPropagation(); - }; - -jQuery.extend( jQuery.event, { - - trigger: function( event, data, elem, onlyHandlers ) { - - var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; - - cur = lastElement = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf( "." ) > -1 ) { - - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split( "." ); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf( ":" ) < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join( "." ); - event.rnamespace = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === ( elem.ownerDocument || document ) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { - lastElement = cur; - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && - dataPriv.get( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( ( !special._default || - special._default.apply( eventPath.pop(), data ) === false ) && - acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name as the event. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - - if ( event.isPropagationStopped() ) { - lastElement.addEventListener( type, stopPropagationCallback ); - } - - elem[ type ](); - - if ( event.isPropagationStopped() ) { - lastElement.removeEventListener( type, stopPropagationCallback ); - } - - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - // Piggyback on a donor event to simulate a different one - // Used only for `focus(in | out)` events - simulate: function( type, elem, event ) { - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true - } - ); - - jQuery.event.trigger( e, null, elem ); - } - -} ); - -jQuery.fn.extend( { - - trigger: function( type, data ) { - return this.each( function() { - jQuery.event.trigger( type, data, this ); - } ); - }, - triggerHandler: function( type, data ) { - var elem = this[ 0 ]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -} ); - - -// Support: Firefox <=44 -// Firefox doesn't have focus(in | out) events -// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 -// -// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 -// focus(in | out) events fire after focus & blur events, -// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order -// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 -if ( !support.focusin ) { - jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - var doc = this.ownerDocument || this, - attaches = dataPriv.access( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this, - attaches = dataPriv.access( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - dataPriv.remove( doc, fix ); - - } else { - dataPriv.access( doc, fix, attaches ); - } - } - }; - } ); -} -var location = window.location; - -var nonce = Date.now(); - -var rquery = ( /\?/ ); - - - -// Cross-browser xml parsing -jQuery.parseXML = function( data ) { - var xml; - if ( !data || typeof data !== "string" ) { - return null; - } - - // Support: IE 9 - 11 only - // IE throws on parseFromString with invalid input. - try { - xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); - } catch ( e ) { - xml = undefined; - } - - if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { - jQuery.error( "Invalid XML: " + data ); - } - return xml; -}; - - -var - rbracket = /\[\]$/, - rCRLF = /\r?\n/g, - rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, - rsubmittable = /^(?:input|select|textarea|keygen)/i; - -function buildParams( prefix, obj, traditional, add ) { - var name; - - if ( Array.isArray( obj ) ) { - - // Serialize array item. - jQuery.each( obj, function( i, v ) { - if ( traditional || rbracket.test( prefix ) ) { - - // Treat each array item as a scalar. - add( prefix, v ); - - } else { - - // Item is non-scalar (array or object), encode its numeric index. - buildParams( - prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", - v, - traditional, - add - ); - } - } ); - - } else if ( !traditional && toType( obj ) === "object" ) { - - // Serialize object item. - for ( name in obj ) { - buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); - } - - } else { - - // Serialize scalar item. - add( prefix, obj ); - } -} - -// Serialize an array of form elements or a set of -// key/values into a query string -jQuery.param = function( a, traditional ) { - var prefix, - s = [], - add = function( key, valueOrFunction ) { - - // If value is a function, invoke it and use its return value - var value = isFunction( valueOrFunction ) ? - valueOrFunction() : - valueOrFunction; - - s[ s.length ] = encodeURIComponent( key ) + "=" + - encodeURIComponent( value == null ? "" : value ); - }; - - if ( a == null ) { - return ""; - } - - // If an array was passed in, assume that it is an array of form elements. - if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { - - // Serialize the form elements - jQuery.each( a, function() { - add( this.name, this.value ); - } ); - - } else { - - // If traditional, encode the "old" way (the way 1.3.2 or older - // did it), otherwise encode params recursively. - for ( prefix in a ) { - buildParams( prefix, a[ prefix ], traditional, add ); - } - } - - // Return the resulting serialization - return s.join( "&" ); -}; - -jQuery.fn.extend( { - serialize: function() { - return jQuery.param( this.serializeArray() ); - }, - serializeArray: function() { - return this.map( function() { - - // Can add propHook for "elements" to filter or add form elements - var elements = jQuery.prop( this, "elements" ); - return elements ? jQuery.makeArray( elements ) : this; - } ) - .filter( function() { - var type = this.type; - - // Use .is( ":disabled" ) so that fieldset[disabled] works - return this.name && !jQuery( this ).is( ":disabled" ) && - rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && - ( this.checked || !rcheckableType.test( type ) ); - } ) - .map( function( i, elem ) { - var val = jQuery( this ).val(); - - if ( val == null ) { - return null; - } - - if ( Array.isArray( val ) ) { - return jQuery.map( val, function( val ) { - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ); - } - - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ).get(); - } -} ); - - -var - r20 = /%20/g, - rhash = /#.*$/, - rantiCache = /([?&])_=[^&]*/, - rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, - - // #7653, #8125, #8152: local protocol detection - rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, - rnoContent = /^(?:GET|HEAD)$/, - rprotocol = /^\/\//, - - /* Prefilters - * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) - * 2) These are called: - * - BEFORE asking for a transport - * - AFTER param serialization (s.data is a string if s.processData is true) - * 3) key is the dataType - * 4) the catchall symbol "*" can be used - * 5) execution will start with transport dataType and THEN continue down to "*" if needed - */ - prefilters = {}, - - /* Transports bindings - * 1) key is the dataType - * 2) the catchall symbol "*" can be used - * 3) selection will start with transport dataType and THEN go to "*" if needed - */ - transports = {}, - - // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression - allTypes = "*/".concat( "*" ), - - // Anchor tag for parsing the document origin - originAnchor = document.createElement( "a" ); - originAnchor.href = location.href; - -// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport -function addToPrefiltersOrTransports( structure ) { - - // dataTypeExpression is optional and defaults to "*" - return function( dataTypeExpression, func ) { - - if ( typeof dataTypeExpression !== "string" ) { - func = dataTypeExpression; - dataTypeExpression = "*"; - } - - var dataType, - i = 0, - dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; - - if ( isFunction( func ) ) { - - // For each dataType in the dataTypeExpression - while ( ( dataType = dataTypes[ i++ ] ) ) { - - // Prepend if requested - if ( dataType[ 0 ] === "+" ) { - dataType = dataType.slice( 1 ) || "*"; - ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); - - // Otherwise append - } else { - ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); - } - } - } - }; -} - -// Base inspection function for prefilters and transports -function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { - - var inspected = {}, - seekingTransport = ( structure === transports ); - - function inspect( dataType ) { - var selected; - inspected[ dataType ] = true; - jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { - var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); - if ( typeof dataTypeOrTransport === "string" && - !seekingTransport && !inspected[ dataTypeOrTransport ] ) { - - options.dataTypes.unshift( dataTypeOrTransport ); - inspect( dataTypeOrTransport ); - return false; - } else if ( seekingTransport ) { - return !( selected = dataTypeOrTransport ); - } - } ); - return selected; - } - - return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); -} - -// A special extend for ajax options -// that takes "flat" options (not to be deep extended) -// Fixes #9887 -function ajaxExtend( target, src ) { - var key, deep, - flatOptions = jQuery.ajaxSettings.flatOptions || {}; - - for ( key in src ) { - if ( src[ key ] !== undefined ) { - ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; - } - } - if ( deep ) { - jQuery.extend( true, target, deep ); - } - - return target; -} - -/* Handles responses to an ajax request: - * - finds the right dataType (mediates between content-type and expected dataType) - * - returns the corresponding response - */ -function ajaxHandleResponses( s, jqXHR, responses ) { - - var ct, type, finalDataType, firstDataType, - contents = s.contents, - dataTypes = s.dataTypes; - - // Remove auto dataType and get content-type in the process - while ( dataTypes[ 0 ] === "*" ) { - dataTypes.shift(); - if ( ct === undefined ) { - ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); - } - } - - // Check if we're dealing with a known content-type - if ( ct ) { - for ( type in contents ) { - if ( contents[ type ] && contents[ type ].test( ct ) ) { - dataTypes.unshift( type ); - break; - } - } - } - - // Check to see if we have a response for the expected dataType - if ( dataTypes[ 0 ] in responses ) { - finalDataType = dataTypes[ 0 ]; - } else { - - // Try convertible dataTypes - for ( type in responses ) { - if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { - finalDataType = type; - break; - } - if ( !firstDataType ) { - firstDataType = type; - } - } - - // Or just use first one - finalDataType = finalDataType || firstDataType; - } - - // If we found a dataType - // We add the dataType to the list if needed - // and return the corresponding response - if ( finalDataType ) { - if ( finalDataType !== dataTypes[ 0 ] ) { - dataTypes.unshift( finalDataType ); - } - return responses[ finalDataType ]; - } -} - -/* Chain conversions given the request and the original response - * Also sets the responseXXX fields on the jqXHR instance - */ -function ajaxConvert( s, response, jqXHR, isSuccess ) { - var conv2, current, conv, tmp, prev, - converters = {}, - - // Work with a copy of dataTypes in case we need to modify it for conversion - dataTypes = s.dataTypes.slice(); - - // Create converters map with lowercased keys - if ( dataTypes[ 1 ] ) { - for ( conv in s.converters ) { - converters[ conv.toLowerCase() ] = s.converters[ conv ]; - } - } - - current = dataTypes.shift(); - - // Convert to each sequential dataType - while ( current ) { - - if ( s.responseFields[ current ] ) { - jqXHR[ s.responseFields[ current ] ] = response; - } - - // Apply the dataFilter if provided - if ( !prev && isSuccess && s.dataFilter ) { - response = s.dataFilter( response, s.dataType ); - } - - prev = current; - current = dataTypes.shift(); - - if ( current ) { - - // There's only work to do if current dataType is non-auto - if ( current === "*" ) { - - current = prev; - - // Convert response if prev dataType is non-auto and differs from current - } else if ( prev !== "*" && prev !== current ) { - - // Seek a direct converter - conv = converters[ prev + " " + current ] || converters[ "* " + current ]; - - // If none found, seek a pair - if ( !conv ) { - for ( conv2 in converters ) { - - // If conv2 outputs current - tmp = conv2.split( " " ); - if ( tmp[ 1 ] === current ) { - - // If prev can be converted to accepted input - conv = converters[ prev + " " + tmp[ 0 ] ] || - converters[ "* " + tmp[ 0 ] ]; - if ( conv ) { - - // Condense equivalence converters - if ( conv === true ) { - conv = converters[ conv2 ]; - - // Otherwise, insert the intermediate dataType - } else if ( converters[ conv2 ] !== true ) { - current = tmp[ 0 ]; - dataTypes.unshift( tmp[ 1 ] ); - } - break; - } - } - } - } - - // Apply converter (if not an equivalence) - if ( conv !== true ) { - - // Unless errors are allowed to bubble, catch and return them - if ( conv && s.throws ) { - response = conv( response ); - } else { - try { - response = conv( response ); - } catch ( e ) { - return { - state: "parsererror", - error: conv ? e : "No conversion from " + prev + " to " + current - }; - } - } - } - } - } - } - - return { state: "success", data: response }; -} - -jQuery.extend( { - - // Counter for holding the number of active queries - active: 0, - - // Last-Modified header cache for next request - lastModified: {}, - etag: {}, - - ajaxSettings: { - url: location.href, - type: "GET", - isLocal: rlocalProtocol.test( location.protocol ), - global: true, - processData: true, - async: true, - contentType: "application/x-www-form-urlencoded; charset=UTF-8", - - /* - timeout: 0, - data: null, - dataType: null, - username: null, - password: null, - cache: null, - throws: false, - traditional: false, - headers: {}, - */ - - accepts: { - "*": allTypes, - text: "text/plain", - html: "text/html", - xml: "application/xml, text/xml", - json: "application/json, text/javascript" - }, - - contents: { - xml: /\bxml\b/, - html: /\bhtml/, - json: /\bjson\b/ - }, - - responseFields: { - xml: "responseXML", - text: "responseText", - json: "responseJSON" - }, - - // Data converters - // Keys separate source (or catchall "*") and destination types with a single space - converters: { - - // Convert anything to text - "* text": String, - - // Text to html (true = no transformation) - "text html": true, - - // Evaluate text as a json expression - "text json": JSON.parse, - - // Parse text as xml - "text xml": jQuery.parseXML - }, - - // For options that shouldn't be deep extended: - // you can add your own custom options here if - // and when you create one that shouldn't be - // deep extended (see ajaxExtend) - flatOptions: { - url: true, - context: true - } - }, - - // Creates a full fledged settings object into target - // with both ajaxSettings and settings fields. - // If target is omitted, writes into ajaxSettings. - ajaxSetup: function( target, settings ) { - return settings ? - - // Building a settings object - ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : - - // Extending ajaxSettings - ajaxExtend( jQuery.ajaxSettings, target ); - }, - - ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), - ajaxTransport: addToPrefiltersOrTransports( transports ), - - // Main method - ajax: function( url, options ) { - - // If url is an object, simulate pre-1.5 signature - if ( typeof url === "object" ) { - options = url; - url = undefined; - } - - // Force options to be an object - options = options || {}; - - var transport, - - // URL without anti-cache param - cacheURL, - - // Response headers - responseHeadersString, - responseHeaders, - - // timeout handle - timeoutTimer, - - // Url cleanup var - urlAnchor, - - // Request state (becomes false upon send and true upon completion) - completed, - - // To know if global events are to be dispatched - fireGlobals, - - // Loop variable - i, - - // uncached part of the url - uncached, - - // Create the final options object - s = jQuery.ajaxSetup( {}, options ), - - // Callbacks context - callbackContext = s.context || s, - - // Context for global events is callbackContext if it is a DOM node or jQuery collection - globalEventContext = s.context && - ( callbackContext.nodeType || callbackContext.jquery ) ? - jQuery( callbackContext ) : - jQuery.event, - - // Deferreds - deferred = jQuery.Deferred(), - completeDeferred = jQuery.Callbacks( "once memory" ), - - // Status-dependent callbacks - statusCode = s.statusCode || {}, - - // Headers (they are sent all at once) - requestHeaders = {}, - requestHeadersNames = {}, - - // Default abort message - strAbort = "canceled", - - // Fake xhr - jqXHR = { - readyState: 0, - - // Builds headers hashtable if needed - getResponseHeader: function( key ) { - var match; - if ( completed ) { - if ( !responseHeaders ) { - responseHeaders = {}; - while ( ( match = rheaders.exec( responseHeadersString ) ) ) { - responseHeaders[ match[ 1 ].toLowerCase() + " " ] = - ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) - .concat( match[ 2 ] ); - } - } - match = responseHeaders[ key.toLowerCase() + " " ]; - } - return match == null ? null : match.join( ", " ); - }, - - // Raw string - getAllResponseHeaders: function() { - return completed ? responseHeadersString : null; - }, - - // Caches the header - setRequestHeader: function( name, value ) { - if ( completed == null ) { - name = requestHeadersNames[ name.toLowerCase() ] = - requestHeadersNames[ name.toLowerCase() ] || name; - requestHeaders[ name ] = value; - } - return this; - }, - - // Overrides response content-type header - overrideMimeType: function( type ) { - if ( completed == null ) { - s.mimeType = type; - } - return this; - }, - - // Status-dependent callbacks - statusCode: function( map ) { - var code; - if ( map ) { - if ( completed ) { - - // Execute the appropriate callbacks - jqXHR.always( map[ jqXHR.status ] ); - } else { - - // Lazy-add the new callbacks in a way that preserves old ones - for ( code in map ) { - statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; - } - } - } - return this; - }, - - // Cancel the request - abort: function( statusText ) { - var finalText = statusText || strAbort; - if ( transport ) { - transport.abort( finalText ); - } - done( 0, finalText ); - return this; - } - }; - - // Attach deferreds - deferred.promise( jqXHR ); - - // Add protocol if not provided (prefilters might expect it) - // Handle falsy url in the settings object (#10093: consistency with old signature) - // We also use the url parameter if available - s.url = ( ( url || s.url || location.href ) + "" ) - .replace( rprotocol, location.protocol + "//" ); - - // Alias method option to type as per ticket #12004 - s.type = options.method || options.type || s.method || s.type; - - // Extract dataTypes list - s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; - - // A cross-domain request is in order when the origin doesn't match the current origin. - if ( s.crossDomain == null ) { - urlAnchor = document.createElement( "a" ); - - // Support: IE <=8 - 11, Edge 12 - 15 - // IE throws exception on accessing the href property if url is malformed, - // e.g. http://example.com:80x/ - try { - urlAnchor.href = s.url; - - // Support: IE <=8 - 11 only - // Anchor's host property isn't correctly set when s.url is relative - urlAnchor.href = urlAnchor.href; - s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== - urlAnchor.protocol + "//" + urlAnchor.host; - } catch ( e ) { - - // If there is an error parsing the URL, assume it is crossDomain, - // it can be rejected by the transport if it is invalid - s.crossDomain = true; - } - } - - // Convert data if not already a string - if ( s.data && s.processData && typeof s.data !== "string" ) { - s.data = jQuery.param( s.data, s.traditional ); - } - - // Apply prefilters - inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); - - // If request was aborted inside a prefilter, stop there - if ( completed ) { - return jqXHR; - } - - // We can fire global events as of now if asked to - // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) - fireGlobals = jQuery.event && s.global; - - // Watch for a new set of requests - if ( fireGlobals && jQuery.active++ === 0 ) { - jQuery.event.trigger( "ajaxStart" ); - } - - // Uppercase the type - s.type = s.type.toUpperCase(); - - // Determine if request has content - s.hasContent = !rnoContent.test( s.type ); - - // Save the URL in case we're toying with the If-Modified-Since - // and/or If-None-Match header later on - // Remove hash to simplify url manipulation - cacheURL = s.url.replace( rhash, "" ); - - // More options handling for requests with no content - if ( !s.hasContent ) { - - // Remember the hash so we can put it back - uncached = s.url.slice( cacheURL.length ); - - // If data is available and should be processed, append data to url - if ( s.data && ( s.processData || typeof s.data === "string" ) ) { - cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; - - // #9682: remove data so that it's not used in an eventual retry - delete s.data; - } - - // Add or update anti-cache param if needed - if ( s.cache === false ) { - cacheURL = cacheURL.replace( rantiCache, "$1" ); - uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; - } - - // Put hash and anti-cache on the URL that will be requested (gh-1732) - s.url = cacheURL + uncached; - - // Change '%20' to '+' if this is encoded form body content (gh-2658) - } else if ( s.data && s.processData && - ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { - s.data = s.data.replace( r20, "+" ); - } - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - if ( jQuery.lastModified[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); - } - if ( jQuery.etag[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); - } - } - - // Set the correct header, if data is being sent - if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { - jqXHR.setRequestHeader( "Content-Type", s.contentType ); - } - - // Set the Accepts header for the server, depending on the dataType - jqXHR.setRequestHeader( - "Accept", - s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? - s.accepts[ s.dataTypes[ 0 ] ] + - ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : - s.accepts[ "*" ] - ); - - // Check for headers option - for ( i in s.headers ) { - jqXHR.setRequestHeader( i, s.headers[ i ] ); - } - - // Allow custom headers/mimetypes and early abort - if ( s.beforeSend && - ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { - - // Abort if not done already and return - return jqXHR.abort(); - } - - // Aborting is no longer a cancellation - strAbort = "abort"; - - // Install callbacks on deferreds - completeDeferred.add( s.complete ); - jqXHR.done( s.success ); - jqXHR.fail( s.error ); - - // Get transport - transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); - - // If no transport, we auto-abort - if ( !transport ) { - done( -1, "No Transport" ); - } else { - jqXHR.readyState = 1; - - // Send global event - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); - } - - // If request was aborted inside ajaxSend, stop there - if ( completed ) { - return jqXHR; - } - - // Timeout - if ( s.async && s.timeout > 0 ) { - timeoutTimer = window.setTimeout( function() { - jqXHR.abort( "timeout" ); - }, s.timeout ); - } - - try { - completed = false; - transport.send( requestHeaders, done ); - } catch ( e ) { - - // Rethrow post-completion exceptions - if ( completed ) { - throw e; - } - - // Propagate others as results - done( -1, e ); - } - } - - // Callback for when everything is done - function done( status, nativeStatusText, responses, headers ) { - var isSuccess, success, error, response, modified, - statusText = nativeStatusText; - - // Ignore repeat invocations - if ( completed ) { - return; - } - - completed = true; - - // Clear timeout if it exists - if ( timeoutTimer ) { - window.clearTimeout( timeoutTimer ); - } - - // Dereference transport for early garbage collection - // (no matter how long the jqXHR object will be used) - transport = undefined; - - // Cache response headers - responseHeadersString = headers || ""; - - // Set readyState - jqXHR.readyState = status > 0 ? 4 : 0; - - // Determine if successful - isSuccess = status >= 200 && status < 300 || status === 304; - - // Get response data - if ( responses ) { - response = ajaxHandleResponses( s, jqXHR, responses ); - } - - // Convert no matter what (that way responseXXX fields are always set) - response = ajaxConvert( s, response, jqXHR, isSuccess ); - - // If successful, handle type chaining - if ( isSuccess ) { - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - modified = jqXHR.getResponseHeader( "Last-Modified" ); - if ( modified ) { - jQuery.lastModified[ cacheURL ] = modified; - } - modified = jqXHR.getResponseHeader( "etag" ); - if ( modified ) { - jQuery.etag[ cacheURL ] = modified; - } - } - - // if no content - if ( status === 204 || s.type === "HEAD" ) { - statusText = "nocontent"; - - // if not modified - } else if ( status === 304 ) { - statusText = "notmodified"; - - // If we have data, let's convert it - } else { - statusText = response.state; - success = response.data; - error = response.error; - isSuccess = !error; - } - } else { - - // Extract error from statusText and normalize for non-aborts - error = statusText; - if ( status || !statusText ) { - statusText = "error"; - if ( status < 0 ) { - status = 0; - } - } - } - - // Set data for the fake xhr object - jqXHR.status = status; - jqXHR.statusText = ( nativeStatusText || statusText ) + ""; - - // Success/Error - if ( isSuccess ) { - deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); - } else { - deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); - } - - // Status-dependent callbacks - jqXHR.statusCode( statusCode ); - statusCode = undefined; - - if ( fireGlobals ) { - globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", - [ jqXHR, s, isSuccess ? success : error ] ); - } - - // Complete - completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); - - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); - - // Handle the global AJAX counter - if ( !( --jQuery.active ) ) { - jQuery.event.trigger( "ajaxStop" ); - } - } - } - - return jqXHR; - }, - - getJSON: function( url, data, callback ) { - return jQuery.get( url, data, callback, "json" ); - }, - - getScript: function( url, callback ) { - return jQuery.get( url, undefined, callback, "script" ); - } -} ); - -jQuery.each( [ "get", "post" ], function( i, method ) { - jQuery[ method ] = function( url, data, callback, type ) { - - // Shift arguments if data argument was omitted - if ( isFunction( data ) ) { - type = type || callback; - callback = data; - data = undefined; - } - - // The url can be an options object (which then must have .url) - return jQuery.ajax( jQuery.extend( { - url: url, - type: method, - dataType: type, - data: data, - success: callback - }, jQuery.isPlainObject( url ) && url ) ); - }; -} ); - - -jQuery._evalUrl = function( url, options ) { - return jQuery.ajax( { - url: url, - - // Make this explicit, since user can override this through ajaxSetup (#11264) - type: "GET", - dataType: "script", - cache: true, - async: false, - global: false, - - // Only evaluate the response if it is successful (gh-4126) - // dataFilter is not invoked for failure responses, so using it instead - // of the default converter is kludgy but it works. - converters: { - "text script": function() {} - }, - dataFilter: function( response ) { - jQuery.globalEval( response, options ); - } - } ); -}; - - -jQuery.fn.extend( { - wrapAll: function( html ) { - var wrap; - - if ( this[ 0 ] ) { - if ( isFunction( html ) ) { - html = html.call( this[ 0 ] ); - } - - // The elements to wrap the target around - wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); - - if ( this[ 0 ].parentNode ) { - wrap.insertBefore( this[ 0 ] ); - } - - wrap.map( function() { - var elem = this; - - while ( elem.firstElementChild ) { - elem = elem.firstElementChild; - } - - return elem; - } ).append( this ); - } - - return this; - }, - - wrapInner: function( html ) { - if ( isFunction( html ) ) { - return this.each( function( i ) { - jQuery( this ).wrapInner( html.call( this, i ) ); - } ); - } - - return this.each( function() { - var self = jQuery( this ), - contents = self.contents(); - - if ( contents.length ) { - contents.wrapAll( html ); - - } else { - self.append( html ); - } - } ); - }, - - wrap: function( html ) { - var htmlIsFunction = isFunction( html ); - - return this.each( function( i ) { - jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); - } ); - }, - - unwrap: function( selector ) { - this.parent( selector ).not( "body" ).each( function() { - jQuery( this ).replaceWith( this.childNodes ); - } ); - return this; - } -} ); - - -jQuery.expr.pseudos.hidden = function( elem ) { - return !jQuery.expr.pseudos.visible( elem ); -}; -jQuery.expr.pseudos.visible = function( elem ) { - return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); -}; - - - - -jQuery.ajaxSettings.xhr = function() { - try { - return new window.XMLHttpRequest(); - } catch ( e ) {} -}; - -var xhrSuccessStatus = { - - // File protocol always yields status code 0, assume 200 - 0: 200, - - // Support: IE <=9 only - // #1450: sometimes IE returns 1223 when it should be 204 - 1223: 204 - }, - xhrSupported = jQuery.ajaxSettings.xhr(); - -support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); -support.ajax = xhrSupported = !!xhrSupported; - -jQuery.ajaxTransport( function( options ) { - var callback, errorCallback; - - // Cross domain only allowed if supported through XMLHttpRequest - if ( support.cors || xhrSupported && !options.crossDomain ) { - return { - send: function( headers, complete ) { - var i, - xhr = options.xhr(); - - xhr.open( - options.type, - options.url, - options.async, - options.username, - options.password - ); - - // Apply custom fields if provided - if ( options.xhrFields ) { - for ( i in options.xhrFields ) { - xhr[ i ] = options.xhrFields[ i ]; - } - } - - // Override mime type if needed - if ( options.mimeType && xhr.overrideMimeType ) { - xhr.overrideMimeType( options.mimeType ); - } - - // X-Requested-With header - // For cross-domain requests, seeing as conditions for a preflight are - // akin to a jigsaw puzzle, we simply never set it to be sure. - // (it can always be set on a per-request basis or even using ajaxSetup) - // For same-domain requests, won't change header if already provided. - if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { - headers[ "X-Requested-With" ] = "XMLHttpRequest"; - } - - // Set headers - for ( i in headers ) { - xhr.setRequestHeader( i, headers[ i ] ); - } - - // Callback - callback = function( type ) { - return function() { - if ( callback ) { - callback = errorCallback = xhr.onload = - xhr.onerror = xhr.onabort = xhr.ontimeout = - xhr.onreadystatechange = null; - - if ( type === "abort" ) { - xhr.abort(); - } else if ( type === "error" ) { - - // Support: IE <=9 only - // On a manual native abort, IE9 throws - // errors on any property access that is not readyState - if ( typeof xhr.status !== "number" ) { - complete( 0, "error" ); - } else { - complete( - - // File: protocol always yields status 0; see #8605, #14207 - xhr.status, - xhr.statusText - ); - } - } else { - complete( - xhrSuccessStatus[ xhr.status ] || xhr.status, - xhr.statusText, - - // Support: IE <=9 only - // IE9 has no XHR2 but throws on binary (trac-11426) - // For XHR2 non-text, let the caller handle it (gh-2498) - ( xhr.responseType || "text" ) !== "text" || - typeof xhr.responseText !== "string" ? - { binary: xhr.response } : - { text: xhr.responseText }, - xhr.getAllResponseHeaders() - ); - } - } - }; - }; - - // Listen to events - xhr.onload = callback(); - errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); - - // Support: IE 9 only - // Use onreadystatechange to replace onabort - // to handle uncaught aborts - if ( xhr.onabort !== undefined ) { - xhr.onabort = errorCallback; - } else { - xhr.onreadystatechange = function() { - - // Check readyState before timeout as it changes - if ( xhr.readyState === 4 ) { - - // Allow onerror to be called first, - // but that will not handle a native abort - // Also, save errorCallback to a variable - // as xhr.onerror cannot be accessed - window.setTimeout( function() { - if ( callback ) { - errorCallback(); - } - } ); - } - }; - } - - // Create the abort callback - callback = callback( "abort" ); - - try { - - // Do send the request (this may raise an exception) - xhr.send( options.hasContent && options.data || null ); - } catch ( e ) { - - // #14683: Only rethrow if this hasn't been notified as an error yet - if ( callback ) { - throw e; - } - } - }, - - abort: function() { - if ( callback ) { - callback(); - } - } - }; - } -} ); - - - - -// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) -jQuery.ajaxPrefilter( function( s ) { - if ( s.crossDomain ) { - s.contents.script = false; - } -} ); - -// Install script dataType -jQuery.ajaxSetup( { - accepts: { - script: "text/javascript, application/javascript, " + - "application/ecmascript, application/x-ecmascript" - }, - contents: { - script: /\b(?:java|ecma)script\b/ - }, - converters: { - "text script": function( text ) { - jQuery.globalEval( text ); - return text; - } - } -} ); - -// Handle cache's special case and crossDomain -jQuery.ajaxPrefilter( "script", function( s ) { - if ( s.cache === undefined ) { - s.cache = false; - } - if ( s.crossDomain ) { - s.type = "GET"; - } -} ); - -// Bind script tag hack transport -jQuery.ajaxTransport( "script", function( s ) { - - // This transport only deals with cross domain or forced-by-attrs requests - if ( s.crossDomain || s.scriptAttrs ) { - var script, callback; - return { - send: function( _, complete ) { - script = jQuery( " - - - - - - - - - - - - -
-

Navigation

- -
- -
-
-
-
- - -

Index

- -
- A - | B - | D - | E - | G - | L - | M - | N - | O - | P - | R - | S - | T - | Z - -
-

A

- - - -
- -

B

- - -
- -

D

- - - -
- -

E

- - -
- -

G

- - -
- -

L

- - - -
- -

M

- - - -
- -

N

- - - -
- -

O

- - - -
- -

P

- - -
- -

R

- - -
- -

S

- - - -
- -

T

- - - -
- -

Z

- - -
- - - -
-
-
-
-
- - -
-
-
-
-
-

Navigation

- -
-
- © Copyright 2009-2020, Simon Kennedy. - Created using Sphinx 3.0.3. -
- - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 81fdeb5..0000000 --- a/docs/index.html +++ /dev/null @@ -1,831 +0,0 @@ - - - - - - - - - - - - Astral v2.2 — Astral 2.2 documentation - - - - - - - - - - - - - - - - - - - -
-

Navigation

- -
- -
-
-
-
- -
-

Astral v2.2

-
-
travis_status pypi_ver
-
-

Astral is a python package for calculating the times of various aspects of -the sun and phases of the moon.

-

It can calculate the following

-
-
Dawn

The time in the morning when the sun is a specific number of degrees -below the horizon.

-
-
Sunrise

The time in the morning when the top of the sun breaks the horizon -(asuming a location with no obscuring features.)

-
-
Noon

The time when the sun is at its highest point directly above the observer.

-
-
Midnight

The time when the sun is at its lowest point.

-
-
Sunset

The time in the evening when the sun is about to disappear below the -horizon (asuming a location with no obscuring features.)

-
-
Dusk

The time in the evening when the sun is a specific number of degrees -below the horizon.

-
-
Daylight

The time when the sun is up i.e. between sunrise and sunset

-
-
Night

The time between astronomical dusk of one day and astronomical dawn of the -next

-
-
Twilight

The time between dawn and sunrise or between sunset and dusk

-
-
The Golden Hour

The time when the sun is between 4 degrees below the horizon and 6 degrees -above.

-
-
The Blue Hour

The time when the sun is between 6 and 4 degrees below the horizon.

-
-
Time At Elevation

the time when the sun is at a specific elevation for either a rising or a -setting sun.

-
-
Solar Azimuth

The number of degrees clockwise from North at which the sun can be seen

-
-
Solar Zenith

The angle of the sun down from directly above the observer

-
-
Solar Elevation

The number of degrees up from the horizon at which the sun can be seen

-
-
Rahukaalam

“Rahukaalam or the period of Rahu is a certain amount of time every day -that is considered inauspicious for any new venture according to Indian -Vedic astrology”.

-
-
Moon Phase

The phase of the moon for a specified date.

-
-
-

Astral also comes with a geocoder containing a local database that allows you -to look up information for a small set of locations (new locations can be -added).

-
-

Note

-

The Google Geocoder has been removed. Instead you should use the -Google Client for Google Maps Services -https://github.com/googlemaps/google-maps-services-python

-
-
-
-

Examples

-

The following examples demonstrates some of the functionality available in the -module

-
-

Sun

-
>>> from astral import LocationInfo
->>> city = LocationInfo("London", "England", "Europe/London", 51.5, -0.116)
->>> print((
-    f"Information for {city.name}/{city.region}\n"
-    f"Timezone: {city.timezone}\n"
-    f"Latitude: {city.latitude:.02f}; Longitude: {city.longitude:.02f}\n"
-))
-
-Information for London/England
-Timezone: Europe/London
-Latitude: 51.50; Longitude: -0.12
-
->>> import datetime
->>> from astral.sun import sun
->>> s = sun(city.observer, date=datetime.date(2009, 4, 22))
->>> print((
-    f'Dawn:    {s["dawn"]}\n'
-    f'Sunrise: {s["sunrise"]}\n'
-    f'Noon:    {s["noon"]}\n'
-    f'Sunset:  {s["sunset"]}\n'
-    f'Dusk:    {s["dusk"]}\n'
-))
-Dawn:    2009-04-22 04:13:04.923309+00:00
-Sunrise: 2009-04-22 04:50:16.515411+00:00
-Noon:    2009-04-22 11:59:02+00:00
-Sunset:  2009-04-22 19:08:41.215821+00:00
-Dusk:    2009-04-22 19:46:06.362457+00:00
-
-
-
-

Note

-

The example above calculates the times of the sun in the UTC timezone. -If you want to return times in a different timezone you can pass the -tzinfo parameter to the function.

-
s = sun(city.observer, date=datetime.date(2009, 4, 22), tzinfo=city.timezone)
-
-
-

In versions prior to 2.2 you’ll need to pass a pytz timezone as tzinfo e.g.

-
s = sun(city.observer,
-        date=datetime.date(2009, 4, 22),
-        tzinfo=pytz.timezone(city.timezone))
-
-
-
-
-
-

Moon

-
>>> import datetime
->>> from astral import moon
->>> moon.phase(datetime.date(2018, 1, 1))
-13.255666666666668
-
-
-

The moon phase method returns an number describing the phase, where the value -is between 0 and 27.99. The following lists the mapping of various values to -the description of the phase of the moon.

- ---- - - - - - - - - - - - - - - -

0 .. 6.99

New moon

7 .. 13.99

First quarter

14 .. 20.99

Full moon

21 .. 27.99

Last quarter

-

If for example the number returned was 27.99 then the moon would be almost at -the New Moon phase, and if it was 24.00 it would be half way between the Last -Quarter and a New Moon.

-
-

Note

-

The moon phase does not depend on your location. However what the moon -actually looks like to you does depend on your location. If you’re in the -southern hemisphere it looks different than if you were in the northern -hemisphere.

-

See http://moongazer.x10.mx/website/astronomy/moon-phases/ for an example.

-

For an example of using this library to generate moon phases including the -names in various languages and the correct Unicode glyphs see the -project by PanderMusubi -on Github.

-
-
-
-

Geocoder

-
>>> from astral.geocoder import database, lookup
->>> lookup("London", database())
-LocationInfo(name='London', region='England', timezone='Europe/London',
-    latitude=51.473333333333336, longitude=-0.0008333333333333334)
-
-
-
-

Note

-

Location elevations have been removed from the database. These were added -due to a misunderstanding of the affect of elevation on the times of the -sun. These are not required for the calculations, only the elevation of the -observer above/below the location is needed.

-

See Effect of Elevation below.

-
-
-

Custom Location

-

If you only need a single location that is not in the database then you can -construct a LocationInfo and fill in the values, either on -initialization

-
from astral import LocationInfo
-l = LocationInfo('name', 'region', 'timezone/name', 0.1, 1.2)
-
-
-

or set the attributes after initialization:

-
from astral import LocationInfo
-l = LocationInfo()
-l.name = 'name'
-l.region = 'region'
-l.timezone = 'US/Central'
-l.latitude = 0.1
-l.longitude = 1.2
-
-
-
-

Note

-

name and region can be anything you like.

-
-
-
-

Additional Locations

-

You can add to the list of available locations using the -add_locations() function and passing either a string -with one line per location or by passing a list containing strings, lists or -tuples (lists and tuples are passed directly to the LocationInfo constructor).

-
>>> from astral.geocoder import add_locations, database, lookup
->>> db = database()
->>> try:
-...     lookup("Somewhere", db)
-... except KeyError:
-...     print("Somewhere not found")
-...
-Somewhere not found
->>> add_locations("Somewhere,Secret Location,UTC,24°28'N,39°36'E", db)
->>> lookup("Somewhere", db)
-LocationInfo(name='Somewhere', region='Secret Location', timezone='UTC',
-    latitude=24.466666666666665, longitude=39.6)
-
-
-
-
-

Timezone Groups

-

Timezone groups such as Europe can be accessed via the group() function -in the geocoder module

-
>>> from astral.geocoder import group
->>> europe = group("europe")
->>> sorted(europe.keys())
-['aberdeen', 'amsterdam', 'andorra_la_vella', 'ankara', 'athens', ...]
-
-
-
-
-
-
-

Effect of Elevation

-
-

Times Of The Sun

-

The times of the sun that you experience depend on what obscurs your view of -it. It may either be obscured by the horizon or some other geographical -feature (e.g. mountains)

-
    -

  1. If what obscures you at ground level is the horizon and you are at a -elevation above ground level then the times of the sun depends on how far -further round the earth you can see due to your elevation (the sun rises -earlier and sets later).

    -

    The extra angle you can see round the earth is determined by calculating the -angle α in the image below based on your elevation above ground level, -and adding this to the depression angle for the sun calculations.

    -_images/elevation_horizon.svg
    2. -

  2. If your view is obscured by some other geographical feature than the -horizon, then the adjustment angle is based on how far you are above or -below the feature and your distance to it.

    3. -
-

For the first case i.e. obscured by the horizon you need to pass a single float -to the Observer as its elevation. For the second case pass a tuple of 2 -floats. The first being the vertical distance to the top of the feature and -the second the horizontal distance to the feature.

-
-
-

Elevation Of The Sun

-

Even though an observer’s elevation can significantly affect the times of the -sun the same is not true for the elevation angle from the observer to the sun.

-

As an example the diagram below shows the difference in angle between an -observer at ground level and one on the ISS orbiting 408 km above the earth.

-_images/elevation_sun.svg

The largest difference between the two angles is when the angle at ground -level is 1 degree. The difference then is approximately 0.15 degrees.

-

At the summit of mount Everest (8,848 m) the maximum difference is -0.00338821 degrees.

-

Due to the very small difference the astral package does not currently adjust -the solar elevation for changes in observer elevation.

-
-
-
-

Effect of Refraction

-

When viewing the sun the position you see it at is different from its actual -position due to the effect of atmospheric refraction which -makes the sun appear to be higher in the sky. The calculations in the -package take this refraction into account.

-

The sunrise() and sunset() functions -use the refraction at an angle when the sun is half of its apparent diameter -below the horizon. This is between about 30 and 32 arcminutes and for the -astral package a value of 32” is used.

-
-

Note

-

The refraction calculation does not take into account -temperature and pressure which can affect the angle of refraction.

-
-
-
-

Note on Localized Timezones

-

When creating a datetime object in a specific timezone do not use the -tzinfo parameter to the datetime constructor. Instead use the -localize() method provided by pytz on the correct pytz -timezone:

-
>>> dt = datetime.datetime(2015, 1, 1, 9, 0, 0)
->>> pytz.timezone('Europe/London').localize(dt)
-datetime.datetime(2015, 1, 1, 9, 0, tzinfo=<DstTzInfo 'Europe/London' GMT0:00:00 STD>)
-
-
-
-
-

License

-

This module is licensed under the terms of the Apache V2.0 license.

-
-
-

Dependencies

-

Astral has one required external Python dependency on pytz.

-
-
-

Installation

-

To install Astral you should use the pip tool:

-
pip3 install astral
-
-
-
-

Note

-

Now that we are Python 3 only and pip provides a versioned executable on -Windows you should use the pip3 command on all operating systems -to ensure you are targetting the right Python version.

-
-
-
-

Cities

-

The module includes location and time zone data for the following cities. -The list includes all capital cities plus some from the UK. The list also -includes the US state capitals and some other US cities.

-

Aberdeen, Abu Dhabi, Abu Dhabi, Abuja, Accra, Addis Ababa, Adelaide, Al Jubail, -Albany, Albuquerque, Algiers, Amman, Amsterdam, Anchorage, Andorra la Vella, -Ankara, Annapolis, Antananarivo, Apia, Ashgabat, Asmara, Astana, Asuncion, -Athens, Atlanta, Augusta, Austin, Avarua, Baghdad, Baku, Baltimore, Bamako, -Bandar Seri Begawan, Bangkok, Bangui, Banjul, Barrow-In-Furness, Basse-Terre, -Basseterre, Baton Rouge, Beijing, Beirut, Belfast, Belgrade, Belmopan, Berlin, -Bern, Billings, Birmingham, Birmingham, Bishkek, Bismarck, Bissau, -Bloemfontein, Bogota, Boise, Bolton, Boston, Bradford, Brasilia, Bratislava, -Brazzaville, Bridgeport, Bridgetown, Brisbane, Bristol, Brussels, Bucharest, -Bucuresti, Budapest, Buenos Aires, Buffalo, Bujumbura, Burlington, Cairo, -Canberra, Cape Town, Caracas, Cardiff, Carson City, Castries, Cayenne, -Charleston, Charlotte, Charlotte Amalie, Cheyenne, Chicago, Chisinau, -Cleveland, Columbia, Columbus, Conakry, Concord, Copenhagen, Cotonou, Crawley, -Dakar, Dallas, Damascus, Dammam, Denver, Des Moines, Detroit, Dhaka, Dili, -Djibouti, Dodoma, Doha, Douglas, Dover, Dublin, Dushanbe, Edinburgh, El Aaiun, -Fargo, Fort-de-France, Frankfort, Freetown, Funafuti, Gaborone, George Town, -Georgetown, Gibraltar, Glasgow, Greenwich, Guatemala, Hanoi, Harare, -Harrisburg, Hartford, Havana, Helena, Helsinki, Hobart, Hong Kong, Honiara, -Honolulu, Houston, Indianapolis, Islamabad, Jackson, Jacksonville, Jakarta, -Jefferson City, Jerusalem, Juba, Jubail, Juneau, Kabul, Kampala, Kansas City, -Kathmandu, Khartoum, Kiev, Kigali, Kingston, Kingston, Kingstown, Kinshasa, -Koror, Kuala Lumpur, Kuwait, La Paz, Lansing, Las Vegas, Leeds, Leicester, -Libreville, Lilongwe, Lima, Lincoln, Lisbon, Little Rock, Liverpool, Ljubljana, -Lome, London, Los Angeles, Louisville, Luanda, Lusaka, Luxembourg, Macau, -Madinah, Madison, Madrid, Majuro, Makkah, Malabo, Male, Mamoudzou, Managua, -Manama, Manchester, Manchester, Manila, Maputo, Maseru, Masqat, Mbabane, Mecca, -Medina, Melbourne, Memphis, Mexico, Miami, Milwaukee, Minneapolis, Minsk, -Mogadishu, Monaco, Monrovia, Montevideo, Montgomery, Montpelier, Moroni, -Moscow, Moskva, Mumbai, Muscat, N’Djamena, Nairobi, Nashville, Nassau, -Naypyidaw, New Delhi, New Orleans, New York, Newark, Newcastle, Newcastle Upon -Tyne, Ngerulmud, Niamey, Nicosia, Norwich, Nouakchott, Noumea, Nuku’alofa, -Nuuk, Oklahoma City, Olympia, Omaha, Oranjestad, Orlando, Oslo, Ottawa, -Ouagadougou, Oxford, P’yongyang, Pago Pago, Palikir, Panama, Papeete, -Paramaribo, Paris, Perth, Philadelphia, Phnom Penh, Phoenix, Pierre, Plymouth, -Podgorica, Port Louis, Port Moresby, Port of Spain, Port-Vila, Port-au-Prince, -Portland, Portland, Porto-Novo, Portsmouth, Prague, Praia, Pretoria, Pristina, -Providence, Quito, Rabat, Raleigh, Reading, Reykjavik, Richmond, Riga, Riyadh, -Road Town, Rome, Roseau, Sacramento, Saint Helier, Saint Paul, Saint Pierre, -Saipan, Salem, Salt Lake City, San Diego, San Francisco, San Jose, San Juan, -San Marino, San Salvador, Sana, Sana’a, Santa Fe, Santiago, Santo Domingo, Sao -Tome, Sarajevo, Seattle, Seoul, Sheffield, Singapore, Sioux Falls, Skopje, -Sofia, Southampton, Springfield, Sri Jayawardenapura Kotte, St. George’s, St. -John’s, St. Peter Port, Stanley, Stockholm, Sucre, Suva, Swansea, Swindon, -Sydney, T’bilisi, Taipei, Tallahassee, Tallinn, Tarawa, Tashkent, Tbilisi, -Tegucigalpa, Tehran, Thimphu, Tirana, Tirane, Tokyo, Toledo, Topeka, Torshavn, -Trenton, Tripoli, Tunis, Ulaanbaatar, Ulan Bator, Vaduz, Valletta, Vienna, -Vientiane, Vilnius, Virginia Beach, W. Indies, Warsaw, Washington DC, -Wellington, Wichita, Willemstad, Wilmington, Windhoek, Wolverhampton, -Yamoussoukro, Yangon, Yaounde, Yaren, Yerevan, Zagreb

-
-

US Cities

-

Albany, Albuquerque, Anchorage, Annapolis, Atlanta, Augusta, Austin, Baltimore, -Baton Rouge, Billings, Birmingham, Bismarck, Boise, Boston, Bridgeport, -Buffalo, Burlington, Carson City, Charleston, Charlotte, Cheyenne, Chicago, -Cleveland, Columbia, Columbus, Concord, Dallas, Denver, Des Moines, Detroit, -Dover, Fargo, Frankfort, Harrisburg, Hartford, Helena, Honolulu, Houston, -Indianapolis, Jackson, Jacksonville, Jefferson City, Juneau, Kansas City, -Lansing, Las Vegas, Lincoln, Little Rock, Los Angeles, Louisville, Madison, -Manchester, Memphis, Miami, Milwaukee, Minneapolis, Montgomery, Montpelier, -Nashville, New Orleans, New York, Newark, Oklahoma City, Olympia, Omaha, -Orlando, Philadelphia, Phoenix, Pierre, Portland, Portland, Providence, -Raleigh, Richmond, Sacramento, Saint Paul, Salem, Salt Lake City, San Diego, -San Francisco, Santa Fe, Seattle, Sioux Falls, Springfield, Tallahassee, -Toledo, Topeka, Trenton, Virginia Beach, Wichita, Wilmington

-
-
-
-

Thanks

-

The sun calculations in this module were adapted, for Python, from the -spreadsheets on the following page.

-
-
-

Refraction calculation is taken from

-
-
-
Sun-Pointing Programs and Their Accuracy
-
John C. Zimmerman Of Sandia National Laboratones
-
https://www.osti.gov/servlets/purl/6377969
-
-
-

Which cites the following as the original source

-
-
-
In Solar Energy Vol 20 No.5-C
-
Robert Walraven Of The University Of California, Davis
-
-
-

The moon phase calculation is based on some javascript code -from Sky and Telescope magazine

-
-
-
Moon-phase calculation
-
Roger W. Sinnott, Sky & Telescope, June 16, 2006.
-
http://www.skyandtelescope.com/wp-content/observing-tools/moonphase/moon.html
-
-
-

Also to Sphinx for making doc generation an easy thing (not that the writing -of the docs is any easier.)

-
-
-

Contact

-

Simon Kennedy <sffjunkie+code@gmail.com>

-
-
-

Version History

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Version

Description

2.2

Fix for bug #48 - As per the bug report the angle to adjust for -the effect of elevation should have been θ (not α).

-

The sun functions can now also be passed a timezone name as a -string. Previously only a pytz timezone was accepted.

-

2.1

Fix for bug #44 - Incorrectly raised exception when UTC sun times -were on the day previous to the day asked for. Only manifested for -timezones with a large positive offset.

2.0

This is a code refactor as well as an update so it is highly likely -that you will need to adapt your code to suit.

-

Astral, AstralGeocoder & GoogleGeocoder classes removed

-

Now only compatible with Python 3.6 and greater due to the -use of data classes

-

New Observer data class to store a latitude, -longitude & elevation

-

New LocationInfo data class to store a location -name, region, timezone, latitude & longitude

-

Geocoder functions return a LocationInfo instead -of a Location

-

All calculations now automatically adjust for refraction. -For elevation you can return the true angle by setting the -with_refraction parameter to False.

-

The solar_noon and solar_midnight functions have been renamed to -noon() and midnight() -respectively.

-

Rahukaalam can now be calculated for night times.

-

1.10.1

Keyword args are now passed to the geocoder class from Astral -__init__ in order to allow the Google Maps API key to be passed to -the GoogleGeocoder.

1.10

Added support to AstralGeocoder to add -additional locations -to the database.

1.9.2

1.9 broke the sun_utc method. Sun UTC calculation passed incorrect -parameter to more specific methods e.g. sunrise, sunset etc.

1.9.1

Correct version number in astral.py

1.9

Now takes elevation into account.

1.8

Location methods now allow the timezone to be None which returns all -times as UTC.

-

Added command line interface to return ‘sun’ values

-

1.7.1

Changed GoogleGeocoder test to not use raise…from as this is not -valid for Python 2

1.7

Requests is now only needed when using GoogleGeocoder

-

GoogleGeocoder now requires the api_key parameter to be passed to -the constructor as Google now require it for their API calls.

-

1.6.1

Updates for Travis CI integration / Github signed release.

1.6

Added api_key parameter to the GoogleGeocoder __init__() -method

1.5

Added parameter rtype to moon_phase() to determine the -return type of the method.

-

Added example for calculating the phase of the moon.

-

1.4.1

Using versioneer to manage version numbers

1.4

Changed to use calculations from NOAA spreadsheets

-

Changed some exception error messages for when sun does not reach -a requested elevation.

-

Added more tests

-

1.3.4

Changes to project configuration files. No user facing changes.

1.3.3

Fixed call to twilight_utc as date and direction parameters -were reversed.

1.3.2

Updated URL to point to gitgub.com

-

Added Apache 2.0 boilerplate to source file

-

1.3.1

Added LICENSE file to sdist

1.3

Corrected solar zenith to return the angle from the vertical.

-

Added solar midnight calculation.

-

1.2

Added handling for when unicode literals are used. This may possibly -affect your code if you’re using Python 2 (there are tests for this -but they may not catch all uses.) (Bug 1588198)

-

Changed timezone for Phoenix, AZ to America/Phoenix -(Bug 1561258)

-

1.1

Added methods to calculate Twilight, the Golden Hour and the Blue -Hour.

1.0

It’s time for a version 1.0

-

Added examples where the location you want is not in the Astral -geocoder.

-

0.9

Added a method to calculate the date and time when the sun is at a -specific elevation, for either a rising or a setting sun.

-

Added daylight and night methods to Location and Astral classes.

-

Rahukaalam methods now return a tuple.

-

0.8.2

Fix for moon phase calcualtions which were off by 1.

-

Use pytz.timezone().localize method instead of passing tzinfo -parameter to datetime.datetime. See the pytz docs for info

-

0.8.1

Fix for bug 1417641: solar_elevation() and -solar_azimuth() fail when a naive -datetime object is used.

-

Added solar_zenith() methods to Astral -and Location as an -alias for solar_elevation()

-

Added tzinfo as an alias for tz

-

0.8

Fix for bug 1407773: Moon phase calculation changed to remove -time zone parameter (tz) as it is not required for the calculation.

0.7.5

Fix for bug 1402103: Buenos Aires incorrect timezone

0.7.4

Added Canadian cities from Yip Shing Ho

0.7.3

Fix for bug 1239387 submitted by Torbjörn Lönnemark

0.7.2

Minor bug fix in GoogleGeocoder. location name and -region are now stripped of whitespace

0.7.1

Bug fix. Missed a vital return statement in the -GoogleGeocoder

0.7

Added ability to lookup location information from -Google’s mapping APIs (see GoogleGeocoder)

-

Renamed City class to Location

-

Renamed CityDB to AstralGeocoder

-

Added elevations of cities to database and property to -obtain elevation from Location class

-

0.6.2

Added various cities to database as per -https://bugs.launchpad.net/astral/+bug/1040936

0.6.1

Docstrings were not updated to match changes to code.

-

Other minor docstring changes made

-

0.6

Fix for bug 884716 submitted by Martin Heemskerk -regarding moon phase calculations

-

Fixes for bug report 944754 submitted by Hajo Werder

-
    -

  • Changed co-ordinate system so that eastern longitudes -are now positive

    • -

  • Added solar_depression property to City class

    • -
-

0.5

Changed City to accept unicode name and country.

-

Moved city information into a database class CityDB

-

Added attribute access to database for timezone groups

-

0.4

Duplicate city names could not be accessed.

-

Sun calculations for some cities failed with times -outside valid ranges.

-

Fixes for city data.

-

Added calculation for moon phase.

-

0.3

Changed to Apache V2.0 license.

-

Fix for bug 555508 submitted by me.

-

US state capitals and other cities added.

-

0.2

Fix for bug 554041 submitted by Derek_ / John Dimatos

0.1

First release

-
-
-
- - -
-
-
-
-
-

Table Of Contents

- - -

Next topic

-

The astral Package

-
-

This Page

- -
- - -
-
-
-
-
-

Navigation

- -
-
- © Copyright 2009-2020, Simon Kennedy. - Created using Sphinx 3.0.3. -
- - diff --git a/docs/objects.inv b/docs/objects.inv deleted file mode 100644 index a6be5ad..0000000 Binary files a/docs/objects.inv and /dev/null differ diff --git a/docs/package.html b/docs/package.html deleted file mode 100644 index 6d6d338..0000000 --- a/docs/package.html +++ /dev/null @@ -1,1265 +0,0 @@ - - - - - - - - - - - - The astral Package — Astral 2.2 documentation - - - - - - - - - - - - - - - - - - - -
-

Navigation

- -
- -
-
-
-
- -
-

The astral Package

-

Calculations for the position of the sun and moon.

-

The astral package provides the means to calculate the following times of the sun

-
    -

  • dawn

    • -

  • sunrise

    • -

  • noon

    • -

  • midnight

    • -

  • sunset

    • -

  • dusk

    • -

  • daylight

    • -

  • night

    • -

  • twilight

    • -

  • blue hour

    • -

  • golden hour

    • -

  • rahukaalam

    • -
-

plus solar azimuth and elevation at a specific latitude/longitude. -It can also calculate the moon phase for a specific date.

-

The package also provides a self contained geocoder to turn a small set of -location names into timezone, latitude and longitude. The lookups -can be perfomed using the lookup() function defined in -astral.geocoder

-
-

Note

-

The Astral and GoogleGeocoder classes from earlier versions have been -removed.

-
-
-
-class astral.Depression
-

The depression angle in degrees for the dawn/dusk calculations

-
- -
-
-class astral.SunDirection
-

Direction of the sun either RISING or SETTING

-
- -
-
-class astral.Observer(latitude: float = 51.4733, longitude: float = - 0.0008333, elevation: Union[float, Tuple[float, float]] = 0.0)
-

Defines the location of an observer on Earth.

-

Latitude and longitude can be set either as a float or as a string. -For strings they must be of the form

-
-

degrees°minutes’seconds”[N|S|E|W] e.g. 51°31’N

-
-

minutes’ & seconds” are optional.

-

Elevations are either

-
    -

  • A float that is the elevation in metres above a location, if the nearest -obscuring feature is the horizon

    • -

  • or a tuple of the elevation in metres and the distance in metres to the -nearest obscuring feature.

    • -
-
-
Parameters
-
    -

  • latitude – Latitude - Northern latitudes should be positive

    • -

  • longitude – Longitude - Eastern longitudes should be positive

    • -

  • elevation – Elevation and/or distance to nearest obscuring feature -in metres above/below the location.

    • -
-
-
-
- -
-
-class astral.LocationInfo(name: str = 'Greenwich', region: str = 'England', timezone: str = 'Europe/London', latitude: float = 51.4733, longitude: float = - 0.0008333)
-

Defines a location on Earth.

-

Latitude and longitude can be set either as a float or as a string. For strings they must -be of the form

-
-

degrees°minutes’seconds”[N|S|E|W] e.g. 51°31’N

-
-

minutes’ & seconds” are optional.

-
-
Parameters
-
    -

  • name – Location name (can be any string)

    • -

  • region – Region location is in (can be any string)

    • -

  • timezone – The location’s time zone (a list of time zone names can be obtained from -pytz.all_timezones)

    • -

  • latitude – Latitude - Northern latitudes should be positive

    • -

  • longitude – Longitude - Eastern longitudes should be positive

    • -
-
-
-
-
-property observer
-

Return an Observer at this location

-
- -
-
-property tzinfo
-

Return a pytz timezone for this location

-
- -
- -
-
-astral.now(tzinfo: datetime.tzinfo = <UTC>) → datetime.datetime
-

Returns the current time in the specified time zone

-
- -
-
-astral.today(tzinfo: datetime.tzinfo = <UTC>) → datetime.date
-

Returns the current date in the specified time zone

-
- -
-
-astral.dms_to_float(dms: Union[str, float, Tuple[float, float]], limit: Optional[float] = None) → float
-

Converts as string of the form degrees°minutes’seconds”[N|S|E|W], -or a float encoded as a string, to a float

-

N and E return positive values -S and W return negative values

-
-
Parameters
-
    -

  • dms – string to convert

    • -

  • limit – Limit the value between ± limit

    • -
-
-
Returns
-

The number of degrees as a float

-
-
-
- -
-

astral.sun

-
-
-astral.sun.sun(observer: astral.Observer, date: Optional[datetime.date] = None, dawn_dusk_depression: Union[float, astral.Depression] = <Depression.CIVIL: 6.0>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Dict
-

Calculate all the info for the sun at once.

-
-
Parameters
-
    -

  • observer – Observer for which to calculate the times of the sun

    • -

  • date – Date to calculate for. -Default is today’s date in the timezone tzinfo.

    • -

  • dawn_dusk_depression – Depression to use to calculate dawn and dusk. -Default is for Civil dusk i.e. 6.0

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Dictionary with keys dawn, sunrise, noon, sunset and dusk -whose values are the results of the corresponding functions.

-
-
Raises
-

ValueError – if passed through from any of the functions

-
-
-
- -
-
-astral.sun.dawn(observer: astral.Observer, date: Optional[datetime.date] = None, depression: Union[float, astral.Depression] = <Depression.CIVIL: 6.0>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculate dawn time.

-
-
Parameters
-
    -

  • observer – Observer to calculate dawn for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • depression – Number of degrees below the horizon to use to calculate dawn. -Default is for Civil dawn i.e. 6.0

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which dawn occurs.

-
-
Raises
-

ValueError – if dawn does not occur on the specified date

-
-
-
- -
-
-astral.sun.sunrise(observer: astral.Observer, date: Optional[datetime.date] = None, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculate sunrise time.

-
-
Parameters
-
    -

  • observer – Observer to calculate sunrise for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which sunrise occurs.

-
-
Raises
-

ValueError – if the sun does not reach the horizon on the specified date

-
-
-
- -
-
-astral.sun.noon(observer: astral.Observer, date: Optional[datetime.date] = None, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculate solar noon time when the sun is at its highest point.

-
-
Parameters
-
    -

  • observer – An observer viewing the sun at a specific, latitude, longitude and elevation

    • -

  • date – Date to calculate for. Default is today for the specified tzinfo.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which noon occurs.

-
-
-
- -
-
-astral.sun.midnight(observer: astral.Observer, date: Optional[datetime.date] = None, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculate solar midnight time.

-
-

Note

-

This calculates the solar midnight that is closest -to 00:00:00 of the specified date i.e. it may return a time that is on -the previous day.

-
-
-
Parameters
-
    -

  • observer – An observer viewing the sun at a specific, latitude, longitude and elevation

    • -

  • date – Date to calculate for. Default is today for the specified tzinfo.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which midnight occurs.

-
-
-
- -
-
-astral.sun.sunset(observer: astral.Observer, date: Optional[datetime.date] = None, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculate sunset time.

-
-
Parameters
-
    -

  • observer – Observer to calculate sunset for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which sunset occurs.

-
-
Raises
-

ValueError – if the sun does not reach the horizon

-
-
-
- -
-
-astral.sun.dusk(observer: astral.Observer, date: Optional[datetime.date] = None, depression: Union[float, astral.Depression] = <Depression.CIVIL: 6.0>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculate dusk time.

-
-
Parameters
-
    -

  • observer – Observer to calculate dusk for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • depression – Number of degrees below the horizon to use to calculate dusk. -Default is for Civil dusk i.e. 6.0

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which dusk occurs.

-
-
Raises
-

ValueError – if dusk does not occur on the specified date

-
-
-
- -
-
-astral.sun.daylight(observer: astral.Observer, date: Optional[datetime.date] = None, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Tuple[datetime.datetime, datetime.datetime]
-

Calculate daylight start and end times.

-
-
Parameters
-
    -

  • observer – Observer to calculate daylight for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

A tuple of the date and time at which daylight starts and ends.

-
-
Raises
-

ValueError – if the sun does not rise or does not set

-
-
-
- -
-
-astral.sun.night(observer: astral.Observer, date: Optional[datetime.date] = None, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Tuple[datetime.datetime, datetime.datetime]
-

Calculate night start and end times.

-

Night is calculated to be between astronomical dusk on the -date specified and astronomical dawn of the next day.

-
-
Parameters
-
    -

  • observer – Observer to calculate night for

    • -

  • date – Date to calculate for. Default is today’s date for the -specified tzinfo.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

A tuple of the date and time at which night starts and ends.

-
-
Raises
-

ValueError – if dawn does not occur on the specified date or - dusk on the following day

-
-
-
- -
-
-astral.sun.twilight(observer: astral.Observer, date: Optional[datetime.date] = None, direction: astral.SunDirection = <SunDirection.RISING: 1>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Tuple[datetime.datetime, datetime.datetime]
-

Returns the start and end times of Twilight -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.

-
-
Parameters
-
    -

  • observer – Observer to calculate twilight for

    • -

  • date – Date for which to calculate the times. -Default is today’s date in the timezone tzinfo.

    • -

  • direction – Determines whether the time is for the sun rising or setting. -Use astral.SunDirection.RISING or astral.SunDirection.SETTING.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

A tuple of the date and time at which twilight starts and ends.

-
-
Raises
-

ValueError – if the sun does not rise or does not set

-
-
-
- -
-
-astral.sun.blue_hour(observer: astral.Observer, date: Optional[datetime.date] = None, direction: astral.SunDirection = <SunDirection.RISING: 1>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Tuple[datetime.datetime, datetime.datetime]
-

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.

-
-
Parameters
-
    -

  • observer – Observer to calculate the blue hour for

    • -

  • date – Date for which to calculate the times. -Default is today’s date in the timezone tzinfo.

    • -

  • direction – Determines whether the time is for the sun rising or setting. -Use SunDirection.RISING or SunDirection.SETTING.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

A tuple of the date and time at which the Blue Hour starts and ends.

-
-
Raises
-

ValueError – if the sun does not transit the elevations -4 & -6 degrees

-
-
-
- -
-
-astral.sun.golden_hour(observer: astral.Observer, date: Optional[datetime.date] = None, direction: astral.SunDirection = <SunDirection.RISING: 1>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Tuple[datetime.datetime, datetime.datetime]
-

Returns 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.

-
-
Parameters
-
    -

  • observer – Observer to calculate the golden hour for

    • -

  • date – Date for which to calculate the times. -Default is today’s date in the timezone tzinfo.

    • -

  • direction – Determines whether the time is for the sun rising or setting. -Use SunDirection.RISING or SunDirection.SETTING.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

A tuple of the date and time at which the Golden Hour starts and ends.

-
-
Raises
-

ValueError – if the sun does not transit the elevations -4 & +6 degrees

-
-
-
- -
-
-astral.sun.rahukaalam(observer: astral.Observer, date: Optional[datetime.date] = None, daytime: bool = True, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → Tuple[datetime.datetime, datetime.datetime]
-

Calculate ruhakaalam times.

-
-
Parameters
-
    -

  • observer – Observer to calculate rahukaalam for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • daytime – If True calculate for the day time else calculate for the night time.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Tuple containing the start and end times for Rahukaalam.

-
-
Raises
-

ValueError – if the sun does not rise or does not set

-
-
-
- -
-
-astral.sun.zenith(observer: astral.Observer, dateandtime: Optional[datetime.datetime] = None, with_refraction: bool = True) → float
-

Calculate the zenith angle of the sun.

-
-
Parameters
-
    -

  • observer – Observer to calculate the solar zenith for

    • -

  • dateandtime – The date and time for which to calculate the angle. -If dateandtime is None or is a naive Python datetime -then it is assumed to be in the UTC timezone.

    • -

  • with_refraction – If True adjust zenith to take refraction into account

    • -
-
-
Returns
-

The zenith angle in degrees.

-
-
-
- -
-
-astral.sun.azimuth(observer: astral.Observer, dateandtime: Optional[datetime.datetime] = None) → float
-

Calculate the azimuth angle of the sun.

-
-
Parameters
-
    -

  • observer – Observer to calculate the solar azimuth for

    • -

  • dateandtime – The date and time for which to calculate the angle. -If dateandtime is None or is a naive Python datetime -then it is assumed to be in the UTC timezone.

    • -
-
-
Returns
-

The azimuth angle in degrees clockwise from North.

-
-
-

If dateandtime is a naive Python datetime then it is assumed to be -in the UTC timezone.

-
- -
-
-astral.sun.elevation(observer: astral.Observer, dateandtime: Optional[datetime.datetime] = None, with_refraction: bool = True) → float
-

Calculate the sun’s angle of elevation.

-
-
Parameters
-
    -

  • observer – Observer to calculate the solar elevation for

    • -

  • dateandtime – The date and time for which to calculate the angle. -If dateandtime is None or is a naive Python datetime -then it is assumed to be in the UTC timezone.

    • -

  • with_refraction – If True adjust elevation to take refraction into account

    • -
-
-
Returns
-

The elevation angle in degrees above the horizon.

-
-
-
- -
-
-astral.sun.time_at_elevation(observer: astral.Observer, elevation: float, date: Optional[datetime.date] = None, direction: astral.SunDirection = <SunDirection.RISING: 1>, tzinfo: Union[str, datetime.tzinfo] = <UTC>) → datetime.datetime
-

Calculates the time when the sun is at the specified elevation on the specified date.

-
-

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.

-
-
-
Parameters
-
    -

  • elevation – Elevation of the sun in degrees above the horizon to calculate for.

    • -

  • observer – Observer to calculate for

    • -

  • date – Date to calculate for. Default is today’s date in the timezone tzinfo.

    • -

  • direction – Determines whether the calculated time is for the sun rising or setting. -Use SunDirection.RISING or SunDirection.SETTING. Default is rising.

    • -

  • tzinfo – Timezone to return times in. Default is UTC.

    • -
-
-
Returns
-

Date and time at which the sun is at the specified elevation.

-
-
-
- -
-
-

astral.moon

-
-
-astral.moon.phase(date: Optional[datetime.date] = None) → float
-

Calculates the phase of the moon on the specified date.

-
-
Parameters
-

date – The date to calculate the phase for. Dates are always in the UTC timezone. -If not specified then today’s 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

-

-
-
-
- -
-
-

astral.geocoder

-

Astral geocoder is a database of locations stored within the package.

-

To get the LocationInfo for a location use the -lookup() function e.g.

-
from astral.geocoder import lookup, database
-l = lookup("London", database())
-
-
-

All locations stored in the database can be accessed using the all_locations generator

-
from astral.geocoder import all_locations
-for location in all_locations:
-    print(location)
-
-
-
-
-astral.geocoder.lookup(name: str, db: Dict[str, Dict[str, List[astral.LocationInfo]]]) → Union[Dict, astral.LocationInfo]
-

Look up a name in a database.

-

If a group with the name specified is a group name then that will -be returned. If no group is found a location with the name will be -looked up.

-
-
Parameters
-
    -

  • name – The group/location name to look up

    • -

  • db – The location database to look in

    • -
-
-
Raises
-

KeyError – if the name is not found

-
-
-
- -
-
-astral.geocoder.database() → Dict[str, Dict[str, List[astral.LocationInfo]]]
-

Returns a database populated with the inital set of locations stored -in this module

-
- -
-
-astral.geocoder.add_locations(locations: Union[List, str], db: Dict[str, Dict[str, List[astral.LocationInfo]]]) → None
-

Add locations to the database.

-

Locations can be added by passing either a string with one line per location or by passing -a list containing strings, lists or tuples (lists and tuples are passed directly to the -LocationInfo constructor).

-
- -
-
-astral.geocoder.all_locations(db: Dict[str, Dict[str, List[astral.LocationInfo]]]) → Generator[astral.LocationInfo, None, None]
-

A generator that returns all the LocationInfos contained in the database

-
- -
-
-

astral.location

-
-
-class astral.location.Location(info: Optional[astral.LocationInfo] = None)
-

Provides access to information for single location.

-
-
-blue_hour(direction: astral.SunDirection = <SunDirection.RISING: 1>, date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → Tuple[datetime.datetime, datetime.datetime]
-

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.

-
-
Parameters
-
    -

  • direction – Determines whether the time is for the sun rising or setting. -Use SunDirection.RISING or SunDirection.SETTING. -Default is rising.

    • -

  • date – The date for which to calculate the times. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

A tuple of the date and time at which the Blue Hour starts and ends.

-
-
-
- -
-
-dawn(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → datetime.datetime
-

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 Astral.solar_depression property.

-
-
Parameters
-
    -

  • date – The date for which to calculate the dawn time. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

The date and time at which dawn occurs.

-
-
-
- -
-
-daylight(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → Tuple[datetime.datetime, datetime.datetime]
-

Calculates the daylight time (the time between sunrise and sunset)

-
-
Parameters
-
    -

  • date – The date for which to calculate daylight. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

A tuple containing the start and end times

-
-
-
- -
-
-dusk(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → datetime.datetime
-

Calculates 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 -solar_depression property.)

-
-
Parameters
-
    -

  • date – The date for which to calculate the dusk time. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

The date and time at which dusk occurs.

-
-
-
- -
-
-golden_hour(direction: astral.SunDirection = <SunDirection.RISING: 1>, date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → Tuple[datetime.datetime, datetime.datetime]
-

Returns 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.

-
-
Parameters
-
    -

  • direction – Determines whether the time is for the sun rising or setting. -Use SunDirection.RISING or SunDirection.SETTING. -Default is rising.

    • -

  • date – The date for which to calculate the times.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

A tuple of the date and time at which the Golden Hour starts and ends.

-
-
-
- -
-
-property latitude
-

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.

-
- -
-
-property longitude
-

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.

-
- -
-
-midnight(date: datetime.date = None, local: bool = True) → datetime.datetime
-

Calculates the solar midnight (the time when the sun is at its lowest -point.)

-
-
Parameters
-
    -

  • date – The date for which to calculate the midnight time. -If no date is specified then the current date will be used.

    • -

  • 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.

-
-
-
- -
-
-moon_phase(date: datetime.date = None, local: bool = True)
-

Calculates the moon phase for a specific date.

-
-
Parameters
-

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

-

-
-
-
- -
-
-night(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → Tuple[datetime.datetime, datetime.datetime]
-

Calculates the night time (the time between astronomical dusk and -astronomical dawn of the next day)

-
-
Parameters
-
    -

  • 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.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

A tuple containing the start and end times

-
-
-
- -
-
-noon(date: datetime.date = None, local: bool = True) → datetime.datetime
-

Calculates the solar noon (the time when the sun is at its highest -point.)

-
-
Parameters
-
    -

  • date – The date for which to calculate the noon time. -If no date is specified then the current date will be used.

    • -

  • 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.

-
-
-
- -
-
-rahukaalam(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → Tuple[datetime.datetime, datetime.datetime]
-

Calculates the period of rahukaalam.

-
-
Parameters
-
    -

  • date – The date for which to calculate the rahukaalam period. -A value of None uses the current date.

    • -

  • local – True = Time to be returned in location’s time zone; -False = Time to be returned in UTC.

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

Tuple containing the start and end times for Rahukaalam.

-
-
-
- -
-
-solar_azimuth(dateandtime: datetime.datetime = None, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → float
-

Calculates the solar azimuth angle for a specific date/time.

-
-
Parameters
-

dateandtime – The date and time for which to calculate the angle.

-
-
Returns
-

The azimuth angle in degrees clockwise from North.

-
-
-
- -
-
-property solar_depression
-

The 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

-
- -
-
-solar_elevation(dateandtime: datetime.datetime = None, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → float
-

Calculates the solar elevation angle for a specific time.

-
-
Parameters
-

dateandtime – The date and time for which to calculate the angle.

-
-
Returns
-

The elevation angle in degrees above the horizon.

-
-
-
- -
-
-solar_zenith(dateandtime: datetime.datetime, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → float
-

Calculates the solar zenith angle for a specific time.

-
-
Parameters
-

dateandtime – The date and time for which to calculate the angle.

-
-
Returns
-

The zenith angle in degrees from vertical.

-
-
-
- -
-
-sun(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → dict
-

Returns dawn, sunrise, noon, sunset and dusk as a dictionary.

-
-
Parameters
-
    -

  • date – The date for which to calculate the times. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • 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.

-
-
-
- -
-
-sunrise(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → datetime.datetime
-

Return 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.

-
-
Parameters
-
    -

  • date – The date for which to calculate the sunrise time. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

The date and time at which sunrise occurs.

-
-
-
- -
-
-sunset(date: datetime.date = None, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0) → datetime.datetime
-

Calculates sunset time (the time in the evening when the sun is a -0.833 degrees below the horizon. This is to account for refraction.)

-
-
Parameters
-
    -

  • date – The date for which to calculate the sunset time. -If no date is specified then the current date will be used.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

The date and time at which sunset occurs.

-
-
-
- -
-
-time_at_elevation(elevation: float, date: datetime.date = None, direction: astral.SunDirection = <SunDirection.RISING: 1>, local: bool = True) → datetime.datetime
-

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.

-
-
-
Parameters
-
    -

  • elevation – Elevation in degrees above the horizon to calculate for.

    • -

  • date – The date for which to calculate the elevation time. -If no date is specified then the current date will be used.

    • -

  • direction – Determines whether the time is for the sun rising or setting. -Use SunDirection.RISING or SunDirection.SETTING. -Default is rising.

    • -

  • 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.

-
-
-
- -
-
-property timezone
-

The name of the time zone for the location.

-

A list of time zone names can be obtained from pytz. For example.

-
>>> from pytz import all_timezones
->>> for timezone in all_timezones:
-...     print(timezone)
-
-
-
- -
-
-twilight(date: datetime.date = None, direction: astral.SunDirection = <SunDirection.RISING: 1>, local: bool = True, observer_elevation: Union[float, Tuple[float, float]] = 0.0)
-

Returns 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.

-
-
Parameters
-
    -

  • direction – Determines whether the time is for the sun rising or setting. -Use astral.SUN_RISING or astral.SunDirection.SETTING.

    • -

  • date – The date for which to calculate the times.

    • -

  • 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

    • -

  • observer_elevation – Elevation of the observer in metres above -the location.

    • -
-
-
Returns
-

A tuple of the UTC date and time at which twilight starts and ends.

-
-
-
- -
-
-property tz
-

Time zone information.

-
- -
-
-property tzinfo
-

Time zone information.

-
- -
- -
-
- - -
-
-
-
-
-

Table Of Contents

- - -

Previous topic

-

Astral v2.2

-
-

This Page

- -
- - -
-
-
-
-
-

Navigation

- -
-
- © Copyright 2009-2020, Simon Kennedy. - Created using Sphinx 3.0.3. -
- - diff --git a/docs/search.html b/docs/search.html deleted file mode 100644 index 2077b7c..0000000 --- a/docs/search.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - - - - - Search — Astral 2.2 documentation - - - - - - - - - - - - - - - - - - - - - -
-

Navigation

- -
- -
-
-
-
- -

Search

-
- -

- Please activate JavaScript to enable the search - functionality. -

-
-

- Searching for multiple words only shows matches that contain - all words. -

-
- - - -
- -
- -
- -
-
-
-
-
-
-
-
-
-
-

Navigation

- -
-
- © Copyright 2009-2020, Simon Kennedy. - Created using Sphinx 3.0.3. -
- - diff --git a/docs/searchindex.js b/docs/searchindex.js deleted file mode 100644 index ba34912..0000000 --- a/docs/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({docnames:["index","package"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["index.rst","package.rst"],objects:{"":{astral:[1,0,0,"-"]},"astral.LocationInfo":{observer:[1,2,1,""],tzinfo:[1,2,1,""]},"astral.geocoder":{add_locations:[1,3,1,""],all_locations:[1,3,1,""],database:[1,3,1,""],lookup:[1,3,1,""]},"astral.location":{Location:[1,1,1,""]},"astral.location.Location":{blue_hour:[1,2,1,""],dawn:[1,2,1,""],daylight:[1,2,1,""],dusk:[1,2,1,""],golden_hour:[1,2,1,""],latitude:[1,2,1,""],longitude:[1,2,1,""],midnight:[1,2,1,""],moon_phase:[1,2,1,""],night:[1,2,1,""],noon:[1,2,1,""],rahukaalam:[1,2,1,""],solar_azimuth:[1,2,1,""],solar_depression:[1,2,1,""],solar_elevation:[1,2,1,""],solar_zenith:[1,2,1,""],sun:[1,2,1,""],sunrise:[1,2,1,""],sunset:[1,2,1,""],time_at_elevation:[1,2,1,""],timezone:[1,2,1,""],twilight:[1,2,1,""],tz:[1,2,1,""],tzinfo:[1,2,1,""]},"astral.moon":{phase:[1,3,1,""]},"astral.sun":{azimuth:[1,3,1,""],blue_hour:[1,3,1,""],dawn:[1,3,1,""],daylight:[1,3,1,""],dusk:[1,3,1,""],elevation:[1,3,1,""],golden_hour:[1,3,1,""],midnight:[1,3,1,""],night:[1,3,1,""],noon:[1,3,1,""],rahukaalam:[1,3,1,""],sun:[1,3,1,""],sunrise:[1,3,1,""],sunset:[1,3,1,""],time_at_elevation:[1,3,1,""],twilight:[1,3,1,""],zenith:[1,3,1,""]},astral:{Depression:[1,1,1,""],LocationInfo:[1,1,1,""],Observer:[1,1,1,""],SunDirection:[1,1,1,""],dms_to_float:[1,3,1,""],geocoder:[1,0,0,"-"],moon:[1,0,0,"-"],now:[1,3,1,""],sun:[1,0,0,"-"],today:[1,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"02f":0,"\u03b1":0,"\u03b8":0,"break":0,"case":0,"catch":0,"class":[0,1],"default":1,"float":[0,1],"function":[0,1],"import":[0,1],"l\u00f6nnemark":0,"new":[0,1],"return":[0,1],"torbj\u00f6rn":0,"true":[0,1],"try":0,Added:0,Des:0,For:[0,1],Las:0,Los:0,Their:0,These:0,Use:[0,1],Using:0,__init__:0,aaiun:0,ababa:0,aberdeen:0,abil:0,about:0,abov:[0,1],abu:0,abuja:0,accept:0,access:[0,1],accord:0,account:[0,1],accra:0,accuraci:0,actual:0,adapt:0,add:[0,1],add_loc:[0,1],added:[0,1],addi:0,adding:0,adelaid:0,adjust:[0,1],affect:0,after:0,air:0,albani:0,albuquerqu:0,algier:0,alia:0,all:[0,1],all_loc:1,all_timezon:1,allow:0,almost:0,alofa:0,also:[0,1],alwai:1,amali:0,america:0,amman:0,amount:0,amsterdam:0,anchorag:0,andorra:0,andorra_la_vella:0,angel:0,angl:[0,1],ani:[0,1],ankara:0,annapoli:0,antananarivo:0,anyth:0,apach:0,api:0,api_kei:0,apia:0,appar:0,appear:0,approxim:0,arcminut:0,arg:0,ashgabat:0,ask:0,asmara:0,aspect:0,assum:1,astana:0,astralgeocod:0,astrolog:0,astronom:[0,1],astronomi:0,asum:0,asuncion:0,athen:0,atlanta:0,atmospher:0,attribut:0,augusta:0,austin:0,automat:0,avail:0,avarua:0,azimuth:[0,1],baghdad:0,baku:0,baltimor:0,bamako:0,bandar:0,bangkok:0,bangui:0,banjul:0,barrow:0,base:0,bass:0,basseterr:0,baton:0,bator:0,beach:0,been:[0,1],begawan:0,beij:0,being:[0,1],beirut:0,belfast:0,belgrad:0,belmopan:0,below:[0,1],berlin:0,bern:0,between:[0,1],bilisi:0,bill:0,birmingham:0,bishkek:0,bismarck:0,bissau:0,bloemfontein:0,blue:[0,1],blue_hour:1,bogota:0,boilerpl:0,bois:0,bolton:0,bool:1,boston:0,bradford:0,brasilia:0,bratislava:0,brazzavil:0,bridgeport:0,bridgetown:0,brisban:0,bristol:0,broke:0,brussel:0,bucharest:0,bucuresti:0,budapest:0,bueno:0,buffalo:0,bug:0,bujumbura:0,burlington:0,cairo:0,calcdetail:0,calcualt:0,calcul:[0,1],california:0,call:0,can:[0,1],canadian:0,canberra:0,cape:0,capit:0,caraca:0,cardiff:0,carson:0,castri:0,cayenn:0,central:0,certain:[0,1],chang:[0,1],charleston:0,charlott:0,cheyenn:0,chicago:0,chisinau:0,cite:0,citydb:0,civil:1,cleveland:0,client:0,clockwis:[0,1],closest:1,code:0,columbia:0,columbu:0,com:0,come:0,command:0,compat:0,conakri:0,concord:0,configur:0,consid:0,construct:0,constructor:[0,1],contain:[0,1],content:0,convert:1,copenhagen:0,correct:0,correspond:1,coton:0,could:0,countri:0,crawlei:0,creat:0,current:[0,1],dai:[0,1],dakar:0,dalla:0,damascu:0,dammam:0,data:0,databas:[0,1],date:[0,1],dateandtim:1,datetim:[0,1],davi:0,dawn:[0,1],dawn_dusk_depress:1,daylight:[0,1],daytim:1,defin:1,definit:1,degre:[0,1],delhi:0,demonstr:0,denver:0,depress:[0,1],derek_:0,describ:0,descript:0,design:1,determin:[0,1],detroit:0,dhabi:0,dhaka:0,diagram:0,diamet:0,dict:1,dictionari:1,diego:0,differ:0,dili:0,dimato:0,direct:[0,1],directli:[0,1],disappear:0,distanc:[0,1],djamena:0,djibouti:0,dms:1,dms_to_float:1,doc:0,docstr:0,dodoma:0,doe:[0,1],doha:0,domingo:0,dougla:0,dover:0,down:0,dsttzinfo:0,dublin:0,due:0,duplic:0,dushanb:0,dusk:[0,1],earlier:[0,1],earth:[0,1],easi:0,easier:0,east:1,eastern:[0,1],edinburgh:0,either:[0,1],elev:1,els:1,encod:1,end:1,energi:0,england:[0,1],ensur:0,error:0,esrl:0,etc:0,europ:[0,1],even:[0,1],everest:0,everi:0,exampl:1,except:0,execut:0,experi:0,extern:0,extra:0,face:0,fail:0,fall:0,fals:[0,1],far:0,fargo:0,featur:[0,1],file:0,fill:0,first:[0,1],fix:0,follow:[0,1],form:1,fort:0,found:[0,1],franc:0,francisco:0,frankfort:0,freetown:0,from:[0,1],full:[0,1],funafuti:0,fur:0,further:0,gaboron:0,gener:[0,1],geograph:0,georg:0,georgetown:0,get:1,gibraltar:0,gitgub:0,github:0,glasgow:0,glyph:0,gmail:0,gmd:0,gmt0:0,golden:[0,1],golden_hour:1,googl:0,googlegeocod:[0,1],googlemap:0,gov:0,grad:0,greater:[0,1],greenwich:[0,1],ground:0,group:1,guatemala:0,hajo:0,half:0,handl:0,hanoi:0,harar:0,harrisburg:0,hartford:0,has:0,havana:0,have:[0,1],heemskerk:0,helena:0,helier:0,helsinki:0,hemispher:0,higher:0,highest:[0,1],highli:0,hobart:0,hong:0,honiara:0,honolulu:0,horizon:[0,1],horizont:0,hour:[0,1],houston:0,how:0,howev:0,html:0,http:0,imag:0,inauspici:0,includ:0,incorrect:0,incorrectli:0,indi:0,indian:0,indianapoli:0,info:[0,1],inform:[0,1],init:1,initi:0,instead:0,integr:0,interfac:0,islamabad:0,iss:0,its:[0,1],jackson:0,jacksonvil:0,jakarta:0,javascript:0,jayawardenapura:0,jefferson:0,jerusalem:0,john:0,jose:0,juan:0,juba:0,jubail:0,june:0,juneau:0,kabul:0,kampala:0,kansa:0,kathmandu:0,kei:[0,1],kennedi:0,keyerror:[0,1],keyword:0,khartoum:0,kiev:0,kigali:0,kingston:0,kingstown:0,kinshasa:0,kong:0,koror:0,kott:0,kuala:0,kuwait:0,laboraton:0,lake:0,languag:0,lans:0,larg:0,largest:0,last:[0,1],later:0,latitud:[0,1],launchpad:0,leed:0,leicest:0,level:0,librari:0,librevil:0,like:0,lilongw:0,lima:0,limit:1,lincoln:0,line:[0,1],lisbon:0,list:[0,1],liter:0,littl:0,liverpool:0,ljubljana:0,local:1,locationinfo:[0,1],lome:0,london:[0,1],longitud:[0,1],look:[0,1],lookup:[0,1],loui:0,louisvil:0,lowest:[0,1],luanda:0,lumpur:0,lusaka:0,luxembourg:0,macau:0,made:0,madinah:0,madison:0,madrid:0,magazin:0,mai:[0,1],majuro:0,make:0,makkah:0,malabo:0,male:0,mamoudz:0,manag:0,managua:0,manama:0,manchest:0,manifest:0,manila:0,map:0,maputo:0,marino:0,martin:0,maseru:0,masqat:0,match:0,maximum:0,mbaban:0,mean:1,mecca:0,medina:0,melbourn:0,memphi:0,messag:0,method:[0,1],metr:1,mexico:0,miami:0,midnight:[0,1],milwauke:0,minneapoli:0,minor:0,minsk:0,minut:1,miss:0,misunderstand:0,modul:[0,1],mogadishu:0,moin:0,monaco:0,monrovia:0,montevideo:0,montgomeri:0,montpeli:0,moon_phas:[0,1],moongaz:0,moonphas:0,more:0,moresbi:0,morn:[0,1],moroni:0,moscow:0,moskva:0,mount:0,mountain:0,move:0,mumbai:0,muscat:0,must:1,nairobi:0,naiv:[0,1],name:[0,1],nashvil:0,nassau:0,nation:0,nautic:1,naypyidaw:0,nearest:1,need:0,neg:1,net:0,newark:0,newcastl:0,next:[0,1],ngerulmud:0,niamei:0,nicosia:0,night:[0,1],noaa:0,none:[0,1],noon:[0,1],north:[0,1],northern:[0,1],norwich:0,nouakchott:0,noumea:0,novo:0,now:[0,1],nuku:0,number:[0,1],nuuk:0,object:0,obscur:[0,1],observ:[0,1],observer_elev:1,obtain:[0,1],occur:1,off:0,offset:0,oklahoma:0,olympia:0,omaha:0,ommit:1,onc:1,one:[0,1],onli:0,oper:0,option:1,oranjestad:0,orbit:0,order:0,ordin:0,origin:0,orlando:0,orlean:0,oslo:0,osti:0,other:0,ottawa:0,ouagadoug:0,outsid:0,oxford:0,packag:0,page:0,pago:0,palikir:0,panama:0,pandermusubi:0,papeet:0,paramaribo:0,paramet:[0,1],pari:0,pass:[0,1],paul:0,paz:0,penh:0,per:[0,1],perfom:1,period:[0,1],perth:0,peter:0,phase:[0,1],philadelphia:0,phnom:0,phoenix:0,photopil:1,pierr:0,pip3:0,pip:0,plu:[0,1],plymouth:0,podgorica:0,point:[0,1],popul:1,port:0,portland:0,porto:0,portsmouth:0,posit:[0,1],possibl:0,pragu:0,praia:0,pressur:0,pretoria:0,previou:[0,1],previous:0,princ:0,print:[0,1],prior:0,pristina:0,program:0,project:0,properti:[0,1],provid:[0,1],purl:0,python:[0,1],pytz:[0,1],quarter:[0,1],quito:0,rabat:0,rahu:0,rahukaalam:[0,1],rais:[0,1],raleigh:0,rang:0,reach:[0,1],read:0,refactor:0,refract:1,regard:0,region:[0,1],releas:0,remov:[0,1],renam:0,report:0,request:0,requir:0,respect:0,result:1,revers:0,reykjavik:0,richmond:0,riga:0,right:0,rise:[0,1],riyadh:0,road:0,robert:0,rock:0,roger:0,rome:0,roseau:0,roug:0,round:0,rtype:0,ruhakaalam:1,sacramento:0,saint:0,saipan:0,salem:0,salt:0,salvador:0,same:0,san:0,sana:0,sandia:0,santa:0,santiago:0,santo:0,sao:0,sarajevo:0,sdist:0,seattl:0,second:[0,1],secret:0,see:0,seen:0,self:1,seoul:0,seri:0,servic:0,servlet:0,set:[0,1],sffjunki:0,sheffield:0,shing:0,should:[0,1],show:0,sign:0,signifi:1,significantli:0,simon:0,singapor:0,singl:[0,1],sinnott:0,sioux:0,skopj:0,sky:0,skyandtelescop:0,small:[0,1],sofia:0,solar:[0,1],solar_azimuth:[0,1],solar_depress:[0,1],solar_elev:[0,1],solar_midnight:0,solar_noon:0,solar_zenith:[0,1],solcalc:0,some:0,somewher:0,sort:0,sourc:0,southampton:0,southern:0,spain:0,specif:[0,1],specifi:[0,1],sphinx:0,spreadsheet:0,springfield:0,sri:0,stanlei:0,start:1,state:0,statement:0,std:0,stockholm:0,store:[0,1],str:1,string:[0,1],strip:0,submit:0,sucr:0,suit:0,summit:0,sun_ris:1,sun_utc:0,sundirect:1,sunris:[0,1],sunset:[0,1],support:0,suva:0,swansea:0,swindon:0,sydnei:0,system:0,taipei:0,take:[0,1],taken:0,tallahasse:0,tallinn:0,tarawa:0,target:0,tashkent:0,tbilisi:0,tegucigalpa:0,tehran:0,telescop:0,temperatur:0,term:0,terr:0,test:0,than:[0,1],thei:[0,1],thi:[0,1],thimphu:0,thing:0,those:1,though:0,through:1,time:1,time_at_elev:1,timezon:1,tiran:0,tirana:0,todai:1,tokyo:0,toledo:0,tome:0,tool:0,top:0,topeka:0,torshavn:0,town:0,transit:1,travers:1,travi:0,trenton:0,tripoli:0,tuni:0,tupl:[0,1],turn:1,twilight:[0,1],twilight_utc:0,two:0,tyne:0,type:0,tzinfo:[0,1],ulaanbaatar:0,ulan:0,under:0,unicod:0,union:1,univers:0,updat:0,upon:0,url:0,use:[0,1],used:[0,1],user:0,uses:[0,1],using:[0,1],utc:[0,1],vaduz:0,valid:0,valletta:0,valu:[0,1],valueerror:1,variou:0,vedic:0,vega:0,vella:0,ventur:0,veri:0,version:1,vertic:[0,1],via:0,vienna:0,vientian:0,view:[0,1],vila:0,vilniu:0,virginia:0,vital:0,vol:0,wai:0,walraven:0,want:0,warsaw:0,washington:0,websit:0,well:0,wellington:0,werder:0,were:0,what:0,when:[0,1],where:0,whether:1,which:[0,1],whitespac:0,whose:1,wichita:0,willemstad:0,wilmington:0,windhoek:0,window:0,with_refract:[0,1],within:1,wolverhampton:0,would:0,write:0,www:0,x10:0,yamoussoukro:0,yangon:0,yaound:0,yaren:0,yerevan:0,yip:0,yongyang:0,york:0,you:0,your:0,zagreb:0,zenith:[0,1],zimmerman:0,zone:[0,1]},titles:["Astral v2.2","The astral Package"],titleterms:{The:[0,1],addit:0,astral:[0,1],citi:0,contact:0,custom:0,depend:0,effect:0,elev:0,exampl:0,geocod:[0,1],group:0,histori:0,instal:0,licens:0,local:0,locat:[0,1],moon:[0,1],note:0,packag:1,refract:0,sun:[0,1],thank:0,time:0,timezon:0,version:0}}) \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..6517047 --- /dev/null +++ b/go.mod @@ -0,0 +1,9 @@ +module github.com/sj14/astral + +go 1.16 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/stretchr/testify v1.7.0 + gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..c221f64 --- /dev/null +++ b/go.sum @@ -0,0 +1,13 @@ +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/install-git-hooks b/install-git-hooks deleted file mode 100644 index a0f01af..0000000 --- a/install-git-hooks +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash -if [ "" = "$1" ] || [ "--help" = "$1" ] ; then - echo "Use to install a git hook in the appropriate place" - echo - echo "./install-git-hooks " - echo - echo "e.g. ./install-git-hooks pre-commit" -else - cp src/git-hooks/$1 .git/hooks/ - chmod +x .git/hooks/$1 -fi; diff --git a/install-git-hooks.bat b/install-git-hooks.bat deleted file mode 100644 index b1fe124..0000000 --- a/install-git-hooks.bat +++ /dev/null @@ -1,10 +0,0 @@ -@echo off -IF "%1" == "--help" ( - echo "Use to install a git hook in the appropriate place" - echo. - echo "./install-git-hooks.bat " - echo. - echo "e.g. ./install-git-hooks.bat pre-commit" -) ELSE ( - copy src\git-hooks\%1 .git\hooks\ -) diff --git a/monkeypatch.py b/monkeypatch.py deleted file mode 100644 index 9574716..0000000 --- a/monkeypatch.py +++ /dev/null @@ -1,77 +0,0 @@ -"""Monkey patch distutils to also use setup-dev.cfg and setuptools to add README.md to the default files""" - -import os -import sys -import distutils.dist -from distutils.util import check_environ -from distutils.debug import DEBUG -import setuptools.command.sdist - - -def find_config_files(self): - """Find as many configuration files as should be processed for this - platform, and return a list of filenames in the order in which they - should be parsed. The filenames returned are guaranteed to exist - (modulo nasty race conditions). - - There are three possible config files: distutils.cfg in the - Distutils installation directory (ie. where the top-level - Distutils __inst__.py file lives), a file in the user's home - directory named .pydistutils.cfg on Unix and pydistutils.cfg - on Windows/Mac; and setup.cfg in the current directory. - - The file in the user's home directory can be disabled with the - --no-user-cfg option. - """ - - files = [] - check_environ() - - # Where to look for the system-wide Distutils config file - sys_dir = os.path.dirname(sys.modules["distutils"].__file__) - - # Look for the system config file - sys_file = os.path.join(sys_dir, "distutils.cfg") - if os.path.isfile(sys_file): - files.append(sys_file) - - # What to call the per-user config file - if os.name == "posix": - user_filename = ".pydistutils.cfg" - else: - user_filename = "pydistutils.cfg" - - # And look for the user config file - if self.want_user_cfg: - user_file = os.path.join(os.path.expanduser("~"), user_filename) - if os.path.isfile(user_file): - files.append(user_file) - - # All platforms support local setup.cfg - local_file = "setup.cfg" - if os.path.isfile(local_file): - files.append(local_file) - - local_dev_file = "setup-dev.cfg" - if os.path.isfile(local_dev_file): - files.append(local_dev_file) - - if DEBUG: - self.announce("using config files: %s" % ", ".join(files)) - - return files - - -def check_readme(self): - self.READMES += ("README.md",) - for f in self.READMES: - if os.path.exists(f): - break - else: - self.warn( - "standard file not found: should have one of " + ", ".join(self.READMES) - ) - - -distutils.dist.Distribution.find_config_files = find_config_files -setuptools.command.sdist.sdist.check_readme = check_readme diff --git a/moon.go b/moon.go new file mode 100644 index 0000000..69c527e --- /dev/null +++ b/moon.go @@ -0,0 +1,80 @@ +package astral + +import ( + "fmt" + "math" + "time" +) + +func properAngle(value float64) float64 { + if value > 0.0 { + value /= 360.0 + return (value - math.Floor(value)) * 360.0 + } + + tmp := math.Ceil(math.Abs(value / 360.0)) + return value + tmp*360.0 +} + +func phaseAsfloat(date time.Time) float64 { + jd := julianday(date) + DT := math.Pow((jd-2382148), 2) / (41048480 * 86400) + T := (jd + DT - 2451545.0) / 36525 + T2 := math.Pow(T, 2) + T3 := math.Pow(T, 3) + D := 297.85 + (445267.1115 * T) - (0.0016300 * T2) + (T3 / 545868) + D = radians(properAngle(D)) + M := 357.53 + (35999.0503 * T) + M = radians(properAngle(M)) + M1 := 134.96 + (477198.8676 * T) + (0.0089970 * T2) + (T3 / 69699) + M1 = radians(properAngle(M1)) + elong := degrees(D) + 6.29*math.Sin(M1) + elong -= 2.10 * math.Sin(M) + elong += 1.27 * math.Sin(2*D-M1) + elong += 0.66 * math.Sin(2*D) + elong = properAngle(elong) + elong = math.Round(elong) + moon := ((elong + 6.43) / 360) * 28 + return moon +} + +// Calculates the phase of the moon on the specified date. +// Args: +// date: The date to calculate the phase for. Dates are always in the UTC timezone. +// If not specified then today's 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 +// ============ ============== +func MoonPhase(date time.Time) float64 { + moon := phaseAsfloat(date) + if moon >= 28.0 { + moon -= 28.0 + } + return moon +} + +// MoonPhaseDescription returns the description of the given moon phase. +func MoonPhaseDescription(x float64) (string, error) { + if x < 0 || x >= 28 { + return "", fmt.Errorf("%v is out of the expected range (0-27.99)", x) + } + if x < 7 { + return "New Moon", nil + } + if x >= 7 && x < 14 { + return "First Quarter", nil + } + if x >= 14 && x < 21 { + return "Full Moon", nil + } + if x >= 21 && x < 28 { + return "Laster Quarter", nil + } + + return "", fmt.Errorf("failed parsing %v", x) +} diff --git a/moon_test.go b/moon_test.go new file mode 100644 index 0000000..d1885ef --- /dev/null +++ b/moon_test.go @@ -0,0 +1,32 @@ +package astral + +import ( + "testing" + "time" + + "github.com/stretchr/testify/require" +) + +func TestMoon(t *testing.T) { + type args struct { + date time.Time + } + tests := []struct { + name string + args args + want float64 + }{ + {args: args{date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, want: 19.477889}, + {args: args{date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC)}, want: 20.411222}, + {args: args{date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC)}, want: 21.266777}, + {args: args{date: time.Date(2014, 12, 1, 0, 0, 0, 0, time.UTC)}, want: 9.0556666}, + {args: args{date: time.Date(2014, 12, 2, 0, 0, 0, 0, time.UTC)}, want: 10.066777}, + {args: args{date: time.Date(2014, 1, 1, 0, 0, 0, 0, time.UTC)}, want: 0.033444}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := MoonPhase(tt.args.date) + require.True(t, almostEqualf(tt.want, got, 0.000001), "want: %v but got: %v", tt.want, got) + }) + } +} diff --git a/mypy.ini b/mypy.ini deleted file mode 100644 index ce362f5..0000000 --- a/mypy.ini +++ /dev/null @@ -1,2 +0,0 @@ -[mypy] -cache_dir = .cache/mypy diff --git a/poetry.toml b/poetry.toml deleted file mode 100644 index 874835f..0000000 --- a/poetry.toml +++ /dev/null @@ -1,2 +0,0 @@ -[virtualenvs] -path = ".venv/poetry" diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 50f630b..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,38 +0,0 @@ -[tool.poetry] -name = "astral" -version = "2.2" -description = "Calculations for the position of the sun and moon." -keywords = ["sun", "moon", "sunrise", "sunset", "dawn", "dusk"] -authors = ["Simon Kennedy "] -license = "Apache-2.0" -readme = "README.rst" -documentation = "https://astral.readthedocs.io/en/stable/index.html" -repository = "https://github.com/sffjunkie/astral" -classifiers = [ - "Intended Audience :: Developers", - "Programming Language :: Python", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", -] -packages = [ - { include = "astral", from = "src"}, - { include = "doc", from = "src", format = "sdist"}, - { include = "test", from = "src", format = "sdist"}, -] - -[tool.poetry.dependencies] -python = "^3.6" -pytz = "*" -dataclasses = { version="*", python = "3.6"} - -[tool.poetry.dev-dependencies] -freezegun = "*" -pytest = "5.0.1" -tox = "*" -pylint = "^2.4.4" -flake8 = "*" - -[build-system] -requires = ["poetry>=1.0.0b1"] -build-backend = "poetry.masonry.api" diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index 2159fda..0000000 --- a/pytest.ini +++ /dev/null @@ -1,16 +0,0 @@ -[pytest] -junit_family=xunit2 - -cache_dir = .cache/pytest -norecursedirs = - __pycache__ - .cache - .mypy_cache - .pytest_cache - .eggs - .git - .settings - .venv - .vscode - dist - build diff --git a/src/astral/__init__.py b/python_reference/astral/__init__.py similarity index 100% rename from src/astral/__init__.py rename to python_reference/astral/__init__.py diff --git a/src/astral/__main__.py b/python_reference/astral/__main__.py similarity index 100% rename from src/astral/__main__.py rename to python_reference/astral/__main__.py diff --git a/src/astral/geocoder.py b/python_reference/astral/geocoder.py similarity index 100% rename from src/astral/geocoder.py rename to python_reference/astral/geocoder.py diff --git a/src/astral/location.py b/python_reference/astral/location.py similarity index 100% rename from src/astral/location.py rename to python_reference/astral/location.py diff --git a/src/astral/moon.py b/python_reference/astral/moon.py similarity index 100% rename from src/astral/moon.py rename to python_reference/astral/moon.py diff --git a/src/astral/py.typed b/python_reference/astral/py.typed similarity index 100% rename from src/astral/py.typed rename to python_reference/astral/py.typed diff --git a/src/astral/sun.py b/python_reference/astral/sun.py similarity index 100% rename from src/astral/sun.py rename to python_reference/astral/sun.py diff --git a/src/test/almost_equal.py b/python_reference/test/almost_equal.py similarity index 100% rename from src/test/almost_equal.py rename to python_reference/test/almost_equal.py diff --git a/src/test/conftest.py b/python_reference/test/conftest.py similarity index 100% rename from src/test/conftest.py rename to python_reference/test/conftest.py diff --git a/src/test/test_Location.py b/python_reference/test/test_Location.py similarity index 100% rename from src/test/test_Location.py rename to python_reference/test/test_Location.py diff --git a/src/test/test_Moon.py b/python_reference/test/test_Moon.py similarity index 100% rename from src/test/test_Moon.py rename to python_reference/test/test_Moon.py diff --git a/src/test/test_Repr.py b/python_reference/test/test_Repr.py similarity index 100% rename from src/test/test_Repr.py rename to python_reference/test/test_Repr.py diff --git a/src/test/test_all.py b/python_reference/test/test_all.py similarity index 100% rename from src/test/test_all.py rename to python_reference/test/test_all.py diff --git a/src/test/test_almost_equal.py b/python_reference/test/test_almost_equal.py similarity index 100% rename from src/test/test_almost_equal.py rename to python_reference/test/test_almost_equal.py diff --git a/src/test/test_buenos_aries.py b/python_reference/test/test_buenos_aries.py similarity index 100% rename from src/test/test_buenos_aries.py rename to python_reference/test/test_buenos_aries.py diff --git a/src/test/test_depression_not_reached.py b/python_reference/test/test_depression_not_reached.py similarity index 100% rename from src/test/test_depression_not_reached.py rename to python_reference/test/test_depression_not_reached.py diff --git a/src/test/test_geocoder.py b/python_reference/test/test_geocoder.py similarity index 100% rename from src/test/test_geocoder.py rename to python_reference/test/test_geocoder.py diff --git a/src/test/test_location_info.py b/python_reference/test/test_location_info.py similarity index 100% rename from src/test/test_location_info.py rename to python_reference/test/test_location_info.py diff --git a/src/test/test_misc.py b/python_reference/test/test_misc.py similarity index 100% rename from src/test/test_misc.py rename to python_reference/test/test_misc.py diff --git a/src/test/test_norway.py b/python_reference/test/test_norway.py similarity index 100% rename from src/test/test_norway.py rename to python_reference/test/test_norway.py diff --git a/src/test/test_observer.py b/python_reference/test/test_observer.py similarity index 100% rename from src/test/test_observer.py rename to python_reference/test/test_observer.py diff --git a/src/test/test_sun_calc.py b/python_reference/test/test_sun_calc.py similarity index 100% rename from src/test/test_sun_calc.py rename to python_reference/test/test_sun_calc.py diff --git a/src/test/test_sun_elevation_adjustment.py b/python_reference/test/test_sun_elevation_adjustment.py similarity index 100% rename from src/test/test_sun_elevation_adjustment.py rename to python_reference/test/test_sun_elevation_adjustment.py diff --git a/src/test/test_sun_golden_blue.py b/python_reference/test/test_sun_golden_blue.py similarity index 100% rename from src/test/test_sun_golden_blue.py rename to python_reference/test/test_sun_golden_blue.py diff --git a/src/test/test_sun_local.py b/python_reference/test/test_sun_local.py similarity index 100% rename from src/test/test_sun_local.py rename to python_reference/test/test_sun_local.py diff --git a/src/test/test_sun_utc.py b/python_reference/test/test_sun_utc.py similarity index 100% rename from src/test/test_sun_utc.py rename to python_reference/test/test_sun_utc.py diff --git a/src/test/test_wellington.py b/python_reference/test/test_wellington.py similarity index 100% rename from src/test/test_wellington.py rename to python_reference/test/test_wellington.py diff --git a/requirements-dev.txt b/requirements-dev.txt deleted file mode 100644 index 337221a..0000000 --- a/requirements-dev.txt +++ /dev/null @@ -1,5 +0,0 @@ -freezegun -pytest==5.0.1 -pytest-cov -tox -flake8 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 2f4e6a6..0000000 --- a/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -pytz -dataclasses; python_version == '3.6' diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index dfdd1de..0000000 --- a/setup.cfg +++ /dev/null @@ -1,39 +0,0 @@ -[metadata] -name = astral -version = 2.2 -description = Calculations for the position of the sun and moon. -description-file = README.rst -keywords = sun, moon, sunrise, sunset, dawn, dusk - -author = Simon Kennedy -author-email = sffjunkie+code@gmail.com - -home-page = https://github.com/sffjunkie/astral -license = Apache-2.0 -classifiers= - Intended Audience :: Developers - Programming Language :: Python - Programming Language :: Python :: 3 :: Only - Programming Language :: Python :: 3.6 - Programming Language :: Python :: 3.7 - Programming Language :: Python :: 3.8 - Programming Language :: Python :: 3.9 - -project_urls = - Documentation = https://astral.readthedocs.io/en/stable/index.html - Source = https://github.com/sffjunkie/astral - Issues = https://github.com/sffjunkie/astral/issues - -[options] -zip_safe = True -package_dir= - =src -packages = astral -python_requires = >=3.6 -install_requires = - pytz - dataclasses;python_version=="3.6" -tests_require = - freezegun - pytest==5.0.1 - tox diff --git a/setup.py b/setup.py deleted file mode 100644 index 1f68e9b..0000000 --- a/setup.py +++ /dev/null @@ -1,20 +0,0 @@ -# Copyright 2009-2021, Simon Kennedy, sffjunkie+code@gmail.com - -import io -import os -from setuptools import setup - -import monkeypatch # noqa: F401 - - -def read_contents(*names, **kwargs): - return io.open(os.path.join(*names), encoding=kwargs.get("encoding", "utf8")).read() - - -description = "Calculations for the position of the sun and moon." -try: - long_description = read_contents(os.path.dirname(__file__), "README.rst") -except: # noqa - long_description = description - -setup(long_description=long_description) diff --git a/src/docs/Makefile b/src/docs/Makefile deleted file mode 100644 index 57fc27e..0000000 --- a/src/docs/Makefile +++ /dev/null @@ -1,177 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yyryr.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yyryr.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/yyryr" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yyryr" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/src/docs/SConstruct b/src/docs/SConstruct deleted file mode 100644 index 48de68f..0000000 --- a/src/docs/SConstruct +++ /dev/null @@ -1,297 +0,0 @@ -""" -This is a generic SCons script for running Sphinx (http://sphinx.pocoo.org). - -Type 'scons -h' for help. This prints the available build targets on your -system, and the configuration options you can set. - -If you set the 'cache' option, the option settings are cached into a file -called '.sconsrc-sphinx' in the current directory. When running -subsequently, this file is reread. A file with this name is also read from -your home directory, if it exists, so you can put global settings there. - -The script looks into your 'conf.py' file for information about the -project. This is used in various places (e.g., to print the introductory -message, and create package files). - -Here's some examples. To build HTML docs: - - scons html - -To create a package containing HTML and PDF docs, remembering the 'install' -setting: - - scons install=html,pdf cache=True package - -To clean up everything: - - scons -c all -""" - -# Script info. -__author__ = "Glenn Hutchings" -__email__ = "zondo42@googlemail.com" -__url__ = "http://bitbucket.org/zondo/sphinx-scons" -__license__ = "BSD" -__version__ = "0.4" - -import sys, os -import runpy - -# Build targets. -targets = ( - ("html", "make standalone HTML files"), - ("dirhtml", "make HTML files named index.html in directories"), - ("pickle", "make pickle files"), - ("json", "make JSON files"), - ("htmlhelp", "make HTML files and a HTML help project"), - ("qthelp", "make HTML files and a qthelp project"), - ("devhelp", "make HTML files and a GNOME DevHelp project"), - ("epub", "make HTML files and an EPUB file for bookreaders"), - ("latex", "make LaTeX sources"), - ("texinfo", "make Texinfo sources"), - ("text", "make text file for each RST file"), - ("pdf", "make PDF file from LaTeX sources"), - ("ps", "make PostScript file from LaTeX sources"), - ("dvi", "make DVI file from LaTeX sources"), - ("changes", "make an overview over all changed/added/deprecated items"), - ("linkcheck", "check all external links for integrity"), - ("doctest", "run all doctests embedded in the documentation if enabled"), - ("source", "run a command to generate the reStructuredText source"), -) - -# LaTeX builders. -latex_builders = {"pdf": "PDF", "ps": "PostScript", "dvi": "DVI"} - -# List of target names. -targetnames = [name for name, desc in targets] - -# Configuration cache filename. -cachefile = ".sconsrc-sphinx" - -# User cache file. -homedir = os.path.expanduser('~') -usercache = os.path.join(homedir, cachefile) - -# Configuration options. -config = Variables([usercache, cachefile], ARGUMENTS) - -config.AddVariables( - EnumVariable("default", "default build target", "html", targetnames), - PathVariable("config", "sphinx configuration file", "conf.py"), - PathVariable("srcdir", "source directory", ".", - PathVariable.PathIsDir), - PathVariable("builddir", "build directory", "build", - PathVariable.PathIsDirCreate), - PathVariable("doctrees", "place to put doctrees", None, - PathVariable.PathAccept), - EnumVariable("paper", "LaTeX paper size", None, - ["a4", "letter"], ignorecase = False), - ("tags", "comma-separated list of 'only' tags", None), - ("builder", "program to run to build things", "sphinx-build"), - ("opts", "extra builder options to use", None), - ListVariable("install", "targets to install", ["html"], targetnames), - PathVariable("instdir", "installation directory", "/usr/local/doc", - PathVariable.PathAccept), - EnumVariable("pkgtype", "package type to build with 'scons package'", - "zip", ["zip", "targz", "tarbz2"], ignorecase = False), - BoolVariable("cache", "whether to cache settings in %s" % cachefile, False), - BoolVariable("debug", "debugging flag", False), - ("genrst", "Command to regenerate reStructuredText source", None), -) - -# Create a new environment, inheriting PATH to find builder program. Also -# force LaTeX instead of TeX, since the .tex file won't exist at the right -# time to check which one to use. -env = Environment(ENV = {"PATH" : os.environ["PATH"]}, - TEX = "latex", PDFTEX = "pdflatex", - tools = ['default', 'packaging'], - variables = config) -if 'PYTHONPATH' in os.environ: - env['ENV']['PYTHONPATH'] = os.environ['PYTHONPATH'] - -# Get configuration values from environment. -sphinxconf = env["config"] -builder = env["builder"] -default = env["default"] - -srcdir = env["srcdir"] -builddir = env["builddir"] -doctrees = env.get("doctrees", os.path.join(builddir, "doctrees")) - -cache = env["cache"] -debug = env["debug"] - -options = env.get("opts", None) -paper = env.get("paper", None) -tags = env.get("tags", None) -genrst = env.get("genrst", None) - -instdir = env["instdir"] -install = env["install"] -pkgtype = env["pkgtype"] - -# Dump internals if debugging. -if debug: - print "Environment:" - print env.Dump() - -# Get parameters from Sphinx config file. -#sphinxparams = {} -#execfile(sphinxconf, sphinxparams) -sphinxparams = runpy.run_path(sphinxconf) - -project = sphinxparams["project"] -release = sphinxparams["release"] -copyright = sphinxparams["copyright"] - -try: - texfilename = sphinxparams["latex_documents"][0][1] -except KeyError: - texfilename = None - -name2tag = lambda name: name.replace(" ", "-").strip("()") -project_tag = name2tag(project) -release_tag = name2tag(release) -package_tag = project_tag.lower() + "-" + release_tag.lower() - -# Build project description string. -description = "%(project)s, release %(release)s, " \ - "copyright %(copyright)s" % locals() - -Help(description + "\n\n") -help_format = " %-10s %s\n" - -# Print banner if required. -if not any(map(GetOption, ("silent", "clean", "help"))): - print - print "This is", description - print - -# Build sphinx command-line options. -opts = [] - -if tags: - opts.extend(["-t %s" % tag for tag in tags.split(",")]) - -if paper: - opts.append("-D latex_paper_size=%s" % paper) - -if options: - opts.append(options) - -options = " ".join(opts) - -# Build Sphinx command template. -sphinxcmd = """ -%(builder)s -b %(name)s -d %(doctrees)s %(options)s %(srcdir)s %(targetdir)s -""".strip() - -# Set up LaTeX input builder if required. -if texfilename: - latexdir = Dir("latex", builddir) - texinput = File(texfilename, latexdir) - env.SideEffect(texinput, "latex") - env.NoClean(texinput) - -# Add build targets. -Help("Build targets:\n\n") - -if genrst != None: - source = env.Command('source', [], genrst, chdir = True) - env.AlwaysBuild(source) - env.Depends(srcdir, source) -else: - source = env.Command( - 'source', [], - '@echo "No reStructuredText generator (genrst) given."') - -for name, desc in targets: - target = Dir(name, builddir) - targetdir = str(target) - - if name == 'source': - pass - elif name not in latex_builders: - # Standard Sphinx target. - targets = env.Command(name, sphinxconf, - sphinxcmd % locals(), chdir = True) - env.Depends(targets, source) - env.AlwaysBuild(name) - env.Alias(target, name) - elif texinput: - # Target built from LaTeX sources. - try: - buildfunc = getattr(env, latex_builders[name]) - except AttributeError: - continue - - filename = project_tag + "." + name - outfile = File(filename, latexdir) - - targets = buildfunc(outfile, texinput) - env.Depends(targets, source) - - # Copy built file to separate directory. - target = File(filename, target) - env.Command(target, outfile, Move(target, outfile), chdir = True) - - env.Alias(name, target) - else: - continue - - env.Clean(name, [target]) - env.Clean('all', target) - - if name == default: desc += " (default)" - Help(help_format % (name, desc)) - -Clean('all', doctrees) -Default(default) - -# Add installation targets and collect package sources. -Help("\nOther targets:\n\n") - -Help(help_format % ("install", "install documentation")) -projectdir = os.path.join(instdir, project_tag) -sources = [] - -for name in install: - source = Dir(name, builddir) - sources.append(source) - - inst = env.Install(projectdir, source) - env.Alias('install', inst) - - for node in env.Glob(os.path.join(str(source), '*')): - filename = str(node).replace(builddir + os.path.sep, "") - dirname = os.path.dirname(filename) - dest = os.path.join(projectdir, dirname) - inst = env.Install(dest, node) - env.Alias('install', inst) - -# Add uninstall target. -env.Command('uninstall', None, Delete(projectdir), chdir = True) -Help(help_format % ("uninstall", "uninstall documentation")) - -# Add package builder. -packageroot = "-".join([project_tag, release_tag]) -archive, package = env.Package(NAME = project_tag, VERSION = release, - PACKAGEROOT = packageroot, - PACKAGETYPE = pkgtype, - source = sources) - -env.AlwaysBuild(archive) -env.AddPostAction(archive, Delete(packageroot)) -Help(help_format % ("package", "build documentation package")) - -env.Clean('all', archive) - -# Add config settings to help. -Help("\nConfiguration variables:") -for line in config.GenerateHelpText(env).split("\n"): - Help("\n " + line) - -# Save local configuration if required. -if cache: - config.Update(env) - config.Save(cachefile, env) diff --git a/src/docs/conf.py b/src/docs/conf.py deleted file mode 100644 index 8c248ab..0000000 --- a/src/docs/conf.py +++ /dev/null @@ -1,210 +0,0 @@ -# -*- coding: utf-8 -*- -import os -import sys - -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -# http://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules -autodoc_mock_imports = ["pytz"] -# MOCK_MODULES = ["pytz"] -# if MOCK_MODULES and on_rtd: -# from unittest.mock import MagicMock - -# class Mock(MagicMock): -# @classmethod -# def __getattr__(cls, name): -# return Mock() - -# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) - -# region General configuration ---------------------------------------------------- - -project = "Astral" -author = "Simon Kennedy" -copyright = "2009-2020, %s" % author -version = "2.2" -release = "2.2" - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.napoleon"] - -# intersphinx_mapping = {"python": ("http://docs.python.org/3", None)} -intersphinx_mapping = {"python": ("http://docs.python.org/3", "python3_intersphinx.inv")} - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.join(os.path.abspath(".."))) - -# The suffix of source filenames. -source_suffix = ".rst" - -# The encoding of source files. -# source_encoding = 'utf-8' - -# The master toctree document. -master_doc = "index" - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["templates"] -# endregion - -# region Options for HTML output --------------------------------------------------- - -if not on_rtd: - project_home = os.environ.get("PROJECT_HOME", None) - if not project_home: - dev_home = os.environ.get("DEV_HOME", None) - if dev_home: - project_home = os.path.join(os.path.expanduser(dev_home), "projects") - else: - project_home = os.path.expanduser(project_home) - - html_theme = None - if project_home: - theme_root = os.path.relpath(os.path.join(project_home, "themes", "sphinx")) - if os.path.exists(theme_root): - html_theme_path = [theme_root] - html_theme = "sffjunkie" - - if not html_theme: - html_theme = "traditional" -# else: -# html_theme = "basic" - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = os.path.join("static", "earth_sun.png") - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -if not on_rtd: - html_favicon = os.path.join('static', 'weather-sunny.png') - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["static"] - -html_css_files = [ - 'astral.css', -] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -html_domain_indices = False - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' -# endregion - -# region Options for HTML Help output -------------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = "AstralDoc" -# endregion - -# region Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'a4' -latex_elements = {"papersize": "a4"} - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [("index", "Astral.tex", "Astral v%s" % release, author, "manual")] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_use_modindex = True -# endregion diff --git a/src/docs/index.rst b/src/docs/index.rst deleted file mode 100644 index ee71ce1..0000000 --- a/src/docs/index.rst +++ /dev/null @@ -1,735 +0,0 @@ -.. Copyright 2009-2021, Simon Kennedy, sffjunkie+code@gmail.com - -.. Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - -.. http://www.apache.org/licenses/LICENSE-2.0 - -.. Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -.. TODO: Spatial reference system - WGS-84? - -.. TODO: Add note about accuracy - -.. TODO: Add note that 0.833 is half sun's disc + refraction adjustment - -Astral v\ |release| -=================== - -| |travis_status| |pypi_ver| - -Astral is a python package for calculating the times of various aspects of -the sun and phases of the moon. - -It can calculate the following - -Dawn - The time in the morning when the sun is a specific number of degrees - below the horizon. - -Sunrise - The time in the morning when the top of the sun breaks the horizon - (asuming a location with no obscuring features.) - -Noon - The time when the sun is at its highest point directly above the observer. - -Midnight - The time when the sun is at its lowest point. - -Sunset - The time in the evening when the sun is about to disappear below the - horizon (asuming a location with no obscuring features.) - -Dusk - The time in the evening when the sun is a specific number of degrees - below the horizon. - -Daylight - The time when the sun is up i.e. between sunrise and sunset - -Night - The time between astronomical dusk of one day and astronomical dawn of the - next - -Twilight - The time between dawn and sunrise or between sunset and dusk - -The Golden Hour - The time when the sun is between 4 degrees below the horizon and 6 degrees - above. - -The Blue Hour - The time when the sun is between 6 and 4 degrees below the horizon. - -Time At Elevation - the time when the sun is at a specific elevation for either a rising or a - setting sun. - -Solar Azimuth - The number of degrees clockwise from North at which the sun can be seen - -Solar Zenith - The angle of the sun down from directly above the observer - -Solar Elevation - The number of degrees up from the horizon at which the sun can be seen - -`Rahukaalam`_ - "Rahukaalam or the period of Rahu is a certain amount of time every day - that is considered inauspicious for any new venture according to Indian - Vedic astrology". - -Moon Phase - The phase of the moon for a specified date. - -Astral also comes with a geocoder containing a local database that allows you -to look up information for a small set of locations (`new locations can be -added `__). - -.. note:: - - The Google Geocoder has been removed. Instead you should use the - Google Client for Google Maps Services - https://github.com/googlemaps/google-maps-services-python - -Examples -======== - -The following examples demonstrates some of the functionality available in the -module - -Sun ----- - -.. code-block:: python - - >>> from astral import LocationInfo - >>> city = LocationInfo("London", "England", "Europe/London", 51.5, -0.116) - >>> print(( - f"Information for {city.name}/{city.region}\n" - f"Timezone: {city.timezone}\n" - f"Latitude: {city.latitude:.02f}; Longitude: {city.longitude:.02f}\n" - )) - - Information for London/England - Timezone: Europe/London - Latitude: 51.50; Longitude: -0.12 - - >>> import datetime - >>> from astral.sun import sun - >>> s = sun(city.observer, date=datetime.date(2009, 4, 22)) - >>> print(( - f'Dawn: {s["dawn"]}\n' - f'Sunrise: {s["sunrise"]}\n' - f'Noon: {s["noon"]}\n' - f'Sunset: {s["sunset"]}\n' - f'Dusk: {s["dusk"]}\n' - )) - Dawn: 2009-04-22 04:13:04.923309+00:00 - Sunrise: 2009-04-22 04:50:16.515411+00:00 - Noon: 2009-04-22 11:59:02+00:00 - Sunset: 2009-04-22 19:08:41.215821+00:00 - Dusk: 2009-04-22 19:46:06.362457+00:00 - -.. note:: - - The example above calculates the times of the sun in the UTC timezone. - If you want to return times in a different timezone you can pass the - tzinfo parameter to the function. - - .. code-block:: python - - s = sun(city.observer, date=datetime.date(2009, 4, 22), tzinfo=city.timezone) - - In versions prior to 2.2 you'll need to pass a pytz timezone as tzinfo e.g. - - .. code-block:: python - - s = sun(city.observer, - date=datetime.date(2009, 4, 22), - tzinfo=pytz.timezone(city.timezone)) - -Moon ----- - -.. code-block:: python - - >>> import datetime - >>> from astral import moon - >>> moon.phase(datetime.date(2018, 1, 1)) - 13.255666666666668 - -The moon phase method returns an number describing the phase, where the value -is between 0 and 27.99. The following lists the mapping of various values to -the description of the phase of the moon. - -============ ============== -0 .. 6.99 New moon -7 .. 13.99 First quarter -14 .. 20.99 Full moon -21 .. 27.99 Last quarter -============ ============== - -If for example the number returned was 27.99 then the moon would be almost at -the New Moon phase, and if it was 24.00 it would be half way between the Last -Quarter and a New Moon. - -.. note :: - - The moon phase does not depend on your location. However what the moon - actually looks like to you does depend on your location. If you're in the - southern hemisphere it looks different than if you were in the northern - hemisphere. - - See http://moongazer.x10.mx/website/astronomy/moon-phases/ for an example. - - For an example of using this library to generate moon phases including the - names in various languages and the correct Unicode glyphs see the - `project by PanderMusubi `_ - on Github. - -Geocoder --------- - -.. code-block:: python - - >>> from astral.geocoder import database, lookup - >>> lookup("London", database()) - LocationInfo(name='London', region='England', timezone='Europe/London', - latitude=51.473333333333336, longitude=-0.0008333333333333334) - -.. note:: - - Location elevations have been removed from the database. These were added - due to a misunderstanding of the affect of elevation on the times of the - sun. These are not required for the calculations, only the elevation of the - observer above/below the location is needed. - - See `Effect of Elevation`_ below. - -Custom Location -~~~~~~~~~~~~~~~ - -If you only need a single location that is not in the database then you can -construct a :class:`~astral.LocationInfo` and fill in the values, either on -initialization - -.. code-block:: python - - from astral import LocationInfo - l = LocationInfo('name', 'region', 'timezone/name', 0.1, 1.2) - -or set the attributes after initialization:: - - from astral import LocationInfo - l = LocationInfo() - l.name = 'name' - l.region = 'region' - l.timezone = 'US/Central' - l.latitude = 0.1 - l.longitude = 1.2 - -.. note:: - - `name` and `region` can be anything you like. - -.. _additional_locations: - -Additional Locations -~~~~~~~~~~~~~~~~~~~~ - -You can add to the list of available locations using the -:func:`~astral.geocoder.add_locations` function and passing either a string -with one line per location or by passing a list containing strings, lists or -tuples (lists and tuples are passed directly to the LocationInfo constructor). - -.. code-block:: python - - >>> from astral.geocoder import add_locations, database, lookup - >>> db = database() - >>> try: - ... lookup("Somewhere", db) - ... except KeyError: - ... print("Somewhere not found") - ... - Somewhere not found - >>> add_locations("Somewhere,Secret Location,UTC,24°28'N,39°36'E", db) - >>> lookup("Somewhere", db) - LocationInfo(name='Somewhere', region='Secret Location', timezone='UTC', - latitude=24.466666666666665, longitude=39.6) - -Timezone Groups -~~~~~~~~~~~~~~~ - -Timezone groups such as Europe can be accessed via the :func:`group` function -in the :mod:`~astral.geocoder` module - -.. code-block:: python - - >>> from astral.geocoder import group - >>> europe = group("europe") - >>> sorted(europe.keys()) - ['aberdeen', 'amsterdam', 'andorra_la_vella', 'ankara', 'athens', ...] - - -Effect of Elevation -=================== - -Times Of The Sun ----------------- - -The times of the sun that you experience depend on what obscurs your view of -it. It may either be obscured by the horizon or some other geographical -feature (e.g. mountains) - -1. If what obscures you at ground level is the horizon and you are at a - elevation above ground level then the times of the sun depends on how far - further round the earth you can see due to your elevation (the sun rises - earlier and sets later). - - The extra angle you can see round the earth is determined by calculating the - angle α in the image below based on your elevation above ground level, - and adding this to the depression angle for the sun calculations. - - .. image:: static/elevation_horizon.svg - :class: adjustment - -2. If your view is obscured by some other geographical feature than the - horizon, then the adjustment angle is based on how far you are above or - below the feature and your distance to it. - -For the first case i.e. obscured by the horizon you need to pass a single float -to the Observer as its elevation. For the second case pass a tuple of 2 -floats. The first being the vertical distance to the top of the feature and -the second the horizontal distance to the feature. - -Elevation Of The Sun --------------------- - -Even though an observer's elevation can significantly affect the times of the -sun the same is not true for the elevation angle from the observer to the sun. - -As an example the diagram below shows the difference in angle between an -observer at ground level and one on the ISS orbiting 408 km above the earth. - -.. image:: static/elevation_sun.svg - :class: adjustment - -The largest difference between the two angles is when the angle at ground -level is 1 degree. The difference then is approximately 0.15 degrees. - -At the summit of mount Everest (8,848 m) the maximum difference is -0.00338821 degrees. - -Due to the very small difference the astral package does not currently adjust -the solar elevation for changes in observer elevation. - -Effect of Refraction -==================== - -When viewing the sun the position you see it at is different from its actual -position due to the effect of atmospheric `refraction`_ which -makes the sun appear to be higher in the sky. The calculations in the -package take this refraction into account. - -The :func:`~astral.sun.sunrise` and :func:`~astral.sun.sunset` functions -use the refraction at an angle when the sun is half of its apparent diameter -below the horizon. This is between about 30 and 32 arcminutes and for the -astral package a value of 32" is used. - -.. note:: - - The refraction calculation does not take into account - temperature and pressure which can affect the angle of refraction. - -Note on Localized Timezones -=========================== - -When creating a datetime object in a specific timezone do not use the -`tzinfo` parameter to the datetime constructor. Instead use the -:meth:`~pytz.tzinfo.localize` method provided by pytz on the correct pytz -timezone:: - - >>> dt = datetime.datetime(2015, 1, 1, 9, 0, 0) - >>> pytz.timezone('Europe/London').localize(dt) - datetime.datetime(2015, 1, 1, 9, 0, tzinfo=) - - -License -======= - -This module is licensed under the terms of the `Apache`_ V2.0 license. - -Dependencies -============ - -Astral has one required external Python dependency on `pytz`. - -Installation -============ - -To install Astral you should use the `pip`_ tool:: - - pip3 install astral - -.. note:: - - Now that we are Python 3 only and pip provides a versioned executable on - Windows you should use the `pip3` command on all operating systems - to ensure you are targetting the right Python version. - -Cities -====== - -The module includes location and time zone data for the following cities. -The list includes all capital cities plus some from the UK. The list also -includes the US state capitals and some other US cities. - -Aberdeen, Abu Dhabi, Abu Dhabi, Abuja, Accra, Addis Ababa, Adelaide, Al Jubail, -Albany, Albuquerque, Algiers, Amman, Amsterdam, Anchorage, Andorra la Vella, -Ankara, Annapolis, Antananarivo, Apia, Ashgabat, Asmara, Astana, Asuncion, -Athens, Atlanta, Augusta, Austin, Avarua, Baghdad, Baku, Baltimore, Bamako, -Bandar Seri Begawan, Bangkok, Bangui, Banjul, Barrow-In-Furness, Basse-Terre, -Basseterre, Baton Rouge, Beijing, Beirut, Belfast, Belgrade, Belmopan, Berlin, -Bern, Billings, Birmingham, Birmingham, Bishkek, Bismarck, Bissau, -Bloemfontein, Bogota, Boise, Bolton, Boston, Bradford, Brasilia, Bratislava, -Brazzaville, Bridgeport, Bridgetown, Brisbane, Bristol, Brussels, Bucharest, -Bucuresti, Budapest, Buenos Aires, Buffalo, Bujumbura, Burlington, Cairo, -Canberra, Cape Town, Caracas, Cardiff, Carson City, Castries, Cayenne, -Charleston, Charlotte, Charlotte Amalie, Cheyenne, Chicago, Chisinau, -Cleveland, Columbia, Columbus, Conakry, Concord, Copenhagen, Cotonou, Crawley, -Dakar, Dallas, Damascus, Dammam, Denver, Des Moines, Detroit, Dhaka, Dili, -Djibouti, Dodoma, Doha, Douglas, Dover, Dublin, Dushanbe, Edinburgh, El Aaiun, -Fargo, Fort-de-France, Frankfort, Freetown, Funafuti, Gaborone, George Town, -Georgetown, Gibraltar, Glasgow, Greenwich, Guatemala, Hanoi, Harare, -Harrisburg, Hartford, Havana, Helena, Helsinki, Hobart, Hong Kong, Honiara, -Honolulu, Houston, Indianapolis, Islamabad, Jackson, Jacksonville, Jakarta, -Jefferson City, Jerusalem, Juba, Jubail, Juneau, Kabul, Kampala, Kansas City, -Kathmandu, Khartoum, Kiev, Kigali, Kingston, Kingston, Kingstown, Kinshasa, -Koror, Kuala Lumpur, Kuwait, La Paz, Lansing, Las Vegas, Leeds, Leicester, -Libreville, Lilongwe, Lima, Lincoln, Lisbon, Little Rock, Liverpool, Ljubljana, -Lome, London, Los Angeles, Louisville, Luanda, Lusaka, Luxembourg, Macau, -Madinah, Madison, Madrid, Majuro, Makkah, Malabo, Male, Mamoudzou, Managua, -Manama, Manchester, Manchester, Manila, Maputo, Maseru, Masqat, Mbabane, Mecca, -Medina, Melbourne, Memphis, Mexico, Miami, Milwaukee, Minneapolis, Minsk, -Mogadishu, Monaco, Monrovia, Montevideo, Montgomery, Montpelier, Moroni, -Moscow, Moskva, Mumbai, Muscat, N'Djamena, Nairobi, Nashville, Nassau, -Naypyidaw, New Delhi, New Orleans, New York, Newark, Newcastle, Newcastle Upon -Tyne, Ngerulmud, Niamey, Nicosia, Norwich, Nouakchott, Noumea, Nuku'alofa, -Nuuk, Oklahoma City, Olympia, Omaha, Oranjestad, Orlando, Oslo, Ottawa, -Ouagadougou, Oxford, P'yongyang, Pago Pago, Palikir, Panama, Papeete, -Paramaribo, Paris, Perth, Philadelphia, Phnom Penh, Phoenix, Pierre, Plymouth, -Podgorica, Port Louis, Port Moresby, Port of Spain, Port-Vila, Port-au-Prince, -Portland, Portland, Porto-Novo, Portsmouth, Prague, Praia, Pretoria, Pristina, -Providence, Quito, Rabat, Raleigh, Reading, Reykjavik, Richmond, Riga, Riyadh, -Road Town, Rome, Roseau, Sacramento, Saint Helier, Saint Paul, Saint Pierre, -Saipan, Salem, Salt Lake City, San Diego, San Francisco, San Jose, San Juan, -San Marino, San Salvador, Sana, Sana'a, Santa Fe, Santiago, Santo Domingo, Sao -Tome, Sarajevo, Seattle, Seoul, Sheffield, Singapore, Sioux Falls, Skopje, -Sofia, Southampton, Springfield, Sri Jayawardenapura Kotte, St. George's, St. -John's, St. Peter Port, Stanley, Stockholm, Sucre, Suva, Swansea, Swindon, -Sydney, T'bilisi, Taipei, Tallahassee, Tallinn, Tarawa, Tashkent, Tbilisi, -Tegucigalpa, Tehran, Thimphu, Tirana, Tirane, Tokyo, Toledo, Topeka, Torshavn, -Trenton, Tripoli, Tunis, Ulaanbaatar, Ulan Bator, Vaduz, Valletta, Vienna, -Vientiane, Vilnius, Virginia Beach, W. Indies, Warsaw, Washington DC, -Wellington, Wichita, Willemstad, Wilmington, Windhoek, Wolverhampton, -Yamoussoukro, Yangon, Yaounde, Yaren, Yerevan, Zagreb - -US Cities ---------- - -Albany, Albuquerque, Anchorage, Annapolis, Atlanta, Augusta, Austin, Baltimore, -Baton Rouge, Billings, Birmingham, Bismarck, Boise, Boston, Bridgeport, -Buffalo, Burlington, Carson City, Charleston, Charlotte, Cheyenne, Chicago, -Cleveland, Columbia, Columbus, Concord, Dallas, Denver, Des Moines, Detroit, -Dover, Fargo, Frankfort, Harrisburg, Hartford, Helena, Honolulu, Houston, -Indianapolis, Jackson, Jacksonville, Jefferson City, Juneau, Kansas City, -Lansing, Las Vegas, Lincoln, Little Rock, Los Angeles, Louisville, Madison, -Manchester, Memphis, Miami, Milwaukee, Minneapolis, Montgomery, Montpelier, -Nashville, New Orleans, New York, Newark, Oklahoma City, Olympia, Omaha, -Orlando, Philadelphia, Phoenix, Pierre, Portland, Portland, Providence, -Raleigh, Richmond, Sacramento, Saint Paul, Salem, Salt Lake City, San Diego, -San Francisco, Santa Fe, Seattle, Sioux Falls, Springfield, Tallahassee, -Toledo, Topeka, Trenton, Virginia Beach, Wichita, Wilmington - -Thanks -====== - -The sun calculations in this module were adapted, for Python, from the -spreadsheets on the following page. - - | https://www.esrl.noaa.gov/gmd/grad/solcalc/calcdetails.html - -Refraction calculation is taken from - - | Sun-Pointing Programs and Their Accuracy - | John C. Zimmerman Of Sandia National Laboratones - | https://www.osti.gov/servlets/purl/6377969 - -Which cites the following as the original source - - | In Solar Energy Vol 20 No.5-C - | Robert Walraven Of The University Of California, Davis - -The moon phase calculation is based on some javascript code -from Sky and Telescope magazine - - | Moon-phase calculation - | Roger W. Sinnott, Sky & Telescope, June 16, 2006. - | http://www.skyandtelescope.com/wp-content/observing-tools/moonphase/moon.html - -Also to `Sphinx`_ for making doc generation an easy thing (not that the writing -of the docs is any easier.) - -Contact -======= - -Simon Kennedy - -Version History -=============== - -========== ==================================================================== -Version Description -========== ==================================================================== -2.2 Fix for `bug #48`_ - As per the bug report the angle to adjust for - the effect of elevation should have been θ (not α). - - The sun functions can now also be passed a timezone name as a - string. Previously only a pytz timezone was accepted. ----------- -------------------------------------------------------------------- -2.1 Fix for bug #44 - Incorrectly raised exception when UTC sun times - were on the day previous to the day asked for. Only manifested for - timezones with a large positive offset. ----------- -------------------------------------------------------------------- -2.0 This is a code refactor as well as an update so it is highly likely - that you will need to adapt your code to suit. - - Astral, AstralGeocoder & GoogleGeocoder classes removed - - Now only compatible with Python 3.6 and greater due to the - use of data classes - - New :class:`~astral.Observer` data class to store a latitude, - longitude & elevation - - New :class:`~astral.LocationInfo` data class to store a location - name, region, timezone, latitude & longitude - - Geocoder functions return a :class:`~astral.LocationInfo` instead - of a :class:`~astral.location.Location` - - All calculations now automatically adjust for refraction. - For elevation you can return the true angle by setting the - `with_refraction` parameter to False. - - The solar_noon and solar_midnight functions have been renamed to - :func:`~astral.sun.noon` and :func:`~astral.sun.midnight` - respectively. - - Rahukaalam can now be calculated for night times. ----------- -------------------------------------------------------------------- -1.10.1 Keyword args are now passed to the geocoder class from Astral - __init__ in order to allow the Google Maps API key to be passed to - the GoogleGeocoder. ----------- -------------------------------------------------------------------- -1.10 Added support to AstralGeocoder to add - `additional locations `__ - to the database. ----------- -------------------------------------------------------------------- -1.9.2 1.9 broke the sun_utc method. Sun UTC calculation passed incorrect - parameter to more specific methods e.g. sunrise, sunset etc. ----------- -------------------------------------------------------------------- -1.9.1 Correct version number in astral.py ----------- -------------------------------------------------------------------- -1.9 Now takes elevation into account. ----------- -------------------------------------------------------------------- -1.8 Location methods now allow the timezone to be None which returns all - times as UTC. - - Added command line interface to return 'sun' values ----------- -------------------------------------------------------------------- -1.7.1 Changed GoogleGeocoder test to not use raise...from as this is not - valid for Python 2 ----------- -------------------------------------------------------------------- -1.7 Requests is now only needed when using GoogleGeocoder - - GoogleGeocoder now requires the `api_key` parameter to be passed to - the constructor as Google now require it for their API calls. ----------- -------------------------------------------------------------------- -1.6.1 Updates for Travis CI integration / Github signed release. ----------- -------------------------------------------------------------------- -1.6 Added api_key parameter to the GoogleGeocoder :meth:`__init__` - method ----------- -------------------------------------------------------------------- -1.5 Added parameter `rtype` to :meth:`moon_phase` to determine the - return type of the method. - - Added example for calculating the phase of the moon. ----------- -------------------------------------------------------------------- -1.4.1 Using versioneer to manage version numbers ----------- -------------------------------------------------------------------- -1.4 Changed to use calculations from NOAA spreadsheets - - Changed some exception error messages for when sun does not reach - a requested elevation. - - Added more tests ----------- -------------------------------------------------------------------- -1.3.4 Changes to project configuration files. No user facing changes. ----------- -------------------------------------------------------------------- -1.3.3 Fixed call to twilight_utc as date and direction parameters - were reversed. ----------- -------------------------------------------------------------------- -1.3.2 Updated URL to point to gitgub.com - - Added Apache 2.0 boilerplate to source file ----------- -------------------------------------------------------------------- -1.3.1 Added LICENSE file to sdist ----------- -------------------------------------------------------------------- -1.3 Corrected solar zenith to return the angle from the vertical. - - Added solar midnight calculation. ----------- -------------------------------------------------------------------- -1.2 Added handling for when unicode literals are used. This may possibly - affect your code if you're using Python 2 (there are tests for this - but they may not catch all uses.) (Bug `1588198`_\) - - Changed timezone for Phoenix, AZ to America/Phoenix - (Bug `1561258`_\) ----------- -------------------------------------------------------------------- -1.1 Added methods to calculate Twilight, the Golden Hour and the Blue - Hour. ----------- -------------------------------------------------------------------- -1.0 It's time for a version 1.0 - - Added examples where the location you want is not in the Astral - geocoder. ----------- -------------------------------------------------------------------- -0.9 Added a method to calculate the date and time when the sun is at a - specific elevation, for either a rising or a setting sun. - - Added daylight and night methods to Location and Astral classes. - - Rahukaalam methods now return a tuple. ----------- -------------------------------------------------------------------- -0.8.2 Fix for moon phase calcualtions which were off by 1. - - Use pytz.timezone().localize method instead of passing tzinfo - parameter to datetime.datetime. See the `pytz docs`_ for info ----------- -------------------------------------------------------------------- -0.8.1 Fix for bug `1417641`_\: :meth:`~astral.Astral.solar_elevation` and - :meth:`~astral.Astral.solar_azimuth` fail when a naive - :class:`~datetime.datetime` object is used. - - Added :meth:`solar_zenith` methods to :class:`~astral.Astral` - and :class:`~astral.Location` as an - alias for :meth:`solar_elevation` - - Added `tzinfo` as an alias for `tz` ----------- -------------------------------------------------------------------- -0.8 Fix for bug `1407773`_\: Moon phase calculation changed to remove - time zone parameter (tz) as it is not required for the calculation. ----------- -------------------------------------------------------------------- -0.7.5 Fix for bug `1402103`_\: Buenos Aires incorrect timezone ----------- -------------------------------------------------------------------- -0.7.4 Added Canadian cities from Yip Shing Ho ----------- -------------------------------------------------------------------- -0.7.3 Fix for bug `1239387`_ submitted by Torbjörn Lönnemark ----------- -------------------------------------------------------------------- -0.7.2 Minor bug fix in :class:`~astral.GoogleGeocoder`. location name and - region are now stripped of whitespace ----------- -------------------------------------------------------------------- -0.7.1 Bug fix. Missed a vital return statement in the - :class:`~astral.GoogleGeocoder` ----------- -------------------------------------------------------------------- -0.7 Added ability to lookup location information from - Google's mapping APIs (see :class:`~astral.GoogleGeocoder`) - - Renamed :class:`City` class to :class:`~astral.Location` - - Renamed :class:`CityDB` to :class:`~astral.AstralGeocoder` - - Added elevations of cities to database and property to - obtain elevation from :class:`~astral.Location` class ----------- -------------------------------------------------------------------- -0.6.2 Added various cities to database as per - https://bugs.launchpad.net/astral/+bug/1040936 ----------- -------------------------------------------------------------------- -0.6.1 Docstrings were not updated to match changes to code. - - Other minor docstring changes made ----------- -------------------------------------------------------------------- -0.6 Fix for bug `884716`_ submitted by Martin Heemskerk - regarding moon phase calculations - - Fixes for bug report `944754`_ submitted by Hajo Werder - - - Changed co-ordinate system so that eastern longitudes - are now positive - - Added solar_depression property to City class ----------- -------------------------------------------------------------------- -0.5 Changed :class:`City` to accept unicode name and country. - - Moved city information into a database class :class:`CityDB` - - Added attribute access to database for timezone groups ----------- -------------------------------------------------------------------- -0.4 Duplicate city names could not be accessed. - - Sun calculations for some cities failed with times - outside valid ranges. - - Fixes for city data. - - Added calculation for moon phase. ----------- -------------------------------------------------------------------- -0.3 Changed to `Apache`_ V2.0 license. - - Fix for bug `555508`_ submitted by me. - - US state capitals and other cities added. ----------- -------------------------------------------------------------------- -0.2 Fix for bug `554041`_ submitted by Derek\_ / John Dimatos ----------- -------------------------------------------------------------------- -0.1 First release -========== ==================================================================== - -.. _Rahukaalam: http://en.wikipedia.org/wiki/Rahukaalam -.. _Sourceforge: http://pytz.sourceforge.net/ -.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall -.. _Apache: http://www.opensource.org/licenses/apache2.0.php -.. _Sphinx: http://sphinx.pocoo.org/ -.. _554041: https://bugs.launchpad.net/astral/+bug/554041 -.. _555508: https://bugs.launchpad.net/astral/+bug/555508 -.. _884716: https://bugs.launchpad.net/astral/+bug/884716 -.. _944754: https://bugs.launchpad.net/astral/+bug/944754 -.. _1239387: https://bugs.launchpad.net/astral/+bug/1239387 -.. _1402103: https://bugs.launchpad.net/astral/+bug/1402103 -.. _1407773: https://bugs.launchpad.net/astral/+bug/1407773 -.. _1417641: https://bugs.launchpad.net/astral/+bug/1417641 -.. _1561258: https://bugs.launchpad.net/astral/+bug/1561258 -.. _1588198: https://bugs.launchpad.net/astral/+bug/1588198 -.. _pytz docs: http://pytz.sourceforge.net/#localized-times-and-date-arithmetic -.. _issue: https://github.com/sffjunkie/astral/issues -.. _refraction: https://en.wikipedia.org/wiki/Refraction -.. _pip: https://pip.pypa.io/en/stable/ -.. _bug #48: https://github.com/sffjunkie/astral/issues/48 - -.. |travis_status| image:: https://travis-ci.org/sffjunkie/astral.svg?branch=master - :target: https://travis-ci.org/sffjunkie/astral - -.. |pypi_ver| image:: https://img.shields.io/pypi/v/astral.svg - :target: https://pypi.org/project/astral/ - -.. toctree:: - :maxdepth: 2 - :hidden: - - package diff --git a/src/docs/make.bat b/src/docs/make.bat deleted file mode 100644 index ba664e4..0000000 --- a/src/docs/make.bat +++ /dev/null @@ -1,244 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=..\..\build\sphinx -set SOURCEDIR=. - -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% %SOURCEDIR% -set I18NSPHINXOPTS=%SPHINXOPTS% %SOURCEDIR% -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%\html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%\dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%\singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%\htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%\qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\yyryr.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\yyryr.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%\epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%\latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%\latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%\latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%\text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%\man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%\texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%\locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%\changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%\linkcheck\output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%\doctest\output.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%\xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%\pseudoxml. - goto end -) - -:end diff --git a/src/docs/package.rst b/src/docs/package.rst deleted file mode 100644 index 1eda343..0000000 --- a/src/docs/package.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. Copyright 2009-2021, Simon Kennedy, sffjunkie+code@gmail.com - -.. Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - -.. http://www.apache.org/licenses/LICENSE-2.0 - -.. Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -The :mod:`astral` Package -========================= - -.. automodule:: astral - :members: - -astral.sun -~~~~~~~~~~~ - -.. automodule:: astral.sun - :members: - -astral.moon -~~~~~~~~~~~ - -.. automodule:: astral.moon - :members: - -astral.geocoder -~~~~~~~~~~~~~~~ - -.. automodule:: astral.geocoder - :members: - -astral.location -~~~~~~~~~~~~~~~ - -.. autoclass:: astral.location.Location - :members: diff --git a/src/docs/python3_intersphinx.inv b/src/docs/python3_intersphinx.inv deleted file mode 100644 index a08de13..0000000 Binary files a/src/docs/python3_intersphinx.inv and /dev/null differ diff --git a/src/docs/static/astral.css b/src/docs/static/astral.css deleted file mode 100644 index 80bfbb0..0000000 --- a/src/docs/static/astral.css +++ /dev/null @@ -1,3 +0,0 @@ -img.adjustment { - margin: 1rem 1.5rem; -} diff --git a/src/docs/static/earth_sun.png b/src/docs/static/earth_sun.png deleted file mode 100644 index 4443720..0000000 Binary files a/src/docs/static/earth_sun.png and /dev/null differ diff --git a/src/docs/static/elevation_horizon.svg b/src/docs/static/elevation_horizon.svg deleted file mode 100644 index 256a4a1..0000000 --- a/src/docs/static/elevation_horizon.svg +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - c=r+elevation - θ - - A - b=r - - θ = arccos(r/(r+elevation)) - B - - C - - θ - - - diff --git a/src/docs/static/elevation_sun.svg b/src/docs/static/elevation_sun.svg deleted file mode 100644 index 9fbb8bd..0000000 --- a/src/docs/static/elevation_sun.svg +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - ISS elevation = 408 kmdistance to sun = 149,600,000 km - Θ1 - - - - Θ2 - - - Sun - ground - X - Y2 - Y1 - - - - - X = distance to sun * sin(Θ1)Y1 = distance to sun * cos(Θ1)Y2 = Y1 - ISS elevationΘ2 = tan-1(Y2 / X)Θ1=1, Θ2=0.8437, Δ=0.1562Θ1=45, Θ2=44.8892, Δ=0.1107 - ISS - - diff --git a/src/docs/static/weather-sunny.png b/src/docs/static/weather-sunny.png deleted file mode 100644 index b9a27fe..0000000 Binary files a/src/docs/static/weather-sunny.png and /dev/null differ diff --git a/src/git-hooks/pre-commit b/src/git-hooks/pre-commit deleted file mode 100644 index 790c3bd..0000000 --- a/src/git-hooks/pre-commit +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/env sh -branch="$(git rev-parse --abbrev-ref HEAD)" - -if [ "$branch" = "master" ]; then - echo "You can't commit directly to master branch" - exit 1 -fi - -flake8 --append-config=setup-dev.cfg src/astral diff --git a/sun.go b/sun.go new file mode 100644 index 0000000..a2ffca9 --- /dev/null +++ b/sun.go @@ -0,0 +1,893 @@ +package astral + +import ( + "errors" + "fmt" + "math" + "time" +) + +// Using 32 arc minutes as sun's apparent diameter +const sunApperentRadius = 32.0 / (60.0 * 2.0) + +func degrees(rad float64) float64 { + return rad * (180 / math.Pi) +} + +func radians(deg float64) float64 { + return deg * (math.Pi / 180) +} + +type SunDirection int + +const ( + SunDirectionRising SunDirection = 1 + SunDirectionSetting SunDirection = -1 +) + +const ( + DepressionCivil float64 = 6.0 + DepressionNautical float64 = 12.0 + DepressionAstronomical float64 = 18.0 +) + +type Observer struct { + Latitude float64 + Longitude float64 + Elevation float64 +} + +func julianday(date time.Time) float64 { + date = date.UTC() + // Calculate the Julian Day for the specified date// + var ( + y = float64(date.Year()) + m = float64(date.Month()) + d = float64(date.Day()) + ) + + if m <= 2 { + y -= 1 + m += 12 + } + + a := math.Floor(y / 100) + b := 2 - a + math.Floor(a/4) + jd := math.Floor(365.25*(y+4716)) + math.Floor(30.6001*(m+1)) + d + b - 1524.5 + + return jd +} + +// Convert a floating point number of minutes to a time.Duration +func minutes_to_timedelta(minutes float64) time.Duration { + nanoseconds := time.Duration(minutes * 60000000000) + return nanoseconds +} + +// Convert a Julian Day number to a Julian Century// +func jday_to_jcentury(julianday float64) float64 { + return (julianday - 2451545.0) / 36525.0 +} + +// Convert a Julian Century number to a Julian Day// +func jcentury_to_jday(juliancentury float64) float64 { + return (juliancentury * 36525.0) + 2451545.0 +} + +// Calculate the geometric mean longitude of the sun// +func geom_mean_long_sun(juliancentury float64) float64 { + l0 := 280.46646 + juliancentury*(36000.76983+0.0003032*juliancentury) + return math.Mod(l0, 360) +} + +// Calculate the geometric mean anomaly of the sun// +func geom_mean_anomaly_sun(juliancentury float64) float64 { + return 357.52911 + juliancentury*(35999.05029-0.0001537*juliancentury) +} + +// Calculate the eccentricity of Earth's orbit// +func eccentric_location_earth_orbit(juliancentury float64) float64 { + return 0.016708634 - juliancentury*(0.000042037+0.0000001267*juliancentury) +} + +// Calculate the equation of the center of the sun// +func sun_eq_of_center(juliancentury float64) float64 { + m := geom_mean_anomaly_sun(juliancentury) + + mrad := radians(m) + sinm := math.Sin(mrad) + sin2m := math.Sin(mrad + mrad) + sin3m := math.Sin(mrad + mrad + mrad) + + c := sinm*(1.914602-juliancentury*(0.004817+0.000014*juliancentury)) + sin2m*(0.019993-0.000101*juliancentury) + sin3m*0.000289 + return c +} + +// Calculate the sun's true longitude// +func sun_true_long(juliancentury float64) float64 { + l0 := geom_mean_long_sun(juliancentury) + c := sun_eq_of_center(juliancentury) + + return l0 + c +} + +// Calculate the sun's true anomaly// +func sun_true_anomoly(juliancentury float64) float64 { + m := geom_mean_anomaly_sun(juliancentury) + c := sun_eq_of_center(juliancentury) + + return m + c +} + +func sun_rad_vector(juliancentury float64) float64 { + v := sun_true_anomoly(juliancentury) + e := eccentric_location_earth_orbit(juliancentury) + + return (1.000001018 * (1 - e*e)) / (1 + e*math.Cos(radians(v))) +} + +func sun_apparent_long(juliancentury float64) float64 { + true_long := sun_true_long(juliancentury) + + omega := 125.04 - 1934.136*juliancentury + return true_long - 0.00569 - 0.00478*math.Sin(radians(omega)) +} + +func mean_obliquity_of_ecliptic(juliancentury float64) float64 { + seconds := 21.448 - juliancentury*(46.815+juliancentury*(0.00059-juliancentury*(0.001813))) + return 23.0 + (26.0+(seconds/60.0))/60.0 +} + +func obliquity_correction(juliancentury float64) float64 { + e0 := mean_obliquity_of_ecliptic(juliancentury) + + omega := 125.04 - 1934.136*juliancentury + return e0 + 0.00256*math.Cos(radians(omega)) +} + +// Calculate the sun's right ascension +func sun_rt_ascension(juliancentury float64) float64 { + oc := obliquity_correction(juliancentury) + al := sun_apparent_long(juliancentury) + + tananum := math.Cos(radians(oc)) * math.Sin(radians(al)) + tanadenom := math.Cos(radians(al)) + return degrees(math.Atan2(tananum, tanadenom)) +} + +// Calculate the sun's declination +func sun_declination(juliancentury float64) float64 { + e := obliquity_correction(juliancentury) + lambd := sun_apparent_long(juliancentury) + + sint := math.Sin(radians(e)) * math.Sin(radians(lambd)) + return degrees(math.Asin(sint)) +} + +func var_y(juliancentury float64) float64 { + epsilon := obliquity_correction(juliancentury) + y := math.Tan(radians(epsilon) / 2.0) + return y * y +} + +func eq_of_time(juliancentury float64) float64 { + l0 := geom_mean_long_sun(juliancentury) + e := eccentric_location_earth_orbit(juliancentury) + m := geom_mean_anomaly_sun(juliancentury) + + y := var_y(juliancentury) + + sin2l0 := math.Sin(2.0 * radians(l0)) + sinm := math.Sin(radians(m)) + cos2l0 := math.Cos(2.0 * radians(l0)) + sin4l0 := math.Sin(4.0 * radians(l0)) + sin2m := math.Sin(2.0 * radians(m)) + + Etime := y*sin2l0 - 2.0*e*sinm + 4.0*e*y*sinm*cos2l0 - 0.5*y*y*sin4l0 - 1.25*e*e*sin2m + + return degrees(Etime) * 4.0 +} + +// Calculate the hour angle of the sun +// +// See https://en.wikipedia.org/wiki/Hour_angle#Solar_hour_angle +// Args: +// latitude: The latitude of the obersver +// declination: The declination of the sun +// zenith: The zenith angle of the sun +// direction: The direction of traversal of the sun +// +// Raises: +// ValueError +// +func hour_angle(latitude float64, declination float64, zenith float64, direction SunDirection) (float64, error) { + latitude_rad := radians(latitude) + declination_rad := radians(declination) + zenith_rad := radians(zenith) + + // n := math.Cos(zenith_rad) + // d := math.Cos(latitude_rad) * math.Cos(declination_rad) + // t := math.Tan(latitude_rad) * math.Tan(declination_rad) + // h := (n / d) - t + + h := (math.Cos(zenith_rad) - math.Sin(latitude_rad)*math.Sin(declination_rad)) / (math.Cos(latitude_rad) * math.Cos(declination_rad)) + + HA := math.Acos(h) + if math.IsNaN(HA) { + return 0, errors.New("not able to determine hour angle") + } + if direction == SunDirectionSetting { + HA = -HA + } + return HA, nil +} + +// Calculate the extra degrees of depression that you can see round the earth +// due to the increase in elevation. +// Args: +// elevation: Elevation above the earth in metres +// Returns: +// A number of degrees to add to adjust for the elevation of the observer +// +func adjust_to_horizon(elevation float64) float64 { + + if elevation <= 0 { + return 0 + } + + r := 6356900.0 // radius of the earth + a1 := r + h1 := r + elevation + theta1 := math.Acos(a1 / h1) + return degrees(theta1) +} + +// Calculate the number of degrees to adjust for an obscuring feature +func adjust_to_obscuring_feature(elevation0, elevation1 float64) float64 { + if elevation0 == 0.0 { + return 0.0 + } + + sign := 1.0 + if elevation0 < 0.0 { + sign = -1 + } + + return sign * degrees(math.Acos(math.Abs(elevation0)/math.Sqrt(math.Pow(elevation0, 2)+math.Pow(elevation1, 2)))) +} + +// Calculate the degrees of refraction of the sun due to the sun's elevation. +func refraction_at_zenith(zenith float64) float64 { + + elevation := 90 - zenith + if elevation >= 85.0 { + return 0 + } + + refractionCorrection := 0.0 + te := math.Tan(radians(elevation)) + if elevation > 5.0 { + refractionCorrection = (58.1/te - 0.07/(te*te*te) + 0.000086/(te*te*te*te*te)) + } else if elevation > -0.575 { + step1 := -12.79 + elevation*0.711 + step2 := 103.4 + elevation*step1 + step3 := -518.2 + elevation*step2 + refractionCorrection = 1735.0 + elevation*step3 + } else { + refractionCorrection = -20.774 / te + } + refractionCorrection = refractionCorrection / 3600.0 + + return refractionCorrection +} + +// Calculate the time in the UTC timezone when the sun transits the specificed zenith +// Args: +// observer: An observer viewing the sun at a specific, latitude, longitude and elevation +// date: The date to calculate for +// zenith: The zenith angle for which to calculate the transit time +// direction: The direction that the sun is traversing +// Raises: +// ValueError if the zenith is not transitted by the sun +// Returns: +// the time when the sun transits the specificed zenith +func time_of_transit(observer Observer, date time.Time, zenith float64, direction SunDirection) (time.Time, error) { + latitude := observer.Latitude + if observer.Latitude > 89.8 { + latitude = 89.8 + } else if observer.Latitude < -89.8 { + latitude = -89.8 + } + + adjustment_for_elevation := 0.0 + if observer.Elevation > 0.0 { + adjustment_for_elevation = adjust_to_horizon(observer.Elevation) + } + + // TODO: + // if isinstance(observer.elevation, float) && observer.elevation > 0.0 { + // adjustment_for_elevation = adjust_to_horizon(observer.elevation) + if observer.Elevation > 0 { + adjustment_for_elevation = adjust_to_horizon(observer.Elevation) + } + // } else if isinstance(observer.elevation, tuple) { + // adjustment_for_elevation = adjust_to_obscuring_feature(observer.elevation) + // } + + adjustment_for_refraction := refraction_at_zenith(zenith + adjustment_for_elevation) + + jd := julianday(date) + t := jday_to_jcentury(jd) + solarDec := sun_declination(t) + + hourangle, err := hour_angle(latitude, solarDec, zenith+adjustment_for_elevation-adjustment_for_refraction, direction) + if err != nil { + return time.Time{}, err + } + + delta := -observer.Longitude - degrees(hourangle) + timeDiff := 4.0 * delta + timeUTC := 720.0 + timeDiff - eq_of_time(t) + + t = jday_to_jcentury(jcentury_to_jday(t) + timeUTC/1440.0) + solarDec = sun_declination(t) + hourangle, err = hour_angle(latitude, solarDec, zenith+adjustment_for_elevation+adjustment_for_refraction, direction) + if err != nil { + return time.Time{}, err + } + + delta = -observer.Longitude - degrees(hourangle) + timeDiff = 4.0 * delta + timeUTC = 720 + timeDiff - eq_of_time(t) + + td := minutes_to_timedelta(timeUTC) + dt := time.Date(date.Year(), date.Month(), date.Day(), 0, 0, 0, 0, time.UTC).Add(td).In(date.Location()) + return dt, nil +} + +// Calculates the time when the sun is at the specified elevation on the specified date. +// 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. +// Args: +// elevation: Elevation of the sun in degrees above the horizon to calculate for. +// observer: Observer to calculate for +// date: Date to calculate for. +// direction: Determines whether the calculated time is for the sun rising or setting. +// Use ``SunDirectionRising`` or ``SunDirectionSetting``. Default is rising. +// Returns: +// Date and time at which the sun is at the specified elevation. +// +func TimeAtElevation(observer Observer, elevation float64, date time.Time, direction SunDirection) (time.Time, error) { + if elevation > 90.0 { + elevation = 180.0 - elevation + direction = SunDirectionSetting + } + + zenith := 90 - elevation + t, err := time_of_transit(observer, date, zenith, direction) + if err != nil { + return time.Time{}, fmt.Errorf("sun never reaches an elevation of %v degrees at this location", elevation) + } + return t, nil +} + +// Calculate solar noon time when the sun is at its highest point. +// Args: +// observer: An observer viewing the sun at a specific, latitude, longitude and elevation +// date: Date to calculate for. Default is today for the specified tzinfo. +// Returns: +// Date and time at which noon occurs. +func Noon(observer Observer, date time.Time) time.Time { + jc := jday_to_jcentury(julianday(date)) + eqtime := eq_of_time(jc) + timeUTC := (720.0 - (4 * observer.Longitude) - eqtime) / 60.0 + + hour := int(timeUTC) + minute := int((timeUTC - float64(hour)) * 60) + second := int((((timeUTC - float64(hour)) * 60.0) - float64(minute)) * 60) + + if second > 59 { + second -= 60 + minute += 1 + } else if second < 0 { + second += 60 + minute -= 1 + } + if minute > 59 { + minute -= 60 + hour += 1 + } else if minute < 0 { + minute += 60 + hour -= 1 + } + if hour > 23 { + hour -= 24 + date.Add(24 * time.Hour) + } else if hour < 0 { + hour += 24 + date.Add(-24 * time.Hour) + } + noon := time.Date(date.Year(), date.Month(), date.Day(), hour, minute, second, 0, time.UTC).In(date.Location()) + return noon +} + +// Calculate solar midnight time. +// Note: +// This calculates the solar midnight that is closest +// to 00:00:00 of the specified date i.e. it may return a time that is on +// the previous day. +// Args: +// observer: An observer viewing the sun at a specific, latitude, longitude and elevation +// date: Date to calculate for. Default is today for the specified tzinfo. +// Returns: +// Date and time at which midnight occurs. +func Midnight(observer Observer, date time.Time) time.Time { + jd := julianday(date) + newt := jday_to_jcentury(jd + 0.5 + -observer.Longitude/360.0) + + eqtime := eq_of_time(newt) + timeUTC := (-observer.Longitude * 4.0) - eqtime + + timeUTC = timeUTC / 60.0 + hour := int(timeUTC) + minute := int((timeUTC - float64(hour)) * 60) + second := int((((timeUTC - float64(hour)) * 60) - float64(minute)) * 60) + + if second > 59 { + second -= 60 + minute += 1 + } else if second < 0 { + second += 60 + minute -= 1 + } + + if minute > 59 { + minute -= 60 + hour += 1 + } else if minute < 0 { + minute += 60 + hour -= 1 + } + + if hour < 0 { + hour += 24 + date.Add(-24 * time.Hour) + } + return time.Date(date.Year(), date.Month(), date.Day(), hour, minute, second, 0, time.UTC).In(date.Location()) +} + +func ZenithAndAzimuth(observer Observer, dateandtime time.Time, with_refraction bool) (float64, float64) { + latitude := observer.Latitude + + if observer.Latitude > 89.8 { + latitude = 89.8 + } else if observer.Latitude < -89.8 { + latitude = -89.8 + } + longitude := observer.Longitude + + utc_datetime := dateandtime.UTC() + + timenow := (utc_datetime.Hour() + (utc_datetime.Minute() / 60.0) + (utc_datetime.Second() / 3600.0)) + + JD := julianday(dateandtime) + t := jday_to_jcentury(JD + float64(timenow)/24.0) + solarDec := sun_declination(t) + eqtime := eq_of_time(t) + + solarTimeFix := eqtime - (4.0 * -longitude) + trueSolarTime := float64(utc_datetime.Hour()*60+utc_datetime.Minute()+utc_datetime.Second()/60) + solarTimeFix + // in minutes as a float, fractional part is seconds + + for trueSolarTime > 1440 { + trueSolarTime = trueSolarTime - 1440 + } + + hourangle := trueSolarTime/4.0 - 180.0 + // Thanks to Louis Schwarzmayr for the next line: + if hourangle < -180 { + hourangle = hourangle + 360.0 + } + + harad := radians(hourangle) + + csz := math.Sin(radians(latitude))*math.Sin(radians(solarDec)) + math.Cos(radians(latitude))*math.Cos(radians(solarDec))*math.Cos(harad) + + if csz > 1.0 { + csz = 1.0 + } else if csz < -1.0 { + csz = -1.0 + } + + zenith := degrees(math.Acos(csz)) + + azDenom := math.Cos(radians(latitude)) * math.Sin(radians(zenith)) + + azimuth := 0.0 + if math.Abs(azDenom) > 0.001 { + azRad := ((math.Sin(radians(latitude)) * math.Cos(radians(zenith))) - math.Sin(radians(solarDec))) / azDenom + + if math.Abs(azRad) > 1.0 { + if azRad < 0 { + azRad = -1.0 + } else { + azRad = 1.0 + } + } + azimuth = 180.0 - degrees(math.Acos(azRad)) + + if hourangle > 0.0 { + azimuth = -azimuth + } + } else { + if latitude > 0.0 { + azimuth = 180.0 + } else { + azimuth = 0.0 + } + } + + if azimuth < 0.0 { + azimuth = azimuth + 360.0 + } + if with_refraction { + zenith -= refraction_at_zenith(zenith) + } + return zenith, azimuth +} + +// Calculate the zenith angle of the sun. +// Args: +// observer: Observer to calculate the solar zenith for +// dateandtime: The date and time for which to calculate the angle. +// with_refraction: If True adjust zenith to take refraction into account + +// Returns: +// The zenith angle in degrees. +// +func Zenith(observer Observer, dateandtime time.Time, with_refraction bool) float64 { + zenith, _ := ZenithAndAzimuth(observer, dateandtime, with_refraction) + return zenith +} + +// Calculate the azimuth angle of the sun. +// Args: +// observer: Observer to calculate the solar azimuth for +// dateandtime: The date and time for which to calculate the angle. +// Returns: +// The azimuth angle in degrees clockwise from North. +func Azimuth(observer Observer, dateandtime time.Time) float64 { + _, azimuth := ZenithAndAzimuth(observer, dateandtime, true) + return azimuth +} + +// Calculate the sun's angle of elevation. +// Args: +// observer: Observer to calculate the solar elevation for +// dateandtime: The date and time for which to calculate the angle. +// with_refraction: If True adjust elevation to take refraction into account +// Returns: +// The elevation angle in degrees above the horizon. +// +func Elevation(observer Observer, dateandtime time.Time, with_refraction bool) float64 { + return 90.0 - Zenith(observer, dateandtime, with_refraction) +} + +// Calculate dawn time. +// Args: +// observer: Observer to calculate dawn for +// date: Date to calculate for. +// depression: Number of degrees below the horizon to use to calculate dawn. +// Default is for Civil dawn i.e. 6.0 +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// Date and time at which dawn occurs. +func Dawn(observer Observer, date time.Time, depression float64) (time.Time, error) { + t, err := time_of_transit(observer, date, 90.0+depression, SunDirectionRising) + if err != nil { + return t, fmt.Errorf("sun never reaches %v degrees below the horizon, at this location", depression) + } + return t, nil +} + +var ( + ErrAlwaysBelow = errors.New("sun is always below the horizon on this day, at this location") + ErrAlwaysAbove = errors.New("sun is always above the horizon on this day, at this location") +) + +// Calculate sunrise time. +// Args: +// observer Observer to calculate sunrise for +// date: Date to calculate for. +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// Date and time at which sunrise occurs. +func Sunrise(observer Observer, date time.Time) (time.Time, error) { + t, err := time_of_transit(observer, date, 90.0+sunApperentRadius, SunDirectionRising) + + if err != nil { + z := Zenith(observer, Noon(observer, date), true) + if z > 90.0 { + return time.Time{}, ErrAlwaysBelow + } + return time.Time{}, ErrAlwaysAbove + } + + return t, nil +} + +// Calculate sunset time. +// Args: +// observer Observer to calculate sunset for +// date: Date to calculate for. +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// Date and time at which sunset occurs. +// Raises: +// ValueError: if the sun does not reach the horizon +// +// if isinstance(tzinfo, str) { +// tzinfo = pytz.timezone(tzinfo) +// } +// if date.IsZero() { +// date := today(tzinfo) +// } +func Sunset(observer Observer, date time.Time) (time.Time, error) { + t, err := time_of_transit(observer, date, 90.0+sunApperentRadius, SunDirectionSetting) + if err != nil { + z := Zenith(observer, Noon(observer, date), true) + if z > 90.0 { + return time.Time{}, ErrAlwaysBelow + } + return time.Time{}, ErrAlwaysAbove + } + return t, nil + +} + +// Calculate dusk time. + +// Args: +// observer: Observer to calculate dusk for +// date: Date to calculate for. +// depression: Number of degrees below the horizon to use to calculate dusk. +// Default is for Civil dusk i.e. 6.0 +// tzinfo: Timezone to return times in. Default is UTC. + +// Returns: +// Date and time at which dusk occurs. + +// Raises: +// ValueError: if dusk does not occur on the specified date +// + +// if isinstance(tzinfo, str) { +// tzinfo = pytz.timezone(tzinfo) +// } +// if date.IsZero() { +// date := today(tzinfo) +// } +func Dusk(observer Observer, date time.Time, depression float64) (time.Time, error) { + t, err := time_of_transit(observer, date, 90.0+depression, SunDirectionSetting) + if err != nil { + return t, fmt.Errorf("sun never reaches %v degrees below the horizon, at this location", depression) + } + return t, nil +} + +// Calculate daylight start and end times. +// Args: +// observer Observer to calculate daylight for +// date: Date to calculate for. +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// A tuple of the date and time at which daylight starts and ends. +// Raises: +// ValueError: if the sun does not rise or does not set +func Daylight(observer Observer, date time.Time) (time.Time, time.Time, error) { + start, err := Sunrise(observer, date) + if err != nil { + return time.Time{}, time.Time{}, err + } + end, err := Sunset(observer, date) + if err != nil { + return time.Time{}, time.Time{}, err + } + return start, end, nil +} + +// Calculate night start and end times. +// Night is calculated to be between astronomical dusk on the +// date specified and astronomical dawn of the next day. +// Args: +// observer Observer to calculate night for +// date: Date to calculate for. Default is today's date for the +// specified tzinfo. +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// A tuple of the date and time at which night starts and ends. +// Raises: +// ValueError: if dawn does not occur on the specified date or +// dusk on the following day +func Night(observer Observer, date time.Time) (time.Time, time.Time, error) { + start, err := Dusk(observer, date, 6) + if err != nil { + return time.Time{}, time.Time{}, err + } + tomorrow := date.Add(24 * time.Hour) + end, err := Dawn(observer, tomorrow, 6) + if err != nil { + return time.Time{}, time.Time{}, err + } + return start, end, nil +} + +// Returns the start and end times of Twilight +// 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. +// Args: +// observer: Observer to calculate twilight for +// date: Date for which to calculate the times. +// +// direction: Determines whether the time is for the sun rising or setting. +// Use ``astral.SunDirectionRising`` or ``astral.SunDirectionSetting``. +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// A tuple of the date and time at which twilight starts and ends. +// Raises: +// ValueError: if the sun does not rise or does not set +// +func Twilight(observer Observer, date time.Time, direction SunDirection) (time.Time, time.Time, error) { + start, err := time_of_transit(observer, date, 90+6, direction) + if err != nil { + return time.Time{}, time.Time{}, err + } + + end, err := Sunset(observer, date) + if err != nil { + return time.Time{}, time.Time{}, err + } + if direction == SunDirectionRising { + end, err := Sunrise(observer, date) + if err != nil { + return time.Time{}, time.Time{}, err + } + return start, end, nil + } + return end, start, nil +} + +// Returns 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. +// Args: +// observer: Observer to calculate the golden hour for +// date: Date for which to calculate the times. +// +// direction: Determines whether the time is for the sun rising or setting. +// Use ``SunDirectionRising`` or ``SunDirectionSetting``. +// tzinfo: Timezone to return times in. Default is UTC. +// Returns: +// A tuple of the date and time at which the Golden Hour starts and ends. +// Raises: +// ValueError: if the sun does not transit the elevations -4 & +6 degrees +// +func GoldenHour(observer Observer, date time.Time, direction SunDirection) (time.Time, time.Time, error) { + start, err := time_of_transit(observer, date, 90+4, direction) + if err != nil { + return time.Time{}, time.Time{}, err + } + end, err := time_of_transit(observer, date, 90-6, direction) + if err != nil { + return time.Time{}, time.Time{}, err + } + + if direction == SunDirectionRising { + return start, end, nil + } + return end, start, nil +} + +// 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. + +// Args: +// observer: Observer to calculate the blue hour for +// date: Date for which to calculate the times. +// +// direction: Determines whether the time is for the sun rising or setting. +// Use ``SunDirectionRising`` or ``SunDirectionSetting``. +// tzinfo: Timezone to return times in. Default is UTC. + +// Returns: +// A tuple of the date and time at which the Blue Hour starts and ends. + +// Raises: +// ValueError: if the sun does not transit the elevations -4 & -6 degrees +// +func BlueHour(observer Observer, date time.Time, direction SunDirection) (time.Time, time.Time, error) { + start, err := time_of_transit(observer, date, 90+6, direction) + if err != nil { + return time.Time{}, time.Time{}, err + } + end, err := time_of_transit(observer, date, 90+4, direction) + if err != nil { + return time.Time{}, time.Time{}, err + } + + if direction == SunDirectionRising { + return start.In(date.Location()), end.In(date.Location()), nil + } + return end, start, nil + +} + +// TODO: not working correctly +// func Rahukaalam(observer Observer, date time.Time, daytime bool) (time.Time, time.Time, error) { +// // Calculate ruhakaalam times. + +// // Args: +// // observer Observer to calculate rahukaalam for +// // date: Date to calculate for. +// // daytime: If True calculate for the day time else calculate for the night time. +// // tzinfo: Timezone to return times in. Default is UTC. + +// // Returns: +// // Tuple containing the start and end times for Rahukaalam. + +// // Raises: +// // ValueError: if the sun does not rise or does not set +// // + +// start, err := Sunrise(observer, date) +// if err != nil { +// return time.Time{}, time.Time{}, err +// } +// end, err := Sunset(observer, date) +// if err != nil { +// return time.Time{}, time.Time{}, err +// } + +// if !daytime { +// start, err = Sunset(observer, date) +// if err != nil { +// return time.Time{}, time.Time{}, err +// } +// end, err = Sunrise(observer, date.Add(24*time.Hour)) +// if err != nil { +// return time.Time{}, time.Time{}, err +// } +// } + +// octant_duration := end.Sub(start).Seconds() / 8 +// // octant_duration := datetime.timedelta((end - start).seconds / 8) + +// // Mo,Sa,Fr,We,Th,Tu,Su +// octant_index := []int{1, 6, 4, 5, 3, 2, 7} + +// weekday := date.Weekday() + +// // convert to python weekday +// if weekday == time.Sunday { +// weekday = 6 +// } else { +// weekday-- +// } + +// octant := octant_index[weekday] + +// // TODO: is seconds correct? +// add := time.Duration(octant_duration*float64(octant)) * time.Second +// start = start.Add(add) +// end = start.Add(time.Duration(octant_duration)) + +// return start.In(date.Location()), end.In(date.Location()), nil +// } diff --git a/sun_test.go b/sun_test.go new file mode 100644 index 0000000..4e6b769 --- /dev/null +++ b/sun_test.go @@ -0,0 +1,658 @@ +package astral + +import ( + "math" + "testing" + "time" + + "github.com/stretchr/testify/require" +) + +func nextEvent(t *testing.T, obs Observer, dt time.Time, event func(observer Observer, date time.Time) (time.Time, error)) time.Time { + for offset := 0; offset < 366; offset++ { + newdate := dt.Add(time.Duration(time.Duration(offset) * 24 * time.Hour)) + ti, err := event(obs, newdate) + if err == nil { + return ti + } + } + + t.Fatalf("should not happen") + return dt +} + +// TODO: this should probably have an own test +func almostEqual(t1, t2 time.Time, allowedDiff time.Duration) bool { + return diff(t1, t2) < allowedDiff +} + +func absDuration(n time.Duration) time.Duration { + if n < 0 { + return -n + } + return n +} + +func diff(t1, t2 time.Time) time.Duration { + return absDuration(t1.Sub(t2)) +} + +func almostEqualf(f1, f2, allowedDiff float64) bool { + return math.Abs(f1-f2) < allowedDiff +} + +func TestNorwaySunUp(t *testing.T) { + // """Test location in Norway where the sun doesn't set in summer.""" + june := time.Date(2019, 6, 5, 0, 0, 0, 0, time.UTC) + obs := Observer{Latitude: 69.6, Longitude: 18.8, Elevation: 0.0} + + _, err := Sunrise(obs, june) + require.Error(t, err) + _, err = Sunset(obs, june) + require.Error(t, err) + + // Find the next sunset and sunrise: + nextSunrise := nextEvent(t, obs, june, Sunrise) + nextSunset := nextEvent(t, obs, june, Sunset) + + require.True(t, nextSunrise.After(nextSunset)) +} + +var london = Observer{Latitude: 51.509865, Longitude: -0.118092} + +func TestDawn(t *testing.T) { + type args struct { + observer Observer + date time.Time + depression float64 + } + tests := []struct { + name string + args args + want time.Time + wantErr bool + }{ + // Civil + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 1, 7, 4, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 2, 7, 5, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 3, 7, 6, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 12, 7, 16, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 25, 7, 25, 0, 0, time.UTC)}, + // Nautical + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 1, 6, 22, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 2, 6, 23, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 3, 6, 24, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 12, 6, 33, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 25, 6, 41, 0, 0, time.UTC)}, + // Astronomical + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC), depression: DepressionAstronomical}, want: time.Date(2015, 12, 1, 5, 41, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC), depression: DepressionAstronomical}, want: time.Date(2015, 12, 2, 5, 42, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC), depression: DepressionAstronomical}, want: time.Date(2015, 12, 3, 5, 44, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC), depression: DepressionAstronomical}, want: time.Date(2015, 12, 12, 5, 52, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC), depression: DepressionAstronomical}, want: time.Date(2015, 12, 25, 6, 1, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Dawn(tt.args.observer, tt.args.date, tt.args.depression) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(got, tt.want, 60*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestDusk(t *testing.T) { + type args struct { + observer Observer + date time.Time + depression float64 + } + tests := []struct { + name string + args args + want time.Time + wantErr bool + }{ + // Civil + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 1, 16, 34, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 2, 16, 34, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 3, 16, 33, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 12, 16, 31, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC), depression: DepressionCivil}, want: time.Date(2015, 12, 25, 16, 36, 0, 0, time.UTC)}, + // Nautical + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 1, 17, 16, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 2, 17, 16, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 3, 17, 16, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 12, 17, 14, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC), depression: DepressionNautical}, want: time.Date(2015, 12, 25, 17, 19, 0, 0, time.UTC)}, + // Astronomical + + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Dusk(tt.args.observer, tt.args.date, tt.args.depression) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(got, tt.want, 60*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestSunrise(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + want time.Time + wantErr bool + }{ + {args: args{observer: london, date: time.Date(2015, 1, 1, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 1, 1, 8, 6, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 1, 7, 43, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 2, 7, 45, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 3, 7, 46, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 12, 7, 56, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 25, 8, 5, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Sunrise(tt.args.observer, tt.args.date) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(got, tt.want, 60*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestSunset(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + want time.Time + wantErr bool + }{ + {args: args{observer: london, date: time.Date(2015, 1, 1, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 1, 1, 16, 1, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 1, 15, 55, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 2, 15, 54, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 3, 15, 54, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 12, 15, 51, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 25, 15, 55, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Sunset(tt.args.observer, tt.args.date) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(got, tt.want, 60*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestNoon(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + want time.Time + }{ + {args: args{observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 1, 11, 49, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 2, 11, 49, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 3, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 3, 11, 50, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 12, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 12, 11, 54, 0, 0, time.UTC)}, + {args: args{observer: london, date: time.Date(2015, 12, 25, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 25, 12, 00, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := Noon(tt.args.observer, tt.args.date) + require.True(t, almostEqual(got, tt.want, 60*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestMidnight(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + want time.Time + }{ + {args: args{observer: london, date: time.Date(2016, 2, 18, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 2, 18, 0, 14, 0, 0, time.UTC)}, + // {args: args{observer: london, date: time.Date(2016, 10, 26, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 10, 25, 23, 44, 0, 0, time.UTC)}, // TODO + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := Midnight(tt.args.observer, tt.args.date) + require.True(t, almostEqual(got, tt.want, 60*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestTwilight(t *testing.T) { + type args struct { + observer Observer + date time.Time + direction SunDirection + } + tests := []struct { + name string + args args + wantStart time.Time + wantEnd time.Time + wantErr bool + }{ + // Rising + {args: args{direction: SunDirectionRising, observer: london, date: time.Date(2019, 8, 29, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2019, 8, 29, 4, 32, 0, 0, time.UTC), wantEnd: time.Date(2019, 8, 29, 5, 7, 0, 0, time.UTC)}, + // Setting + {args: args{direction: SunDirectionSetting, observer: london, date: time.Date(2019, 8, 29, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2019, 8, 29, 18, 54, 0, 0, time.UTC), wantEnd: time.Date(2019, 8, 29, 19, 30, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + start, end, err := Twilight(tt.args.observer, tt.args.date, tt.args.direction) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(start, tt.wantStart, 60*time.Second), "want: %v but got: %v", tt.wantStart, start) + require.True(t, almostEqual(end, tt.wantEnd, 60*time.Second), "want: %v but got: %v", tt.wantEnd, end) + }) + } +} + +var newDelhi = Observer{Latitude: 28.644800, Longitude: 77.216721} + +// TODO: FIXME +// func TestRahukaalam(t *testing.T) { +// type args struct { +// observer Observer +// date time.Time +// daytime bool +// } +// tests := []struct { +// name string +// args args +// wantStart time.Time +// wantEnd time.Time +// wantErr bool +// }{ + +// // datetime.date(2015, 12, 1), +// // ( +// // datetime.datetime(2015, 12, 1, 9, 17), +// // datetime.datetime(2015, 12, 1, 10, 35), +// // ), +// // ), +// // ( +// // datetime.date(2015, 12, 2), +// // ( +// // datetime.datetime(2015, 12, 2, 6, 40), +// // datetime.datetime(2015, 12, 2, 7, 58), +// // ), + +// // Day +// // {args: args{daytime: true, observer: newDelhi, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2015, 12, 1, 9, 17, 0, 0, time.UTC), wantEnd: time.Date(2015, 12, 1, 10, 35, 0, 0, time.UTC)}, +// // {args: args{daytime: true, observer: london, date: time.Date(2021, 4, 16, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2021, 4, 16, 10, 15, 37, 0, time.UTC), wantEnd: time.Date(2021, 4, 16, 12, 0, 14, 0, time.UTC)}, + +// // Night +// // {args: args{daytime: true, observer: newDelhi, date: time.Date(2015, 12, 2, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2015, 12, 2, 6, 40, 0, 0, time.UTC), wantEnd: time.Date(2015, 12, 2, 7, 58, 0, 0, time.UTC)}, +// } +// for _, tt := range tests { +// t.Run(tt.name, func(t *testing.T) { +// start, end, err := Rahukaalam(tt.args.observer, tt.args.date, tt.args.daytime) +// if (err != nil) != tt.wantErr { +// t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) +// return +// } +// require.True(t, almostEqual(start, tt.wantStart, 60*time.Second), "start want: %v but got: %v", tt.wantStart, start) +// require.True(t, almostEqual(end, tt.wantEnd, 60*time.Second), "end want: %v but got: %v", tt.wantEnd, end) +// }) +// } +// } + +func TestElevation(t *testing.T) { + type args struct { + observer Observer + date time.Time + refraction bool + } + tests := []struct { + name string + args args + want float64 + wantErr bool + }{ + {args: args{refraction: true, observer: london, date: time.Date(2015, 12, 14, 11, 0, 0, 0, time.UTC)}, want: 14.381311}, + {args: args{refraction: true, observer: london, date: time.Date(2015, 12, 14, 20, 1, 0, 0, time.UTC)}, want: -37.3710156}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := Elevation(tt.args.observer, tt.args.date, tt.args.refraction) + // TODO: too far off. Python code uses accuracy of 0.001 + require.True(t, almostEqualf(got, tt.want, 0.005), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestAzimuth(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + want float64 + wantErr bool + }{ + {args: args{observer: london, date: time.Date(2015, 12, 14, 11, 0, 0, 0, time.UTC)}, want: 166.9676}, + {args: args{observer: london, date: time.Date(2015, 12, 14, 20, 1, 0, 0, time.UTC)}, want: 279.4093}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := Azimuth(tt.args.observer, tt.args.date) + // TODO: too far off. Python code uses accuracy of 0.001 + require.True(t, almostEqualf(got, tt.want, 0.01), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestZenith(t *testing.T) { + type args struct { + observer Observer + date time.Time + refraction bool + } + tests := []struct { + name string + args args + want float64 + wantErr bool + }{ + // {args: args{refraction: true, observer: london, date: time.Date(2019, 8, 29, 14, 34, 0, 0, time.UTC)}, want: 46}, // TODO: FIXME + {args: args{refraction: true, observer: london, date: time.Date(2020, 2, 3, 10, 37, 0, 0, time.UTC)}, want: 71}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := Zenith(tt.args.observer, tt.args.date, tt.args.refraction) + require.True(t, almostEqualf(got, tt.want, 0.5), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestTimeAtElevation(t *testing.T) { + type args struct { + observer Observer + elevation float64 + date time.Time + direction SunDirection + } + tests := []struct { + name string + args args + want time.Time + wantErr bool + }{ + // Rising + {args: args{direction: SunDirectionRising, elevation: 6, observer: london, date: time.Date(2016, 1, 4, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 1, 4, 9, 5, 0, 0, time.UTC)}, + {args: args{direction: SunDirectionRising, elevation: 166, observer: london, date: time.Date(2016, 1, 4, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 1, 4, 13, 20, 0, 0, time.UTC)}, + {args: args{direction: SunDirectionRising, elevation: 186, observer: london, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, want: time.Date(2015, 12, 1, 16, 34, 0, 0, time.UTC)}, + {args: args{direction: SunDirectionRising, elevation: -18, observer: london, date: time.Date(2016, 1, 4, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 1, 4, 6, 0, 0, 0, time.UTC)}, + // Setting + {args: args{direction: SunDirectionSetting, elevation: 14, observer: london, date: time.Date(2016, 1, 4, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 1, 4, 13, 20, 0, 0, time.UTC)}, + // Error + {wantErr: true, args: args{direction: SunDirectionRising, elevation: 20, observer: london, date: time.Date(2016, 1, 4, 0, 0, 0, 0, time.UTC)}, want: time.Date(2016, 1, 4, 6, 0, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := TimeAtElevation(tt.args.observer, tt.args.elevation, tt.args.date, tt.args.direction) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(got, tt.want, 180*time.Second), "want: %v but got: %v", tt.want, got) + }) + } +} + +func TestDaylight(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + wantStart time.Time + wantEnd time.Time + wantErr bool + }{ + {args: args{observer: london, date: time.Date(2016, 1, 6, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2016, 1, 6, 8, 5, 0, 0, time.UTC), wantEnd: time.Date(2016, 1, 6, 16, 7, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotStart, gotEnd, err := Daylight(tt.args.observer, tt.args.date) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(gotStart, tt.wantStart, 60*time.Second), "want: %v but got: %v", tt.wantStart, gotStart) + require.True(t, almostEqual(gotEnd, tt.wantEnd, 60*time.Second), "want: %v but got: %v", tt.wantEnd, gotEnd) + }) + } +} + +func TestNight(t *testing.T) { + type args struct { + observer Observer + date time.Time + } + tests := []struct { + name string + args args + wantStart time.Time + wantEnd time.Time + wantErr bool + }{ + {args: args{observer: london, date: time.Date(2016, 1, 6, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2016, 1, 6, 16, 46, 0, 0, time.UTC), wantEnd: time.Date(2016, 1, 7, 7, 25, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotStart, gotEnd, err := Night(tt.args.observer, tt.args.date) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(gotStart, tt.wantStart, 90*time.Second), "wantStart: %v but got: %v", tt.wantStart, gotStart) + require.True(t, almostEqual(gotEnd, tt.wantEnd, 60*time.Second), "wantEnd: %v but got: %v", tt.wantEnd, gotEnd) + }) + } +} + +func TestGoldenHour(t *testing.T) { + type args struct { + observer Observer + date time.Time + direction SunDirection + } + tests := []struct { + name string + args args + wantStart time.Time + wantEnd time.Time + wantErr bool + }{ + {args: args{direction: SunDirectionRising, observer: newDelhi, date: time.Date(2015, 12, 1, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2015, 12, 1, 1, 10, 10, 0, time.UTC), wantEnd: time.Date(2015, 12, 1, 2, 0, 43, 0, time.UTC)}, + {args: args{direction: SunDirectionSetting, observer: london, date: time.Date(2016, 5, 18, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2016, 5, 18, 19, 1, 0, 0, time.UTC), wantEnd: time.Date(2016, 5, 18, 20, 17, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotStart, gotEnd, err := GoldenHour(tt.args.observer, tt.args.date, tt.args.direction) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(gotStart, tt.wantStart, 90*time.Second), "wantStart: %v but got: %v", tt.wantStart, gotStart) + require.True(t, almostEqual(gotEnd, tt.wantEnd, 60*time.Second), "wantEnd: %v but got: %v", tt.wantEnd, gotEnd) + }) + } +} + +func TestBlueHour(t *testing.T) { + type args struct { + observer Observer + date time.Time + direction SunDirection + } + tests := []struct { + name string + args args + wantStart time.Time + wantEnd time.Time + wantErr bool + }{ + {args: args{direction: SunDirectionRising, observer: london, date: time.Date(2016, 5, 19, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2016, 5, 19, 3, 19, 0, 0, time.UTC), wantEnd: time.Date(2016, 5, 19, 3, 36, 0, 0, time.UTC)}, + {args: args{direction: SunDirectionSetting, observer: london, date: time.Date(2016, 5, 19, 0, 0, 0, 0, time.UTC)}, wantStart: time.Date(2016, 5, 19, 20, 18, 0, 0, time.UTC), wantEnd: time.Date(2016, 5, 19, 20, 35, 0, 0, time.UTC)}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotStart, gotEnd, err := BlueHour(tt.args.observer, tt.args.date, tt.args.direction) + if (err != nil) != tt.wantErr { + t.Errorf("Dawn() error = %v, wantErr %v", err, tt.wantErr) + return + } + require.True(t, almostEqual(gotStart, tt.wantStart, 90*time.Second), "wantStart: %v but got: %v", tt.wantStart, gotStart) + require.True(t, almostEqual(gotEnd, tt.wantEnd, 60*time.Second), "wantEnd: %v but got: %v", tt.wantEnd, gotEnd) + }) + } +} + +func TestAdjustToHorizon(t *testing.T) { + type args struct { + elevation float64 + } + tests := []struct { + name string + args args + want float64 + }{ + {args: args{elevation: 12000}, want: 3.517744168209966}, + {args: args{elevation: -1}, want: 0}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := adjust_to_horizon(tt.args.elevation) + require.True(t, almostEqualf(got, tt.want, 0.0000000000001), "wantStart: %v but got: %v", tt.want, got) + }) + } +} + +func TestAdjustToObscuringFeature(t *testing.T) { + type args struct { + elevation0 float64 + elevation1 float64 + } + tests := []struct { + name string + args args + want float64 + }{ + {args: args{elevation0: 0, elevation1: 100}, want: 0}, + {args: args{elevation0: 10, elevation1: 10}, want: 45}, + {args: args{elevation0: 3, elevation1: 4}, want: 53.130102354156}, + {args: args{elevation0: -10, elevation1: 10}, want: -45}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := adjust_to_obscuring_feature(tt.args.elevation0, tt.args.elevation1) + require.True(t, almostEqualf(got, tt.want, 0.0000000000001), "wantStart: %v but got: %v", tt.want, got) + }) + } +} + +func TestJulianday(t *testing.T) { + type args struct { + date time.Time + } + tests := []struct { + name string + args args + want float64 + }{ + {args: args{date: time.Date(2012, 1, 1, 0, 0, 0, 0, time.UTC)}, want: 2455927.5}, + {args: args{date: time.Date(2013, 6, 1, 0, 0, 0, 0, time.UTC)}, want: 2456444.5}, + {args: args{date: time.Date(1867, 2, 1, 0, 0, 0, 0, time.UTC)}, want: 2402998.5}, + {args: args{date: time.Date(3200, 11, 14, 0, 0, 0, 0, time.UTC)}, want: 2890153.5}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := julianday(tt.args.date) + require.Equal(t, tt.want, got, "wantStart: %v but got: %v", tt.want, got) + }) + } +} + +func TestJulianDayToCentury(t *testing.T) { + type args struct { + date float64 + } + tests := []struct { + name string + args args + want float64 + }{ + {args: args{date: 2455927.5}, want: 0.119986311}, + {args: args{date: 2456293.5}, want: 0.130006845}, + {args: args{date: 2456444.5}, want: 0.134140999}, + {args: args{date: 2402998.5}, want: -1.329130732}, + {args: args{date: 2890153.5}, want: 12.00844627}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := jday_to_jcentury(tt.args.date) + require.True(t, almostEqualf(tt.want, got, 0.000000001), "wantStart: %v but got: %v", tt.want, got) + }) + } +} + +func TestJulianCenturyToDay(t *testing.T) { + type args struct { + date float64 + } + tests := []struct { + name string + args args + want float64 + }{ + {args: args{date: 0.119986311}, want: 2455927.5}, + {args: args{date: 0.130006845}, want: 2456293.5}, + {args: args{date: 0.134140999}, want: 2456444.5}, + {args: args{date: -1.32913073}, want: 2402998.5}, + {args: args{date: 12.00844627}, want: 2890153.5}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := jcentury_to_jday(tt.args.date) + // TODO: not sure if the accuracy is good enough + require.True(t, almostEqualf(tt.want, got, 0.0001), "want: %v but got: %v", tt.want, got) + }) + } +} diff --git a/tox.travis.ini b/tox.travis.ini deleted file mode 100644 index abed4ad..0000000 --- a/tox.travis.ini +++ /dev/null @@ -1,19 +0,0 @@ -[tox] -project = astral -envlist = py36, py37 - -[testenv] -deps = - freezegun - pytest - pytest-runner -commands = - pytest - -[testenv:doc] -changedir = src/docs -deps = - sphinx - sphinx_press_theme -commands = - sphinx-build -W -b html . ./html