# Copyright (C) 2002  Tobias Klausmann

# Modified by Jerome Alet

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.        See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

#

# By reading this code you agree not to ridicule the author =)

import string

import re

import urllib

import types

import math, fpformat

__author__ = "klausman-usenet@tuts.net"

__version__ = "0.4"

__doc__ = """Pymetar v%s (c) 2002 Tobias Klausman

Pymetar is a python module and command line tool designed to fetch Metar

reports from the NOAA (http://www.noaa.gov) and allow access to the included

weather information.

This program is free software; you can redistribute it and/or modify it under

the terms of the GNU General Public License as published by the Free Software

Foundation; either version 2 of the License, or (at your option) any later

version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY

WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with

this program; if not, write to the Free Software Foundation, Inc., 59 Temple

Place, Suite 330, Boston, MA 02111-1307, USA.

Please e-mail bugs to: %s""" % (__version__, __author__)

#

# What a boring list to type !

#

# It seems the NOAA doesn't want to return plain text, but considering the

# format of their response, this is not to save bandwidth :-)

#

_WeatherConditions = {

                      "DZ" : ("Drizzle", "rain", {

                               "" :   "Moderate drizzle",

                               "-" :  "Light drizzle",

                               "+" :  "Heavy drizzle",

                               "VC" : "Drizzle in the vicinity",

                               "MI" : "Shallow drizzle",

                               "BC" : "Patches of drizzle",

                               "PR" : "Partial drizzle",

                               "TS" : ("Thunderstorm", "storm"),

                               "BL" : "Windy drizzle",

                               "SH" : "Showers",

                               "DR" : "Drifting drizzle",

                               "FZ" : "Freezing drizzle",

                             }),

                      "RA" : ("Rain", "rain", {

                               "" :   "Moderate rain",

                               "-" :  "Light rain",

                               "+" :  "Heavy rain",

                               "VC" : "Rain in the vicinity",

                               "MI" : "Shallow rain",

                               "BC" : "Patches of rain",

                               "PR" : "Partial rainfall",

                               "TS" : ("Thunderstorm", "storm"),

                               "BL" : "Blowing rainfall",

                               "SH" : "Rain showers",

                               "DR" : "Drifting rain",

                               "FZ" : "Freezing rain",

                             }),

                      "SN" : ("Snow", "snow", {

                               "" :   "Moderate snow",

                               "-" :  "Light snow",

                               "+" :  "Heavy snow",

                               "VC" : "Snow in the vicinity",

                               "MI" : "Shallow snow",

                               "BC" : "Patches of snow",

                               "PR" : "Partial snowfall",

                               "TS" : ("Snowstorm", "storm"),

                               "BL" : "Blowing snowfall",

                               "SH" : "Snowfall showers",

                               "DR" : "Drifting snow",

                               "FZ" : "Freezing snow",

                             }),

                      "SG" : ("Snow grains", "snow", {

                               "" :   "Moderate snow grains",

                               "-" :  "Light snow grains",

                               "+" :  "Heavy snow grains",

                               "VC" : "Snow grains in the vicinity",

                               "MI" : "Shallow snow grains",

                               "BC" : "Patches of snow grains",

                               "PR" : "Partial snow grains",

                               "TS" : ("Snowstorm", "storm"),

                               "BL" : "Blowing snow grains",

                               "SH" : "Snow grain showers",

                               "DR" : "Drifting snow grains",

                               "FZ" : "Freezing snow grains",

                             }),

                      "IC" : ("Ice crystals", "snow", {

                               "" :   "Moderate ice crystals",

                               "-" :  "Few ice crystals",

                               "+" :  "Heavy ice crystals",

                               "VC" : "Ice crystals in the vicinity",

                               "BC" : "Patches of ice crystals",

                               "PR" : "Partial ice crystals",

                               "TS" : ("Ice crystal storm", "storm"),

                               "BL" : "Blowing ice crystals",

                               "SH" : "Showers of ice crystals",

                               "DR" : "Drifting ice crystals",

                               "FZ" : "Freezing ice crystals",

                             }),

                      "PE" : ("Ice pellets", "snow", {

                               "" :   "Moderate ice pellets",

                               "-" :  "Few ice pellets",

                               "+" :  "Heavy ice pellets",

                               "VC" : "Ice pellets in the vicinity",

                               "MI" : "Shallow ice pellets",

                               "BC" : "Patches of ice pellets",

                               "PR" : "Partial ice pellets",

                               "TS" : ("Ice pellets storm", "storm"),

                               "BL" : "Blowing ice pellets",

                               "SH" : "Showers of ice pellets",

                               "DR" : "Drifting ice pellets",

                               "FZ" : "Freezing ice pellets",

                             }),

                      "GR" : ("Hail", "rain", {

                               "" :   "Moderate hail",

                               "-" :  "Light hail",

                               "+" :  "Heavy hail",

                               "VC" : "Hail in the vicinity",

                               "MI" : "Shallow hail",

                               "BC" : "Patches of hail",

                               "PR" : "Partial hail",

                               "TS" : ("Hailstorm", "storm"),

                               "BL" : "Blowing hail",

                               "SH" : "Hail showers",

                               "DR" : "Drifting hail",

                               "FZ" : "Freezing hail",

                             }),

                      "GS" : ("Small hail", "rain", {

                               "" :   "Moderate small hail",

                               "-" :  "Light small hail",

                               "+" :  "Heavy small hail",

                               "VC" : "Small hail in the vicinity",

                               "MI" : "Shallow small hail",

                               "BC" : "Patches of small hail",

                               "PR" : "Partial small hail",

                               "TS" : ("Small hailstorm", "storm"),

                               "BL" : "Blowing small hail",

                               "SH" : "Showers of small hail",

                               "DR" : "Drifting small hail",

                               "FZ" : "Freezing small hail",

                             }),

                      "UP" : ("Precipitation", "rain", {

                               "" :   "Moderate precipitation",

                               "-" :  "Light precipitation",

                               "+" :  "Heavy precipitation",

                               "VC" : "Precipitation in the vicinity",

                               "MI" : "Shallow precipitation",

                               "BC" : "Patches of precipitation",

                               "PR" : "Partial precipitation",

                               "TS" : ("Unknown thunderstorm", "storm"),

                               "BL" : "Blowing precipitation",

                               "SH" : "Showers, type unknown",

                               "DR" : "Drifting precipitation",

                               "FZ" : "Freezing precipitation",

                             }),

                      "BR" : ("Mist", "fog", {

                               "" :   "Moderate mist",

                               "-" :  "Light mist",

                               "+" :  "Thick mist",

                               "VC" : "Mist in the vicinity",

                               "MI" : "Shallow mist",

                               "BC" : "Patches of mist",

                               "PR" : "Partial mist",

                               "BL" : "Mist with wind",

                               "DR" : "Drifting mist",

                               "FZ" : "Freezing mist",

                             }),

                      "FG" : ("Fog", "fog", {

                               "" :   "Moderate fog",

                               "-" :  "Light fog",

                               "+" :  "Thick fog",

                               "VC" : "Fog in the vicinity",

                               "MI" : "Shallow fog",

                               "BC" : "Patches of fog",

                               "PR" : "Partial fog",

                               "BL" : "Fog with wind",

                               "DR" : "Drifting fog",

                               "FZ" : "Freezing fog",

                             }),

                      "FU" : ("Smoke", "fog", {

                               "" :   "Moderate smoke",

                               "-" :  "Thin smoke",

                               "+" :  "Thick smoke",

                               "VC" : "Smoke in the vicinity",

                               "MI" : "Shallow smoke",

                               "BC" : "Patches of smoke",

                               "PR" : "Partial smoke",

                               "TS" : ("Smoke w/ thunders", "storm"),

                               "BL" : "Smoke with wind",

                               "DR" : "Drifting smoke",

                             }),

                      "VA" : ("Volcanic ash", "fog", {

                               "" :   "Moderate volcanic ash",

                               "+" :  "Thick volcanic ash",

                               "VC" : "Volcanic ash in the vicinity",

                               "MI" : "Shallow volcanic ash",

                               "BC" : "Patches of volcanic ash",

                               "PR" : "Partial volcanic ash",

                               "TS" : ("Volcanic ash w/ thunders", "storm"),

                               "BL" : "Blowing volcanic ash",

                               "SH" : "Showers of volcanic ash",

                               "DR" : "Drifting volcanic ash",

                               "FZ" : "Freezing volcanic ash",

                             }),

                      "SA" : ("Sand", "fog", {

                               "" :   "Moderate sand",

                               "-" :  "Light sand",

                               "+" :  "Heavy sand",

                               "VC" : "Sand in the vicinity",

                               "BC" : "Patches of sand",

                               "PR" : "Partial sand",

                               "BL" : "Blowing sand",

                               "DR" : "Drifting sand",

                             }),

                      "HZ" : ("Haze", "fog", {

                               "" :   "Moderate haze",

                               "-" :  "Light haze",

                               "+" :  "Thick haze",

                               "VC" : "Haze in the vicinity",

                               "MI" : "Shallow haze",

                               "BC" : "Patches of haze",

                               "PR" : "Partial haze",

                               "BL" : "Haze with wind",

                               "DR" : "Drifting haze",

                               "FZ" : "Freezing haze",

                             }),

                      "PY" : ("Sprays", "fog", {

                               "" :   "Moderate sprays",

                               "-" :  "Light sprays",

                               "+" :  "Heavy sprays",

                               "VC" : "Sprays in the vicinity",

                               "MI" : "Shallow sprays",

                               "BC" : "Patches of sprays",

                               "PR" : "Partial sprays",

                               "BL" : "Blowing sprays",

                               "DR" : "Drifting sprays",

                               "FZ" : "Freezing sprays",

                             }),

                      "DU" : ("Dust", "fog", {

                               "" :   "Moderate dust",

                               "-" :  "Light dust",

                               "+" :  "Heavy dust",

                               "VC" : "Dust in the vicinity",

                               "BC" : "Patches of dust",

                               "PR" : "Partial dust",

                               "BL" : "Blowing dust",

                               "DR" : "Drifting dust",

                             }),

                      "SQ" : ("Squall", "storm", {

                               "" :   "Moderate squall",

                               "-" :  "Light squall",

                               "+" :  "Heavy squall",

                               "VC" : "Squall in the vicinity",

                               "PR" : "Partial squall",

                               "TS" : "Thunderous squall",

                               "BL" : "Blowing squall",

                               "DR" : "Drifting squall",

                               "FZ" : "Freezing squall",

                             }),

                      "SS" : ("Sandstorm", "fog", {

                               "" :   "Moderate sandstorm",

                               "-" :  "Light sandstorm",

                               "+" :  "Heavy sandstorm",

                               "VC" : "Sandstorm in the vicinity",

                               "MI" : "Shallow sandstorm",

                               "PR" : "Partial sandstorm",

                               "TS" : ("Thunderous sandstorm", "storm"),

                               "BL" : "Blowing sandstorm",

                               "DR" : "Drifting sandstorm",

                               "FZ" : "Freezing sandstorm",

                             }),

                      "DS" : ("Duststorm", "fog", {

                               "" :   "Moderate duststorm",

                               "-" :  "Light duststorm",

                               "+" :  "Heavy duststorm",

                               "VC" : "Duststorm in the vicinity",

                               "MI" : "Shallow duststorm",

                               "PR" : "Partial duststorm",

                               "TS" : ("Thunderous duststorm", "storm"),

                               "BL" : "Blowing duststorm",

                               "DR" : "Drifting duststorm",

                               "FZ" : "Freezing duststorm",

                             }),

                      "PO" : ("Dustwhirls", "fog", {

                               "" :   "Moderate dustwhirls",

                               "-" :  "Light dustwhirls",

                               "+" :  "Heavy dustwhirls",

                               "VC" : "Dustwhirls in the vicinity",

                               "MI" : "Shallow dustwhirls",

                               "BC" : "Patches of dustwhirls",

                               "PR" : "Partial dustwhirls",

                               "BL" : "Blowing dustwhirls",

                               "DR" : "Drifting dustwhirls",

                             }),

                      "+FC" : ("Tornado", "storm", {

                               "" :   "Moderate tornado",

                               "+" :  "Raging tornado",

                               "VC" : "Tornado in the vicinity",

                               "PR" : "Partial tornado",

                               "TS" : "Thunderous tornado",

                               "BL" : "Tornado",

                               "DR" : "Drifting tornado",

                               "FZ" : "Freezing tornado",

                              }),

                      "FC" : ("Funnel cloud", "fog", {

                               "" :   "Moderate funnel cloud",

                               "-" :  "Light funnel cloud",

                               "+" :  "Thick funnel cloud",

                               "VC" : "Funnel cloud in the vicinity",

                               "MI" : "Shallow funnel cloud",

                               "BC" : "Patches of funnel cloud",

                               "PR" : "Partial funnel cloud",

                               "BL" : "Funnel cloud w/ wind",

                               "DR" : "Drifting funnel cloud",

                             }),

                    }

