Skip to main content

Lint for HTTP messages.

Project description

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 three bytes arguments: method, uri, and version
    • process_response_topline, which takes three bytes arguments: version, status_code, and status_phrase
  • process_headers for the headers, taking a list of (name, value) tuples (both bytes)
  • feed_content for the body (which can be called zero to many times), taking an inbytes argument
  • finish_content when done, which has two arguments; a bool indicating whether the response was complete, and an optional list of tuples for the trailers, in the same format that process_headers takes.

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; see note.categories
  • level - see note.levels
  • summary - a brief, one-line description of the note
  • detail - 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

httplint-2023.11.1.tar.gz (69.0 kB view details)

Uploaded Source

Built Distribution

httplint-2023.11.1-py3-none-any.whl (102.9 kB view details)

Uploaded Python 3

File details

Details for the file httplint-2023.11.1.tar.gz.

File metadata

  • Download URL: httplint-2023.11.1.tar.gz
  • Upload date:
  • Size: 69.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for httplint-2023.11.1.tar.gz
Algorithm Hash digest
SHA256 557cf8aea72d5136a10da20be315854cf780a76dc17327c139816fd8d6185344
MD5 e965bb0fb3fa234f501271ced00aad7e
BLAKE2b-256 417b4a7d02314e431d79652d7e64cf32230dd42cc9060b195e12e6459c07aa47

See more details on using hashes here.

Provenance

File details

Details for the file httplint-2023.11.1-py3-none-any.whl.

File metadata

  • Download URL: httplint-2023.11.1-py3-none-any.whl
  • Upload date:
  • Size: 102.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for httplint-2023.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e3826ad36c79a985e96eef9c14644141764fa63d3f0837c91294c09764c16aa3
MD5 9d905112571a5ef3cdf5c37e2e10b28b
BLAKE2b-256 92093c1e82128591005ada12f2bb0bef026a5e2300c55e0cf966c08ae1049fa8

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page