Compare commits

..

5 Commits

Author SHA1 Message Date
Batuhan Taskaya
309037fca9 Apply review feedback. 2022-05-05 19:24:37 +03:00
Batuhan Taskaya
6e75c5244d Don't make the pie-colors the bold 2022-05-05 18:30:28 +03:00
Batuhan Taskaya
34175e2d19 adapt to the new loglevel construct 2022-05-05 18:24:30 +03:00
Batuhan Taskaya
366b0c3fcd httpie cli check-updates 2022-05-05 18:18:12 +03:00
Batuhan Taskaya
c56692c9af Automatic release update warnings. 2022-05-05 18:18:12 +03:00
27 changed files with 248 additions and 445 deletions

View File

@@ -22,7 +22,7 @@ jobs:
python-version: 3.9
- name: Build a binary wheel and a source tarball
run: make install && make build
run: make build
- name: Release on PyPI
uses: pypa/gh-action-pypi-publish@master

View File

@@ -3,24 +3,14 @@
This document records all notable changes to [HTTPie](https://httpie.io).
This project adheres to [Semantic Versioning](https://semver.org/).
## [3.2.1](https://github.com/httpie/httpie/compare/3.1.0...3.2.1) (2022-05-06)
## [3.1.1.dev0](https://github.com/httpie/httpie/compare/3.1.0...HEAD) (Unreleased)
- Improved support for determining auto-streaming when the `Content-Type` header includes encoding information. ([#1383](https://github.com/httpie/httpie/pull/1383))
- Fixed the display of the crash happening in the secondary process for update checks. ([#1388](https://github.com/httpie/httpie/issues/1388))
## [3.2.0](https://github.com/httpie/httpie/compare/3.1.0...3.2.0) (2022-05-05)
- Added a warning for notifying the user about the new updates. ([#1336](https://github.com/httpie/httpie/pull/1336))
- Added support for single binary executables. ([#1330](https://github.com/httpie/httpie/pull/1330))
- Added support for man pages (and auto generation of them from the parser declaration). ([#1317](https://github.com/httpie/httpie/pull/1317))
- Added `http --manual` for man pages & regular manual with pager. ([#1343](https://github.com/httpie/httpie/pull/1343))
- Added support for session persistence of repeated headers with the same name. ([#1335](https://github.com/httpie/httpie/pull/1335))
- Added support for sending `Secure` cookies to the `localhost` (and `.local` suffixed domains). ([#1308](https://github.com/httpie/httpie/issues/1308))
- Improved UI for the progress bars. ([#1324](https://github.com/httpie/httpie/pull/1324))
- Changed `httpie plugins` to the new `httpie cli` namespace as `httpie cli plugins` (`httpie plugins` continues to work as a hidden alias). ([#1320](https://github.com/httpie/httpie/issues/1320))
- Fixed redundant creation of `Content-Length` header on `OPTIONS` requests. ([#1310](https://github.com/httpie/httpie/issues/1310))
- Fixed blocking of warning thread on some use cases. ([#1349](https://github.com/httpie/httpie/issues/1349))
- Changed `httpie plugins` to the new `httpie cli` namespace as `httpie cli plugins` (`httpie plugins` continues to work as a hidden alias). ([#1320](https://github.com/httpie/httpie/issues/1320))
- Soft deprecated the `--history-print`. ([#1380](https://github.com/httpie/httpie/pull/1380))
- Added support for sending `Secure` cookies to the `localhost` (and `.local` suffixed domains). ([#1308](https://github.com/httpie/httpie/issues/1308))
## [3.1.0](https://github.com/httpie/httpie/compare/3.0.2...3.1.0) (2022-03-08)

View File

@@ -162,8 +162,6 @@ Also works for other Debian-derived distributions like MX Linux, Linux Mint, dee
```bash
# Install httpie
$ curl -SsL https://packages.httpie.io/deb/KEY.gpg | apt-key add -
$ curl -SsL -o /etc/apt/sources.list.d/httpie.list https://packages.httpie.io/deb/httpie.list
$ apt update
$ apt install httpie
```
@@ -279,7 +277,7 @@ Synopsis:
$ http [flags] [METHOD] URL [ITEM [ITEM]]
```
See also `http --help` (and for systems where man pages are available, you can use `man http`).
See also `http --help`.
### Examples

View File

@@ -252,7 +252,6 @@ def fetch_missing_users_details(people: People) -> None:
def save_awesome_people(people: People) -> None:
with DB_FILE.open(mode='w', encoding='utf-8') as fh:
json.dump(people, fh, indent=4, sort_keys=True)
fh.write("\n")
def debug(*args: Any) -> None:

View File

@@ -8,27 +8,19 @@ from jinja2 import Template
from fetch import HERE, load_awesome_people
TPL_FILE = HERE / 'snippet.jinja2'
HTTPIE_TEAM = {
'claudiatd',
'jakubroztocil',
'jkbr',
'isidentical'
}
BOT_ACCOUNTS = {
'dependabot-sr'
}
IGNORE_ACCOUNTS = HTTPIE_TEAM | BOT_ACCOUNTS
def generate_snippets(release: str) -> str:
people = load_awesome_people()
contributors = {
name: details
for name, details in people.items()
if details['github'] not in IGNORE_ACCOUNTS
if details['github'] not in HTTPIE_TEAM
and (release in details['committed'] or release in details['reported'])
}

View File

@@ -53,13 +53,11 @@
},
"Batuhan Taskaya": {
"committed": [
"3.0.0",
"3.2.0"
"3.0.0"
],
"github": "isidentical",
"reported": [
"3.0.0",
"3.2.0"
"3.0.0"
],
"twitter": "isidentical"
},
@@ -120,14 +118,6 @@
"reported": [],
"twitter": "elena_lape"
},
"Ethan Mills": {
"committed": [
"3.2.0"
],
"github": "ethanmills",
"reported": [],
"twitter": null
},
"Fabio Peruzzo": {
"committed": [],
"github": "peruzzof",
@@ -199,8 +189,7 @@
"committed": [
"2.5.0",
"2.6.0",
"3.0.0",
"3.2.0"
"3.0.0"
],
"github": "jakubroztocil",
"reported": [
@@ -224,8 +213,7 @@
],
"github": "blyxxyz",
"reported": [
"3.0.0",
"3.2.0"
"3.0.0"
],
"twitter": null
},
@@ -321,8 +309,7 @@
"committed": [],
"github": "ducaale",
"reported": [
"2.5.0",
"3.2.0"
"2.5.0"
],
"twitter": null
},
@@ -334,22 +321,6 @@
],
"twitter": "sevenc_nanashi"
},
"Nicklas Ansman Giertz": {
"committed": [],
"github": "ansman",
"reported": [
"3.2.0"
],
"twitter": null
},
"Oliver Fish": {
"committed": [],
"github": "Oliver-Fish",
"reported": [
"3.2.0"
],
"twitter": null
},
"Omer Akram": {
"committed": [
"2.6.0",
@@ -386,14 +357,6 @@
],
"twitter": null
},
"Roberto L\u00f3pez L\u00f3pez": {
"committed": [],
"github": "robertolopezlopez",
"reported": [
"3.2.0"
],
"twitter": null
},
"Russell Shurts": {
"committed": [],
"github": "rshurts",
@@ -524,14 +487,6 @@
],
"twitter": null
},
"dependabot[bot]": {
"committed": [
"3.2.0"
],
"github": "dependabot-sr",
"reported": [],
"twitter": null
},
"dkreeft": {
"committed": [
"2.6.0",
@@ -598,14 +553,6 @@
],
"twitter": null
},
"luzpaz": {
"committed": [
"3.2.0"
],
"github": "luzpaz",
"reported": [],
"twitter": null
},
"nixbytes": {
"committed": [
"2.5.0"
@@ -646,14 +593,6 @@
],
"twitter": null
},
"zhaohanqing95": {
"committed": [],
"github": "zhaohanqing95",
"reported": [
"3.2.0"
],
"twitter": null
},
"zoulja": {
"committed": [],
"github": "zoulja",

View File

@@ -2,10 +2,9 @@
## Community contributions
Wed like to thank these amazing people for their contributions to this release:
{% for name, details in contributors.items() -%}
- [{{ name }}](https://github.com/{{ details.github }}){{ '' if loop.last else '\n' }}
{%- endfor %}
Wed like to thank these amazing people for their contributions to this release: {% for name, details in contributors.items() -%}
[{{ name }}](https://github.com/{{ details.github }}){{ '' if loop.last else ', ' }}
{%- endfor %}.
<!-- Twitter -->

View File

@@ -36,8 +36,6 @@ tools:
package: https://packages.debian.org/sid/web/httpie
commands:
install:
- curl -SsL https://packages.httpie.io/deb/KEY.gpg | apt-key add -
- curl -SsL -o /etc/apt/sources.list.d/httpie.list https://packages.httpie.io/deb/httpie.list
- apt update
- apt install httpie
upgrade:

View File

@@ -1,5 +1,4 @@
.\" This file is auto-generated from the parser declaration in httpie/cli/definition.py by extras/scripts/generate_man_pages.py.
.TH http 1 "2022-05-06" "HTTPie 3.2.1" "HTTPie Manual"
.TH http 1 "2022-03-08" "HTTPie 3.1.1.dev0" "HTTPie Manual"
.SH NAME
http
.SH SYNOPSIS
@@ -7,7 +6,7 @@ http [METHOD] URL [REQUEST_ITEM ...]
.SH DESCRIPTION
HTTPie: modern, user-friendly command-line HTTP client for the API era. <https://httpie.io>
.SH Positional arguments
.SH Positional Arguments
These arguments come after any flags and in the order they are listed here.
Only URL is required.
@@ -28,8 +27,8 @@ is some data to be sent, otherwise GET:
.IP "\fB\,URL\/\fR"
The request URL. Scheme defaults to \[aq]http://\[aq] if the URL
does not include one. (You can override this with: \fB\,--default-scheme\/\fR=http/https)
The request URL. Scheme defaults to \'http://\' if the URL
does not include one. (You can override this with:\fB\,--default-scheme\/\fR=http/https)
You can also use a shorthand for localhost
@@ -44,44 +43,44 @@ You can also use a shorthand for localhost
Optional key-value pairs to be included in the request. The separator used
determines the type:
\[aq]:\[aq] HTTP headers:
\':\' HTTP headers:
Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0
\[aq]==\[aq] URL parameters to be appended to the request URI:
\'==\' URL parameters to be appended to the request URI:
search==httpie
\[aq]=\[aq] Data fields to be serialized into a JSON object (with \fB\,--json\/\fR, \fB\,-j\/\fR)
or form data (with \fB\,--form\/\fR, \fB\,-f\/\fR):
\'=\' Data fields to be serialized into a JSON object (with\fB\,--json\/\fR,\fB\,-j\/\fR)
or form data (with\fB\,--form\/\fR,\fB\,-f\/\fR):
name=HTTPie language=Python description=\[aq]CLI HTTP client\[aq]
name=HTTPie language=Python description=\'CLI HTTP client\'
\[aq]:=\[aq] Non-string JSON data fields (only with \fB\,--json\/\fR, \fB\,-j\/\fR):
\':=\' Non-string JSON data fields (only with\fB\,--json\/\fR,\fB\,-j\/\fR):
awesome:=true amount:=42 colors:=\[aq][\[dq]red\[dq], \[dq]green\[dq], \[dq]blue\[dq]]\[aq]
awesome:=true amount:=42 colors:=\'["red", "green", "blue"]\'
\[aq]@\[aq] Form file fields (only with \fB\,--form\/\fR or \fB\,--multipart\/\fR):
\'@\' Form file fields (only with\fB\,--form\/\fR or\fB\,--multipart\/\fR):
cv@\(ti/Documents/CV.pdf
cv@\[aq]\(ti/Documents/CV.pdf;type=application/pdf\[aq]
cv@\~/Documents/CV.pdf
cv@\'\~/Documents/CV.pdf;type=application/pdf\'
\[aq]=@\[aq] A data field like \[aq]=\[aq], but takes a file path and embeds its content:
\'=@\' A data field like \'=\', but takes a file path and embeds its content:
essay=@Documents/essay.txt
\[aq]:=@\[aq] A raw JSON field like \[aq]:=\[aq], but takes a file path and embeds its content:
\':=@\' A raw JSON field like \':=\', but takes a file path and embeds its content:
package:=@./package.json
You can use a backslash to escape a colliding separator in the field name:
field-name-with\e:colon=value
field-name-with\\:colon=value
.PP
.SH Predefined content types
.SH Predefined Content Types
.IP "\fB\,--json\/\fR, \fB\,-j\/\fR"
@@ -105,13 +104,13 @@ multipart/form-data request.
.IP "\fB\,--multipart\/\fR"
Similar to \fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
Similar to\fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
.IP "\fB\,--boundary\/\fR"
Specify a custom boundary string for multipart/form-data requests. Only has effect only together with \fB\,--form\/\fR.
Specify a custom boundary string for multipart/form-data requests. Only has effect only together with\fB\,--form\/\fR.
.IP "\fB\,--raw\/\fR"
@@ -120,7 +119,7 @@ Specify a custom boundary string for multipart/form-data requests. Only has effe
This option allows you to pass raw request data without extra processing
(as opposed to the structured request items syntax):
$ http \fB\,--raw\/\fR=\[aq]data\[aq] pie.dev/post
$ http\fB\,--raw\/\fR=\'data\' pie.dev/post
You can achieve the same by piping the data via stdin:
@@ -134,7 +133,7 @@ Or have HTTPie load the raw data from a file:
.PP
.SH Content processing options
.SH Content Processing Options
.IP "\fB\,--compress\/\fR, \fB\,-x\/\fR"
@@ -147,39 +146,39 @@ negative. Compression can be forced by repeating the argument.
.PP
.SH Output processing
.SH Output Processing
.IP "\fB\,--pretty\/\fR"
Controls output processing. The value can be \[dq]none\[dq] to not prettify
the output (default for redirected output), \[dq]all\[dq] to apply both colors
and formatting (default for terminal output), \[dq]colors\[dq], or \[dq]format\[dq].
Controls output processing. The value can be "none" to not prettify
the output (default for redirected output), "all" to apply both colors
and formatting (default for terminal output), "colors", or "format".
.IP "\fB\,--style\/\fR, \fB\,-s\/\fR \fI\,STYLE\/\fR"
Output coloring style (default is \[dq]auto\[dq]). It can be one of:
Output coloring style (default is "auto"). It can be one of:
auto, pie, pie-dark, pie-light, solarized
For finding out all available styles in your system, try:
$ http \fB\,--style\/\fR
$ http\fB\,--style\/\fR
The \[dq]auto\[dq] style follows your terminal\[aq]s ANSI color styles.
The "auto" style follows your terminal\'s ANSI color styles.
For non-auto styles to work properly, please make sure that the
$TERM environment variable is set to \[dq]xterm-256color\[dq] or similar
(e.g., via `export TERM=xterm-256color\[aq] in your \(ti/.bashrc).
$TERM environment variable is set to "xterm-256color" or similar
(e.g., via `export TERM=xterm-256color\' in your \~/.bashrc).
.IP "\fB\,--unsorted\/\fR"
Disables all sorting while formatting output. It is a shortcut for:
\fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
\fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
@@ -188,7 +187,7 @@ Disables all sorting while formatting output. It is a shortcut for:
Re-enables all sorting options while formatting output. It is a shortcut for:
\fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
\fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
@@ -197,8 +196,8 @@ Re-enables all sorting options while formatting output. It is a shortcut for:
Override the response encoding for terminal display purposes, e.g.:
\fB\,--response-charset\/\fR=utf8
\fB\,--response-charset\/\fR=big5
\fB\,--response-charset\/\fR=utf8
\fB\,--response-charset\/\fR=big5
@@ -207,8 +206,8 @@ Override the response encoding for terminal display purposes, e.g.:
Override the response mime type for coloring and formatting for the terminal, e.g.:
\fB\,--response-mime\/\fR=application/json
\fB\,--response-mime\/\fR=text/xml
\fB\,--response-mime\/\fR=application/json
\fB\,--response-mime\/\fR=text/xml
@@ -216,7 +215,7 @@ Override the response mime type for coloring and formatting for the terminal, e.
Controls output formatting. Only relevant when formatting is enabled
through (explicit or implied) \fB\,--pretty\/\fR=all or \fB\,--pretty\/\fR=format.
through (explicit or implied)\fB\,--pretty\/\fR=all or\fB\,--pretty\/\fR=format.
The following are the default options:
headers.sort:true
@@ -230,26 +229,26 @@ You may use this option multiple times, as well as specify multiple
comma-separated options at the same time. For example, this modifies the
settings to disable the sorting of JSON keys, and sets the indent size to 2:
\fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
\fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
This is something you will typically put into your config file.
.PP
.SH Output options
.SH Output Options
.IP "\fB\,--print\/\fR, \fB\,-p\/\fR \fI\,WHAT\/\fR"
String specifying what the output should contain:
\[aq]H\[aq] request headers
\[aq]B\[aq] request body
\[aq]h\[aq] response headers
\[aq]b\[aq] response body
\[aq]m\[aq] response metadata
\'H\' request headers
\'B\' request body
\'h\' response headers
\'b\' response body
\'m\' response metadata
The default behaviour is \[aq]hb\[aq] (i.e., the response
The default behaviour is \'hb\' (i.e., the response
headers and body is printed), if standard output is not redirected.
If the output is piped to another program or to a file, then only the
response body is printed by default.
@@ -259,34 +258,34 @@ response body is printed by default.
.IP "\fB\,--headers\/\fR, \fB\,-h\/\fR"
Print only the response headers. Shortcut for \fB\,--print\/\fR=h.
Print only the response headers. Shortcut for\fB\,--print\/\fR=h.
.IP "\fB\,--meta\/\fR, \fB\,-m\/\fR"
Print only the response metadata. Shortcut for \fB\,--print\/\fR=m.
Print only the response metadata. Shortcut for\fB\,--print\/\fR=m.
.IP "\fB\,--body\/\fR, \fB\,-b\/\fR"
Print only the response body. Shortcut for \fB\,--print\/\fR=b.
Print only the response body. Shortcut for\fB\,--print\/\fR=b.
.IP "\fB\,--verbose\/\fR, \fB\,-v\/\fR"
Verbose output. For the level one (with single `\fB\,-v\/\fR`/`\fB\,--verbose\/\fR`), print
Verbose output. For the level one (with single \fB\,-v\/\fR`/\fB\,--verbose\/\fR`), print
the whole request as well as the response. Also print any intermediary
requests/responses (such as redirects). For the second level and higher,
print these as well as the response metadata.
Level one is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbh
Level two is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbhm
Level one is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbh
Level two is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbhm
.IP "\fB\,--all\/\fR"
@@ -294,23 +293,23 @@ Level two is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbhm
By default, only the final request/response is shown. Use this flag to show
any intermediary requests/responses as well. Intermediary requests include
followed redirects (with \fB\,--follow\/\fR), the first unauthorized request when
Digest auth is used (\fB\,--auth\/\fR=digest), etc.
followed redirects (with\fB\,--follow\/\fR), the first unauthorized request when
Digest auth is used \fB\,--auth\/\fR=digest), etc.
.IP "\fB\,--stream\/\fR, \fB\,-S\/\fR"
Always stream the response body by line, i.e., behave like `tail \fB\,-f\/\fR\[aq].
Always stream the response body by line, i.e., behave like `tail\fB\,-f\/\fR\'.
Without \fB\,--stream\/\fR and with \fB\,--pretty\/\fR (either set or implied),
Without\fB\,--stream\/\fR and with\fB\,--pretty\/\fR (either set or implied),
HTTPie fetches the whole response before it outputs the processed data.
Set this option when you want to continuously display a prettified
long-lived response, such as one from the Twitter streaming API.
It is useful also without \fB\,--pretty\/\fR: It ensures that the output is flushed
It is useful also without\fB\,--pretty\/\fR: It ensures that the output is flushed
more often and in smaller chunks.
@@ -318,7 +317,7 @@ more often and in smaller chunks.
.IP "\fB\,--output\/\fR, \fB\,-o\/\fR \fI\,FILE\/\fR"
Save output to FILE instead of stdout. If \fB\,--download\/\fR is also set, then only
Save output to FILE instead of stdout. If\fB\,--download\/\fR is also set, then only
the response body is saved to FILE. Other parts of the HTTP exchange are
printed to stderr.
@@ -328,7 +327,7 @@ printed to stderr.
Do not print the response body to stdout. Rather, download it and store it
in a file. The filename is guessed unless specified with \fB\,--output\/\fR
in a file. The filename is guessed unless specified with\fB\,--output\/\fR
[filename]. This action is similar to the default behaviour of wget.
@@ -336,7 +335,7 @@ in a file. The filename is guessed unless specified with \fB\,--output\/\fR
.IP "\fB\,--continue\/\fR, \fB\,-c\/\fR"
Resume an interrupted download. Note that the \fB\,--output\/\fR option needs to be
Resume an interrupted download. Note that the\fB\,--output\/\fR option needs to be
specified as well.
@@ -346,8 +345,8 @@ specified as well.
Do not print to stdout or stderr, except for errors and warnings when provided once.
Provide twice to suppress warnings as well.
stdout is still redirected if \fB\,--output\/\fR is specified.
Flag doesn\[aq]t affect behaviour of download beyond not printing to terminal.
stdout is still redirected if\fB\,--output\/\fR is specified.
Flag doesn\'t affect behaviour of download beyond not printing to terminal.
@@ -384,24 +383,24 @@ exchange.
For username/password based authentication mechanisms (e.g
basic auth or digest auth) if only the username is provided
(\fB\,-a\/\fR username), HTTPie will prompt for the password.
\fB\,-a\/\fR username), HTTPie will prompt for the password.
.IP "\fB\,--auth-type\/\fR, \fB\,-A\/\fR"
The authentication mechanism to be used. Defaults to \[dq]basic\[dq].
The authentication mechanism to be used. Defaults to "basic".
\[dq]basic\[dq]: Basic HTTP auth
"basic": Basic HTTP auth
\[dq]digest\[dq]: Digest HTTP auth
"digest": Digest HTTP auth
\[dq]bearer\[dq]: Bearer HTTP Auth
"bearer": Bearer HTTP Auth
For finding out all available authentication types in your system, try:
$ http \fB\,--auth-type\/\fR
$ http\fB\,--auth-type\/\fR
.IP "\fB\,--ignore-netrc\/\fR"
@@ -414,7 +413,7 @@ Ignore credentials from .netrc.
.IP "\fB\,--offline\/\fR"
Build the request and print it but don\(gat actually send it.
Build the request and print it but don\'t actually send it.
.IP "\fB\,--proxy\/\fR \fI\,PROTOCOL:PROXY_URL\/\fR"
@@ -436,7 +435,7 @@ Follow 30x Location redirects.
.IP "\fB\,--max-redirects\/\fR"
By default, requests have a limit of 30 redirects (works with \fB\,--follow\/\fR).
By default, requests have a limit of 30 redirects (works with\fB\,--follow\/\fR).
@@ -467,7 +466,7 @@ exit with an error if the status indicates one.
When the server replies with a 4xx (Client Error) or 5xx (Server Error)
status code, HTTPie exits with 4 or 5 respectively. If the response is a
3xx (Redirect) and \fB\,--follow\/\fR hasn\[aq]t been set, then the exit status is 3.
3xx (Redirect) and\fB\,--follow\/\fR hasn\'t been set, then the exit status is 3.
Also an error message is written to stderr if stdout is redirected.
@@ -489,8 +488,8 @@ Enable streaming via chunked transfer encoding. The Transfer-Encoding header is
.IP "\fB\,--verify\/\fR"
Set to \[dq]no\[dq] (or \[dq]false\[dq]) to skip checking the host\[aq]s SSL certificate.
Defaults to \[dq]yes\[dq] (\[dq]true\[dq]). You can also pass the path to a CA_BUNDLE file
Set to "no" (or "false") to skip checking the host\'s SSL certificate.
Defaults to "yes" ("true"). You can also pass the path to a CA_BUNDLE file
for private certs. (Or you can set the REQUESTS_CA_BUNDLE environment
variable instead.)
@@ -522,14 +521,14 @@ ECDHE+AESGCM:ECDHE+CHACHA20:DHE+AESGCM:DHE+CHACHA20:ECDH+AESGCM:DH+AESGCM:ECDH+A
You can specify a local cert to use as client side SSL certificate.
This file may either contain both private key and certificate or you may
specify \fB\,--cert-key\/\fR separately.
specify\fB\,--cert-key\/\fR separately.
.IP "\fB\,--cert-key\/\fR"
The private key to use with SSL. Only needed if \fB\,--cert\/\fR is given and the
The private key to use with SSL. Only needed if\fB\,--cert\/\fR is given and the
certificate file does not contain the private key.
@@ -537,9 +536,9 @@ certificate file does not contain the private key.
.IP "\fB\,--cert-key-pass\/\fR"
The passphrase to be used to with the given private key. Only needed if \fB\,--cert-key\/\fR
The passphrase to be used to with the given private key. Only needed if\fB\,--cert-key\/\fR
is given and the key file requires a passphrase.
If not provided, you\(gall be prompted interactively.
If not provided, you\'ll be prompted interactively.
.PP
@@ -589,10 +588,3 @@ information useful for debugging HTTPie itself and for reporting bugs.
.PP
.SH SEE ALSO
For every \fB\,--OPTION\/\fR there is also a \fB\,--no-OPTION\/\fR that reverts OPTION
to its default value.
Suggestions and bug reports are greatly appreciated:
https://github.com/httpie/httpie/issues

View File

@@ -1,9 +1,9 @@
.\" This file is auto-generated from the parser declaration in httpie/manager/cli.py by extras/scripts/generate_man_pages.py.
.TH httpie 1 "2022-05-06" "HTTPie 3.2.1" "HTTPie Manual"
.TH httpie 1 "2022-03-08" "HTTPie 3.1.1.dev0" "HTTPie Manual"
.SH NAME
httpie
.SH SYNOPSIS
httpie
httpie HOSTNAME SESSION_NAME_OR_PATH TARGET TARGET TARGET TARGET TARGET TARGET
.SH DESCRIPTION
Managing interface for the HTTPie itself. <https://httpie.io/docs#manager>
@@ -12,21 +12,12 @@ Be aware that you might be looking for http/https commands for sending
HTTP requests. This command is only available for managing the HTTTPie
plugins and the configuration around it.
If you are looking for the man pages of http/https commands, try one of the following:
$ man http
$ man https
.SH httpie cli export-args
Export available options for the CLI
.IP "\fB\,-f\/\fR, \fB\,--format\/\fR"
Format to export in.
.PP
.SH httpie cli check-updates
Check for updates
.PP
.SH httpie cli sessions upgrade
Upgrade the given HTTPie session with the latest layout. A list of changes between different session versions can be found in the official documentation.

View File

@@ -1,5 +1,4 @@
.\" This file is auto-generated from the parser declaration in httpie/cli/definition.py by extras/scripts/generate_man_pages.py.
.TH https 1 "2022-05-06" "HTTPie 3.2.1" "HTTPie Manual"
.TH https 1 "2022-03-08" "HTTPie 3.1.1.dev0" "HTTPie Manual"
.SH NAME
https
.SH SYNOPSIS
@@ -7,7 +6,7 @@ https [METHOD] URL [REQUEST_ITEM ...]
.SH DESCRIPTION
HTTPie: modern, user-friendly command-line HTTP client for the API era. <https://httpie.io>
.SH Positional arguments
.SH Positional Arguments
These arguments come after any flags and in the order they are listed here.
Only URL is required.
@@ -28,8 +27,8 @@ is some data to be sent, otherwise GET:
.IP "\fB\,URL\/\fR"
The request URL. Scheme defaults to \[aq]http://\[aq] if the URL
does not include one. (You can override this with: \fB\,--default-scheme\/\fR=http/https)
The request URL. Scheme defaults to \'http://\' if the URL
does not include one. (You can override this with:\fB\,--default-scheme\/\fR=http/https)
You can also use a shorthand for localhost
@@ -44,44 +43,44 @@ You can also use a shorthand for localhost
Optional key-value pairs to be included in the request. The separator used
determines the type:
\[aq]:\[aq] HTTP headers:
\':\' HTTP headers:
Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0
\[aq]==\[aq] URL parameters to be appended to the request URI:
\'==\' URL parameters to be appended to the request URI:
search==httpie
\[aq]=\[aq] Data fields to be serialized into a JSON object (with \fB\,--json\/\fR, \fB\,-j\/\fR)
or form data (with \fB\,--form\/\fR, \fB\,-f\/\fR):
\'=\' Data fields to be serialized into a JSON object (with\fB\,--json\/\fR,\fB\,-j\/\fR)
or form data (with\fB\,--form\/\fR,\fB\,-f\/\fR):
name=HTTPie language=Python description=\[aq]CLI HTTP client\[aq]
name=HTTPie language=Python description=\'CLI HTTP client\'
\[aq]:=\[aq] Non-string JSON data fields (only with \fB\,--json\/\fR, \fB\,-j\/\fR):
\':=\' Non-string JSON data fields (only with\fB\,--json\/\fR,\fB\,-j\/\fR):
awesome:=true amount:=42 colors:=\[aq][\[dq]red\[dq], \[dq]green\[dq], \[dq]blue\[dq]]\[aq]
awesome:=true amount:=42 colors:=\'["red", "green", "blue"]\'
\[aq]@\[aq] Form file fields (only with \fB\,--form\/\fR or \fB\,--multipart\/\fR):
\'@\' Form file fields (only with\fB\,--form\/\fR or\fB\,--multipart\/\fR):
cv@\(ti/Documents/CV.pdf
cv@\[aq]\(ti/Documents/CV.pdf;type=application/pdf\[aq]
cv@\~/Documents/CV.pdf
cv@\'\~/Documents/CV.pdf;type=application/pdf\'
\[aq]=@\[aq] A data field like \[aq]=\[aq], but takes a file path and embeds its content:
\'=@\' A data field like \'=\', but takes a file path and embeds its content:
essay=@Documents/essay.txt
\[aq]:=@\[aq] A raw JSON field like \[aq]:=\[aq], but takes a file path and embeds its content:
\':=@\' A raw JSON field like \':=\', but takes a file path and embeds its content:
package:=@./package.json
You can use a backslash to escape a colliding separator in the field name:
field-name-with\e:colon=value
field-name-with\\:colon=value
.PP
.SH Predefined content types
.SH Predefined Content Types
.IP "\fB\,--json\/\fR, \fB\,-j\/\fR"
@@ -105,13 +104,13 @@ multipart/form-data request.
.IP "\fB\,--multipart\/\fR"
Similar to \fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
Similar to\fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
.IP "\fB\,--boundary\/\fR"
Specify a custom boundary string for multipart/form-data requests. Only has effect only together with \fB\,--form\/\fR.
Specify a custom boundary string for multipart/form-data requests. Only has effect only together with\fB\,--form\/\fR.
.IP "\fB\,--raw\/\fR"
@@ -120,7 +119,7 @@ Specify a custom boundary string for multipart/form-data requests. Only has effe
This option allows you to pass raw request data without extra processing
(as opposed to the structured request items syntax):
$ http \fB\,--raw\/\fR=\[aq]data\[aq] pie.dev/post
$ http\fB\,--raw\/\fR=\'data\' pie.dev/post
You can achieve the same by piping the data via stdin:
@@ -134,7 +133,7 @@ Or have HTTPie load the raw data from a file:
.PP
.SH Content processing options
.SH Content Processing Options
.IP "\fB\,--compress\/\fR, \fB\,-x\/\fR"
@@ -147,39 +146,39 @@ negative. Compression can be forced by repeating the argument.
.PP
.SH Output processing
.SH Output Processing
.IP "\fB\,--pretty\/\fR"
Controls output processing. The value can be \[dq]none\[dq] to not prettify
the output (default for redirected output), \[dq]all\[dq] to apply both colors
and formatting (default for terminal output), \[dq]colors\[dq], or \[dq]format\[dq].
Controls output processing. The value can be "none" to not prettify
the output (default for redirected output), "all" to apply both colors
and formatting (default for terminal output), "colors", or "format".
.IP "\fB\,--style\/\fR, \fB\,-s\/\fR \fI\,STYLE\/\fR"
Output coloring style (default is \[dq]auto\[dq]). It can be one of:
Output coloring style (default is "auto"). It can be one of:
auto, pie, pie-dark, pie-light, solarized
For finding out all available styles in your system, try:
$ http \fB\,--style\/\fR
$ http\fB\,--style\/\fR
The \[dq]auto\[dq] style follows your terminal\[aq]s ANSI color styles.
The "auto" style follows your terminal\'s ANSI color styles.
For non-auto styles to work properly, please make sure that the
$TERM environment variable is set to \[dq]xterm-256color\[dq] or similar
(e.g., via `export TERM=xterm-256color\[aq] in your \(ti/.bashrc).
$TERM environment variable is set to "xterm-256color" or similar
(e.g., via `export TERM=xterm-256color\' in your \~/.bashrc).
.IP "\fB\,--unsorted\/\fR"
Disables all sorting while formatting output. It is a shortcut for:
\fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
\fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
@@ -188,7 +187,7 @@ Disables all sorting while formatting output. It is a shortcut for:
Re-enables all sorting options while formatting output. It is a shortcut for:
\fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
\fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
@@ -197,8 +196,8 @@ Re-enables all sorting options while formatting output. It is a shortcut for:
Override the response encoding for terminal display purposes, e.g.:
\fB\,--response-charset\/\fR=utf8
\fB\,--response-charset\/\fR=big5
\fB\,--response-charset\/\fR=utf8
\fB\,--response-charset\/\fR=big5
@@ -207,8 +206,8 @@ Override the response encoding for terminal display purposes, e.g.:
Override the response mime type for coloring and formatting for the terminal, e.g.:
\fB\,--response-mime\/\fR=application/json
\fB\,--response-mime\/\fR=text/xml
\fB\,--response-mime\/\fR=application/json
\fB\,--response-mime\/\fR=text/xml
@@ -216,7 +215,7 @@ Override the response mime type for coloring and formatting for the terminal, e.
Controls output formatting. Only relevant when formatting is enabled
through (explicit or implied) \fB\,--pretty\/\fR=all or \fB\,--pretty\/\fR=format.
through (explicit or implied)\fB\,--pretty\/\fR=all or\fB\,--pretty\/\fR=format.
The following are the default options:
headers.sort:true
@@ -230,26 +229,26 @@ You may use this option multiple times, as well as specify multiple
comma-separated options at the same time. For example, this modifies the
settings to disable the sorting of JSON keys, and sets the indent size to 2:
\fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
\fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
This is something you will typically put into your config file.
.PP
.SH Output options
.SH Output Options
.IP "\fB\,--print\/\fR, \fB\,-p\/\fR \fI\,WHAT\/\fR"
String specifying what the output should contain:
\[aq]H\[aq] request headers
\[aq]B\[aq] request body
\[aq]h\[aq] response headers
\[aq]b\[aq] response body
\[aq]m\[aq] response metadata
\'H\' request headers
\'B\' request body
\'h\' response headers
\'b\' response body
\'m\' response metadata
The default behaviour is \[aq]hb\[aq] (i.e., the response
The default behaviour is \'hb\' (i.e., the response
headers and body is printed), if standard output is not redirected.
If the output is piped to another program or to a file, then only the
response body is printed by default.
@@ -259,34 +258,34 @@ response body is printed by default.
.IP "\fB\,--headers\/\fR, \fB\,-h\/\fR"
Print only the response headers. Shortcut for \fB\,--print\/\fR=h.
Print only the response headers. Shortcut for\fB\,--print\/\fR=h.
.IP "\fB\,--meta\/\fR, \fB\,-m\/\fR"
Print only the response metadata. Shortcut for \fB\,--print\/\fR=m.
Print only the response metadata. Shortcut for\fB\,--print\/\fR=m.
.IP "\fB\,--body\/\fR, \fB\,-b\/\fR"
Print only the response body. Shortcut for \fB\,--print\/\fR=b.
Print only the response body. Shortcut for\fB\,--print\/\fR=b.
.IP "\fB\,--verbose\/\fR, \fB\,-v\/\fR"
Verbose output. For the level one (with single `\fB\,-v\/\fR`/`\fB\,--verbose\/\fR`), print
Verbose output. For the level one (with single \fB\,-v\/\fR`/\fB\,--verbose\/\fR`), print
the whole request as well as the response. Also print any intermediary
requests/responses (such as redirects). For the second level and higher,
print these as well as the response metadata.
Level one is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbh
Level two is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbhm
Level one is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbh
Level two is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbhm
.IP "\fB\,--all\/\fR"
@@ -294,23 +293,23 @@ Level two is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbhm
By default, only the final request/response is shown. Use this flag to show
any intermediary requests/responses as well. Intermediary requests include
followed redirects (with \fB\,--follow\/\fR), the first unauthorized request when
Digest auth is used (\fB\,--auth\/\fR=digest), etc.
followed redirects (with\fB\,--follow\/\fR), the first unauthorized request when
Digest auth is used \fB\,--auth\/\fR=digest), etc.
.IP "\fB\,--stream\/\fR, \fB\,-S\/\fR"
Always stream the response body by line, i.e., behave like `tail \fB\,-f\/\fR\[aq].
Always stream the response body by line, i.e., behave like `tail\fB\,-f\/\fR\'.
Without \fB\,--stream\/\fR and with \fB\,--pretty\/\fR (either set or implied),
Without\fB\,--stream\/\fR and with\fB\,--pretty\/\fR (either set or implied),
HTTPie fetches the whole response before it outputs the processed data.
Set this option when you want to continuously display a prettified
long-lived response, such as one from the Twitter streaming API.
It is useful also without \fB\,--pretty\/\fR: It ensures that the output is flushed
It is useful also without\fB\,--pretty\/\fR: It ensures that the output is flushed
more often and in smaller chunks.
@@ -318,7 +317,7 @@ more often and in smaller chunks.
.IP "\fB\,--output\/\fR, \fB\,-o\/\fR \fI\,FILE\/\fR"
Save output to FILE instead of stdout. If \fB\,--download\/\fR is also set, then only
Save output to FILE instead of stdout. If\fB\,--download\/\fR is also set, then only
the response body is saved to FILE. Other parts of the HTTP exchange are
printed to stderr.
@@ -328,7 +327,7 @@ printed to stderr.
Do not print the response body to stdout. Rather, download it and store it
in a file. The filename is guessed unless specified with \fB\,--output\/\fR
in a file. The filename is guessed unless specified with\fB\,--output\/\fR
[filename]. This action is similar to the default behaviour of wget.
@@ -336,7 +335,7 @@ in a file. The filename is guessed unless specified with \fB\,--output\/\fR
.IP "\fB\,--continue\/\fR, \fB\,-c\/\fR"
Resume an interrupted download. Note that the \fB\,--output\/\fR option needs to be
Resume an interrupted download. Note that the\fB\,--output\/\fR option needs to be
specified as well.
@@ -346,8 +345,8 @@ specified as well.
Do not print to stdout or stderr, except for errors and warnings when provided once.
Provide twice to suppress warnings as well.
stdout is still redirected if \fB\,--output\/\fR is specified.
Flag doesn\[aq]t affect behaviour of download beyond not printing to terminal.
stdout is still redirected if\fB\,--output\/\fR is specified.
Flag doesn\'t affect behaviour of download beyond not printing to terminal.
@@ -384,24 +383,24 @@ exchange.
For username/password based authentication mechanisms (e.g
basic auth or digest auth) if only the username is provided
(\fB\,-a\/\fR username), HTTPie will prompt for the password.
\fB\,-a\/\fR username), HTTPie will prompt for the password.
.IP "\fB\,--auth-type\/\fR, \fB\,-A\/\fR"
The authentication mechanism to be used. Defaults to \[dq]basic\[dq].
The authentication mechanism to be used. Defaults to "basic".
\[dq]basic\[dq]: Basic HTTP auth
"basic": Basic HTTP auth
\[dq]digest\[dq]: Digest HTTP auth
"digest": Digest HTTP auth
\[dq]bearer\[dq]: Bearer HTTP Auth
"bearer": Bearer HTTP Auth
For finding out all available authentication types in your system, try:
$ http \fB\,--auth-type\/\fR
$ http\fB\,--auth-type\/\fR
.IP "\fB\,--ignore-netrc\/\fR"
@@ -414,7 +413,7 @@ Ignore credentials from .netrc.
.IP "\fB\,--offline\/\fR"
Build the request and print it but don\(gat actually send it.
Build the request and print it but don\'t actually send it.
.IP "\fB\,--proxy\/\fR \fI\,PROTOCOL:PROXY_URL\/\fR"
@@ -436,7 +435,7 @@ Follow 30x Location redirects.
.IP "\fB\,--max-redirects\/\fR"
By default, requests have a limit of 30 redirects (works with \fB\,--follow\/\fR).
By default, requests have a limit of 30 redirects (works with\fB\,--follow\/\fR).
@@ -467,7 +466,7 @@ exit with an error if the status indicates one.
When the server replies with a 4xx (Client Error) or 5xx (Server Error)
status code, HTTPie exits with 4 or 5 respectively. If the response is a
3xx (Redirect) and \fB\,--follow\/\fR hasn\[aq]t been set, then the exit status is 3.
3xx (Redirect) and\fB\,--follow\/\fR hasn\'t been set, then the exit status is 3.
Also an error message is written to stderr if stdout is redirected.
@@ -489,8 +488,8 @@ Enable streaming via chunked transfer encoding. The Transfer-Encoding header is
.IP "\fB\,--verify\/\fR"
Set to \[dq]no\[dq] (or \[dq]false\[dq]) to skip checking the host\[aq]s SSL certificate.
Defaults to \[dq]yes\[dq] (\[dq]true\[dq]). You can also pass the path to a CA_BUNDLE file
Set to "no" (or "false") to skip checking the host\'s SSL certificate.
Defaults to "yes" ("true"). You can also pass the path to a CA_BUNDLE file
for private certs. (Or you can set the REQUESTS_CA_BUNDLE environment
variable instead.)
@@ -522,14 +521,14 @@ ECDHE+AESGCM:ECDHE+CHACHA20:DHE+AESGCM:DHE+CHACHA20:ECDH+AESGCM:DH+AESGCM:ECDH+A
You can specify a local cert to use as client side SSL certificate.
This file may either contain both private key and certificate or you may
specify \fB\,--cert-key\/\fR separately.
specify\fB\,--cert-key\/\fR separately.
.IP "\fB\,--cert-key\/\fR"
The private key to use with SSL. Only needed if \fB\,--cert\/\fR is given and the
The private key to use with SSL. Only needed if\fB\,--cert\/\fR is given and the
certificate file does not contain the private key.
@@ -537,9 +536,9 @@ certificate file does not contain the private key.
.IP "\fB\,--cert-key-pass\/\fR"
The passphrase to be used to with the given private key. Only needed if \fB\,--cert-key\/\fR
The passphrase to be used to with the given private key. Only needed if\fB\,--cert-key\/\fR
is given and the key file requires a passphrase.
If not provided, you\(gall be prompted interactively.
If not provided, you\'ll be prompted interactively.
.PP
@@ -589,10 +588,3 @@ information useful for debugging HTTPie itself and for reporting bugs.
.PP
.SH SEE ALSO
For every \fB\,--OPTION\/\fR there is also a \fB\,--no-OPTION\/\fR that reverts OPTION
to its default value.
Suggestions and bug reports are greatly appreciated:
https://github.com/httpie/httpie/issues

View File

@@ -14,19 +14,16 @@ from httpie.utils import split
# Escape certain characters so they are rendered properly on
# all terminals.
# https://man7.org/linux/man-pages/man7/groff_char.7.html
ESCAPE_MAP = {
'"': '\[dq]',
"'": '\[aq]',
'~': '\(ti',
'': "\(ga",
'\\': '\e',
"'": "\\'",
'~': '\\~',
'': "\\'",
'\\': '\\\\',
}
ESCAPE_MAP = {ord(key): value for key, value in ESCAPE_MAP.items()}
EXTRAS_DIR = Path(__file__).parent.parent
MAN_PAGE_PATH = EXTRAS_DIR / 'man'
PROJECT_ROOT = EXTRAS_DIR.parent
OPTION_HIGHLIGHT_RE = re.compile(
OptionsHighlighter.highlights[0]
@@ -60,18 +57,6 @@ class ManPageBuilder:
def separate(self) -> None:
self.source.append('.PP')
def format_desc(self, desc: str) -> str:
description = _escape_and_dedent(desc)
description = OPTION_HIGHLIGHT_RE.sub(
# Boldify the option part, but don't remove the prefix (start of the match).
lambda match: match[1] + self.boldify(match['option']),
description
)
return description
def add_comment(self, comment: str) -> None:
self.source.append(f'.\\" {comment}')
def add_options(self, options: Iterable[str], *, metavar: Optional[str] = None) -> None:
text = ", ".join(map(self.boldify, options))
if metavar:
@@ -107,13 +92,8 @@ def _escape_and_dedent(text: str) -> str:
return '\n'.join(lines).translate(ESCAPE_MAP)
def to_man_page(program_name: str, spec: ParserSpec, *, is_top_level_cmd: bool = False) -> str:
def to_man_page(program_name: str, spec: ParserSpec) -> str:
builder = ManPageBuilder()
builder.add_comment(
f"This file is auto-generated from the parser declaration "
+ (f"in {Path(spec.source_file).relative_to(PROJECT_ROOT)} " if spec.source_file else "")
+ f"by {Path(__file__).relative_to(PROJECT_ROOT)}."
)
builder.title_line(
full_name='HTTPie',
@@ -124,19 +104,10 @@ def to_man_page(program_name: str, spec: ParserSpec, *, is_top_level_cmd: bool =
builder.set_name(program_name)
with builder.section('SYNOPSIS'):
# `http` and `https` are commands that can be directly used, so they can have
# have a valid usage. But `httpie` is a top-level command with multiple sub commands,
# so for the synopsis we'll only reference the `httpie` name.
if is_top_level_cmd:
synopsis = program_name
else:
synopsis = render_as_string(to_usage(spec, program_name=program_name))
builder.write(synopsis)
builder.write(render_as_string(to_usage(spec, program_name=program_name)))
with builder.section('DESCRIPTION'):
builder.write(spec.description)
if spec.man_page_hint:
builder.write(spec.man_page_hint)
for index, group in enumerate(spec.groups, 1):
with builder.section(group.name):
@@ -156,26 +127,28 @@ def to_man_page(program_name: str, spec: ParserSpec, *, is_top_level_cmd: bool =
metavar = None
builder.add_options(raw_arg['options'], metavar=metavar)
desc = builder.format_desc(raw_arg.get('description', ''))
builder.write('\n' + desc + '\n')
description = _escape_and_dedent(raw_arg.get('description', ''))
description = OPTION_HIGHLIGHT_RE.sub(
lambda match: builder.boldify(match['option']),
description
)
builder.write('\n' + description + '\n')
builder.separate()
if spec.epilog:
with builder.section('SEE ALSO'):
builder.write(builder.format_desc(spec.epilog))
return builder.build()
def main() -> None:
for program_name, spec, config in [
('http', core_options, {}),
('https', core_options, {}),
('httpie', manager_options, {'is_top_level_cmd': True}),
for program_name, spec in [
('http', core_options),
('https', core_options),
('httpie', manager_options),
]:
with open((MAN_PAGE_PATH / program_name).with_suffix('.1'), 'w') as stream:
stream.write(to_man_page(program_name, spec, **config))
stream.write(to_man_page(program_name, spec))

View File

@@ -3,7 +3,7 @@ HTTPie: modern, user-friendly command-line HTTP client for the API era.
"""
__version__ = '3.2.1'
__date__ = '2022-05-06'
__version__ = '3.1.1.dev0'
__date__ = '2022-03-08'
__author__ = 'Jakub Roztocil'
__licence__ = 'BSD'

View File

@@ -572,6 +572,12 @@ class HTTPieArgumentParser(BaseHTTPieArgumentParser):
highlight=False
)
def print_help(self):
from httpie.output.ui import rich_help
for renderable in rich_help.to_help_message(self.spec):
self.env.rich_console.print(renderable)
def print_usage(self, file):
from rich.text import Text
from httpie.output.ui import rich_help

View File

@@ -26,13 +26,16 @@ options = ParserSpec(
'http',
description=f'{__doc__.strip()} <https://httpie.io>',
epilog="""
To learn more, you can try:
-> running 'http --manual'
-> visiting our full documentation at https://httpie.io/docs/cli
For every --OPTION there is also a --no-OPTION that reverts OPTION
to its default value.
Suggestions and bug reports are greatly appreciated:
https://github.com/httpie/httpie/issues
""",
source_file=__file__
)

View File

@@ -35,6 +35,17 @@ def drop_keys(
}
def _get_first_line(source: str) -> str:
parts = []
for line in source.strip().splitlines():
line = line.strip()
parts.append(line)
if line.endswith("."):
break
return " ".join(parts)
PARSER_SPEC_VERSION = '0.0.1a0'
@@ -44,8 +55,6 @@ class ParserSpec:
description: Optional[str] = None
epilog: Optional[str] = None
groups: List['Group'] = field(default_factory=list)
man_page_hint: Optional[str] = None
source_file: Optional[str] = None
def finalize(self) -> 'ParserSpec':
if self.description:
@@ -239,11 +248,10 @@ def to_data(abstract_options: ParserSpec) -> Dict[str, Any]:
return {'version': PARSER_SPEC_VERSION, 'spec': abstract_options.serialize()}
def parser_to_parser_spec(parser: argparse.ArgumentParser, **kwargs) -> ParserSpec:
def parser_to_parser_spec(parser: argparse.ArgumentParser) -> ParserSpec:
"""Take an existing argparse parser, and create a spec from it."""
return ParserSpec(
program=parser.prog,
description=parser.description,
epilog=parser.epilog,
**kwargs
epilog=parser.epilog
)

View File

@@ -3,7 +3,7 @@ from contextlib import redirect_stderr, redirect_stdout
from typing import List
from httpie.context import Environment
from httpie.internal.update_warnings import _fetch_updates, _get_suppress_context
from httpie.internal.update_warnings import _fetch_updates
from httpie.status import ExitStatus
STATUS_FILE = '.httpie-test-daemon-status'
@@ -44,7 +44,6 @@ def run_daemon_task(env: Environment, args: List[str]) -> ExitStatus:
assert options.daemon
assert options.task_id in DAEMONIZED_TASKS
with redirect_stdout(env.devnull), redirect_stderr(env.devnull):
with _get_suppress_context(env):
DAEMONIZED_TASKS[options.task_id](env)
DAEMONIZED_TASKS[options.task_id](env)
return ExitStatus.SUCCESS

View File

@@ -11,7 +11,7 @@ import platform
import sys
import httpie.__main__
from contextlib import suppress
from subprocess import Popen, DEVNULL
from subprocess import Popen
from typing import Dict, List
from httpie.compat import is_frozen, is_windows
@@ -26,7 +26,7 @@ def _start_process(cmd: List[str], **kwargs) -> Popen:
if not is_frozen:
main_entrypoint = httpie.__main__.__file__
prefix += [main_entrypoint]
return Popen(prefix + cmd, close_fds=True, shell=False, stdout=DEVNULL, stderr=DEVNULL, **kwargs)
return Popen(prefix + cmd, close_fds=True, shell=False, **kwargs)
def _spawn_windows(cmd: List[str], process_context: ProcessContext) -> None:

View File

@@ -20,7 +20,6 @@ COMMANDS = {
{
'flags': ['-f', '--format'],
'choices': ['json'],
'help': 'Format to export in.',
'default': 'json'
}
],
@@ -170,12 +169,5 @@ parser.add_argument(
'''
)
man_page_hint = '''
If you are looking for the man pages of http/https commands, try one of the following:
$ man http
$ man https
'''
options = parser_to_parser_spec(parser, man_page_hint=man_page_hint, source_file=__file__)
options = parser_to_parser_spec(parser)
generate_subparsers(parser, parser, COMMANDS, options)

View File

@@ -7,13 +7,6 @@ from httpie.context import Environment
MAN_COMMAND = 'man'
NO_MAN_PAGES = os.getenv('HTTPIE_NO_MAN_PAGES', False)
# On some systems, HTTP(n) might exist but we are only
# interested in HTTP(1).
#
# For more information on man page sections: https://unix.stackexchange.com/a/138643
MAN_PAGE_SECTION = '1'
def is_available(program: str) -> bool:
"""Check whether HTTPie's man pages are available in this system."""
@@ -21,27 +14,18 @@ def is_available(program: str) -> bool:
if NO_MAN_PAGES or os.system == 'nt':
return False
try:
process = subprocess.run(
[MAN_COMMAND, MAN_PAGE_SECTION, program],
shell=False,
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL
)
except Exception:
# There might be some errors outside of the process, e.g
# a permission error to execute something that is not an
# executable.
return False
else:
return process.returncode == 0
process = subprocess.run(
[MAN_COMMAND, program],
shell=False,
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
)
return process.returncode == 0
def display_for(env: Environment, program: str) -> None:
"""Display the man page for the given command (http/https)."""
subprocess.run(
[MAN_COMMAND, MAN_PAGE_SECTION, program],
stdout=env.stdout,
stderr=env.stderr
[MAN_COMMAND, program], stdout=env.stdout, stderr=env.stderr
)

View File

@@ -1,6 +1,5 @@
from dataclasses import dataclass, field
from enum import Enum, auto
from typing import Optional, List
from typing import Optional
PYGMENTS_BRIGHT_BLACK = 'ansibrightblack'
@@ -35,21 +34,7 @@ class ColorString(str):
E.g: PieColor.BLUE | BOLD | ITALIC
"""
if isinstance(other, str):
# In case of PieColor.BLUE | SOMETHING
# we just create a new string.
return ColorString(self + ' ' + other)
elif isinstance(other, GenericColor):
# If we see a GenericColor, then we'll wrap it
# in with the desired property in a different class.
return _StyledGenericColor(other, styles=self.split())
elif isinstance(other, _StyledGenericColor):
# And if it is already wrapped, we'll just extend the
# list of properties.
other.styles.extend(self.split())
return other
else:
return NotImplemented
return ColorString(self + ' ' + other)
class PieColor(ColorString, Enum):
@@ -101,12 +86,6 @@ class GenericColor(Enum):
return exposed_color
@dataclass
class _StyledGenericColor:
color: 'GenericColor'
styles: List[str] = field(default_factory=list)
# noinspection PyDictCreation
COLOR_PALETTE = {
# Copy the brand palette

View File

@@ -26,7 +26,6 @@ STYLE_BOLD = 'bold'
MAX_CHOICE_CHARS = 80
LEFT_PADDING_2 = (0, 0, 0, 2)
LEFT_PADDING_3 = (0, 0, 0, 3)
LEFT_PADDING_4 = (0, 0, 0, 4)
LEFT_PADDING_5 = (0, 0, 0, 4)
@@ -34,12 +33,6 @@ LEFT_INDENT_2 = (1, 0, 0, 2)
LEFT_INDENT_3 = (1, 0, 0, 3)
LEFT_INDENT_BOTTOM_3 = (0, 0, 1, 3)
MORE_INFO_COMMANDS = """
To learn more, you can try:
-> running 'http --manual'
-> visiting our full documentation at https://httpie.io/docs/cli
"""
class OptionsHighlighter(RegexHighlighter):
highlights = [
@@ -220,10 +213,6 @@ def to_help_message(
Text('More Information', style=STYLE_SWITCH),
LEFT_INDENT_2,
)
yield Padding(
MORE_INFO_COMMANDS.rstrip('\n'),
LEFT_PADDING_3
)
yield Padding(
spec.epilog.rstrip('\n'),
LEFT_INDENT_BOTTOM_3,

View File

@@ -4,22 +4,20 @@ from typing import TYPE_CHECKING, Any, Optional
if TYPE_CHECKING:
from rich.theme import Theme
from httpie.output.ui.palette import GenericColor, PieStyle, Styles, ColorString, _StyledGenericColor # noqa
RICH_BOLD = ColorString('bold')
from httpie.output.ui.palette import GenericColor, PieStyle, Styles # noqa
# Rich-specific color code declarations
# <https://github.com/Textualize/rich/blob/fcd684dd3a482977cab620e71ccaebb94bf13ac9/rich/default_styles.py>
CUSTOM_STYLES = {
'progress.description': RICH_BOLD | GenericColor.WHITE,
'progress.data.speed': RICH_BOLD | GenericColor.GREEN,
'progress.percentage': RICH_BOLD | GenericColor.AQUA,
'progress.download': RICH_BOLD | GenericColor.AQUA,
'progress.remaining': RICH_BOLD | GenericColor.ORANGE,
'bar.complete': RICH_BOLD | GenericColor.PURPLE,
'bar.finished': RICH_BOLD | GenericColor.GREEN,
'bar.pulse': RICH_BOLD | GenericColor.PURPLE,
'option': RICH_BOLD | GenericColor.PINK,
'progress.description': GenericColor.WHITE,
'progress.data.speed': GenericColor.GREEN,
'progress.percentage': GenericColor.AQUA,
'progress.download': GenericColor.AQUA,
'progress.remaining': GenericColor.ORANGE,
'bar.complete': GenericColor.PURPLE,
'bar.finished': GenericColor.GREEN,
'bar.pulse': GenericColor.PURPLE,
'option': GenericColor.PINK,
}
@@ -42,7 +40,7 @@ class _GenericColorCaster(dict):
return super().get(self._translate(key))
def _make_rich_color_theme(style_name: Optional[str] = None) -> 'Theme':
def _make_rich_color_theme(style_name: Optional[str]) -> 'Theme':
from rich.style import Style
from rich.theme import Theme
@@ -57,15 +55,8 @@ def _make_rich_color_theme(style_name: Optional[str] = None) -> 'Theme':
for color, color_set in ChainMap(
GenericColor.__members__, CUSTOM_STYLES
).items():
if isinstance(color_set, _StyledGenericColor):
properties = dict.fromkeys(color_set.styles, True)
color_set = color_set.color
else:
properties = {}
theme.styles[color.lower()] = Style(
color=color_set.apply_style(style, style_name=style_name),
**properties,
color=color_set.apply_style(style, style_name=style_name)
)
# E.g translate GenericColor.BLUE into blue on key access

View File

@@ -6,15 +6,13 @@ from contextlib import contextmanager
from rich.console import Console, RenderableType
from rich.highlighter import Highlighter
from httpie.output.ui.rich_palette import _make_rich_color_theme
def render_as_string(renderable: RenderableType) -> str:
"""Render any `rich` object in a fake console and
return a *style-less* version of it as a string."""
with open(os.devnull, 'w') as null_stream:
fake_console = Console(file=null_stream, record=True, theme=_make_rich_color_theme())
fake_console = Console(file=null_stream, record=True)
fake_console.print(renderable)
return fake_console.export_text()

View File

@@ -17,7 +17,6 @@ from .processing import Conversion, Formatting
from .streams import (
BaseStream, BufferedPrettyStream, EncodedStream, PrettyStream, RawStream,
)
from ..utils import parse_content_type_header
MESSAGE_SEPARATOR = '\n\n'
@@ -164,10 +163,7 @@ def get_stream_type_and_kwargs(
if not is_stream and message_type is HTTPResponse:
# If this is a response, then check the headers for determining
# auto-streaming.
raw_content_type_header = headers.get('Content-Type', None)
if raw_content_type_header:
content_type_header, _ = parse_content_type_header(raw_content_type_header)
is_stream = (content_type_header == 'text/event-stream')
is_stream = headers.get('Content-Type') == 'text/event-stream'
if not env.stdout_isatty and not prettify_groups:
stream_class = RawStream

View File

@@ -117,6 +117,5 @@ setup(
data_files=[
('share/man/man1', ['extras/man/http.1']),
('share/man/man1', ['extras/man/https.1']),
('share/man/man1', ['extras/man/httpie.1']),
]
)

View File

@@ -124,10 +124,6 @@ def test_redirected_stream(httpbin):
['Accept:text/event-stream'],
3
),
(
['Accept:text/event-stream; charset=utf-8'],
3
),
(
['Accept:text/plain'],
1