mirror of
https://github.com/Unidata/python-awips.git
synced 2025-02-24 06:57:56 -05:00
254 lines
8 KiB
Python
254 lines
8 KiB
Python
# #
|
|
# This software was developed and / or modified by Raytheon Company,
|
|
# pursuant to Contract DG133W-05-CQ-1067 with the US Government.
|
|
#
|
|
# U.S. EXPORT CONTROLLED TECHNICAL DATA
|
|
# This software product contains export-restricted data whose
|
|
# export/transfer/disclosure is restricted by U.S. law. Dissemination
|
|
# to non-U.S. persons whether in the United States or abroad requires
|
|
# an export license or other authorization.
|
|
#
|
|
# Contractor Name: Raytheon Company
|
|
# Contractor Address: 6825 Pine Street, Suite 340
|
|
# Mail Stop B8
|
|
# Omaha, NE 68106
|
|
# 402.291.0100
|
|
#
|
|
# See the AWIPS II Master Rights File ("Master Rights File.pdf") for
|
|
# further licensing information.
|
|
# #
|
|
|
|
|
|
#
|
|
# Published interface for awips.dataaccess package
|
|
#
|
|
#
|
|
# SOFTWARE HISTORY
|
|
#
|
|
# Date Ticket# Engineer Description
|
|
# ------------ ---------- ----------- --------------------------
|
|
# 12/10/12 njensen Initial Creation.
|
|
# Feb 14, 2013 1614 bsteffen refactor data access framework
|
|
# to use single request.
|
|
# 04/10/13 1871 mnash move getLatLonCoords to JGridData and add default args
|
|
# 05/29/13 2023 dgilling Hook up ThriftClientRouter.
|
|
# 03/03/14 2673 bsteffen Add ability to query only ref times.
|
|
# 07/22/14 3185 njensen Added optional/default args to newDataRequest
|
|
# 07/30/14 3185 njensen Renamed valid identifiers to optional
|
|
# Apr 26, 2015 4259 njensen Updated for new JEP API
|
|
# Apr 13, 2016 5379 tgurney Add getIdentifierValues()
|
|
# Jun 01, 2016 5587 tgurney Add new signatures for
|
|
# getRequiredIdentifiers() and
|
|
# getOptionalIdentifiers()
|
|
# 10/07/16 ---- mjames@ucar Added getForecastRun
|
|
#
|
|
#
|
|
#
|
|
|
|
|
|
import sys
|
|
import subprocess
|
|
import warnings
|
|
|
|
THRIFT_HOST = "edex"
|
|
USING_NATIVE_THRIFT = False
|
|
|
|
if sys.modules.has_key('jep'):
|
|
# intentionally do not catch if this fails to import, we want it to
|
|
# be obvious that something is configured wrong when running from within
|
|
# Java instead of allowing false confidence and fallback behavior
|
|
import JepRouter
|
|
router = JepRouter
|
|
else:
|
|
from awips.dataaccess import ThriftClientRouter
|
|
router = ThriftClientRouter.ThriftClientRouter(THRIFT_HOST)
|
|
USING_NATIVE_THRIFT = True
|
|
|
|
def getForecastRun(cycle, times):
|
|
fcstRun = []
|
|
for t in times:
|
|
if str(t)[:19] == str(cycle):
|
|
fcstRun.append(t)
|
|
return fcstRun
|
|
|
|
def getAvailableTimes(request, refTimeOnly=False):
|
|
"""
|
|
Get the times of available data to the request.
|
|
|
|
Args:
|
|
request: the IDataRequest to get data for
|
|
refTimeOnly: optional, use True if only unique refTimes should be
|
|
returned (without a forecastHr)
|
|
|
|
Returns:
|
|
a list of DataTimes
|
|
"""
|
|
return router.getAvailableTimes(request, refTimeOnly)
|
|
|
|
|
|
def getGridData(request, times=[]):
|
|
"""
|
|
Gets the grid data that matches the request at the specified times. Each
|
|
combination of parameter, level, and dataTime will be returned as a
|
|
separate IGridData.
|
|
|
|
Args:
|
|
request: the IDataRequest to get data for
|
|
times: a list of DataTimes, a TimeRange, or None if the data is time
|
|
agnostic
|
|
|
|
Returns:
|
|
a list of IGridData
|
|
"""
|
|
return router.getGridData(request, times)
|
|
|
|
|
|
def getGeometryData(request, times=[]):
|
|
"""
|
|
Gets the geometry data that matches the request at the specified times.
|
|
Each combination of geometry, level, and dataTime will be returned as a
|
|
separate IGeometryData.
|
|
|
|
Args:
|
|
request: the IDataRequest to get data for
|
|
times: a list of DataTimes, a TimeRange, or None if the data is time
|
|
agnostic
|
|
|
|
Returns:
|
|
a list of IGeometryData
|
|
"""
|
|
return router.getGeometryData(request, times)
|
|
|
|
|
|
def getAvailableLocationNames(request):
|
|
"""
|
|
Gets the available location names that match the request without actually
|
|
requesting the data.
|
|
|
|
Args:
|
|
request: the request to find matching location names for
|
|
|
|
Returns:
|
|
a list of strings of available location names.
|
|
"""
|
|
return router.getAvailableLocationNames(request)
|
|
|
|
|
|
def getAvailableParameters(request):
|
|
"""
|
|
Gets the available parameters names that match the request without actually
|
|
requesting the data.
|
|
|
|
Args:
|
|
request: the request to find matching parameter names for
|
|
|
|
Returns:
|
|
a list of strings of available parameter names.
|
|
"""
|
|
return router.getAvailableParameters(request)
|
|
|
|
|
|
def getAvailableLevels(request):
|
|
"""
|
|
Gets the available levels that match the request without actually
|
|
requesting the data.
|
|
|
|
Args:
|
|
request: the request to find matching levels for
|
|
|
|
Returns:
|
|
a list of strings of available levels.
|
|
"""
|
|
return router.getAvailableLevels(request)
|
|
|
|
|
|
def getRequiredIdentifiers(request):
|
|
"""
|
|
Gets the required identifiers for this request. These identifiers
|
|
must be set on a request for the request of this datatype to succeed.
|
|
|
|
Args:
|
|
request: the request to find required identifiers for
|
|
|
|
Returns:
|
|
a list of strings of required identifiers
|
|
"""
|
|
if str(request) == request:
|
|
warnings.warn("Use getRequiredIdentifiers(IDataRequest) instead",
|
|
DeprecationWarning)
|
|
return router.getRequiredIdentifiers(request)
|
|
|
|
|
|
def getOptionalIdentifiers(request):
|
|
"""
|
|
Gets the optional identifiers for this request.
|
|
|
|
Args:
|
|
request: the request to find optional identifiers for
|
|
|
|
Returns:
|
|
a list of strings of optional identifiers
|
|
"""
|
|
if str(request) == request:
|
|
warnings.warn("Use getOptionalIdentifiers(IDataRequest) instead",
|
|
DeprecationWarning)
|
|
return router.getOptionalIdentifiers(request)
|
|
|
|
|
|
def getIdentifierValues(request, identifierKey):
|
|
"""
|
|
Gets the allowed values for a particular identifier on this datatype.
|
|
|
|
Args:
|
|
request: the request to find identifier values for
|
|
identifierKey: the identifier to find values for
|
|
|
|
Returns:
|
|
a list of strings of allowed values for the specified identifier
|
|
"""
|
|
return router.getIdentifierValues(request, identifierKey)
|
|
|
|
def newDataRequest(datatype=None, **kwargs):
|
|
""""
|
|
Creates a new instance of IDataRequest suitable for the runtime environment.
|
|
All args are optional and exist solely for convenience.
|
|
|
|
Args:
|
|
datatype: the datatype to create a request for
|
|
parameters: a list of parameters to set on the request
|
|
levels: a list of levels to set on the request
|
|
locationNames: a list of locationNames to set on the request
|
|
envelope: an envelope to limit the request
|
|
**kwargs: any leftover kwargs will be set as identifiers
|
|
|
|
Returns:
|
|
a new IDataRequest
|
|
"""
|
|
return router.newDataRequest(datatype, **kwargs)
|
|
|
|
def getSupportedDatatypes():
|
|
"""
|
|
Gets the datatypes that are supported by the framework
|
|
|
|
Returns:
|
|
a list of strings of supported datatypes
|
|
"""
|
|
return router.getSupportedDatatypes()
|
|
|
|
|
|
def changeEDEXHost(newHostName):
|
|
"""
|
|
Changes the EDEX host the Data Access Framework is communicating with. Only
|
|
works if using the native Python client implementation, otherwise, this
|
|
method will throw a TypeError.
|
|
|
|
Args:
|
|
newHostHame: the EDEX host to connect to
|
|
"""
|
|
if USING_NATIVE_THRIFT:
|
|
global THRIFT_HOST
|
|
THRIFT_HOST = newHostName
|
|
global router
|
|
router = ThriftClientRouter.ThriftClientRouter(THRIFT_HOST)
|
|
else:
|
|
raise TypeError("Cannot call changeEDEXHost when using JepRouter.")
|