#

# RegExps to extract the different parts from the Metar encoded report

TIME_RE_STR = r"^([0-9]{6})Z$"

WIND_RE_STR = r"^(([0-9]{3})|VRB)([0-9]?[0-9]{2})(G[0-9]?[0-9]{2})?KT$"

VIS_RE_STR  = r"^(([0-9]?[0-9])|(M?1/[0-9]?[0-9]))SM$"

CLOUD_RE_STR= r"^(CLR|SKC|BKN|SCT|FEW|OVC)([0-9]{3})?$"

TEMP_RE_STR = r"^(M?[0-9][0-9])/(M?[0-9][0-9])$"

PRES_RE_STR = r"^(A|Q)([0-9]{4})$"

COND_RE_STR = r"^(-|\\+)?(VC|MI|BC|PR|TS|BL|SH|DR|FZ)?(DZ|RA|SN|SG|IC|PE|GR|GS|UP|BR|FG|FU|VA|SA|HZ|PY|DU|SQ|SS|DS|PO|\\+?FC)$"

class MetarReport:

    """

    This class provides a means to download and parse the decoded METAR reports

    from http://weather.noaa.gov/

    In order to find the report relevant for you, find the closest station at

    http://www.nws.noaa.gov/oso/siteloc.shtml and feed its 4-letter station

    code to fetchMetarReport(), case does not matter.

    All methods return metric values, no matter what the station provides. The

    conversion factors were taken from the excellent "units" program.

    If None is returned that means the information wasn't available or could

    not be parsed. If you have the suspicion that failure to parse an

    information was this libs fault, please save the report generating the

    error send it to me with a few lines detailing the problem. Thanks!

    """

    def match_WeatherPart(self, regexp) :

        """

        Returns the matching part of the encoded Metar report.  

        regexp: the regexp needed to extract this part.  

        Returns the first matching string or None.  

        WARNING: Some Metar reports may contain several matching strings, only

        the first one is taken into account, e.g. FEW020 SCT075 BKN053 

        """

        if self.code is not None :

            rg = re.compile(regexp)

            for wpart in self.getRawMetarCode().split() :

                match = rg.match(wpart)

                if match :

                    return match.string[match.start(0) : match.end(0)]

    def extractSkyConditions(self) :

        """

        Extracts sky condition information from the encoded report.  Returns a

        tuple containing the description of the sky conditions as a string and

        a suggested pixmap name for an icon representing said sky condition.

        """

        wcond = self.match_WeatherPart(COND_RE_STR)

        if wcond is not None :

            if (len(wcond) > 3) and (wcond.startswith('+') or wcond.startswith('-')) :

                wcond = wcond[1:]

            if wcond.startswith('+') or wcond.startswith('-') :

                pphen = 1

            elif len(wcond) < 4 :

                pphen = 0

            else :

                pphen = 2

            squal = wcond[:pphen]

            sphen = wcond[pphen : pphen + 4]

            phenomenon = _WeatherConditions.get(sphen, None)

            if phenomenon is not None :

                (name, pixmap, phenomenon) = phenomenon

                pheninfo = phenomenon.get(squal, name)

                if type(pheninfo) != types.TupleType :

                    return (pheninfo, pixmap)

                else :

                    # contains pixmap info

                    return pheninfo

    def parseLatLong(self, latlong):

        """

        Parse Lat or Long in METAR notation into float values. N and E are +, S

        and W are -. Expects one positional string and returns one float value.

        """

        # I know, I could invert this if and put