use singular for enums

CHANGES.md

@@ -6,6 +6,10 @@
 * update FastAPI requirements
 * update minimal python version to 3.6
 
+**breaking change**
+
+* renamed `OptionalHeader`, `MimeTypes` and `ImageDrivers` to the singular form.
+
 ## 0.1.0 (2021-02-17)
 
 * update FastAPI requirements

tests/test_factories.py

@@ -9,7 +9,7 @@
 
 from titiler.dependencies import TMSParams, WebMercatorTMSParams
 from titiler.endpoints import factory
-from titiler.resources.enums import OptionalHeaders
+from titiler.resources.enums import OptionalHeader
 
 from .conftest import DATA_DIR
 
@@ -30,7 +30,7 @@ def test_TilerFactory():
     assert len(cog.router.routes) == 17
 
     app = FastAPI()
-    cog = factory.TilerFactory(optional_headers=[OptionalHeaders.server_timing])
+    cog = factory.TilerFactory(optional_headers=[OptionalHeader.server_timing])
     app.include_router(cog.router)
     client = TestClient(app)
 
@@ -87,7 +87,7 @@ def tmpmosaic():
 def test_MosaicTilerFactory():
     """Test MosaicTilerFactory class."""
     mosaic = factory.MosaicTilerFactory(
-        optional_headers=[OptionalHeaders.server_timing, OptionalHeaders.x_assets],
+        optional_headers=[OptionalHeader.server_timing, OptionalHeader.x_assets],
         router_prefix="mosaic",
     )
     assert len(mosaic.router.routes) == 19

titiler/endpoints/factory.py

@@ -36,12 +36,7 @@
 )
 from ..models.mapbox import TileJSON
 from ..models.OGC import TileMatrixSetList
-from ..resources.enums import (
-    ImageType,
-    MimeTypes,
-    OptionalHeaders,
-    PixelSelectionMethod,
-)
+from ..resources.enums import ImageType, MimeType, OptionalHeader, PixelSelectionMethod
 from ..resources.responses import GeoJSONResponse, XMLResponse
 from ..templates import templates
 
@@ -106,7 +101,7 @@ class BaseTilerFactory(metaclass=abc.ABCMeta):
     gdal_config: Dict = field(default_factory=dict)
 
     # add additional headers in response
-    optional_headers: List[OptionalHeaders] = field(default_factory=list)
+    optional_headers: List[OptionalHeader] = field(default_factory=list)
 
     def __post_init__(self):
         """Post Init: register route and configure specific options."""
@@ -349,7 +344,7 @@ def tile(
                 )
             timings.append(("format", round(t.elapsed * 1000, 2)))
 
-            if OptionalHeaders.server_timing in self.optional_headers:
+            if OptionalHeader.server_timing in self.optional_headers:
                 headers["Server-Timing"] = ", ".join(
                     [f"{name};dur={time}" for (name, time) in timings]
                 )
@@ -516,7 +511,7 @@ def wmts(
                     "layer_name": "cogeo",
                     "media_type": tile_format.mimetype,
                 },
-                media_type=MimeTypes.xml.value,
+                media_type=MimeType.xml.value,
             )
 
     ############################################################################
@@ -553,7 +548,7 @@ def point(
                         )
             timings.append(("dataread", round(t.elapsed * 1000, 2)))
 
-            if OptionalHeaders.server_timing in self.optional_headers:
+            if OptionalHeader.server_timing in self.optional_headers:
                 response.headers["Server-Timing"] = ", ".join(
                     [f"{name};dur={time}" for (name, time) in timings]
                 )
@@ -616,7 +611,7 @@ def preview(
                 )
             timings.append(("format", round(t.elapsed * 1000, 2)))
 
-            if OptionalHeaders.server_timing in self.optional_headers:
+            if OptionalHeader.server_timing in self.optional_headers:
                 headers["Server-Timing"] = ", ".join(
                     [f"{name};dur={time}" for (name, time) in timings]
                 )
