Before you begin
- Python 3.12 or newer
Set up your example
- Save the complete code as http-cache-inspect.py in a working folder.
- Save the provided sample files in that same folder; run commands from that folder.
- For the provided local HTTP examples, open another terminal in this folder and run: python -m http.server 8765 --bind 127.0.0.1. Keep it running while using the tool.
Sample files in this download:
- urls.txt
- sample.txt
- data.json
- page1.json
- page2.json
- robots.txt
- ips.txt
Download the ZIP, extract it, and open a terminal inside the extracted folder. The source file is http-cache-inspect.py.
Run the script
python "http-cache-inspect.py" --url "http://127.0.0.1:8765/sample.txt" --output "cache.json"If your system uses python3 instead of python, use that command for Python examples. Keep paths containing spaces in quotes. Required inputs and optional settings are described in the code and setup steps.
What to expect
Collect cache validators, freshness declarations, and vary information. The local fixture supplies last-modified and date; other entries may be null.
The complete script
#!/usr/bin/env python3
'Inspect HTTP cache-related headers'
import argparse
import json
from pathlib import Path
def write_json(path, value):
data = json.dumps(value, indent=2, ensure_ascii=False, allow_nan=False) + "\n"
with Path(path).open("x", encoding="utf-8", newline="") as handle:
handle.write(data)
import urllib.request
import urllib.error
import urllib.parse
import urllib.robotparser
import socket
import ssl
import time
import re
import ipaddress
import queue
import threading
from datetime import datetime, timezone
def url(value):
parts=urllib.parse.urlsplit(value)
if parts.scheme not in {"http","https"} or not parts.hostname or parts.username is not None or parts.password is not None:
raise ValueError("Use an http(s) URL without embedded credentials.")
return value
def request(address,timeout,method="GET",headers=None,limit=1024*1024,opener=None):
url(address)
if not 0<timeout<=120: raise ValueError("Timeout must be 0..120 seconds, excluding zero.")
req=urllib.request.Request(address,method=method,headers={"User-Agent":"ScriptageLearning/1.0",**(headers or {})})
try: response=(opener.open(req,timeout=timeout) if opener else urllib.request.urlopen(req,timeout=timeout))
except urllib.error.HTTPError as exc: response=exc
with response:
data=response.read(limit+1) if limit else b""
if len(data)>limit: raise ValueError("Response exceeds the byte limit.")
return response.status,response.geturl(),{k.lower():v for k,v in response.headers.items()},data
def checked(address,timeout,**kwargs):
status,final,headers,data=request(address,timeout,**kwargs)
if not 200<=status<300: raise ValueError("HTTP status "+str(status))
return final,headers,data
def urls(path):
result=[line.strip() for line in Path(path).read_text(encoding="utf-8").splitlines() if line.strip()]
if len(result)>100: raise ValueError("At most 100 URLs per run.")
return result
def resolve(host,port,timeout):
result=queue.Queue()
def work():
try: result.put((True,socket.getaddrinfo(host,port,type=socket.SOCK_STREAM)))
except OSError as exc: result.put((False,str(exc)))
threading.Thread(target=work,daemon=True).start()
try: ok,value=result.get(timeout=timeout)
except queue.Empty: raise ValueError("DNS lookup timed out.")
if not ok: raise ValueError(value)
return value
def connect(host,port,timeout):
last=None
for family,kind,proto,_,address in resolve(host,port,timeout):
connection=socket.socket(family,kind,proto)
connection.settimeout(timeout)
try:
connection.connect(address)
return connection
except OSError as exc:
last=exc
connection.close()
raise OSError(str(last))
def main():
parser = argparse.ArgumentParser(description='Inspect HTTP cache-related headers')
parser.add_argument("--output",required=True,help="New output file")
parser.add_argument("--timeout",type=float,default=10,help="Per-operation timeout in seconds")
parser.add_argument("--url",required=True)
args = parser.parse_args()
if not 0<args.timeout<=120: raise ValueError("Timeout must be greater than zero and at most 120.")
status,final,headers,_=request(args.url,args.timeout,method="HEAD",limit=0)
keys=["cache-control","expires","etag","last-modified","age","vary","date"]
write_json(args.output,{"url":final,"status":status,"cache_headers":{k:headers.get(k) for k in keys}})
if __name__ == "__main__":
try:
main()
except (OSError, ValueError, KeyError, TypeError, ArithmeticError, IndexError, LookupError) as exc:
raise SystemExit(str(exc))
Open source as plain text · Download source and sample files
How it works
- The command names every destination explicitly and refuses an existing output.
- Absent headers are recorded as null; the tool does not simulate a browser cache or calculate effective freshness.
- The local fixture supplies last-modified and date; other entries may be null.
Make it your own
--url
Choose a resource whose caching configuration you control.
Adapt the processing
Edit main's keys list to include another diagnostic response header.
Change one setting at a time, run it again on sample data, and compare the output. The customization guide walks through this process.
If something goes wrong
ETag is null.
Not every server emits an ETag; use last-modified when supported.
The destination already exists.
Choose a new --output path. The script deliberately refuses to replace an existing result.
Reference & next steps
These official references explain the underlying tools. The Scriptage example and guide are original instructional content. See verification notes for what has been checked and the limits of those checks.
Copies a template for your own notes. It does not send anything.