{
"content": [
{
"type": "text",
"text": "# http (pydoc)\n\n## TLDR\n\n> HTTPie: an HTTP client designed for testing, debugging, and generally interacting with APIs and HTTP servers.\n\n- Make a simple GET request (shows response headers and content):\n `http {{https://example.com}}`\n- Print specific parts of the content (`H`: request headers, `B`: request body, `h`: response headers, `b`: response body, `m`: response metadata):\n `http {{-p|--print}} {{H|B|h|b|m|Hh|Hhb|...}} {{https://example.com}}`\n- Specify the HTTP method when sending a request and use a proxy to intercept the request:\n `http {{GET|POST|HEAD|PUT|PATCH|DELETE|...}} --proxy {{http|https}}:{{http://localhost:8080|socks5://localhost:9050|...}} {{https://example.com}}`\n- Follow any `3xx` redirects and specify additional headers in a request:\n `http {{-F|--follow}} {{https://example.com}} {{'User-Agent: Mozilla/5.0' 'Accept-Encoding: gzip'}}`\n- Authenticate to a server using different authentication methods:\n `http {{-a|--auth}} {{username:password|token}} {{-A|--auth-type}} {{basic|digest|bearer}} {{GET|POST|...}} {{https://example.com/auth}}`\n- Construct a request but do not send it (similar to a dry-run):\n `http --offline {{GET|DELETE|...}} {{https://example.com}}`\n- Use named sessions for persistent custom headers, auth credentials and cookies:\n `http --session {{session_name|path/to/session.json}} {{-a|--auth}} {{username}}:{{password}} {{https://example.com/auth}} {{API-KEY:xxx}}`\n- Upload a file to a form (the example below assumes that the form field is ``):\n `http {{-f|--form}} {{POST}} {{https://example.com/upload}} {{cv@path/to/file}}`\n\n*Source: tldr-pages*\n\n---\n\n**Summary:** http\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **PACKAGE CONTENTS** (5 lines)\n- **CLASSES** (3 lines) — 1 subsections\n - class HTTPStatus (171 lines)\n- **DATA** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\nhttp\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/http.html\n\nThe following documentation is automatically generated from the Python\nsource files. It may be incomplete, incorrect or include features that\nare considered implementation detail and may vary between Python\nimplementations. When in doubt, consult the module reference at the\nlocation listed above.\n\n### PACKAGE CONTENTS\n\nclient\ncookiejar\ncookies\nserver\n\n### CLASSES\n\nenum.IntEnum(builtins.int, enum.Enum)\nHTTPStatus\n\n#### class HTTPStatus\n\n| HTTPStatus(value, names=None, *, module=None, qualname=None, type=None, start=1)\n|\n| HTTP status codes and reason phrases\n|\n| Status codes from the following RFCs are all observed:\n|\n| * RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 2616\n| * RFC 6585: Additional HTTP Status Codes\n| * RFC 3229: Delta encoding in HTTP\n| * RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518\n| * RFC 5842: Binding Extensions to WebDAV\n| * RFC 7238: Permanent Redirect\n| * RFC 2295: Transparent Content Negotiation in HTTP\n| * RFC 2774: An HTTP Extension Framework\n| * RFC 7725: An HTTP Status Code to Report Legal Obstacles\n| * RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)\n| * RFC 2324: Hyper Text Coffee Pot Control Protocol (HTCPCP/1.0)\n| * RFC 8297: An HTTP Status Code for Indicating Hints\n| * RFC 8470: Using Early Data in HTTP\n|\n| Method resolution order:\n| HTTPStatus\n| enum.IntEnum\n| builtins.int\n| enum.Enum\n| builtins.object\n|\n| Data and other attributes defined here:\n|\n| ACCEPTED = \n|\n| ALREADYREPORTED = \n|\n| BADGATEWAY = \n|\n| BADREQUEST = \n|\n| CONFLICT = \n|\n| CONTINUE = \n|\n| CREATED = \n|\n| EARLYHINTS = \n|\n| EXPECTATIONFAILED = \n|\n| FAILEDDEPENDENCY = \n|\n| FORBIDDEN = \n|\n| FOUND = \n|\n| GATEWAYTIMEOUT = \n|\n| GONE = \n|\n| HTTPVERSIONNOTSUPPORTED = \n|\n| IMUSED = \n|\n| INSUFFICIENTSTORAGE = \n|\n| INTERNALSERVERERROR = \n|\n| LENGTHREQUIRED = \n|\n| LOCKED = \n|\n| LOOPDETECTED = \n|\n| METHODNOTALLOWED = \n|\n| MISDIRECTEDREQUEST = \n|\n| MOVEDPERMANENTLY = \n|\n| MULTIPLECHOICES = \n|\n| MULTISTATUS = \n|\n| NETWORKAUTHENTICATIONREQUIRED = \n|\n| NOTEXTENDED = \n|\n| NOTFOUND = \n|\n| NOTIMPLEMENTED = \n|\n| NOTMODIFIED = \n|\n| NOCONTENT = \n|\n| OK = \n|\n| PARTIALCONTENT = \n|\n| PAYMENTREQUIRED = \n|\n| PERMANENTREDIRECT = \n|\n| PRECONDITIONFAILED = \n|\n| PRECONDITIONREQUIRED = \n|\n| PROCESSING = \n|\n| PROXYAUTHENTICATIONREQUIRED = \n|\n| REQUESTHEADERFIELDSTOOLARGE = \n|\n| REQUESTURITOOLONG = \n|\n| RESETCONTENT = \n|\n| SEEOTHER = \n|\n| SERVICEUNAVAILABLE = \n|\n| SWITCHINGPROTOCOLS = \n|\n| TEMPORARYREDIRECT = \n|\n| TOOEARLY = \n|\n| TOOMANYREQUESTS = \n|\n| UNAUTHORIZED = \n|\n| UNAVAILABLEFORLEGALREASONS = \n|\n| UNSUPPORTEDMEDIATYPE = \n|\n| UPGRADEREQUIRED = \n|\n| USEPROXY = \n|\n| VARIANTALSONEGOTIATES = \n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from enum.Enum:\n|\n| name\n| The name of the Enum member.\n|\n| value\n| The value of the Enum member.\n|\n| ----------------------------------------------------------------------\n| Readonly properties inherited from enum.EnumMeta:\n|\n| members\n| Returns a mapping of member name->value.\n|\n| This mapping lists all enum members, including aliases. Note that this\n| is a read-only view of the internal mapping.\n\n### DATA\n\nall = ['HTTPStatus']\n\n### FILE\n\n/usr/lib/python3.10/http/init.py\n\n"
}
],
"structuredContent": {
"command": "http",
"section": "",
"mode": "pydoc",
"summary": "http",
"synopsis": null,
"tldr_summary": "HTTPie: an HTTP client designed for testing, debugging, and generally interacting with APIs and HTTP servers.",
"tldr_examples": [
{
"description": "Make a simple GET request (shows response headers and content)",
"command": "http {{https://example.com}}"
},
{
"description": "Print specific parts of the content (`H`: request headers, `B`: request body, `h`: response headers, `b`: response body, `m`: response metadata)",
"command": "http {{-p|--print}} {{H|B|h|b|m|Hh|Hhb|...}} {{https://example.com}}"
},
{
"description": "Specify the HTTP method when sending a request and use a proxy to intercept the request",
"command": "http {{GET|POST|HEAD|PUT|PATCH|DELETE|...}} --proxy {{http|https}}:{{http://localhost:8080|socks5://localhost:9050|...}} {{https://example.com}}"
},
{
"description": "Follow any `3xx` redirects and specify additional headers in a request",
"command": "http {{-F|--follow}} {{https://example.com}} {{'User-Agent: Mozilla/5.0' 'Accept-Encoding: gzip'}}"
},
{
"description": "Authenticate to a server using different authentication methods",
"command": "http {{-a|--auth}} {{username:password|token}} {{-A|--auth-type}} {{basic|digest|bearer}} {{GET|POST|...}} {{https://example.com/auth}}"
},
{
"description": "Construct a request but do not send it (similar to a dry-run)",
"command": "http --offline {{GET|DELETE|...}} {{https://example.com}}"
},
{
"description": "Use named sessions for persistent custom headers, auth credentials and cookies",
"command": "http --session {{session_name|path/to/session.json}} {{-a|--auth}} {{username}}:{{password}} {{https://example.com/auth}} {{API-KEY:xxx}}"
},
{
"description": "Upload a file to a form (the example below assumes that the form field is ``)",
"command": "http {{-f|--form}} {{POST}} {{https://example.com/upload}} {{cv@path/to/file}}"
}
],
"tldr_source": "official",
"flags": [],
"examples": [],
"see_also": [],
"section_outline": [
{
"name": "NAME",
"lines": 2,
"subsections": []
},
{
"name": "MODULE REFERENCE",
"lines": 8,
"subsections": []
},
{
"name": "PACKAGE CONTENTS",
"lines": 5,
"subsections": []
},
{
"name": "CLASSES",
"lines": 3,
"subsections": [
{
"name": "class HTTPStatus",
"lines": 171
}
]
},
{
"name": "DATA",
"lines": 2,
"subsections": []
},
{
"name": "FILE",
"lines": 3,
"subsections": []
}
]
}
}