@@ -684,7 +679,7 @@ def part(
                 )
             timings.append(("format", round(t.elapsed * 1000, 2)))
 
-            if OptionalHeaders.server_timing in self.optional_headers:
+            if OptionalHeader.server_timing in self.optional_headers:
                 headers["Server-Timing"] = ", ".join(
                     [f"{name};dur={time}" for (name, time) in timings]
                 )
@@ -1140,12 +1135,12 @@ def tile(
                 )
             timings.append(("format", round(t.elapsed * 1000, 2)))
 
-            if OptionalHeaders.server_timing in self.optional_headers:
+            if OptionalHeader.server_timing in self.optional_headers:
                 headers["Server-Timing"] = ", ".join(
                     [f"{name};dur={time}" for (name, time) in timings]
                 )
 
-            if OptionalHeaders.x_assets in self.optional_headers:
+            if OptionalHeader.x_assets in self.optional_headers:
                 headers["X-Assets"] = ",".join(data.assets)
 
             return Response(content, media_type=format.mimetype, headers=headers)
@@ -1308,7 +1303,7 @@ def wmts(
                     "layer_name": "cogeo",
                     "media_type": tile_format.mimetype,
                 },
-                media_type=MimeTypes.xml.value,
+                media_type=MimeType.xml.value,
             )
 
     ############################################################################
@@ -1354,7 +1349,7 @@ def point(
                         )
             timings.append(("dataread", round((t.elapsed - mosaic_read) * 1000, 2)))
 
-            if OptionalHeaders.server_timing in self.optional_headers:
+            if OptionalHeader.server_timing in self.optional_headers:
                 response.headers["Server-Timing"] = ", ".join(
                     [f"{name};dur={time}" for (name, time) in timings]
                 )

titiler/models/OGC.py

@@ -5,7 +5,7 @@
 
 from pydantic import AnyHttpUrl, BaseModel
 
-from ..resources.enums import MimeTypes
+from ..resources.enums import MimeType
 
 
 class TileMatrixSetLink(BaseModel):
@@ -18,7 +18,7 @@ class TileMatrixSetLink(BaseModel):
 
     href: AnyHttpUrl
     rel: str = "item"
-    type: MimeTypes = MimeTypes.json
+    type: MimeType = MimeType.json
 
     class Config:
         """Config for model."""

titiler/resources/enums.py

@@ -7,8 +7,8 @@
 from rio_tiler.profiles import img_profiles
 
 
-class MimeTypes(str, Enum):
-    """Responses MineTypes."""
+class MimeType(str, Enum):
+    """Responses MineType."""
 
     tif = "image/tiff; application=geotiff"
     jp2 = "image/jp2"
@@ -24,8 +24,8 @@ class MimeTypes(str, Enum):
     text = "text/plain"
 
 
-class ImageDrivers(str, Enum):
-    """Rio-tiler supported output drivers."""
+class ImageDriver(str, Enum):
+    """Supported output GDAL drivers."""
 
     jpeg = "JPEG"
     png = "PNG"
@@ -55,16 +55,16 @@ def profile(self):
     @DynamicClassAttribute
     def driver(self):
         """Return rio-tiler image default profile."""
-        return ImageDrivers[self._name_].value
+        return ImageDriver[self._name_].value
 
     @DynamicClassAttribute
     def mimetype(self):
         """Return image mimetype."""
-        return MimeTypes[self._name_].value
+        return MimeType[self._name_].value
 
 
 class PixelSelectionMethod(str, Enum):
-    """rio-tiler-mosaic pixel selection methods"""
+    """rio-tiler.mosaic pixel selection methods"""
 
     first = "first"
     highest = "highest"
@@ -79,8 +79,8 @@ def method(self):
         return getattr(defaults, f"{self._value_.title()}Method")
 
 
-class OptionalHeaders(str, Enum):
-    """Optional Headers in responses."""
+class OptionalHeader(str, Enum):
+    """Optional Header to add in responses."""
 
     server_timing = "Server-Timing"
     x_assets = "X-Assets"