From b5fd733e29ae03cc7babfb21340bd19d47d7c93d Mon Sep 17 00:00:00 2001 From: Michael James Date: Thu, 11 Oct 2018 14:18:36 -0600 Subject: [PATCH] doc updates for api pages --- awips/RadarCommon.py | 12 +++++--- awips/dataaccess/DataAccessLayer.py | 34 +++++++++++++++++++++-- awips/dataaccess/DataNotificationLayer.py | 6 ++-- docs/source/api/CombinedTimeQuery.rst | 7 +++++ docs/source/api/IFPClient.rst | 7 +++++ docs/source/api/ThriftClient.rst | 7 +++++ docs/source/api/TimeUtil.rst | 7 +++++ docs/source/api/index.rst | 4 +++ 8 files changed, 75 insertions(+), 9 deletions(-) create mode 100644 docs/source/api/CombinedTimeQuery.rst create mode 100644 docs/source/api/IFPClient.rst create mode 100644 docs/source/api/ThriftClient.rst create mode 100644 docs/source/api/TimeUtil.rst diff --git a/awips/RadarCommon.py b/awips/RadarCommon.py index f09b362..bd74730 100644 --- a/awips/RadarCommon.py +++ b/awips/RadarCommon.py @@ -30,9 +30,11 @@ def get_datetime_str(record): """ Get the datetime string for a record. - :param record: the record to get data for. + Args: + record: the record to get data for. - :returns: datetime string. + Returns: + datetime string. """ return str(record.getDataTime())[0:19].replace(" ","_") + ".0" @@ -40,9 +42,11 @@ def get_data_type(azdat): """ Get the radar file type (radial or raster). - :param azdat: Boolean. + Args: + azdat: Boolean. - :returns: Radial or raster. + Returns: + Radial or raster. """ if azdat: dattyp = "radial" diff --git a/awips/dataaccess/DataAccessLayer.py b/awips/dataaccess/DataAccessLayer.py index 9f30a04..28bc368 100644 --- a/awips/dataaccess/DataAccessLayer.py +++ b/awips/dataaccess/DataAccessLayer.py @@ -46,6 +46,17 @@ else: def getMetarObs(response): + """ + Processes a DataAccessLayer "obs" response into a dictionary, + with special consideration for multi-value parameters + "presWeather", "skyCover", and "skyLayerBase". + + Args: + response: DAL getGeometry() list + + Returns: + A dictionary of METAR obs + """ from datetime import datetime single_val_params = ["timeObs", "stationName", "longitude", "latitude", "temperature", "dewpoint", "windDir", @@ -87,6 +98,16 @@ def getMetarObs(response): def getSynopticObs(response): + """ + Processes a DataAccessLayer "sfcobs" response into a dictionary + of available parameters. + + Args: + response: DAL getGeometry() list + + Returns: + A dictionary of synop obs + """ from datetime import datetime station_names = [] params = response[0].getParameters() @@ -109,9 +130,16 @@ def getSynopticObs(response): def getForecastRun(cycle, times): """ - :param cycle: Forecast cycle reference time - :param times: All available times/cycles - :return: DataTime array for a single forecast run + Get the latest forecast run (list of objects) from all + all cycles and times returned from DataAccessLayer "grid" + response. + + Args: + cycle: Forecast cycle reference time + times: All available times/cycles + + Returns: + DataTime array for a single forecast run """ fcstRun = [] for t in times: diff --git a/awips/dataaccess/DataNotificationLayer.py b/awips/dataaccess/DataNotificationLayer.py index 8b10e57..fc2ccc8 100644 --- a/awips/dataaccess/DataNotificationLayer.py +++ b/awips/dataaccess/DataNotificationLayer.py @@ -93,7 +93,8 @@ def getGridDataUpdates(request): response = router.getNotificationFilter(request) notificationFilter = response.getNotificationFilter() jmsInfo = _getJmsConnectionInfo(response) - notifier = PyGridNotification(request, notificationFilter, requestHost=THRIFT_HOST, **jmsInfo) + notifier = PyGridNotification(request, notificationFilter, + requestHost=THRIFT_HOST, **jmsInfo) return notifier @@ -111,7 +112,8 @@ def getGeometryDataUpdates(request): response = router.getNotificationFilter(request) notificationFilter = response.getNotificationFilter() jmsInfo = _getJmsConnectionInfo(response) - notifier = PyGeometryNotification(request, notificationFilter, requestHost=THRIFT_HOST, **jmsInfo) + notifier = PyGeometryNotification(request, notificationFilter, + requestHost=THRIFT_HOST, **jmsInfo) return notifier diff --git a/docs/source/api/CombinedTimeQuery.rst b/docs/source/api/CombinedTimeQuery.rst new file mode 100644 index 0000000..8a33c80 --- /dev/null +++ b/docs/source/api/CombinedTimeQuery.rst @@ -0,0 +1,7 @@ +================= +CombinedTimeQuery +================= + +.. automodule:: awips.dataaccess.CombinedTimeQuery + :members: + :undoc-members: diff --git a/docs/source/api/IFPClient.rst b/docs/source/api/IFPClient.rst new file mode 100644 index 0000000..14c94f5 --- /dev/null +++ b/docs/source/api/IFPClient.rst @@ -0,0 +1,7 @@ +========= +IFPClient +========= + +.. automodule:: awips.gfe.IFPClient + :members: + :undoc-members: diff --git a/docs/source/api/ThriftClient.rst b/docs/source/api/ThriftClient.rst new file mode 100644 index 0000000..72cfb1d --- /dev/null +++ b/docs/source/api/ThriftClient.rst @@ -0,0 +1,7 @@ +====================== +ThriftClient +====================== + +.. automodule:: awips.ThriftClient + :members: + :undoc-members: diff --git a/docs/source/api/TimeUtil.rst b/docs/source/api/TimeUtil.rst new file mode 100644 index 0000000..d583e2a --- /dev/null +++ b/docs/source/api/TimeUtil.rst @@ -0,0 +1,7 @@ +====================== +TimeUtil +====================== + +.. automodule:: awips.TimeUtil + :members: + :undoc-members: diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index c18d4aa..a00c6da 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -12,7 +12,11 @@ API Documentation PyGeometryData SoundingsSupport ThriftClientRouter + ThriftClient + TimeUtil RadarCommon + IFPClient DateTimeConverter + CombinedTimeQuery * :ref:`genindex`