Fix for tests

Use HTTPStatus enum for statuses

Author: drkane

findthatpostcode/areatypes.py

@@ -1,6 +1,7 @@
 import codecs
 import os
 import tempfile
+from http import HTTPStatus
 from typing import Annotated
 
 from fastapi import APIRouter, Form, HTTPException, Request, Response, UploadFile
@@ -67,10 +68,14 @@ def return_csv(
 
     filename = csvfile.filename
     if not isinstance(filename, str):
-        raise HTTPException(status_code=400, detail="No file uploaded.")
+        raise HTTPException(
+            status_code=HTTPStatus.BAD_REQUEST, detail="No file uploaded."
+        )
     _, ext = os.path.splitext(filename)
     if ext not in [".csv"]:
-        raise HTTPException(status_code=400, detail="File extension not allowed.")
+        raise HTTPException(
+            status_code=HTTPStatus.BAD_REQUEST, detail="File extension not allowed."
+        )
 
     with tempfile.SpooledTemporaryFile(mode="w+", newline="") as output:
         process_csv(

findthatpostcode/blueprints/addtocsv.py

@@ -1,6 +1,7 @@
 import csv
 import io
 import re
+from http import HTTPStatus
 from typing import Iterator
 
 from fastapi import APIRouter, Request, Response
@@ -22,7 +23,7 @@ def area_search(request: Request, filetype="json", q: str | None = None) -> Resp
     redirect_url = request.url_for("search_index")
     if q:
         redirect_url = redirect_url.include_query_params(q=q)
-    return RedirectResponse(redirect_url, status_code=301)
+    return RedirectResponse(redirect_url, status_code=HTTPStatus.SEE_OTHER)
 
 
 @bp.get("/names.csv")
@@ -63,7 +64,7 @@ def get_area_boundary(areacodes: str, es: ElasticsearchDep, s3_client: S3Dep):
             areacode, es, boundary=True, examples_count=0, s3_client=s3_client
         )
         status, r = result.geoJSON()
-        if status == 200 and isinstance(r, dict):
+        if status == HTTPStatus.OK and isinstance(r, dict):
             features.extend(r.get("features", []))
     return {"type": "FeatureCollection", "features": features}
 
@@ -82,14 +83,14 @@ def get_area_children_boundary(
                 child_area.id, es, boundary=True, examples_count=0, s3_client=s3_client
             )
             status, r = result.geoJSON()
-            if status == 200 and isinstance(r, dict):
+            if status == HTTPStatus.OK and isinstance(r, dict):
                 features.extend(r.get("features", []))
             else:
                 errors[child_area.id] = r
     else:
         errors["area"] = f"No children of type {areatype} found for area {areacode}"
     if not features:
-        return JSONResponse(dict(message=errors), status_code=404)
+        return JSONResponse(dict(message=errors), status_code=HTTPStatus.NOT_FOUND)
     return {"type": "FeatureCollection", "features": features}
 
 
@@ -114,7 +115,7 @@ def get_area(
 
     if filetype == "geojson":
         status, r = result.geoJSON()
-        if status != 200:
+        if status != HTTPStatus.OK:
             return JSONResponse(content={"message": r}, status_code=status)
         return JSONResponse(r)
 

findthatpostcode/blueprints/areas.py

@@ -1,3 +1,5 @@
+from http import HTTPStatus
+
 from fastapi import APIRouter, HTTPException, Request, Response
 
 from findthatpostcode.blueprints.areas import areas_csv
@@ -44,7 +46,9 @@ def get_areatype(
     try:
         result = Areatype.get_from_es(areacode, es)
     except ValueError:
-        raise HTTPException(status_code=404, detail="AreaType not found")
+        raise HTTPException(
+            status_code=HTTPStatus.NOT_FOUND, detail="AreaType not found"
+        )
     pagination = Pagination(page=p, size=size)
     result.get_areas(es, pagination=pagination)
 

findthatpostcode/blueprints/areatypes.py

@@ -1,3 +1,5 @@
+from http import HTTPStatus
+
 from fastapi import APIRouter, Request, Response
 from fastapi.responses import JSONResponse, RedirectResponse
 
@@ -15,7 +17,7 @@
 def point_redirect(lat: float, lon: float, request: Request) -> Response:
     return RedirectResponse(
         request.url_for("places.nearest", lat=lat, lon=lon, filetype="html"),
-        status_code=303,
+        status_code=HTTPStatus.SEE_OTHER,
     )
 
 
@@ -35,7 +37,7 @@ def nearest(
     data = es.search(
         index=PLACENAME_INDEX,
         body=query,
-        ignore=[404],  # type: ignore
+        ignore=[HTTPStatus.NOT_FOUND],  # type: ignore
         size=10,  # type: ignore
         _source_excludes=[],  # type: ignore
     )

findthatpostcode/blueprints/places.py

@@ -1,3 +1,5 @@
+from http import HTTPStatus
+
 from fastapi import APIRouter, Request, Response
 from fastapi.responses import RedirectResponse
 
@@ -17,7 +19,7 @@ def point_redirect(lat: float, lon: float, request: Request) -> Response:
         request.url_for(
             "get_point", latlon="{},{}.html".format(lat, lon), filetype="html"
         ),
-        status_code=303,
+        status_code=HTTPStatus.SEE_OTHER,
     )
 
 

findthatpostcode/blueprints/points.py

@@ -1,3 +1,4 @@
+from http import HTTPStatus
 from typing import Annotated
 
 from dictlib import dig_get
@@ -25,7 +26,7 @@
 def postcode_redirect(postcode: str, request: Request) -> Response:
     return RedirectResponse(
         request.url_for("get_postcode", postcode=postcode, filetype="html"),
-        status_code=303,
+        status_code=HTTPStatus.SEE_OTHER,
     )
 
 
@@ -87,7 +88,8 @@ def get_postcode_by_hash(
     for hash_ in hashes:
         if len(hash_) < 3:
             raise HTTPException(
-                status_code=400, detail="Hash length must be at least 3 characters"
+                status_code=HTTPStatus.UNPROCESSABLE_ENTITY,
+                detail="Hash length must be at least 3 characters",
             )
         query.append(
             {

findthatpostcode/blueprints/postcodes.py

@@ -2,6 +2,7 @@
 
 import csv
 import io
+from http import HTTPStatus
 from typing import Iterable
 
 from elasticsearch import Elasticsearch
@@ -42,7 +43,7 @@ def process_csv(
                 index=es_config.es_index,
                 doc_type=es_config.es_type,
                 id=postcode,
-                ignore=[404],  # type: ignore
+                ignore=[HTTPStatus.NOT_FOUND],  # type: ignore
             )
             if pc["found"]:
                 for i in fields:
@@ -55,7 +56,7 @@ def process_csv(
                                 index=AREA_INDEX,
                                 doc_type=es_config.es_type,
                                 id=code,
-                                ignore=[404],  # type: ignore
+                                ignore=[HTTPStatus.NOT_FOUND],  # type: ignore
                                 _source_excludes=["boundary"],  # type: ignore
                             )
                             if area["found"]:

findthatpostcode/blueprints/process_csv.py

@@ -1,4 +1,5 @@
 import re
+from http import HTTPStatus
 
 from fastapi import APIRouter, Request
 from fastapi.responses import RedirectResponse
@@ -52,13 +53,13 @@ def search_index(
                 "get_point",
                 latlon="{},{}.html".format(latlon["lat"], latlon["lon"]),  # type: ignore
             ),
-            status_code=303,
+            status_code=HTTPStatus.SEE_OTHER,
         )
 
     if is_postcode(q):
         return RedirectResponse(
             request.url_for("get_postcode", postcode=q, filetype="html"),
-            status_code=303,
+            status_code=HTTPStatus.SEE_OTHER,
         )
 
     pagination = Pagination(page=p, size=size)

findthatpostcode/blueprints/search.py

@@ -1,3 +1,5 @@
+from http import HTTPStatus
+
 from fastapi import HTTPException, Request, Response
 
 from findthatpostcode.controllers.controller import Controller
@@ -12,15 +14,18 @@ def return_result(
     **kwargs,
 ) -> Response | dict:
     if filetype == "html" and not template:
-        raise HTTPException(status_code=500, detail="No template provided")
+        raise HTTPException(
+            status_code=HTTPStatus.INTERNAL_SERVER_ERROR, detail="No template provided"
+        )
     if template is not None and request is None:
         raise HTTPException(
-            status_code=500, detail="No request provided for HTML response"
+            status_code=HTTPStatus.INTERNAL_SERVER_ERROR,
+            detail="No request provided for HTML response",
         )
 
-    status = 200 if result.found else 404
+    status = HTTPStatus.OK if result.found else HTTPStatus.NOT_FOUND
 
-    if status != 200:
+    if status != HTTPStatus.OK:
         errors = result.get_errors()
         if errors and errors[0].get("status"):
             status = int(errors[0]["status"])
@@ -45,4 +50,4 @@ def return_result(
             media_type="text/html",
         )
 
-    raise HTTPException(status_code=404, detail="Not found")
+    raise HTTPException(status_code=HTTPStatus.NOT_FOUND, detail="Not found")