httplint
This Python library lints HTTP messages; it checks them for correctness and reports any issues it finds.
It has been extracted from REDbot, which will eventually depend upon it. Unlike REDbot, it does not perform any 'active' checks by making requests to the network, and it does not have a Web user interface.
Using httplint
httplint exposes two classes for linting: HttpRequestLinter and HttpResponseLinter. They expose the following methods for telling the linter about the HTTP message:
- As appropriate:
process_request_topline, which takes threebytesarguments:method,uri, andversionprocess_response_topline, which takes threebytesarguments:version,status_code, andstatus_phrase
process_headersfor the headers, taking a list of (name,value) tuples (bothbytes)feed_contentfor the body (which can be called zero to many times), taking aninbytesargumentfinish_contentwhen done, which has two arguments; aboolindicating whether the response was complete, and an optional list of tuples for the trailers, in the same format thatprocess_headerstakes.
For example:
from httplint import HttpResponseLinter
linter = HttpResponseLinter()
linter.process_response_topline(b'HTTP/1.1', b'200', b'OK')
linter.process_headers([
(b'Content-Type', b'text/plain'),
(b'Content-Length', b'10'),
(b'Cache-Control', b'max-age=60')
])
linter.feed_content(b'12345')
linter.feed_content(b'67890')
linter.finish_content(True)
Interpreting Notes
Once a message has been linted, the results will appear on the notes property. This is a list of Note objects, each having the following attributes:
category- the Note's category; seenote.categorieslevel- seenote.levelssummary- a brief, one-line description of the notedetail- a longer explanation
Note that summary is textual, and needs to be escaped in a markup environment; detail, however, is already escaped HTML.
Continuing our example:
for note in linter.notes:
print(note.summary)
and the output should be:
The Content-Length header is correct.
This response allows all caches to store it.
This response doesn't have a Date header.
This response is fresh until 1 min from now.
This response may still be served by a cache once it becomes stale.
Field Descriptions
The description of any field can be found by calling get_field_description. For example:
>>> from httplint import get_field_description
>>> get_field_description("Allow")
'The `Allow` response header advertises the set of methods that are supported by the resource.'
If a description cannot be found it will return None.
1 maintainer
Metadata
1 maintainer
Release files for httplint 2023.11.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| httplint-2023.11.1.tar.gz | 69.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| httplint-2023.11.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 172.0 kB
Release files / httplint-2023.11.1.tar.gz
| Download URL | httplint-2023.11.1.tar.gz |
|---|---|
| Size | 69.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
557cf8aea72d5136a10da20be315854cf780a76dc17327c139816fd8d6185344
|
|
BLAKE2b-256 checksum How to use checksums |
417b4a7d02314e431d79652d7e64cf32230dd42cc9060b195e12e6459c07aa47
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / httplint-2023.11.1-py3-none-any.whl
| Download URL | httplint-2023.11.1-py3-none-any.whl |
|---|---|
| Size | 102.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e3826ad36c79a985e96eef9c14644141764fa63d3f0837c91294c09764c16aa3
|
|
BLAKE2b-256 checksum How to use checksums |
92093c1e82128591005ada12f2bb0bef026a5e2300c55e0cf966c08ae1049fa8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
