Skip to the content.

Home

jc.parsers.curl_head

jc - JSON Convert curl --head command output parser

This parser converts standard and verbose curl --head output.

When converting verbose output from curl (to gather request headers, for example) you will need to redirect STDERR to STDOUT with 2>&1. The magic syntax will not work in this case.

Usage (cli):

$ curl --head www.example.com | jc --curl-head
$ curl -Ivs www.example.com 2>&1 | jc --curl-head

or

$ jc curl --head www.example.com

Usage (module):

import jc
result = jc.parse('curl_head', curl_head_command_output)

Schema:

[
  {
    "_type":                                string,  # request or response
    "_request_method":                      string,
    "_request_uri":                         string,
    "_request_version":                     string,
    "_response_version":                    string,
    "_response_status":                     integer,
    "_response_reason":                     string or null,
    "<header>":                             string,

    # well-known headers:

    "accept": [
                                            string
    ],
    "accept-ch": [
                                            string
    ],
    "accept-ch-lifetime":                   integer,
    "accept-encoding": [
                                            string
    ],
    "accept-language": [
                                            string
    ],
    "accept-patch": [
                                            string
    ],
    "accept-post": [
                                            string
    ],
    "accept-ranges": [
                                            string
    ],
    "access-control-allow-headers": [
                                            string
    ],
    "access-control-allow-methods": [
                                            string
    ],
    "access-control-expose-headers": [
                                            string
    ],
    "access-control-max-age":               integer,
    "access-control-request-headers": [
                                            string
    ],
    "age":                                  integer,
    "allow": [
                                            string
    ],
    "alt-svc": [
                                            string
    ],
    "cache-control": [
                                            string
    ],
    "clear-site-data": [
                                            string
    ],
    "connection": [
                                            string
    ],
    "content-encoding": [
                                            string
    ],
    "content-dpr":                          integer,
    "content-language": [
                                            string
    ],
    "content-length":                       integer,
    "content-security-policy": [
                                            string
    ],
    "content-security-policy-report-only": [
                                            string
    ],
    "cookie": [
                                            string
    ],
    "critical-ch": [
                                            string
    ],
    "date":                                 string,
    "date_epoch_utc":                       integer,
    "expect-ct": [
                                            string
    ],
    "expires":                              string,
    "expires_epoch_utc":                    integer,
    "device-memory":                        integer,
    "downlink":                             integer,
    "dpr":                                  integer,
    "forwarded": [
                                            string
    ],
    "if-match": [
                                            string
    ],
    "if-modified-since":                    string,
    "if-modified-since_epoch_utc":          integer,
    "if-none-match": [
                                            string
    ],
    "if-range":                             string,
    "if-range_epoch_utc":                   integer,
    "if-unmodified-since":                  string,
    "if-unmodified-since_epoch_utc":        integer,
    "im": [
                                            string
    ],
    "keep-alive": [
                                            string
    ],
    "large-allocation":                     integer,
    "last-modified":                        string,
    "last-modified_epoch_utc":              integer,
    "link": [
                                            string
    ],
    "max-forwards":                         integer,
    "memento-datetime":                     string,
    "memento-datetime_epoch_utc":           integer,
    "permissions-policy": [
                                            string
    ],
    "permissions-policy-report-only": [
                                            string
    ],
    "pragma": [
                                            string
    ],
    "proxy-authenticate": [
                                            string
    ],
    "reporting-endpoints": [
                                            string
    ],
    "retry-after":                          string,
    "retry-after_epoch_utc":                integer,
    "rtt":                                  integer,
    "sec-ch-ua": [
                                            string
    ],
    "sec-ch-ua-full-version-list": [
                                            string
    ],
    "server": [
                                            string
    ],
    "server-timing": [
                                            string
    ],
    "set-cookie": [
                                            string
    ],
    "timing-allow-origin": [
                                            string
    ],
    "trailer": [
                                            string
    ],
    "transfer-encoding": [
                                            string
    ],
    "upgrade": [
                                            string
    ],
    "upgrade-insecure-requests":            integer,
    "vary": [
                                            string
    ],
    "via": [
                                            string
    ],
    "warning": [
                                            string
    ],
    "www-authenticate": [
                                            string
    ],
    "x-cache-hits": [
                                            integer
    ],
    "x-content-duration":                   float
  }
]

Examples:

$ curl --head www.example.com | jc --curl-head -p
[
  {
    "_type": "response",
    "_response_version": "HTTP/1.1",
    "_response_status": 200,
    "_response_reason": [
      "OK"
    ],
    "accept-ranges": [
      "bytes"
    ],
    "age": 241144,
    "cache-control": [
      "max-age=604800"
    ],
    "content-type": "text/html; charset=UTF-8",
    "date": "Sun, 04 Feb 2024 23:26:29 GMT",
    "etag": "\"3147526947\"",
    "expires": "Sun, 11 Feb 2024 23:26:29 GMT",
    "last-modified": "Thu, 17 Oct 2019 07:18:26 GMT",
    "server": [
      "ECS (sac/2508)"
    ],
    "x-cache": "HIT",
    "content-length": 1256,
    "date_epoch_utc": 1707089189,
    "expires_epoch_utc": 1707693989,
    "last-modified_epoch_utc": 1571296706
  }
]

$ curl --head www.example.com | jc --curl-head -p -r
[
  {
    "_type": "response",
    "_response_version": "HTTP/1.1",
    "_response_status": 200,
    "_response_reason": [
      "OK"
    ],
    "accept-ranges": [
      "bytes"
    ],
    "age": "225102",
    "cache-control": [
      "max-age=604800"
    ],
    "content-type": "text/html; charset=UTF-8",
    "date": "Sun, 04 Feb 2024 23:28:17 GMT",
    "etag": "\"3147526947\"",
    "expires": "Sun, 11 Feb 2024 23:28:17 GMT",
    "last-modified": "Thu, 17 Oct 2019 07:18:26 GMT",
    "server": [
      "ECS (sac/2575)"
    ],
    "x-cache": "HIT",
    "content-length": "1256"
  }
]

parse

def parse(data: str,
          raw: bool = False,
          quiet: bool = False) -> List[Dict[str, Any]]

Main text parsing function

Parameters:

data:        (string)  text data to parse
raw:         (boolean) unprocessed output if True
quiet:       (boolean) suppress warning messages if True

Returns:

List of Dictionaries. Raw or processed structured data.

Parser Information

Compatibility: linux, darwin, cygwin, win32, aix, freebsd

Source: jc/parsers/curl_head.py

Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)