From 7812fda63e4550ce615867297c31432bd596c8ab Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Sat, 10 Oct 2020 08:40:21 -0400 Subject: [PATCH 1/2] fix typos in docstrings --- pygeoapi/formatter/base.py | 2 +- pygeoapi/provider/base.py | 2 +- pygeoapi/provider/csv_.py | 2 +- pygeoapi/provider/elasticsearch_.py | 2 +- pygeoapi/provider/mongo.py | 2 +- pygeoapi/provider/ogr.py | 14 +++++++------- pygeoapi/provider/postgresql.py | 2 +- pygeoapi/provider/rasterio_.py | 2 +- pygeoapi/provider/sqlite.py | 2 +- pygeoapi/provider/tile.py | 2 +- pygeoapi/provider/xarray_.py | 2 +- 11 files changed, 17 insertions(+), 17 deletions(-) diff --git a/pygeoapi/formatter/base.py b/pygeoapi/formatter/base.py index 62e73e8..4a79de6 100644 --- a/pygeoapi/formatter/base.py +++ b/pygeoapi/formatter/base.py @@ -41,7 +41,7 @@ class BaseFormatter: :param formatter_def: formatter definition - :returns: pygeoapi.providers.base.BaseFormatter + :returns: pygeoapi.formatter.base.BaseFormatter """ self.mimetype = None diff --git a/pygeoapi/provider/base.py b/pygeoapi/provider/base.py index a40c945..b0a6414 100644 --- a/pygeoapi/provider/base.py +++ b/pygeoapi/provider/base.py @@ -41,7 +41,7 @@ class BaseProvider: :param provider_def: provider definition - :returns: pygeoapi.providers.base.BaseProvider + :returns: pygeoapi.provider.base.BaseProvider """ try: diff --git a/pygeoapi/provider/csv_.py b/pygeoapi/provider/csv_.py index 70dc8f9..df0024b 100644 --- a/pygeoapi/provider/csv_.py +++ b/pygeoapi/provider/csv_.py @@ -47,7 +47,7 @@ class CSVProvider(BaseProvider): :param provider_def: provider definition - :returns: pygeoapi.providers.csv_.CSVProvider + :returns: pygeoapi.provider.csv_.CSVProvider """ BaseProvider.__init__(self, provider_def) diff --git a/pygeoapi/provider/elasticsearch_.py b/pygeoapi/provider/elasticsearch_.py index 163a1c8..5d4987b 100644 --- a/pygeoapi/provider/elasticsearch_.py +++ b/pygeoapi/provider/elasticsearch_.py @@ -50,7 +50,7 @@ class ElasticsearchProvider(BaseProvider): :param provider_def: provider definition - :returns: pygeoapi.providers.elasticsearch_.ElasticsearchProvider + :returns: pygeoapi.provider.elasticsearch_.ElasticsearchProvider """ BaseProvider.__init__(self, provider_def) diff --git a/pygeoapi/provider/mongo.py b/pygeoapi/provider/mongo.py index eea5e23..698e803 100644 --- a/pygeoapi/provider/mongo.py +++ b/pygeoapi/provider/mongo.py @@ -50,7 +50,7 @@ class MongoProvider(BaseProvider): :param provider_def: provider definitions from yml pygeoapi-config. data,id_field, name set in parent class - :returns: pygeoapi.providers.mongo.MongoProvider + :returns: pygeoapi.provider.mongo.MongoProvider """ # this is dummy value never used in case of Mongo. # Mongo id field is _id diff --git a/pygeoapi/provider/ogr.py b/pygeoapi/provider/ogr.py index b8c16f5..f188d22 100644 --- a/pygeoapi/provider/ogr.py +++ b/pygeoapi/provider/ogr.py @@ -106,7 +106,7 @@ class OGRProvider(BaseProvider): :param provider_def: provider definition - :returns: pygeoapi.providers.ogr.OGRProvider + :returns: pygeoapi.provider.ogr.OGRProvider """ BaseProvider.__init__(self, provider_def) @@ -535,7 +535,7 @@ class SourceHelper: :param provider: provider instance - :returns: pygeoapi.providers.ogr.SourceHelper + :returns: pygeoapi.provider.ogr.SourceHelper """ self.provider = provider @@ -590,7 +590,7 @@ class CommonSourceHelper(SourceHelper): :param provider: provider instance - :returns: pygeoapi.providers.ogr.SourceHelper + :returns: pygeoapi.provider.ogr.SourceHelper """ SourceHelper.__init__(self, provider) self.startindex = -1 @@ -674,7 +674,7 @@ class ESRIJSONHelper(CommonSourceHelper): :param provider: provider instance - :returns: pygeoapi.providers.ogr.SourceHelper + :returns: pygeoapi.provider.ogr.SourceHelper """ CommonSourceHelper.__init__(self, provider) @@ -737,7 +737,7 @@ class WFSHelper(SourceHelper): :param provider: provider instance - :returns: pygeoapi.providers.ogr.SourceHelper + :returns: pygeoapi.provider.ogr.SourceHelper """ SourceHelper.__init__(self, provider) @@ -774,7 +774,7 @@ class GdalErrorHandler: """ Initialize the error handler - :returns: pygeoapi.providers.ogr.GdalErrorHandler + :returns: pygeoapi.provider.ogr.GdalErrorHandler """ self.err_level = osgeo_gdal.CE_None self.err_num = 0 @@ -788,7 +788,7 @@ class GdalErrorHandler: :param err_num: internal gdal error number :param err_msg: error message - :returns: pygeoapi.providers.ogr.GdalErrorHandler + :returns: pygeoapi.provider.ogr.GdalErrorHandler """ err_type = { diff --git a/pygeoapi/provider/postgresql.py b/pygeoapi/provider/postgresql.py index 0af04e2..cd0b84d 100644 --- a/pygeoapi/provider/postgresql.py +++ b/pygeoapi/provider/postgresql.py @@ -144,7 +144,7 @@ class PostgreSQLProvider(BaseProvider): data contains the connection information for class DatabaseCursor - :returns: pygeoapi.providers.base.PostgreSQLProvider + :returns: pygeoapi.provider.base.PostgreSQLProvider """ BaseProvider.__init__(self, provider_def) diff --git a/pygeoapi/provider/rasterio_.py b/pygeoapi/provider/rasterio_.py index 68fdefa..00ac50e 100644 --- a/pygeoapi/provider/rasterio_.py +++ b/pygeoapi/provider/rasterio_.py @@ -47,7 +47,7 @@ class RasterioProvider(BaseProvider): """ Initialize object :param provider_def: provider definition - :returns: pygeoapi.providers.rasterio_.RasterioProvider + :returns: pygeoapi.provider.rasterio_.RasterioProvider """ BaseProvider.__init__(self, provider_def) diff --git a/pygeoapi/provider/sqlite.py b/pygeoapi/provider/sqlite.py index aaa5103..48c7e50 100644 --- a/pygeoapi/provider/sqlite.py +++ b/pygeoapi/provider/sqlite.py @@ -59,7 +59,7 @@ class SQLiteGPKGProvider(BaseProvider): :param provider_def: provider definitions from yml pygeoapi-config. data,id_field, name set in parent class - :returns: pygeoapi.providers.base.SQLiteProvider + :returns: pygeoapi.provider.base.SQLiteProvider """ BaseProvider.__init__(self, provider_def) diff --git a/pygeoapi/provider/tile.py b/pygeoapi/provider/tile.py index cfac7d2..9433b7c 100644 --- a/pygeoapi/provider/tile.py +++ b/pygeoapi/provider/tile.py @@ -43,7 +43,7 @@ class BaseTileProvider: :param provider_def: provider definition - :returns: pygeoapi.providers.tile.BaseTileProvider + :returns: pygeoapi.provider.tile.BaseTileProvider """ self.name = provider_def['name'] diff --git a/pygeoapi/provider/xarray_.py b/pygeoapi/provider/xarray_.py index d9e603b..713fa34 100644 --- a/pygeoapi/provider/xarray_.py +++ b/pygeoapi/provider/xarray_.py @@ -51,7 +51,7 @@ class XarrayProvider(BaseProvider): """ Initialize object :param provider_def: provider definition - :returns: pygeoapi.providers.xarray_.XarrayProvider + :returns: pygeoapi.provider.xarray_.XarrayProvider """ BaseProvider.__init__(self, provider_def) From 3cffb7bfda7d0a9a711b328b71a5eb1469a30a01 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Sat, 10 Oct 2020 08:40:45 -0400 Subject: [PATCH 2/2] remove unused pathinfo arg for coverages --- pygeoapi/api.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/pygeoapi/api.py b/pygeoapi/api.py index 9c0afc3..b82fac1 100644 --- a/pygeoapi/api.py +++ b/pygeoapi/api.py @@ -1222,15 +1222,13 @@ class API: return headers_, 200, to_json(content, self.pretty_print) @jsonldify - def get_collection_coverage(self, headers, args, dataset, - pathinfo=None): + def get_collection_coverage(self, headers, args, dataset): """ Returns a subset of a collection coverage :param headers: dict of HTTP headers :param args: dict of HTTP request parameters :param dataset: dataset name - :param pathinfo: path location :returns: tuple of headers, status code, content """ @@ -1364,15 +1362,13 @@ class API: return headers_, 400, to_json(data, self.pretty_print) @jsonldify - def get_collection_coverage_domainset(self, headers, args, dataset, - pathinfo=None): + def get_collection_coverage_domainset(self, headers, args, dataset): """ Returns a collection coverage domainset :param headers: dict of HTTP headers :param args: dict of HTTP request parameters :param dataset: dataset name - :param pathinfo: path location :returns: tuple of headers, status code, content """ @@ -1431,15 +1427,13 @@ class API: return headers_, 400, to_json(exception, self.pretty_print) @jsonldify - def get_collection_coverage_rangetype(self, headers, args, dataset, - pathinfo=None): + def get_collection_coverage_rangetype(self, headers, args, dataset): """ Returns a collection coverage rangetype :param headers: dict of HTTP headers :param args: dict of HTTP request parameters :param dataset: dataset name - :param pathinfo: path location :returns: tuple of headers, status code, content """