The app/utils.py module provides utility functions used throughout the application for validating document expiry and detecting contact information types.
Functions
Determines the type of contact information (email, link, or other) for a service.
def assess_contact_type(service_contact_info: str) -> str
Service contact information string (email, URL, or plain text)
"email", "link", or "other"
Implementation:
import re
from notifications_utils.recipient_validation.email_address import EMAIL_REGEX_PATTERN
def assess_contact_type(service_contact_info):
if re.search(EMAIL_REGEX_PATTERN, service_contact_info):
return "email"
if service_contact_info.startswith("http"):
return "link"
else:
return "other"
# Email detection
assess_contact_type("support@example.gov.uk") # Returns: "email"
# URL detection
assess_contact_type("https://example.gov.uk/contact") # Returns: "link"
# Other contact info
assess_contact_type("Call 0800 123 4567") # Returns: "other"
# From app/main/views/index.py
service_contact_info = service["data"]["contact_link"]
contact_info_type = assess_contact_type(service_contact_info)
# contact_info_type is then passed to templates to control rendering
document_has_expired
Checks if a document has passed its expiry date based on the available_until timestamp.
def document_has_expired(available_until: str) -> bool
ISO 8601 date string indicating when the document expires
True if the document expiry date has passed, False otherwise
Implementation:
from datetime import date
from dateutil import parser
def document_has_expired(available_until):
file_expiry_date = parser.parse(available_until).date()
# if expiry date passed, even if file is still available, we do not return it
# to respect data retention period set by the service
if file_expiry_date < date.today():
return True
return False
from datetime import date, timedelta
# Document expired yesterday
expired_date = (date.today() - timedelta(days=1)).isoformat()
document_has_expired(expired_date) # Returns: True
# Document expires tomorrow
valid_date = (date.today() + timedelta(days=1)).isoformat()
document_has_expired(valid_date) # Returns: False
# Document expires today (still valid)
today = date.today().isoformat()
document_has_expired(today) # Returns: False
# From app/main/views/index.py
metadata = response.json().get("document")
# Check expiry - abort with 410 Gone if expired
if metadata is None or (metadata["available_until"] and document_has_expired(metadata["available_until"])):
abort(410)
Documents are never served past their expiry date, even if they remain technically available in storage. This respects the data retention period set by the service.
