mirror of
https://github.com/httpie/cli.git
synced 2025-08-13 22:29:23 +02:00
Compare commits
3 Commits
mickael/os
...
0.9.2
| Author | SHA1 | Date | |
|---|---|---|---|
| 80a2c8266c | |||
| bc742b62cf | |||
| 43ce0b6fa1 |
@ -1,17 +0,0 @@
|
|||||||
# https://editorconfig.org
|
|
||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 4
|
|
||||||
end_of_line = lf
|
|
||||||
charset = utf-8
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
insert_final_newline = true
|
|
||||||
|
|
||||||
[*.yml]
|
|
||||||
indent_size = 2
|
|
||||||
|
|
||||||
[Makefile]
|
|
||||||
indent_style = tab
|
|
||||||
indent_size = 8
|
|
||||||
44
.github/ISSUE_TEMPLATE/bug_report.md
vendored
44
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,44 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Report a possible bug in HTTPie
|
|
||||||
title: ''
|
|
||||||
labels: "new, bug"
|
|
||||||
assignees: 'BoboTiG'
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Checklist
|
|
||||||
|
|
||||||
- [ ] I've searched for similar issues.
|
|
||||||
- [ ] I'm using the latest version of HTTPie.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Minimal reproduction code and steps
|
|
||||||
|
|
||||||
1.
|
|
||||||
2.
|
|
||||||
3.
|
|
||||||
|
|
||||||
## Current result
|
|
||||||
|
|
||||||
…
|
|
||||||
|
|
||||||
## Expected result
|
|
||||||
|
|
||||||
…
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Debug output
|
|
||||||
|
|
||||||
Please re-run the command with `--debug`, then copy the entire command & output and paste both below:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ http --debug <COMPLETE ARGUMENT LIST THAT TRIGGERS THE ERROR>
|
|
||||||
<COMPLETE OUTPUT>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Additional information, screenshots, or code examples
|
|
||||||
|
|
||||||
…
|
|
||||||
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,30 +0,0 @@
|
|||||||
---
|
|
||||||
name: Feature request
|
|
||||||
about: Suggest an enhancement for HTTPie
|
|
||||||
title: ''
|
|
||||||
labels: "new, enhancement"
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Checklist
|
|
||||||
|
|
||||||
- [ ] I've searched for similar feature requests.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Enhancement request
|
|
||||||
|
|
||||||
…
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Problem it solves
|
|
||||||
|
|
||||||
E.g. “I'm always frustrated when […]”, “I’m trying to do […] so that […]”.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Additional information, screenshots, or code examples
|
|
||||||
|
|
||||||
…
|
|
||||||
10
.github/ISSUE_TEMPLATE/other.md
vendored
10
.github/ISSUE_TEMPLATE/other.md
vendored
@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
name: Other
|
|
||||||
about: Anything else that isn't a feature or a bug
|
|
||||||
title: ''
|
|
||||||
labels: "new"
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
If you have a general question, please consider asking on Discord: https://httpie.io/chat
|
|
||||||
9
.github/dependabot.yml
vendored
9
.github/dependabot.yml
vendored
@ -1,9 +0,0 @@
|
|||||||
version: 2
|
|
||||||
updates:
|
|
||||||
# GitHub Actions
|
|
||||||
- package-ecosystem: github-actions
|
|
||||||
directory: /
|
|
||||||
schedule:
|
|
||||||
interval: daily
|
|
||||||
assignees:
|
|
||||||
- BoboTiG
|
|
||||||
19
.github/workflows/code-style.yml
vendored
19
.github/workflows/code-style.yml
vendored
@ -1,19 +0,0 @@
|
|||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- .github/workflows/code-style.yml
|
|
||||||
- extras/*.py
|
|
||||||
- httpie/**/*.py
|
|
||||||
- setup.py
|
|
||||||
- tests/**/*.py
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
code-style:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-python@v2
|
|
||||||
with:
|
|
||||||
python-version: 3.9
|
|
||||||
- run: make venv
|
|
||||||
- run: make codestyle
|
|
||||||
22
.github/workflows/coverage.yml
vendored
22
.github/workflows/coverage.yml
vendored
@ -1,22 +0,0 @@
|
|||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- .github/workflows/coverage.yml
|
|
||||||
- httpie/**/*.py
|
|
||||||
- setup.*
|
|
||||||
- tests/**/*.py
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
coverage:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-python@v2
|
|
||||||
with:
|
|
||||||
python-version: "3.10"
|
|
||||||
- run: make install
|
|
||||||
- run: make test-cover
|
|
||||||
- run: make codecov-upload
|
|
||||||
env:
|
|
||||||
CODECOV_TOKEN: ${{ secrets.CODECOV_REPO_TOKEN }}
|
|
||||||
- run: make test-dist
|
|
||||||
19
.github/workflows/docs-check-markdown.yml
vendored
19
.github/workflows/docs-check-markdown.yml
vendored
@ -1,19 +0,0 @@
|
|||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "*.md"
|
|
||||||
- "**/*.md"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
doc:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- name: Setup Ruby
|
|
||||||
uses: ruby/setup-ruby@v1
|
|
||||||
with:
|
|
||||||
ruby-version: 2.7
|
|
||||||
- name: Install the linter
|
|
||||||
run: sudo gem install mdl
|
|
||||||
- name: Check files
|
|
||||||
run: make doc-check
|
|
||||||
20
.github/workflows/docs-deploy.yml
vendored
20
.github/workflows/docs-deploy.yml
vendored
@ -1,20 +0,0 @@
|
|||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths:
|
|
||||||
- docs/README.md
|
|
||||||
- docs/config.json
|
|
||||||
release:
|
|
||||||
types:
|
|
||||||
- published
|
|
||||||
- unpublished
|
|
||||||
- deleted
|
|
||||||
jobs:
|
|
||||||
trigger-doc-build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Install HTTPie
|
|
||||||
run: sudo snap install --edge httpie
|
|
||||||
- name: Trigger new documentation build
|
|
||||||
run: http --ignore-stdin POST ${{ secrets.DOCS_UPDATE_VERCEL_HOOK }}
|
|
||||||
26
.github/workflows/docs-update-install.yml
vendored
26
.github/workflows/docs-update-install.yml
vendored
@ -1,26 +0,0 @@
|
|||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths:
|
|
||||||
- docs/installation/*
|
|
||||||
|
|
||||||
# Allow to call the workflow manually
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
doc:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-python@v2
|
|
||||||
with:
|
|
||||||
python-version: 3.9
|
|
||||||
- run: make install
|
|
||||||
- run: make doc-update-install
|
|
||||||
- uses: Automattic/action-commit-to-branch@master
|
|
||||||
with:
|
|
||||||
branch: master
|
|
||||||
commit_message: Auto-update installation instructions in the docs
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
26
.github/workflows/release.yml
vendored
26
.github/workflows/release.yml
vendored
@ -1,26 +0,0 @@
|
|||||||
on:
|
|
||||||
# Add a "Trigger" button to manually start the workflow.
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
branch:
|
|
||||||
description: "The branch, tag or SHA to release from"
|
|
||||||
required: true
|
|
||||||
default: "master"
|
|
||||||
# It could be fully automated by uncommenting following lines.
|
|
||||||
# Let's see later if we are confident enough to try it :)
|
|
||||||
# release:
|
|
||||||
# types:
|
|
||||||
# - published
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
new-release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-python@v2
|
|
||||||
with:
|
|
||||||
python-version: 3.9
|
|
||||||
- run: make publish
|
|
||||||
env:
|
|
||||||
TWINE_USERNAME: __token__
|
|
||||||
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
|
|
||||||
23
.github/workflows/test-package-linux-snap.yml
vendored
23
.github/workflows/test-package-linux-snap.yml
vendored
@ -1,23 +0,0 @@
|
|||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- .github/workflows/test-package-linux-snap.yml
|
|
||||||
- snapcraft.yaml
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
snap:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- name: Build
|
|
||||||
uses: snapcore/action-build@v1
|
|
||||||
id: snapcraft
|
|
||||||
- name: Install
|
|
||||||
run: sudo snap install --dangerous ${{ steps.snapcraft.outputs.snap }}
|
|
||||||
- name: Test
|
|
||||||
run: |
|
|
||||||
httpie.http --version
|
|
||||||
httpie.https --version
|
|
||||||
# Auto-aliases cannot be tested when installing a snap outside the store.
|
|
||||||
# http --version
|
|
||||||
# https --version
|
|
||||||
17
.github/workflows/test-package-mac-brew.yml
vendored
17
.github/workflows/test-package-mac-brew.yml
vendored
@ -1,17 +0,0 @@
|
|||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- .github/workflows/test-package-mac-brew.yml
|
|
||||||
- docs/packaging/brew/httpie.rb
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
brew:
|
|
||||||
runs-on: macos-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- name: Setup brew
|
|
||||||
run: |
|
|
||||||
brew developer on
|
|
||||||
brew update
|
|
||||||
- name: Build and test the formula
|
|
||||||
run: make brew-test
|
|
||||||
45
.github/workflows/tests.yml
vendored
45
.github/workflows/tests.yml
vendored
@ -1,45 +0,0 @@
|
|||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths:
|
|
||||||
- .github/workflows/tests.yml
|
|
||||||
- httpie/**/*.py
|
|
||||||
- setup.*
|
|
||||||
- tests/**/*.py
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- .github/workflows/tests.yml
|
|
||||||
- httpie/**/*.py
|
|
||||||
- setup.*
|
|
||||||
- tests/**/*.py
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
|
||||||
python-version: [3.6, 3.7, 3.8, 3.9, "3.10"]
|
|
||||||
pyopenssl: [0, 1]
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-python@v2
|
|
||||||
with:
|
|
||||||
python-version: ${{ matrix.python-version }}
|
|
||||||
- name: Windows setup
|
|
||||||
if: matrix.os == 'windows-latest'
|
|
||||||
run: |
|
|
||||||
python -m pip install --upgrade pip wheel
|
|
||||||
python -m pip install --upgrade '.[dev]'
|
|
||||||
python -m pytest --verbose ./httpie ./tests
|
|
||||||
env:
|
|
||||||
HTTPIE_TEST_WITH_PYOPENSSL: ${{ matrix.pyopenssl }}
|
|
||||||
- name: Linux & Mac setup
|
|
||||||
if: matrix.os != 'windows-latest'
|
|
||||||
run: |
|
|
||||||
make install
|
|
||||||
make test
|
|
||||||
env:
|
|
||||||
HTTPIE_TEST_WITH_PYOPENSSL: ${{ matrix.pyopenssl }}
|
|
||||||
158
.gitignore
vendored
158
.gitignore
vendored
@ -1,153 +1,11 @@
|
|||||||
.DS_Store
|
dist
|
||||||
.idea/
|
httpie.egg-info
|
||||||
*.egg-info
|
build
|
||||||
.cache/
|
|
||||||
*.pyc
|
*.pyc
|
||||||
htmlcov
|
|
||||||
|
|
||||||
|
|
||||||
##############################################################################
|
|
||||||
# The below is GitHub template for Python project. gitignore.
|
|
||||||
# <https://github.com/github/gitignore/blob/master/Python.gitignore>
|
|
||||||
##############################################################################
|
|
||||||
|
|
||||||
# Byte-compiled / optimized / DLL files
|
|
||||||
__pycache__/
|
|
||||||
*.py[cod]
|
|
||||||
*$py.class
|
|
||||||
|
|
||||||
# C extensions
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Distribution / packaging
|
|
||||||
.Python
|
|
||||||
build/
|
|
||||||
develop-eggs/
|
|
||||||
dist/
|
|
||||||
downloads/
|
|
||||||
eggs/
|
|
||||||
.eggs/
|
|
||||||
lib/
|
|
||||||
lib64/
|
|
||||||
parts/
|
|
||||||
sdist/
|
|
||||||
var/
|
|
||||||
wheels/
|
|
||||||
pip-wheel-metadata/
|
|
||||||
share/python-wheels/
|
|
||||||
*.egg-info/
|
|
||||||
.installed.cfg
|
|
||||||
*.egg
|
*.egg
|
||||||
MANIFEST
|
.tox
|
||||||
|
README.html
|
||||||
# PyInstaller
|
|
||||||
# Usually these files are written by a python script from a template
|
|
||||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
||||||
*.manifest
|
|
||||||
*.spec
|
|
||||||
|
|
||||||
# Installer logs
|
|
||||||
pip-log.txt
|
|
||||||
pip-delete-this-directory.txt
|
|
||||||
|
|
||||||
# Unit test / coverage reports
|
|
||||||
htmlcov/
|
|
||||||
.nox/
|
|
||||||
.coverage
|
.coverage
|
||||||
.coverage.*
|
htmlcov
|
||||||
.cache
|
.idea
|
||||||
nosetests.xml
|
.DS_Store
|
||||||
coverage.xml
|
|
||||||
*.cover
|
|
||||||
*.py,cover
|
|
||||||
.hypothesis/
|
|
||||||
.pytest_cache/
|
|
||||||
|
|
||||||
# Translations
|
|
||||||
*.mo
|
|
||||||
*.pot
|
|
||||||
|
|
||||||
# Django stuff:
|
|
||||||
*.log
|
|
||||||
local_settings.py
|
|
||||||
db.sqlite3
|
|
||||||
db.sqlite3-journal
|
|
||||||
|
|
||||||
# Flask stuff:
|
|
||||||
instance/
|
|
||||||
.webassets-cache
|
|
||||||
|
|
||||||
# Scrapy stuff:
|
|
||||||
.scrapy
|
|
||||||
|
|
||||||
# Sphinx documentation
|
|
||||||
docs/_build/
|
|
||||||
|
|
||||||
# PyBuilder
|
|
||||||
target/
|
|
||||||
|
|
||||||
# Jupyter Notebook
|
|
||||||
.ipynb_checkpoints
|
|
||||||
|
|
||||||
# IPython
|
|
||||||
profile_default/
|
|
||||||
ipython_config.py
|
|
||||||
|
|
||||||
# pyenv
|
|
||||||
.python-version
|
|
||||||
|
|
||||||
# pipenv
|
|
||||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
||||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
||||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
||||||
# install all needed dependencies.
|
|
||||||
#Pipfile.lock
|
|
||||||
|
|
||||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
|
||||||
__pypackages__/
|
|
||||||
|
|
||||||
# Celery stuff
|
|
||||||
celerybeat-schedule
|
|
||||||
celerybeat.pid
|
|
||||||
|
|
||||||
# SageMath parsed files
|
|
||||||
*.sage.py
|
|
||||||
|
|
||||||
# Environments
|
|
||||||
.env
|
|
||||||
.venv
|
|
||||||
env/
|
|
||||||
venv/
|
|
||||||
venv*/
|
|
||||||
ENV/
|
|
||||||
env.bak/
|
|
||||||
venv.bak/
|
|
||||||
|
|
||||||
# Spyder project settings
|
|
||||||
.spyderproject
|
|
||||||
.spyproject
|
|
||||||
|
|
||||||
# Rope project settings
|
|
||||||
.ropeproject
|
|
||||||
|
|
||||||
# mkdocs documentation
|
|
||||||
/site
|
|
||||||
|
|
||||||
# mypy
|
|
||||||
.mypy_cache/
|
|
||||||
.dmypy.json
|
|
||||||
dmypy.json
|
|
||||||
|
|
||||||
# Pyre type checker
|
|
||||||
.pyre/
|
|
||||||
|
|
||||||
# Packit
|
|
||||||
/httpie.spec
|
|
||||||
/httpie-*.rpm
|
|
||||||
/httpie-*.tar.gz
|
|
||||||
|
|
||||||
# VS Code
|
|
||||||
.vscode/
|
|
||||||
|
|
||||||
# Windows Chocolatey
|
|
||||||
*.nupkg
|
|
||||||
|
|||||||
19
.packit.yaml
19
.packit.yaml
@ -1,19 +0,0 @@
|
|||||||
# See the documentation for more information:
|
|
||||||
# https://packit.dev/docs/configuration/
|
|
||||||
specfile_path: httpie.spec
|
|
||||||
actions:
|
|
||||||
# get the current Fedora Rawhide specfile:
|
|
||||||
post-upstream-clone: "wget https://src.fedoraproject.org/rpms/httpie/raw/rawhide/f/httpie.spec -O httpie.spec"
|
|
||||||
jobs:
|
|
||||||
- job: copr_build
|
|
||||||
trigger: pull_request
|
|
||||||
metadata:
|
|
||||||
targets:
|
|
||||||
- fedora-all
|
|
||||||
additional_repos:
|
|
||||||
- "https://kojipkgs.fedoraproject.org/repos/f$releasever-build/latest/$basearch/"
|
|
||||||
- job: propose_downstream
|
|
||||||
trigger: release
|
|
||||||
metadata:
|
|
||||||
dist_git_branches:
|
|
||||||
- rawhide
|
|
||||||
20
.travis.yml
Normal file
20
.travis.yml
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# https://travis-ci.org/jakubroztocil/httpie
|
||||||
|
sudo: false
|
||||||
|
os:
|
||||||
|
- linux
|
||||||
|
- osx
|
||||||
|
env:
|
||||||
|
global:
|
||||||
|
- NEWEST_PYTHON=3.4
|
||||||
|
language: python
|
||||||
|
python:
|
||||||
|
- 2.6
|
||||||
|
- 2.7
|
||||||
|
- pypy
|
||||||
|
- 3.3
|
||||||
|
- 3.4
|
||||||
|
- pypy3
|
||||||
|
script:
|
||||||
|
- make
|
||||||
|
after_success:
|
||||||
|
- if [[ $TRAVIS_PYTHON_VERSION == $NEWEST_PYTHON ]]; then pip install python-coveralls && coveralls; fi
|
||||||
41
AUTHORS.md
41
AUTHORS.md
@ -1,41 +0,0 @@
|
|||||||
# HTTPie authors
|
|
||||||
|
|
||||||
- [Jakub Roztocil](https://github.com/jakubroztocil)
|
|
||||||
|
|
||||||
## Patches, features, ideas
|
|
||||||
|
|
||||||
[Complete list of contributors on GitHub](https://github.com/httpie/httpie/graphs/contributors)
|
|
||||||
|
|
||||||
- [Cláudia T. Delgado](https://github.com/claudiatd)
|
|
||||||
- [Hank Gay](https://github.com/gthank)
|
|
||||||
- [Jake Basile](https://github.com/jakebasile)
|
|
||||||
- [Vladimir Berkutov](https://github.com/dair-targ)
|
|
||||||
- [Jakob Kramer](https://github.com/gandaro)
|
|
||||||
- [Chris Faulkner](https://github.com/faulkner)
|
|
||||||
- [Alen Mujezinovic](https://github.com/flashingpumpkin)
|
|
||||||
- [Praful Mathur](https://github.com/tictactix)
|
|
||||||
- [Marc Abramowitz](https://github.com/msabramo)
|
|
||||||
- [Ismail Badawi](https://github.com/isbadawi)
|
|
||||||
- [Laurent Bachelier](https://github.com/laurentb)
|
|
||||||
- [Isman Firmansyah](https://github.com/iromli)
|
|
||||||
- [Simon Olofsson](https://github.com/simono)
|
|
||||||
- [Churkin Oleg](https://github.com/Bahus)
|
|
||||||
- [Jökull Sólberg Auðunsson](https://github.com/jokull)
|
|
||||||
- [Matthew M. Boedicker](https://github.com/mmb)
|
|
||||||
- [marblar](https://github.com/marblar)
|
|
||||||
- [Tomek Wójcik](https://github.com/tomekwojcik)
|
|
||||||
- [Davey Shafik](https://github.com/dshafik)
|
|
||||||
- [cido](https://github.com/cido)
|
|
||||||
- [Justin Bonnar](https://github.com/jargonjustin)
|
|
||||||
- [Nathan LaFreniere](https://github.com/nlf)
|
|
||||||
- [Matthias Lehmann](https://github.com/matleh)
|
|
||||||
- [Dennis Brakhane](https://github.com/brakhane)
|
|
||||||
- [Matt Layman](https://github.com/mblayman)
|
|
||||||
- [Edward Yang](https://github.com/honorabrutroll)
|
|
||||||
- [Aleksandr Vinokurov](https://github.com/aleksandr-vin)
|
|
||||||
- [Jeff Byrnes](https://github.com/jeffbyrnes)
|
|
||||||
- [Denis Belavin](https://github.com/LuckyDenis)
|
|
||||||
- [Mickaël Schoentgen](https://github.com/BoboTiG)
|
|
||||||
- [Elena Lape](https://github.com/elenalape)
|
|
||||||
- [Rohit Sehgal](https://github.com/r0hi7)
|
|
||||||
- [Bartłomiej Jacak](https://github.com/bartekjacak)
|
|
||||||
34
AUTHORS.rst
Normal file
34
AUTHORS.rst
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
==============
|
||||||
|
HTTPie authors
|
||||||
|
==============
|
||||||
|
|
||||||
|
* `Jakub Roztocil <https://github.com/jakubroztocil>`_
|
||||||
|
|
||||||
|
|
||||||
|
Patches and ideas
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
* `Cláudia T. Delgado <https://github.com/claudiatd>`_ (logo)
|
||||||
|
* `Hank Gay <https://github.com/gthank>`_
|
||||||
|
* `Jake Basile <https://github.com/jakebasile>`_
|
||||||
|
* `Vladimir Berkutov <https://github.com/dair-targ>`_
|
||||||
|
* `Jakob Kramer <https://github.com/gandaro>`_
|
||||||
|
* `Chris Faulkner <https://github.com/faulkner>`_
|
||||||
|
* `Alen Mujezinovic <https://github.com/flashingpumpkin>`_
|
||||||
|
* `Praful Mathur <https://github.com/tictactix>`_
|
||||||
|
* `Marc Abramowitz <https://github.com/msabramo>`_
|
||||||
|
* `Ismail Badawi <https://github.com/isbadawi>`_
|
||||||
|
* `Laurent Bachelier <https://github.com/laurentb>`_
|
||||||
|
* `Isman Firmansyah <https://github.com/iromli>`_
|
||||||
|
* `Simon Olofsson <https://github.com/simono>`_
|
||||||
|
* `Churkin Oleg <https://github.com/Bahus>`_
|
||||||
|
* `Jökull Sólberg Auðunsson <https://github.com/jokull>`_
|
||||||
|
* `Matthew M. Boedicker <https://github.com/mmb>`_
|
||||||
|
* `marblar <https://github.com/marblar>`_
|
||||||
|
* `Tomek Wójcik <https://github.com/tomekwojcik>`_
|
||||||
|
* `Davey Shafik <https://github.com/dshafik>`_
|
||||||
|
* `cido <https://github.com/cido>`_
|
||||||
|
* `Justin Bonnar <https://github.com/jargonjustin>`_
|
||||||
|
* `Nathan LaFreniere <https://github.com/nlf>`_
|
||||||
|
* `Matthias Lehmann <https://github.com/matleh>`_
|
||||||
|
* `Dennis Brakhane <https://github.com/brakhane>`_
|
||||||
378
CHANGELOG.md
378
CHANGELOG.md
@ -1,378 +0,0 @@
|
|||||||
# Change Log
|
|
||||||
|
|
||||||
This document records all notable changes to [HTTPie](https://httpie.io).
|
|
||||||
This project adheres to [Semantic Versioning](https://semver.org/).
|
|
||||||
|
|
||||||
## [2.6.0.dev0](https://github.com/httpie/httpie/compare/2.5.0...master) (unreleased)
|
|
||||||
|
|
||||||
- Added support for formatting & coloring of JSON bodies preceded by non-JSON data (e.g., an XXSI prefix). ([#1130](https://github.com/httpie/httpie/issues/1130))
|
|
||||||
- Added `--response-charset` to allow overriding the response encoding for terminal display purposes. ([#1168](https://github.com/httpie/httpie/issues/1168))
|
|
||||||
- Added `--response-mime` to allow overriding the response mime type for coloring and formatting for the terminal. ([#1168](https://github.com/httpie/httpie/issues/1168))
|
|
||||||
- Improved handling of responses with incorrect `Content-Type`. ([#1110](https://github.com/httpie/httpie/issues/1110), [#1168](https://github.com/httpie/httpie/issues/1168))
|
|
||||||
- Installed plugins are now listed in `--debug` output. ([#1165](https://github.com/httpie/httpie/issues/1165))
|
|
||||||
- Fixed duplicate keys preservation of JSON data. ([#1163](https://github.com/httpie/httpie/issues/1163))
|
|
||||||
|
|
||||||
## [2.5.0](https://github.com/httpie/httpie/compare/2.4.0...2.5.0) (2021-09-06)
|
|
||||||
|
|
||||||
Blog post: [What’s new in HTTPie 2.5.0](https://httpie.io/blog/httpie-2.5.0)
|
|
||||||
|
|
||||||
- Added `--raw` to allow specifying the raw request body without extra processing as
|
|
||||||
an alternative to `stdin`. ([#534](https://github.com/httpie/httpie/issues/534))
|
|
||||||
- Added support for XML formatting. ([#1129](https://github.com/httpie/httpie/issues/1129))
|
|
||||||
- Added internal support for file-like object responses to improve adapter plugin support. ([#1094](https://github.com/httpie/httpie/issues/1094))
|
|
||||||
- Fixed `--continue --download` with a single byte to be downloaded left. ([#1032](https://github.com/httpie/httpie/issues/1032))
|
|
||||||
- Fixed `--verbose` HTTP 307 redirects with streamed request body. ([#1088](https://github.com/httpie/httpie/issues/1088))
|
|
||||||
- Fixed handling of session files with `Cookie:` followed by other headers. ([#1126](https://github.com/httpie/httpie/issues/1126))
|
|
||||||
|
|
||||||
## [2.4.0](https://github.com/httpie/httpie/compare/2.3.0...2.4.0) (2021-02-06)
|
|
||||||
|
|
||||||
- Added support for `--session` cookie expiration based on `Set-Cookie: max-age=<n>`. ([#1029](https://github.com/httpie/httpie/issues/1029))
|
|
||||||
- Show a `--check-status` warning with `--quiet` as well, not only when the output is redirected. ([#1026](https://github.com/httpie/httpie/issues/1026))
|
|
||||||
- Fixed upload with `--session` ([#1020](https://github.com/httpie/httpie/issues/1020)).
|
|
||||||
- Fixed a missing blank line between request and response ([#1006](https://github.com/httpie/httpie/issues/1006)).
|
|
||||||
|
|
||||||
## [2.3.0](https://github.com/httpie/httpie/compare/2.2.0...2.3.0) (2020-10-25)
|
|
||||||
|
|
||||||
- Added support for streamed uploads ([#201](https://github.com/httpie/httpie/issues/201)).
|
|
||||||
- Added support for multipart upload streaming ([#684](https://github.com/httpie/httpie/issues/684)).
|
|
||||||
- Added support for body-from-file upload streaming (`http pie.dev/post @file`).
|
|
||||||
- Added `--chunked` to enable chunked transfer encoding ([#753](https://github.com/httpie/httpie/issues/753)).
|
|
||||||
- Added `--multipart` to allow `multipart/form-data` encoding for non-file `--form` requests as well.
|
|
||||||
- Added support for preserving field order in multipart requests ([#903](https://github.com/httpie/httpie/issues/903)).
|
|
||||||
- Added `--boundary` to allow a custom boundary string for `multipart/form-data` requests.
|
|
||||||
- Added support for combining cookies specified on the CLI and in a session file ([#932](https://github.com/httpie/httpie/issues/932)).
|
|
||||||
- Added out of the box SOCKS support with no extra installation ([#904](https://github.com/httpie/httpie/issues/904)).
|
|
||||||
- Added `--quiet, -q` flag to enforce silent behaviour.
|
|
||||||
- Fixed the handling of invalid `expires` dates in `Set-Cookie` headers ([#963](https://github.com/httpie/httpie/issues/963)).
|
|
||||||
- Removed Tox testing entirely ([#943](https://github.com/httpie/httpie/issues/943)).
|
|
||||||
|
|
||||||
## [2.2.0](https://github.com/httpie/httpie/compare/2.1.0...2.2.0) (2020-06-18)
|
|
||||||
|
|
||||||
- Added support for custom content types for uploaded files ([#668](https://github.com/httpie/httpie/issues/668)).
|
|
||||||
- Added support for `$XDG_CONFIG_HOME` ([#920](https://github.com/httpie/httpie/issues/920)).
|
|
||||||
- Added support for `Set-Cookie`-triggered cookie expiration ([#853](https://github.com/httpie/httpie/issues/853)).
|
|
||||||
- Added `--format-options` to allow disabling sorting, etc. ([#128](https://github.com/httpie/httpie/issues/128))
|
|
||||||
- Added `--sorted` and `--unsorted` shortcuts for (un)setting all sorting-related `--format-options`. ([#128](https://github.com/httpie/httpie/issues/128))
|
|
||||||
- Added `--ciphers` to allow configuring OpenSSL ciphers ([#870](https://github.com/httpie/httpie/issues/870)).
|
|
||||||
- Added `netrc` support for auth plugins. Enabled for `--auth-type=basic`
|
|
||||||
and `digest`, 3rd parties may opt in ([#718](https://github.com/httpie/httpie/issues/718), [#719](https://github.com/httpie/httpie/issues/719), [#852](https://github.com/httpie/httpie/issues/852), [#934](https://github.com/httpie/httpie/issues/934)).
|
|
||||||
- Fixed built-in plugins-related circular imports ([#925](https://github.com/httpie/httpie/issues/925)).
|
|
||||||
|
|
||||||
## [2.1.0](https://github.com/httpie/httpie/compare/2.0.0...2.1.0) (2020-04-18)
|
|
||||||
|
|
||||||
- Added `--path-as-is` to bypass dot segment (`/../` or `/./`)
|
|
||||||
URL squashing ([#895](https://github.com/httpie/httpie/issues/895)).
|
|
||||||
- Changed the default `Accept` header value for JSON requests from
|
|
||||||
`application/json, */*` to `application/json, */*;q=0.5`
|
|
||||||
to clearly indicate preference ([#488](https://github.com/httpie/httpie/issues/488)).
|
|
||||||
- Fixed `--form` file upload mixed with redirected `stdin` error handling
|
|
||||||
([#840](https://github.com/httpie/httpie/issues/840)).
|
|
||||||
|
|
||||||
## [2.0.0](https://github.com/httpie/httpie/compare/1.0.3...2.0.0) (2020-01-12)
|
|
||||||
|
|
||||||
- Removed Python 2.7 support ([EOL Jan 2020](https://www.python.org/doc/sunset-python-2/).
|
|
||||||
- Added `--offline` to allow building an HTTP request and printing it but not
|
|
||||||
actually sending it over the network.
|
|
||||||
- Replaced the old collect-all-then-process handling of HTTP communication
|
|
||||||
with one-by-one processing of each HTTP request or response as they become
|
|
||||||
available. This means that you can see headers immediately,
|
|
||||||
see what is being sent even if the request fails, etc.
|
|
||||||
- Removed automatic config file creation to avoid concurrency issues.
|
|
||||||
- Removed the default 30-second connection `--timeout` limit.
|
|
||||||
- Removed Python’s default limit of 100 response headers.
|
|
||||||
- Added `--max-headers` to allow setting the max header limit.
|
|
||||||
- Added `--compress` to allow request body compression.
|
|
||||||
- Added `--ignore-netrc` to allow bypassing credentials from `.netrc`.
|
|
||||||
- Added `https` alias command with `https://` as the default scheme.
|
|
||||||
- Added `$ALL_PROXY` documentation.
|
|
||||||
- Added type annotations throughout the codebase.
|
|
||||||
- Added `tests/` to the PyPi package for the convenience of
|
|
||||||
downstream package maintainers.
|
|
||||||
- Fixed an error when `stdin` was a closed fd.
|
|
||||||
- Improved `--debug` output formatting.
|
|
||||||
|
|
||||||
## [1.0.3](https://github.com/httpie/httpie/compare/1.0.2...1.0.3) (2019-08-26)
|
|
||||||
|
|
||||||
- Fixed CVE-2019-10751 — the way the output filename is generated for
|
|
||||||
`--download` requests without `--output` resulting in a redirect has
|
|
||||||
been changed to only consider the initial URL as the base for the generated
|
|
||||||
filename, and not the final one. This fixes a potential security issue under
|
|
||||||
the following scenario:
|
|
||||||
|
|
||||||
1. A `--download` request with no explicit `--output` is made (e.g.,
|
|
||||||
`$ http -d example.org/file.txt`), instructing httpie to
|
|
||||||
[generate the output filename](https://httpie.org/doc#downloaded-filename)
|
|
||||||
from the `Content-Disposition` response header, or from the URL if the header
|
|
||||||
is not provided.
|
|
||||||
2. The server handling the request has been modified by an attacker and
|
|
||||||
instead of the expected response the URL returns a redirect to another
|
|
||||||
URL, e.g., `attacker.example.org/.bash_profile`, whose response does
|
|
||||||
not provide a `Content-Disposition` header (i.e., the base for the
|
|
||||||
generated filename becomes `.bash_profile` instead of `file.txt`).
|
|
||||||
3. Your current directory doesn’t already contain `.bash_profile`
|
|
||||||
(i.e., no unique suffix is added to the generated filename).
|
|
||||||
4. You don’t notice the potentially unexpected output filename
|
|
||||||
as reported by httpie in the console output
|
|
||||||
(e.g., `Downloading 100.00 B to ".bash_profile"`).
|
|
||||||
|
|
||||||
Reported by Raul Onitza and Giulio Comi.
|
|
||||||
|
|
||||||
## [1.0.2](https://github.com/httpie/httpie/compare/1.0.1...1.0.2) (2018-11-14)
|
|
||||||
|
|
||||||
- Fixed tests for installation with pyOpenSSL.
|
|
||||||
|
|
||||||
## [1.0.1](https://github.com/httpie/httpie/compare/1.0.0...1.0.1) (2018-11-14)
|
|
||||||
|
|
||||||
- Removed external URL calls from tests.
|
|
||||||
|
|
||||||
## [1.0.0](https://github.com/httpie/httpie/compare/0.9.9...1.0.0) (2018-11-02)
|
|
||||||
|
|
||||||
- Added `--style=auto` which follows the terminal ANSI color styles.
|
|
||||||
- Added support for selecting TLS 1.3 via `--ssl=tls1.3`
|
|
||||||
(available once implemented in upstream libraries).
|
|
||||||
- Added `true`/`false` as valid values for `--verify`
|
|
||||||
(in addition to `yes`/`no`) and the boolean value is case-insensitive.
|
|
||||||
- Changed the default `--style` from `solarized` to `auto` (on Windows it stays `fruity`).
|
|
||||||
- Fixed default headers being incorrectly case-sensitive.
|
|
||||||
- Removed Python 2.6 support.
|
|
||||||
|
|
||||||
## [0.9.9](https://github.com/httpie/httpie/compare/0.9.8...0.9.9) (2016-12-08)
|
|
||||||
|
|
||||||
- Fixed README.
|
|
||||||
|
|
||||||
## [0.9.8](https://github.com/httpie/httpie/compare/0.9.6...0.9.8) (2016-12-08)
|
|
||||||
|
|
||||||
- Extended auth plugin API.
|
|
||||||
- Added exit status code `7` for plugin errors.
|
|
||||||
- Added support for `curses`-less Python installations.
|
|
||||||
- Fixed `REQUEST_ITEM` arg incorrectly being reported as required.
|
|
||||||
- Improved `CTRL-C` interrupt handling.
|
|
||||||
- Added the standard exit status code `130` for keyboard interrupts.
|
|
||||||
|
|
||||||
## [0.9.6](https://github.com/httpie/httpie/compare/0.9.4...0.9.6) (2016-08-13)
|
|
||||||
|
|
||||||
- Added Python 3 as a dependency for Homebrew installations
|
|
||||||
to ensure some of the newer HTTP features work out of the box
|
|
||||||
for macOS users (starting with HTTPie 0.9.4.).
|
|
||||||
- Added the ability to unset a request header with `Header:`, and send an
|
|
||||||
empty value with `Header;`.
|
|
||||||
- Added `--default-scheme <URL_SCHEME>` to enable things like
|
|
||||||
`$ alias https='http --default-scheme=https`.
|
|
||||||
- Added `-I` as a shortcut for `--ignore-stdin`.
|
|
||||||
- Added fish shell completion (located in `extras/httpie-completion.fish`
|
|
||||||
in the GitHub repo).
|
|
||||||
- Updated `requests` to 2.10.0 so that SOCKS support can be added via
|
|
||||||
`pip install requests[socks]`.
|
|
||||||
- Changed the default JSON `Accept` header from `application/json`
|
|
||||||
to `application/json, */*`.
|
|
||||||
- Changed the pre-processing of request HTTP headers so that any leading
|
|
||||||
and trailing whitespace is removed.
|
|
||||||
|
|
||||||
## [0.9.4](https://github.com/httpie/httpie/compare/0.9.3...0.9.4) (2016-07-01)
|
|
||||||
|
|
||||||
- Added `Content-Type` of files uploaded in `multipart/form-data` requests
|
|
||||||
- Added `--ssl=<PROTOCOL>` to specify the desired SSL/TLS protocol version
|
|
||||||
to use for HTTPS requests.
|
|
||||||
- Added JSON detection with `--json, -j` to work around incorrect
|
|
||||||
`Content-Type`
|
|
||||||
- Added `--all` to show intermediate responses such as redirects (with `--follow`)
|
|
||||||
- Added `--history-print, -P WHAT` to specify formatting of intermediate responses
|
|
||||||
- Added `--max-redirects=N` (default 30)
|
|
||||||
- Added `-A` as short name for `--auth-type`
|
|
||||||
- Added `-F` as short name for `--follow`
|
|
||||||
- Removed the `implicit_content_type` config option
|
|
||||||
(use `"default_options": ["--form"]` instead)
|
|
||||||
- Redirected `stdout` doesn't trigger an error anymore when `--output FILE`
|
|
||||||
is set
|
|
||||||
- Changed the default `--style` back to `solarized` for better support
|
|
||||||
of light and dark terminals
|
|
||||||
- Improved `--debug` output
|
|
||||||
- Fixed `--session` when used with `--download`
|
|
||||||
- Fixed `--download` to trim too long filenames before saving the file
|
|
||||||
- Fixed the handling of `Content-Type` with multiple `+subtype` parts
|
|
||||||
- Removed the XML formatter as the implementation suffered from multiple issues
|
|
||||||
|
|
||||||
## [0.9.3](https://github.com/httpie/httpie/compare/0.9.2...0.9.3) (2016-01-01)
|
|
||||||
|
|
||||||
- Changed the default color `--style` from `solarized` to `monokai`
|
|
||||||
- Added basic Bash autocomplete support (need to be installed manually)
|
|
||||||
- Added request details to connection error messages
|
|
||||||
- Fixed `'requests.packages.urllib3' has no attribute 'disable_warnings'`
|
|
||||||
errors that occurred in some installations
|
|
||||||
- Fixed colors and formatting on Windows
|
|
||||||
- Fixed `--auth` prompt on Windows
|
|
||||||
|
|
||||||
## [0.9.2](https://github.com/httpie/httpie/compare/0.9.1...0.9.2) (2015-02-24)
|
|
||||||
|
|
||||||
- Fixed compatibility with Requests 2.5.1
|
|
||||||
- Changed the default JSON `Content-Type` to `application/json` as UTF-8
|
|
||||||
is the default JSON encoding
|
|
||||||
|
|
||||||
## [0.9.1](https://github.com/httpie/httpie/compare/0.9.0...0.9.1) (2015-02-07)
|
|
||||||
|
|
||||||
- Added support for Requests transport adapter plugins
|
|
||||||
(see [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket)
|
|
||||||
and [httpie-http2](https://github.com/httpie/httpie-http2))
|
|
||||||
|
|
||||||
## [0.9.0](https://github.com/httpie/httpie/compare/0.8.0...0.9.0) (2015-01-31)
|
|
||||||
|
|
||||||
- Added `--cert` and `--cert-key` parameters to specify a client side
|
|
||||||
certificate and private key for SSL
|
|
||||||
- Improved unicode support
|
|
||||||
- Improved terminal color depth detection via `curses`
|
|
||||||
- To make it easier to deal with Windows paths in request items, `\`
|
|
||||||
now only escapes special characters (the ones that are used as key-value
|
|
||||||
separators by HTTPie)
|
|
||||||
- Switched from `unittest` to `pytest`
|
|
||||||
- Added Python `wheel` support
|
|
||||||
- Various test suite improvements
|
|
||||||
- Added `CONTRIBUTING`
|
|
||||||
- Fixed `User-Agent` overwriting when used within a session
|
|
||||||
- Fixed handling of empty passwords in URL credentials
|
|
||||||
- Fixed multiple file uploads with the same form field name
|
|
||||||
- Fixed `--output=/dev/null` on Linux
|
|
||||||
- Miscellaneous bugfixes
|
|
||||||
|
|
||||||
## [0.8.0](https://github.com/httpie/httpie/compare/0.7.1...0.8.0) (2014-01-25)
|
|
||||||
|
|
||||||
- Added `field=@file.txt` and `field:=@file.json` for embedding
|
|
||||||
the contents of text and JSON files into request data
|
|
||||||
- Added curl-style shorthand for localhost
|
|
||||||
- Fixed request `Host` header value output so that it doesn't contain
|
|
||||||
credentials, if included in the URL
|
|
||||||
|
|
||||||
## [0.7.1](https://github.com/httpie/httpie/compare/0.6.0...0.7.1) (2013-09-24)
|
|
||||||
|
|
||||||
- Added `--ignore-stdin`
|
|
||||||
- Added support for auth plugins
|
|
||||||
- Improved `--help` output
|
|
||||||
- Improved `Content-Disposition` parsing for `--download` mode
|
|
||||||
- Update to Requests 2.0.0
|
|
||||||
|
|
||||||
## [0.6.0](https://github.com/httpie/httpie/compare/0.5.1...0.6.0) (2013-06-03)
|
|
||||||
|
|
||||||
- XML data is now formatted
|
|
||||||
- `--session` and `--session-read-only` now also accept paths to
|
|
||||||
session files (eg. `http --session=/tmp/session.json example.org`)
|
|
||||||
|
|
||||||
## [0.5.1](https://github.com/httpie/httpie/compare/0.5.0...0.5.1) (2013-05-13)
|
|
||||||
|
|
||||||
- `Content-*` and `If-*` request headers are not stored in sessions
|
|
||||||
anymore as they are request-specific
|
|
||||||
|
|
||||||
## [0.5.0](https://github.com/httpie/httpie/compare/0.4.1...0.5.0) (2013-04-27)
|
|
||||||
|
|
||||||
- Added a download mode via `--download`
|
|
||||||
- Fixes miscellaneous bugs
|
|
||||||
|
|
||||||
## [0.4.1](https://github.com/httpie/httpie/compare/0.4.0...0.4.1) (2013-02-26)
|
|
||||||
|
|
||||||
- Fixed `setup.py`
|
|
||||||
|
|
||||||
## [0.4.0](https://github.com/httpie/httpie/compare/0.3.0...0.4.0) (2013-02-22)
|
|
||||||
|
|
||||||
- Added Python 3.3 compatibility
|
|
||||||
- Added Requests >= v1.0.4 compatibility
|
|
||||||
- Added support for credentials in URL
|
|
||||||
- Added `--no-option` for every `--option` to be config-friendly
|
|
||||||
- Mutually exclusive arguments can be specified multiple times. The
|
|
||||||
last value is used
|
|
||||||
|
|
||||||
## [0.3.0](https://github.com/httpie/httpie/compare/0.2.7...0.3.0) (2012-09-21)
|
|
||||||
|
|
||||||
- Allow output redirection on Windows
|
|
||||||
- Added configuration file
|
|
||||||
- Added persistent session support
|
|
||||||
- Renamed `--allow-redirects` to `--follow`
|
|
||||||
- Improved the usability of `http --help`
|
|
||||||
- Fixed installation on Windows with Python 3
|
|
||||||
- Fixed colorized output on Windows with Python 3
|
|
||||||
- CRLF HTTP header field separation in the output
|
|
||||||
- Added exit status code `2` for timed-out requests
|
|
||||||
- Added the option to separate colorizing and formatting
|
|
||||||
(`--pretty=all`, `--pretty=colors` and `--pretty=format`)
|
|
||||||
`--ugly` has bee removed in favor of `--pretty=none`
|
|
||||||
|
|
||||||
## [0.2.7](https://github.com/httpie/httpie/compare/0.2.5...0.2.7) (2012-08-07)
|
|
||||||
|
|
||||||
- Added compatibility with Requests 0.13.6
|
|
||||||
- Added streamed terminal output. `--stream, -S` can be used to enable
|
|
||||||
streaming also with `--pretty` and to ensure a more frequent output
|
|
||||||
flushing
|
|
||||||
- Added support for efficient large file downloads
|
|
||||||
- Sort headers by name (unless `--pretty=none`)
|
|
||||||
- Response body is fetched only when needed (e.g., not with `--headers`)
|
|
||||||
- Improved content type matching
|
|
||||||
- Updated Solarized color scheme
|
|
||||||
- Windows: Added `--output FILE` to store output into a file
|
|
||||||
(piping results in corrupted data on Windows)
|
|
||||||
- Proper handling of binary requests and responses
|
|
||||||
- Fixed printing of `multipart/form-data` requests
|
|
||||||
- Renamed `--traceback` to `--debug`
|
|
||||||
|
|
||||||
## [0.2.6](https://github.com/httpie/httpie/compare/0.2.5...0.2.6) (2012-07-26)
|
|
||||||
|
|
||||||
- The short option for `--headers` is now `-h` (`-t` has been
|
|
||||||
removed, for usage use `--help`)
|
|
||||||
- Form data and URL parameters can have multiple fields with the same name
|
|
||||||
(e.g.,`http -f url a=1 a=2`)
|
|
||||||
- Added `--check-status` to exit with an error on HTTP 3xx, 4xx and
|
|
||||||
5xx (3, 4, and 5, respectively)
|
|
||||||
- If the output is piped to another program or redirected to a file,
|
|
||||||
the default behaviour is to only print the response body
|
|
||||||
(It can still be overwritten via the `--print` flag.)
|
|
||||||
- Improved highlighting of HTTP headers
|
|
||||||
- Added query string parameters (`param==value`)
|
|
||||||
- Added support for terminal colors under Windows
|
|
||||||
|
|
||||||
## [0.2.5](https://github.com/httpie/httpie/compare/0.2.2...0.2.5) (2012-07-17)
|
|
||||||
|
|
||||||
- Unicode characters in prettified JSON now don't get escaped for
|
|
||||||
improved readability
|
|
||||||
- --auth now prompts for a password if only a username provided
|
|
||||||
- Added support for request payloads from a file path with automatic
|
|
||||||
`Content-Type` (`http URL @/path`)
|
|
||||||
- Fixed missing query string when displaying the request headers via
|
|
||||||
`--verbose`
|
|
||||||
- Fixed Content-Type for requests with no data
|
|
||||||
|
|
||||||
## [0.2.2](https://github.com/httpie/httpie/compare/0.2.1...0.2.2) (2012-06-24)
|
|
||||||
|
|
||||||
- The `METHOD` positional argument can now be omitted (defaults to
|
|
||||||
`GET`, or to `POST` with data)
|
|
||||||
- Fixed --verbose --form
|
|
||||||
- Added support for Tox
|
|
||||||
|
|
||||||
## [0.2.1](https://github.com/httpie/httpie/compare/0.2.0...0.2.1) (2012-06-13)
|
|
||||||
|
|
||||||
- Added compatibility with `requests-0.12.1`
|
|
||||||
- Dropped custom JSON and HTTP lexers in favor of the ones newly included
|
|
||||||
in `pygments-1.5`
|
|
||||||
|
|
||||||
## [0.2.0](https://github.com/httpie/httpie/compare/0.1.6...0.2.0) (2012-04-25)
|
|
||||||
|
|
||||||
- Added Python 3 support
|
|
||||||
- Added the ability to print the HTTP request as well as the response
|
|
||||||
(see `--print` and `--verbose`)
|
|
||||||
- Added support for Digest authentication
|
|
||||||
- Added file upload support
|
|
||||||
(`http -f POST file_field_name@/path/to/file`)
|
|
||||||
- Improved syntax highlighting for JSON
|
|
||||||
- Added support for field name escaping
|
|
||||||
- Many bug fixes
|
|
||||||
|
|
||||||
## [0.1.6](https://github.com/httpie/httpie/compare/0.1.5...0.1.6) (2012-03-04)
|
|
||||||
|
|
||||||
- Fixed `setup.py`
|
|
||||||
|
|
||||||
## [0.1.5](https://github.com/httpie/httpie/compare/0.1.4...0.1.5) (2012-03-04)
|
|
||||||
|
|
||||||
- Many improvements and bug fixes
|
|
||||||
|
|
||||||
## [0.1.4](https://github.com/httpie/httpie/compare/b966efa...0.1.4) (2012-02-28)
|
|
||||||
|
|
||||||
- Many improvements and bug fixes
|
|
||||||
|
|
||||||
## [0.1.0](https://github.com/httpie/httpie/commit/b966efa) (2012-02-25)
|
|
||||||
|
|
||||||
- Initial public release
|
|
||||||
252
CHANGELOG.rst
Normal file
252
CHANGELOG.rst
Normal file
@ -0,0 +1,252 @@
|
|||||||
|
==========
|
||||||
|
Change Log
|
||||||
|
==========
|
||||||
|
|
||||||
|
This document records all notable changes to `HTTPie <http://httpie.org>`_.
|
||||||
|
This project adheres to `Semantic Versioning <http://semver.org/>`_.
|
||||||
|
|
||||||
|
|
||||||
|
`1.0.0-dev`_ (Unreleased)
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`0.9.2`_ (2015-02-24)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Fixed compatibility with Requests 2.5.1
|
||||||
|
* Changed the default JSON ``Content-Type`` to ``application/json`` as UTF-8
|
||||||
|
is the default JSON encoding
|
||||||
|
|
||||||
|
|
||||||
|
`0.9.1`_ (2015-02-07)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added support for Requests transport adapter plugins
|
||||||
|
(see `httpie-unixsocket <https://github.com/msabramo/httpie-unixsocket>`_
|
||||||
|
and `httpie-http2 <https://github.com/jakubroztocil/httpie-http2>`_)
|
||||||
|
|
||||||
|
|
||||||
|
`0.9.0`_ (2015-01-31)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added ``--cert`` and ``--cert-key`` parameters to specify a client side
|
||||||
|
certificate and private key for SSL
|
||||||
|
* Improved unicode support
|
||||||
|
* Improved terminal color depth detection via ``curses``
|
||||||
|
* To make it easier to deal with Windows paths in request items, ``\``
|
||||||
|
now only escapes special characters (the ones that are used as key-value
|
||||||
|
separators by HTTPie)
|
||||||
|
* Switched from ``unittest`` to ``pytest``
|
||||||
|
* Added Python `wheel` support
|
||||||
|
* Various test suite improvements
|
||||||
|
* Added ``CONTRIBUTING``
|
||||||
|
* Fixed ``User-Agent`` overwriting when used within a session
|
||||||
|
* Fixed handling of empty passwords in URL credentials
|
||||||
|
* Fixed multiple file uploads with the same form field name
|
||||||
|
* Fixed ``--output=/dev/null`` on Linux
|
||||||
|
* Miscellaneous bugfixes
|
||||||
|
|
||||||
|
|
||||||
|
`0.8.0`_ (2014-01-25)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added ``field=@file.txt`` and ``field:=@file.json`` for embedding
|
||||||
|
the contents of text and JSON files into request data
|
||||||
|
* Added curl-style shorthand for localhost
|
||||||
|
* Fixed request ``Host`` header value output so that it doesn't contain
|
||||||
|
credentials, if included in the URL
|
||||||
|
|
||||||
|
|
||||||
|
`0.7.1`_ (2013-09-24)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added ``--ignore-stdin``
|
||||||
|
* Added support for auth plugins
|
||||||
|
* Improved ``--help`` output
|
||||||
|
* Improved ``Content-Disposition`` parsing for ``--download`` mode
|
||||||
|
* Update to Requests 2.0.0
|
||||||
|
|
||||||
|
|
||||||
|
`0.6.0`_ (2013-06-03)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* XML data is now formatted
|
||||||
|
* ``--session`` and ``--session-read-only`` now also accept paths to
|
||||||
|
session files (eg. ``http --session=/tmp/session.json example.org``)
|
||||||
|
|
||||||
|
|
||||||
|
`0.5.1`_ (2013-05-13)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* ``Content-*`` and ``If-*`` request headers are not stored in sessions
|
||||||
|
anymore as they are request-specific
|
||||||
|
|
||||||
|
|
||||||
|
`0.5.0`_ (2013-04-27)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added a download mode via ``--download``
|
||||||
|
* Fixes miscellaneous bugs
|
||||||
|
|
||||||
|
|
||||||
|
`0.4.1`_ (2013-02-26)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Fixed ``setup.py``
|
||||||
|
|
||||||
|
|
||||||
|
`0.4.0`_ (2013-02-22)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added Python 3.3 compatibility
|
||||||
|
* Added Requests >= v1.0.4 compatibility
|
||||||
|
* Added support for credentials in URL
|
||||||
|
* Added ``--no-option`` for every ``--option`` to be config-friendly
|
||||||
|
* Mutually exclusive arguments can be specified multiple times. The
|
||||||
|
last value is used
|
||||||
|
|
||||||
|
|
||||||
|
`0.3.0`_ (2012-09-21)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Allow output redirection on Windows
|
||||||
|
* Added configuration file
|
||||||
|
* Added persistent session support
|
||||||
|
* Renamed ``--allow-redirects`` to ``--follow``
|
||||||
|
* Improved the usability of ``http --help``
|
||||||
|
* Fixed installation on Windows with Python 3
|
||||||
|
* Fixed colorized output on Windows with Python 3
|
||||||
|
* CRLF HTTP header field separation in the output
|
||||||
|
* Added exit status code ``2`` for timed-out requests
|
||||||
|
* Added the option to separate colorizing and formatting
|
||||||
|
(``--pretty=all``, ``--pretty=colors`` and ``--pretty=format``)
|
||||||
|
``--ugly`` has bee removed in favor of ``--pretty=none``
|
||||||
|
|
||||||
|
|
||||||
|
`0.2.7`_ (2012-08-07)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added compatibility with Requests 0.13.6
|
||||||
|
* Added streamed terminal output. ``--stream, -S`` can be used to enable
|
||||||
|
streaming also with ``--pretty`` and to ensure a more frequent output
|
||||||
|
flushing
|
||||||
|
* Added support for efficient large file downloads
|
||||||
|
* Sort headers by name (unless ``--pretty=none``)
|
||||||
|
* Response body is fetched only when needed (e.g., not with ``--headers``)
|
||||||
|
* Improved content type matching
|
||||||
|
* Updated Solarized color scheme
|
||||||
|
* Windows: Added ``--output FILE`` to store output into a file
|
||||||
|
(piping results in corrupted data on Windows)
|
||||||
|
* Proper handling of binary requests and responses
|
||||||
|
* Fixed printing of ``multipart/form-data`` requests
|
||||||
|
* Renamed ``--traceback`` to ``--debug``
|
||||||
|
|
||||||
|
|
||||||
|
`0.2.6`_ (2012-07-26)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* The short option for ``--headers`` is now ``-h`` (``-t`` has been
|
||||||
|
removed, for usage use ``--help``)
|
||||||
|
* Form data and URL parameters can have multiple fields with the same name
|
||||||
|
(e.g.,``http -f url a=1 a=2``)
|
||||||
|
* Added ``--check-status`` to exit with an error on HTTP 3xx, 4xx and
|
||||||
|
5xx (3, 4, and 5, respectively)
|
||||||
|
* If the output is piped to another program or redirected to a file,
|
||||||
|
the default behaviour is to only print the response body
|
||||||
|
(It can still be overwritten via the ``--print`` flag.)
|
||||||
|
* Improved highlighting of HTTP headers
|
||||||
|
* Added query string parameters (``param==value``)
|
||||||
|
* Added support for terminal colors under Windows
|
||||||
|
|
||||||
|
|
||||||
|
`0.2.5`_ (2012-07-17)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Unicode characters in prettified JSON now don't get escaped for
|
||||||
|
improved readability
|
||||||
|
* --auth now prompts for a password if only a username provided
|
||||||
|
* Added support for request payloads from a file path with automatic
|
||||||
|
``Content-Type`` (``http URL @/path``)
|
||||||
|
* Fixed missing query string when displaying the request headers via
|
||||||
|
``--verbose``
|
||||||
|
* Fixed Content-Type for requests with no data
|
||||||
|
|
||||||
|
|
||||||
|
`0.2.2`_ (2012-06-24)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* The ``METHOD`` positional argument can now be omitted (defaults to
|
||||||
|
``GET``, or to ``POST`` with data)
|
||||||
|
* Fixed --verbose --form
|
||||||
|
* Added support for Tox
|
||||||
|
|
||||||
|
|
||||||
|
`0.2.1`_ (2012-06-13)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added compatibility with ``requests-0.12.1``
|
||||||
|
* Dropped custom JSON and HTTP lexers in favor of the ones newly included
|
||||||
|
in ``pygments-1.5``
|
||||||
|
|
||||||
|
|
||||||
|
`0.2.0`_ (2012-04-25)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Added Python 3 support
|
||||||
|
* Added the ability to print the HTTP request as well as the response
|
||||||
|
(see ``--print`` and ``--verbose``)
|
||||||
|
* Added support for Digest authentication
|
||||||
|
* Added file upload support
|
||||||
|
(``http -f POST file_field_name@/path/to/file``)
|
||||||
|
* Improved syntax highlighting for JSON
|
||||||
|
* Added support for field name escaping
|
||||||
|
* Many bug fixes
|
||||||
|
|
||||||
|
|
||||||
|
`0.1.6`_ (2012-03-04)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Fixed ``setup.py``
|
||||||
|
|
||||||
|
|
||||||
|
`0.1.5`_ (2012-03-04)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Many improvements and bug fixes
|
||||||
|
|
||||||
|
|
||||||
|
`0.1.4`_ (2012-02-28)
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Many improvements and bug fixes
|
||||||
|
|
||||||
|
|
||||||
|
`0.1`_ (2012-02-25)
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
* Initial public release
|
||||||
|
|
||||||
|
|
||||||
|
.. _`0.1`: https://github.com/jakubroztocil/httpie/commit/b966efa
|
||||||
|
.. _0.1.4: https://github.com/jakubroztocil/httpie/compare/b966efa...0.1.4
|
||||||
|
.. _0.1.5: https://github.com/jakubroztocil/httpie/compare/0.1.4...0.1.5
|
||||||
|
.. _0.1.6: https://github.com/jakubroztocil/httpie/compare/0.1.5...0.1.6
|
||||||
|
.. _0.2.0: https://github.com/jakubroztocil/httpie/compare/0.1.6...0.2.0
|
||||||
|
.. _0.2.1: https://github.com/jakubroztocil/httpie/compare/0.2.0...0.2.1
|
||||||
|
.. _0.2.2: https://github.com/jakubroztocil/httpie/compare/0.2.1...0.2.2
|
||||||
|
.. _0.2.5: https://github.com/jakubroztocil/httpie/compare/0.2.2...0.2.5
|
||||||
|
.. _0.2.6: https://github.com/jakubroztocil/httpie/compare/0.2.5...0.2.6
|
||||||
|
.. _0.2.7: https://github.com/jakubroztocil/httpie/compare/0.2.5...0.2.7
|
||||||
|
.. _0.3.0: https://github.com/jakubroztocil/httpie/compare/0.2.7...0.3.0
|
||||||
|
.. _0.4.0: https://github.com/jakubroztocil/httpie/compare/0.3.0...0.4.0
|
||||||
|
.. _0.4.1: https://github.com/jakubroztocil/httpie/compare/0.4.0...0.4.1
|
||||||
|
.. _0.5.0: https://github.com/jakubroztocil/httpie/compare/0.4.1...0.5.0
|
||||||
|
.. _0.5.1: https://github.com/jakubroztocil/httpie/compare/0.5.0...0.5.1
|
||||||
|
.. _0.6.0: https://github.com/jakubroztocil/httpie/compare/0.5.1...0.6.0
|
||||||
|
.. _0.7.1: https://github.com/jakubroztocil/httpie/compare/0.6.0...0.7.1
|
||||||
|
.. _0.8.0: https://github.com/jakubroztocil/httpie/compare/0.7.1...0.8.0
|
||||||
|
.. _0.9.0: https://github.com/jakubroztocil/httpie/compare/0.8.0...0.9.0
|
||||||
|
.. _0.9.1: https://github.com/jakubroztocil/httpie/compare/0.9.0...0.9.1
|
||||||
|
.. _0.9.2: https://github.com/jakubroztocil/httpie/compare/0.9.1...0.9.2
|
||||||
|
.. _1.0.0-dev: https://github.com/jakubroztocil/httpie/compare/0.9.2...master
|
||||||
@ -1,74 +0,0 @@
|
|||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as
|
|
||||||
contributors and maintainers pledge to making participation in our project and
|
|
||||||
our community a harassment-free experience for everyone, regardless of age, body
|
|
||||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
|
||||||
level of experience, education, socio-economic status, nationality, personal
|
|
||||||
appearance, race, religion, or sexual identity and orientation.
|
|
||||||
|
|
||||||
## Our Standards
|
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment
|
|
||||||
include:
|
|
||||||
|
|
||||||
- Using welcoming and inclusive language
|
|
||||||
- Being respectful of differing viewpoints and experiences
|
|
||||||
- Gracefully accepting constructive criticism
|
|
||||||
- Focusing on what is best for the community
|
|
||||||
- Showing empathy towards other community members
|
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
|
||||||
|
|
||||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
|
||||||
advances
|
|
||||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
|
||||||
- Public or private harassment
|
|
||||||
- Publishing others' private information, such as a physical or electronic
|
|
||||||
address, without explicit permission
|
|
||||||
- Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Our Responsibilities
|
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
|
||||||
response to any instances of unacceptable behavior.
|
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or
|
|
||||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
||||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
||||||
permanently any contributor for other behaviors that they deem inappropriate,
|
|
||||||
threatening, offensive, or harmful.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces
|
|
||||||
when an individual is representing the project or its community. Examples of
|
|
||||||
representing a project or community include using an official project e-mail
|
|
||||||
address, posting via an official social media account, or acting as an appointed
|
|
||||||
representative at an online or offline event. Representation of a project may be
|
|
||||||
further defined and clarified by project maintainers.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
||||||
reported by contacting the project team at jakub@roztocil.co. All
|
|
||||||
complaints will be reviewed and investigated and will result in a response that
|
|
||||||
is deemed necessary and appropriate to the circumstances. The project team is
|
|
||||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
||||||
Further details of specific enforcement policies may be posted separately.
|
|
||||||
|
|
||||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
||||||
faith may face temporary or permanent repercussions as determined by other
|
|
||||||
members of the project's leadership.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
|
|
||||||
version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see
|
|
||||||
<https://www.contributor-covenant.org/faq>
|
|
||||||
196
CONTRIBUTING.md
196
CONTRIBUTING.md
@ -1,196 +0,0 @@
|
|||||||
# Contributing to HTTPie
|
|
||||||
|
|
||||||
Bug reports and code and documentation patches are welcome. You can
|
|
||||||
help this project also by using the development version of HTTPie
|
|
||||||
and by reporting any bugs you might encounter.
|
|
||||||
|
|
||||||
## 1. Reporting bugs
|
|
||||||
|
|
||||||
**It's important that you provide the full command argument list
|
|
||||||
as well as the output of the failing command.**
|
|
||||||
|
|
||||||
Use the `--debug` flag and copy&paste both the command and its output
|
|
||||||
to your bug report, e.g.:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ http --debug <COMPLETE ARGUMENT LIST THAT TRIGGERS THE ERROR>
|
|
||||||
<COMPLETE OUTPUT>
|
|
||||||
```
|
|
||||||
|
|
||||||
## 2. Contributing Code and Docs
|
|
||||||
|
|
||||||
Before working on a new feature or a bug, please browse [existing issues](https://github.com/httpie/httpie/issues)
|
|
||||||
to see whether it has previously been discussed.
|
|
||||||
|
|
||||||
If your change alters HTTPie’s behaviour or interface, it's a good idea to
|
|
||||||
discuss it before you start working on it.
|
|
||||||
|
|
||||||
If you are fixing an issue, the first step should be to create a test case that
|
|
||||||
reproduces the incorrect behaviour. That will also help you to build an
|
|
||||||
understanding of the issue at hand.
|
|
||||||
|
|
||||||
**Pull requests introducing code changes without tests
|
|
||||||
will generally not get merged. The same goes for PRs changing HTTPie’s
|
|
||||||
behaviour and not providing documentation.**
|
|
||||||
|
|
||||||
Conversely, PRs consisting of documentation improvements or tests
|
|
||||||
for existing-yet-previously-untested behavior will very likely be merged.
|
|
||||||
Therefore, docs and tests improvements are a great candidate for your first
|
|
||||||
contribution.
|
|
||||||
|
|
||||||
Consider also adding a [CHANGELOG](https://github.com/httpie/httpie/blob/master/CHANGELOG.md) entry for your changes.
|
|
||||||
|
|
||||||
### Development Environment
|
|
||||||
|
|
||||||
#### Getting the code
|
|
||||||
|
|
||||||
Go to <https://github.com/httpie/httpie> and fork the project repository.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Clone your fork
|
|
||||||
$ git clone git@github.com:<YOU>/httpie.git
|
|
||||||
|
|
||||||
# Enter the project directory
|
|
||||||
$ cd httpie
|
|
||||||
|
|
||||||
# Create a branch for your changes
|
|
||||||
$ git checkout -b my_topical_branch
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Setup
|
|
||||||
|
|
||||||
The [Makefile](https://github.com/httpie/httpie/blob/master/Makefile) contains a bunch of tasks to get you started. Just run
|
|
||||||
the following command, which:
|
|
||||||
|
|
||||||
- Creates an isolated Python virtual environment inside `./venv`
|
|
||||||
(via the standard library [venv](https://docs.python.org/3/library/venv.html) tool);
|
|
||||||
- installs all dependencies and also installs HTTPie
|
|
||||||
(in editable mode so that the `http` command will point to your
|
|
||||||
working copy).
|
|
||||||
- and runs tests (It is the same as running `make install test`).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Python virtual environment
|
|
||||||
|
|
||||||
Activate the Python virtual environment—created via the `make install`
|
|
||||||
task during [setup](#setup) for your active shell session using the following command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ source venv/bin/activate
|
|
||||||
```
|
|
||||||
|
|
||||||
(If you use `virtualenvwrapper`, you can also use `workon httpie` to
|
|
||||||
activate the environment — we have created a symlink for you. It’s a bit of
|
|
||||||
a hack but it works™.)
|
|
||||||
|
|
||||||
You should now see `(httpie)` next to your shell prompt, and
|
|
||||||
the `http` command should point to your development copy:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
(httpie) ~/Code/httpie $ which http
|
|
||||||
/Users/<user>/Code/httpie/venv/bin/http
|
|
||||||
(httpie) ~/Code/httpie $ http --version
|
|
||||||
2.0.0-dev
|
|
||||||
```
|
|
||||||
|
|
||||||
(Btw, you don’t need to activate the virtual environment if you just want
|
|
||||||
run some of the `make` tasks. You can also invoke the development
|
|
||||||
version of HTTPie directly with `./venv/bin/http` without having to activate
|
|
||||||
the environment first. The same goes for `./venv/bin/pytest`, etc.).
|
|
||||||
|
|
||||||
### Making Changes
|
|
||||||
|
|
||||||
Please make sure your changes conform to [Style Guide for Python Code](https://python.org/dev/peps/pep-0008/) (PEP8)
|
|
||||||
and that `make pycodestyle` passes.
|
|
||||||
|
|
||||||
### Testing & CI
|
|
||||||
|
|
||||||
Please add tests for any new features and bug fixes.
|
|
||||||
|
|
||||||
When you open a Pull Request, [GitHub Actions](https://github.com/httpie/httpie/actions) will automatically run HTTPie’s [test suite](https://github.com/httpie/httpie/tree/master/tests) against your code, so please make sure all checks pass.
|
|
||||||
|
|
||||||
#### Running tests locally
|
|
||||||
|
|
||||||
HTTPie uses the [pytest](https://pytest.org/) runner.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run tests on the current Python interpreter with coverage.
|
|
||||||
$ make test
|
|
||||||
|
|
||||||
# Run tests with coverage
|
|
||||||
$ make test-cover
|
|
||||||
|
|
||||||
# Test PEP8 compliance
|
|
||||||
$ make codestyle
|
|
||||||
|
|
||||||
# Run extended tests — for code as well as .md files syntax, packaging, etc.
|
|
||||||
$ make test-all
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Running specific tests
|
|
||||||
|
|
||||||
After you have activated your virtual environment (see [setup](#setup)), you
|
|
||||||
can run specific tests from the terminal:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run specific tests on the current Python
|
|
||||||
$ python -m pytest tests/test_uploads.py
|
|
||||||
$ python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload
|
|
||||||
$ python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload::test_upload_ok
|
|
||||||
```
|
|
||||||
|
|
||||||
See [Makefile](https://github.com/httpie/httpie/blob/master/Makefile) for additional development utilities.
|
|
||||||
|
|
||||||
#### Windows
|
|
||||||
|
|
||||||
If you are on a Windows machine and not able to run `make`,
|
|
||||||
follow the next steps for a basic setup. As a prerequisite, you need to have
|
|
||||||
Python 3.6+ installed.
|
|
||||||
|
|
||||||
Create a virtual environment and activate it:
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
C:\> python -m venv --prompt httpie venv
|
|
||||||
C:\> venv\Scripts\activate
|
|
||||||
```
|
|
||||||
|
|
||||||
Install HTTPie in editable mode with all the dependencies:
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
C:\> python -m pip install --upgrade -e . -r requirements-dev.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
You should now see `(httpie)` next to your shell prompt, and
|
|
||||||
the `http` command should point to your development copy:
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
# In PowerShell:
|
|
||||||
(httpie) PS C:\Users\ovezovs\httpie> Get-Command http
|
|
||||||
CommandType Name Version Source
|
|
||||||
----------- ---- ------- ------
|
|
||||||
Application http.exe 0.0.0.0 C:\Users\ovezovs\httpie\venv\Scripts\http.exe
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# In CMD:
|
|
||||||
(httpie) C:\Users\ovezovs\httpie> where http
|
|
||||||
C:\Users\ovezovs\httpie\venv\Scripts\http.exe
|
|
||||||
C:\Users\ovezovs\AppData\Local\Programs\Python\Python38-32\Scripts\http.exe
|
|
||||||
|
|
||||||
(httpie) C:\Users\ovezovs\httpie> http --version
|
|
||||||
2.3.0-dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Use `pytest` to run tests locally with an active virtual environment:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run all tests
|
|
||||||
$ python -m pytest
|
|
||||||
```
|
|
||||||
|
|
||||||
______________________________________________________________________
|
|
||||||
|
|
||||||
Finally, feel free to add yourself to [AUTHORS](https://github.com/httpie/httpie/blob/master/AUTHORS.md)!
|
|
||||||
95
CONTRIBUTING.rst
Normal file
95
CONTRIBUTING.rst
Normal file
@ -0,0 +1,95 @@
|
|||||||
|
Contributing to HTTPie
|
||||||
|
######################
|
||||||
|
|
||||||
|
Bug reports and code and documentation patches are greatly appretiated. You can
|
||||||
|
also help by using the development version of HTTPie and reporting any bugs you
|
||||||
|
might encounter.
|
||||||
|
|
||||||
|
Bug Reports
|
||||||
|
===========
|
||||||
|
|
||||||
|
**It's important that you provide the full command argument list
|
||||||
|
as well as the output of the failing command.**
|
||||||
|
Use the ``--debug`` flag and copy&paste both the command and its output
|
||||||
|
to your bug report, e.g.:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ http --debug [arguments that trigger the error]
|
||||||
|
[complete output]
|
||||||
|
|
||||||
|
|
||||||
|
Contributing Code and Documentation
|
||||||
|
===================================
|
||||||
|
|
||||||
|
Before working on a new feature or a bug, please browse `existing issues`_
|
||||||
|
to see whether it has been previously discussed. If the change in question
|
||||||
|
is a bigger one, it's always good to discuss before your starting working on
|
||||||
|
it.
|
||||||
|
|
||||||
|
|
||||||
|
Development Environment
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
git clone https://github.com/<YOU>/httpie
|
||||||
|
|
||||||
|
cd httpie
|
||||||
|
|
||||||
|
git checkout -b my_topical_branch
|
||||||
|
|
||||||
|
# (Recommended: create a new virtualenv)
|
||||||
|
|
||||||
|
# Install dev. requirements and also HTTPie (in editable mode
|
||||||
|
# so that the `http' command will point to your working copy):
|
||||||
|
make
|
||||||
|
|
||||||
|
|
||||||
|
Making Changes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Please make sure your changes conform to `Style Guide for Python Code`_ (PEP8).
|
||||||
|
|
||||||
|
|
||||||
|
Tests
|
||||||
|
-----
|
||||||
|
|
||||||
|
Before opening a pull requests, please make sure the `test suite`_ passes
|
||||||
|
in all of the `supported Python environments`_. You should also **add tests
|
||||||
|
for any new features and bug fixes**.
|
||||||
|
|
||||||
|
HTTPie uses `pytest`_ and `Tox`_.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
### Running all tests:
|
||||||
|
|
||||||
|
# Current Python
|
||||||
|
make test
|
||||||
|
|
||||||
|
# Current Python with coverage
|
||||||
|
make test-cover
|
||||||
|
|
||||||
|
# All the supported and available Pythons via Tox
|
||||||
|
make test-tox
|
||||||
|
|
||||||
|
### Running specific tests:
|
||||||
|
|
||||||
|
# Current Python
|
||||||
|
pytest tests/test_uploads.py
|
||||||
|
|
||||||
|
# All Pythons
|
||||||
|
tox -- tests/test_uploads.py --verbose
|
||||||
|
|
||||||
|
|
||||||
|
Don't forget to add yourself to `AUTHORS.rst`_.
|
||||||
|
|
||||||
|
|
||||||
|
.. _Tox: http://tox.testrun.org
|
||||||
|
.. _supported Python environments: https://github.com/jakubroztocil/httpie/blob/master/tox.ini
|
||||||
|
.. _existing issues: https://github.com/jakubroztocil/httpie/issues?state=open
|
||||||
|
.. _AUTHORS.rst: https://github.com/jakubroztocil/httpie/blob/master/AUTHORS.rst
|
||||||
|
.. _pytest: http://pytest.org/
|
||||||
|
.. _Style Guide for Python Code: http://python.org/dev/peps/pep-0008/
|
||||||
|
.. _test suite: https://github.com/jakubroztocil/httpie/tree/master/tests
|
||||||
10
LICENSE
10
LICENSE
@ -1,4 +1,4 @@
|
|||||||
Copyright © 2012-2021 Jakub Roztocil <jakub@roztocil.co>
|
Copyright © 2012 Jakub Roztocil <jakub@roztocil.co>
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
Redistribution and use in source and binary forms, with or without
|
||||||
modification, are permitted provided that the following conditions are met:
|
modification, are permitted provided that the following conditions are met:
|
||||||
@ -10,14 +10,14 @@ modification, are permitted provided that the following conditions are met:
|
|||||||
notice, this list of conditions and the following disclaimer in the
|
notice, this list of conditions and the following disclaimer in the
|
||||||
documentation and/or other materials provided with the distribution.
|
documentation and/or other materials provided with the distribution.
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors
|
3. Neither the name of The author nor the names of its contributors may
|
||||||
may be used to endorse or promote products derived from this software
|
be used to endorse or promote products derived from this software
|
||||||
without specific prior written permission.
|
without specific prior written permission.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
|
||||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR AND CONTRIBUTORS BE LIABLE FOR
|
||||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||||
|
|||||||
10
MANIFEST.in
10
MANIFEST.in
@ -1,8 +1,4 @@
|
|||||||
include LICENSE
|
include LICENSE
|
||||||
include README.md
|
include README.rst
|
||||||
include CHANGELOG.md
|
include CHANGELOG.rst
|
||||||
include AUTHORS.md
|
include AUTHORS.rst
|
||||||
include docs/README.md
|
|
||||||
|
|
||||||
# <https://github.com/httpie/httpie/issues/182>
|
|
||||||
recursive-include tests/ *
|
|
||||||
|
|||||||
231
Makefile
231
Makefile
@ -1,212 +1,67 @@
|
|||||||
###############################################################################
|
|
||||||
# See ./CONTRIBUTING.md
|
|
||||||
###############################################################################
|
|
||||||
|
|
||||||
.PHONY: build
|
|
||||||
|
|
||||||
ROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
|
|
||||||
VERSION=$(shell grep __version__ httpie/__init__.py)
|
VERSION=$(shell grep __version__ httpie/__init__.py)
|
||||||
H1="\n\n\033[0;32m\#\#\# "
|
REQUIREMENTS="requirements-dev.txt"
|
||||||
H1END=" \#\#\# \033[0m\n"
|
TAG="\n\n\033[0;32m\#\#\# "
|
||||||
|
END=" \#\#\# \033[0m\n"
|
||||||
|
|
||||||
|
all: test
|
||||||
|
|
||||||
# Only used to create our venv.
|
uninstall-httpie:
|
||||||
SYSTEM_PYTHON=python3
|
@echo $(TAG)Removing existing installation of HTTPie$(END)
|
||||||
|
- pip uninstall --yes httpie >/dev/null
|
||||||
VENV_ROOT=venv
|
! which http
|
||||||
VENV_BIN=$(VENV_ROOT)/bin
|
|
||||||
VENV_PIP=$(VENV_BIN)/pip3
|
|
||||||
VENV_PYTHON=$(VENV_BIN)/python
|
|
||||||
|
|
||||||
|
|
||||||
export PATH := $(VENV_BIN):$(PATH)
|
|
||||||
|
|
||||||
|
|
||||||
all: uninstall-httpie install test
|
|
||||||
|
|
||||||
|
|
||||||
install: venv install-reqs
|
|
||||||
|
|
||||||
|
|
||||||
install-reqs:
|
|
||||||
@echo $(H1)Updating package tools$(H1END)
|
|
||||||
$(VENV_PIP) install --upgrade pip wheel
|
|
||||||
|
|
||||||
@echo $(H1)Installing dev requirements$(H1END)
|
|
||||||
$(VENV_PIP) install --upgrade --editable '.[dev]'
|
|
||||||
|
|
||||||
@echo $(H1)Installing HTTPie$(H1END)
|
|
||||||
$(VENV_PIP) install --upgrade --editable .
|
|
||||||
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
uninstall-all: uninstall-httpie
|
||||||
|
- pip uninstall --yes -r $(REQUIREMENTS)
|
||||||
|
|
||||||
clean:
|
init: uninstall-httpie
|
||||||
@echo $(H1)Cleaning up$(H1END)
|
@echo $(TAG)Installing dev requirements$(END)
|
||||||
rm -rf $(VENV_ROOT)
|
pip install --upgrade -r $(REQUIREMENTS)
|
||||||
# Remove symlink for virtualenvwrapper, if we’ve created one.
|
@echo $(TAG)Installing HTTPie$(END)
|
||||||
[ -n "$(WORKON_HOME)" -a -L "$(WORKON_HOME)/httpie" -a -f "$(WORKON_HOME)/httpie" ] && rm $(WORKON_HOME)/httpie || true
|
pip install --upgrade --editable .
|
||||||
rm -rf *.egg dist build .coverage .cache .pytest_cache httpie.egg-info
|
|
||||||
find . -name '__pycache__' -delete -o -name '*.pyc' -delete
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
test: init
|
||||||
venv:
|
@echo $(TAG)Running tests in on current Python with coverage $(END)
|
||||||
@echo $(H1)Creating a Python environment $(VENV_ROOT) $(H1END)
|
py.test --cov ./httpie --cov ./tests --doctest-modules --verbose ./httpie ./tests
|
||||||
|
|
||||||
$(SYSTEM_PYTHON) -m venv --prompt httpie $(VENV_ROOT)
|
|
||||||
|
|
||||||
@echo
|
|
||||||
@echo done.
|
|
||||||
@echo
|
|
||||||
@echo To active it manually, run:
|
|
||||||
@echo
|
|
||||||
@echo " source $(VENV_BIN)/activate"
|
|
||||||
@echo
|
|
||||||
@echo '(learn more: https://docs.python.org/3/library/venv.html)'
|
|
||||||
@echo
|
|
||||||
@if [ -n "$(WORKON_HOME)" ]; then \
|
|
||||||
echo $(ROOT_DIR) > $(VENV_ROOT)/.project; \
|
|
||||||
if [ ! -d $(WORKON_HOME)/httpie -a ! -L $(WORKON_HOME)/httpie ]; then \
|
|
||||||
ln -s $(ROOT_DIR)/$(VENV_ROOT) $(WORKON_HOME)/httpie ; \
|
|
||||||
echo ''; \
|
|
||||||
echo 'Since you use virtualenvwrapper, we created a symlink'; \
|
|
||||||
echo 'so you can also use "workon httpie" to activate the venv.'; \
|
|
||||||
echo ''; \
|
|
||||||
fi; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# Testing
|
|
||||||
###############################################################################
|
|
||||||
|
|
||||||
|
|
||||||
test:
|
|
||||||
@echo $(H1)Running tests$(HEADER_EXTRA)$(H1END)
|
|
||||||
$(VENV_BIN)/python -m pytest $(COV)
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
test-tox: init
|
||||||
test-cover: COV=--cov=httpie --cov=tests
|
@echo $(TAG)Running tests on all Pythons via Tox$(END)
|
||||||
test-cover: HEADER_EXTRA=' (with coverage)'
|
tox
|
||||||
test-cover: test
|
|
||||||
|
|
||||||
|
|
||||||
# test-all is meant to test everything — even this Makefile
|
|
||||||
test-all: clean install test test-dist codestyle
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
|
||||||
test-dist: test-sdist test-bdist-wheel
|
test-dist: test-sdist test-bdist-wheel
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
test-sdist: clean uninstall-httpie
|
||||||
test-sdist: clean venv
|
@echo $(TAG)Testing sdist build an installation$(END)
|
||||||
@echo $(H1)Testing sdist build an installation$(H1END)
|
python setup.py sdist
|
||||||
$(VENV_PYTHON) setup.py sdist
|
pip install --force-reinstall --upgrade dist/*.gz
|
||||||
$(VENV_PIP) install --force-reinstall --upgrade dist/*.gz
|
which http
|
||||||
$(VENV_BIN)/http --version
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
test-bdist-wheel: clean uninstall-httpie
|
||||||
test-bdist-wheel: clean venv
|
@echo $(TAG)Testing wheel build an installation$(END)
|
||||||
@echo $(H1)Testing wheel build an installation$(H1END)
|
python setup.py bdist_wheel
|
||||||
$(VENV_PIP) install wheel
|
pip install --force-reinstall --upgrade dist/*.whl
|
||||||
$(VENV_PYTHON) setup.py bdist_wheel
|
which http
|
||||||
$(VENV_PIP) install --force-reinstall --upgrade dist/*.whl
|
|
||||||
$(VENV_BIN)/http --version
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
# This tests everything, even this Makefile.
|
||||||
|
test-all: uninstall-all clean init test test-tox test-dist
|
||||||
|
|
||||||
twine-check:
|
publish: test-all
|
||||||
twine check dist/*
|
@echo $(TAG)Testing wheel build an installation$(END)
|
||||||
|
|
||||||
|
|
||||||
# Kept for convenience, "make codestyle" is preferred though
|
|
||||||
pycodestyle: codestyle
|
|
||||||
|
|
||||||
|
|
||||||
codestyle:
|
|
||||||
@echo $(H1)Running flake8$(H1END)
|
|
||||||
@[ -f $(VENV_BIN)/flake8 ] || $(VENV_PIP) install --upgrade --editable '.[dev]'
|
|
||||||
$(VENV_BIN)/flake8 httpie/ tests/ docs/packaging/brew/ *.py
|
|
||||||
@echo
|
|
||||||
|
|
||||||
|
|
||||||
codecov-upload:
|
|
||||||
@echo $(H1)Running codecov$(H1END)
|
|
||||||
@[ -f $(VENV_BIN)/codecov ] || $(VENV_PIP) install codecov
|
|
||||||
# $(VENV_BIN)/codecov --required
|
|
||||||
$(VENV_BIN)/codecov
|
|
||||||
@echo
|
|
||||||
|
|
||||||
|
|
||||||
doc-check:
|
|
||||||
@echo $(H1)Running documentations checks$(H1END)
|
|
||||||
mdl --git-recurse --style docs/markdownlint.rb .
|
|
||||||
|
|
||||||
|
|
||||||
doc-update-install:
|
|
||||||
@echo $(H1)Updating installation instructions in the docs$(H1END)
|
|
||||||
$(VENV_PYTHON) docs/installation/generate.py
|
|
||||||
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# Publishing to PyPi
|
|
||||||
###############################################################################
|
|
||||||
|
|
||||||
|
|
||||||
build:
|
|
||||||
rm -rf build/
|
|
||||||
$(VENV_PYTHON) setup.py sdist bdist_wheel
|
|
||||||
|
|
||||||
|
|
||||||
publish: test-all publish-no-test
|
|
||||||
|
|
||||||
|
|
||||||
publish-no-test:
|
|
||||||
@echo $(H1)Testing wheel build an installation$(H1END)
|
|
||||||
@echo "$(VERSION)"
|
@echo "$(VERSION)"
|
||||||
@echo "$(VERSION)" | grep -q "dev" && echo '!!!Not publishing dev version!!!' && exit 1 || echo ok
|
@echo "$(VERSION)" | grep -q "dev" && echo "!!!Not publishing dev version!!!" && exit 1
|
||||||
make build
|
python setup.py register
|
||||||
make twine-check
|
python setup.py sdist upload
|
||||||
$(VENV_BIN)/twine upload --repository=httpie dist/*
|
python setup.py bdist_wheel upload
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
clean:
|
||||||
|
@echo $(TAG)Cleaning up$(END)
|
||||||
###############################################################################
|
rm -rf .tox *.egg dist build .coverage
|
||||||
# Uninstalling
|
find . -name '__pycache__' -delete -print -o -name '*.pyc' -delete -print
|
||||||
###############################################################################
|
|
||||||
|
|
||||||
uninstall-httpie:
|
|
||||||
@echo $(H1)Uninstalling httpie$(H1END)
|
|
||||||
- $(VENV_PIP) uninstall --yes httpie &2>/dev/null
|
|
||||||
|
|
||||||
@echo "Verifying…"
|
|
||||||
cd .. && ! $(VENV_PYTHON) -m httpie --version &2>/dev/null
|
|
||||||
|
|
||||||
@echo "Done"
|
|
||||||
@echo
|
@echo
|
||||||
|
|
||||||
|
|
||||||
###############################################################################
|
|
||||||
# Homebrew
|
|
||||||
###############################################################################
|
|
||||||
|
|
||||||
brew-deps:
|
|
||||||
docs/packaging/brew/brew-deps.py
|
|
||||||
|
|
||||||
brew-test:
|
|
||||||
@echo $(H1)Uninstalling httpie$(H1END)
|
|
||||||
- brew uninstall httpie
|
|
||||||
|
|
||||||
@echo $(H1)Building from source…$(H1END)
|
|
||||||
- brew install --build-from-source ./docs/packaging/brew/httpie.rb
|
|
||||||
|
|
||||||
@echo $(H1)Verifying…$(H1END)
|
|
||||||
brew test httpie
|
|
||||||
|
|
||||||
@echo $(H1)Auditing…$(H1END)
|
|
||||||
brew audit --strict httpie
|
|
||||||
|
|||||||
84
README.md
84
README.md
@ -1,84 +0,0 @@
|
|||||||
<br/>
|
|
||||||
<a href="https://httpie.io" target="blank_">
|
|
||||||
<img height="100" alt="HTTPie" src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-logo.svg" />
|
|
||||||
</a>
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
# HTTPie: human-friendly CLI HTTP client for the API era
|
|
||||||
|
|
||||||
HTTPie (pronounced _aitch-tee-tee-pie_) is a command-line HTTP client.
|
|
||||||
Its goal is to make CLI interaction with web services as human-friendly as possible.
|
|
||||||
HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.
|
|
||||||
The `http` & `https` commands allow for creating and sending arbitrary HTTP requests.
|
|
||||||
They use simple and natural syntax and provide formatted and colorized output.
|
|
||||||
|
|
||||||
[](https://httpie.org/docs)
|
|
||||||
[](https://pypi.python.org/pypi/httpie)
|
|
||||||
[](https://github.com/httpie/httpie/actions)
|
|
||||||
[](https://codecov.io/gh/httpie/httpie)
|
|
||||||
[](https://twitter.com/httpie)
|
|
||||||
[](https://httpie.io/discord)
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/httpie/httpie/master/docs/httpie-animation.gif" alt="HTTPie in action" width="100%"/>
|
|
||||||
|
|
||||||
## Getting started
|
|
||||||
|
|
||||||
- [Installation instructions →](https://httpie.io/docs#installation)
|
|
||||||
- [Full documentation →](https://httpie.io/docs)
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- Expressive and intuitive syntax
|
|
||||||
- Formatted and colorized terminal output
|
|
||||||
- Built-in JSON support
|
|
||||||
- Forms and file uploads
|
|
||||||
- HTTPS, proxies, and authentication
|
|
||||||
- Arbitrary request data
|
|
||||||
- Custom headers
|
|
||||||
- Persistent sessions
|
|
||||||
- `wget`-like downloads
|
|
||||||
|
|
||||||
[See all features →](https://httpie.io/docs)
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
Hello World:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ https httpie.io/hello
|
|
||||||
```
|
|
||||||
|
|
||||||
Custom [HTTP method](https://httpie.io/docs#http-method), [HTTP headers](https://httpie.io/docs#http-headers) and [JSON](https://httpie.io/docs#json) data:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ http PUT pie.dev/put X-API-Token:123 name=John
|
|
||||||
```
|
|
||||||
|
|
||||||
Build and print a request without sending it using [offline mode](https://httpie.io/docs#offline-mode):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ http --offline pie.dev/post hello=offline
|
|
||||||
```
|
|
||||||
|
|
||||||
Use [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comment) to post a comment on an [Issue](https://github.com/httpie/httpie/issues/83) with [authentication](https://httpie.io/docs#authentication):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:'
|
|
||||||
```
|
|
||||||
|
|
||||||
[See more examples →](https://httpie.io/docs#examples)
|
|
||||||
|
|
||||||
## Community & support
|
|
||||||
|
|
||||||
- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links.
|
|
||||||
- Join our [Discord server](https://httpie.io/discord) is to ask questions, discuss features, and for general API chat.
|
|
||||||
- Tweet at [@httpie](https://twitter.com/httpie) on Twitter.
|
|
||||||
- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag.
|
|
||||||
- Create [GitHub Issues](https://github.com/httpie/httpie/issues) for bug reports and feature requests.
|
|
||||||
- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Have a look through existing [Issues](https://github.com/httpie/httpie/issues) and [Pull Requests](https://github.com/httpie/httpie/pulls) that you could help with. If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/httpie/issues) using one of the templates provided.
|
|
||||||
|
|
||||||
[See contribution guide →](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md)
|
|
||||||
1343
README.rst
Normal file
1343
README.rst
Normal file
File diff suppressed because it is too large
Load Diff
17
appveyor.yml
Normal file
17
appveyor.yml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# https://ci.appveyor.com/project/jakubroztocil/httpie
|
||||||
|
build: false
|
||||||
|
environment:
|
||||||
|
matrix:
|
||||||
|
- PYTHON: "C:/Python27"
|
||||||
|
- PYTHON: "C:/Python34"
|
||||||
|
init:
|
||||||
|
- "ECHO %PYTHON%"
|
||||||
|
- ps: "ls C:/Python*"
|
||||||
|
install:
|
||||||
|
- ps: (new-object net.webclient).DownloadFile('https://raw.github.com/pypa/pip/master/contrib/get-pip.py', 'C:/get-pip.py')
|
||||||
|
- "%PYTHON%/python.exe C:/get-pip.py"
|
||||||
|
- "%PYTHON%/Scripts/pip.exe install -e ."
|
||||||
|
test_script:
|
||||||
|
- "%PYTHON%/Scripts/pip.exe --version"
|
||||||
|
- "%PYTHON%/Scripts/http.exe --debug"
|
||||||
|
- "%PYTHON%/python.exe setup.py test"
|
||||||
1979
docs/README.md
1979
docs/README.md
File diff suppressed because it is too large
Load Diff
@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"website": {
|
|
||||||
"master_and_released_docs_differ_after": "8f8851f1dbd511d3bc0ea0f6da7459045610afce"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 1019 KiB |
@ -1 +0,0 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1635.31 470"><defs><style>.cls-1{fill:#4b78e6;}</style></defs><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M1322.19,73.91h0a36.56,36.56,0,0,1,36.56-36.29h3.41a36.56,36.56,0,0,1,36.56,36.83h0a36.56,36.56,0,0,1-36.56,36.29h-3.41A36.56,36.56,0,0,1,1322.19,73.91Zm6.16,276.93V142.35a7.94,7.94,0,0,1,8-7.94h48.32a7.93,7.93,0,0,1,7.94,7.94V350.84a7.94,7.94,0,0,1-7.94,7.94H1336.3A8,8,0,0,1,1328.35,350.84Z"/><path class="cls-1" d="M1635.31,233.34c0-61.06-33.28-105.09-101.71-105.09-72.17,0-114.82,45.45-114.82,123.08,0,74.79,46.86,113.6,113.89,113.6,56.83,0,85.93-27.17,98.33-63.86a8,8,0,0,0-5.34-10.28l-40.32-11.39a8,8,0,0,0-9.54,4.73c-5.77,14.37-16.57,25.42-42.2,25.42-29.32,0-46.06-13.62-50.74-44.29a7.17,7.17,0,0,0,.81.08h143.7a8,8,0,0,0,7.94-7.94V242.23c0-.09,0-.18,0-.28C1635.31,239.17,1635.31,236.36,1635.31,233.34Zm-103.58-51.6c28.59,0,43.12,15.15,45,45H1483C1487.21,195,1503.61,181.74,1531.73,181.74Z"/><path class="cls-1" d="M581.91,358.75H533.56a7.93,7.93,0,0,1-7.94-7.94V76.39a7.93,7.93,0,0,1,7.94-7.94h48.35a7.93,7.93,0,0,1,7.94,7.94v84.66a6,6,0,0,0,11.22,2.77c13.45-25.56,34.68-35.33,60.42-35.69,38.66-.55,70,31.45,70,70.12V350.81a7.94,7.94,0,0,1-7.94,7.94H675.63a7.94,7.94,0,0,1-7.94-7.94V227.1c0-23.21-10.32-40.73-37-40.73-25.79,0-40.8,15.15-40.8,40.73V350.81A7.93,7.93,0,0,1,581.91,358.75Z"/><path class="cls-1" d="M1052.84,306.12a7.94,7.94,0,0,0-9.77-6.78c-6.47,1.55-13.73,3.05-20.35,3.05-19.23,0-25.79-8.52-25.79-26.52V188.26h50.67a7.94,7.94,0,0,0,7.94-7.94v-38.1a8,8,0,0,0-7.94-7.95H996.93V85.86A7.94,7.94,0,0,0,989,77.92H941.1a7.93,7.93,0,0,0-7.94,7.94v48.41H842.67V85.86a7.94,7.94,0,0,0-7.94-7.94H786.84a7.93,7.93,0,0,0-7.94,7.94v48.41H761.05a7.94,7.94,0,0,0-7.94,7.95v38.1a7.93,7.93,0,0,0,7.94,7.94H778.9v99.93c0,42.62,21.57,77.19,73.15,77.19,21.16,0,32.43-2.5,46.08-6.56a8,8,0,0,0,5.65-8.56l-5.2-44.14a7.94,7.94,0,0,0-9.77-6.78c-6.47,1.55-13.73,3.05-20.35,3.05-19.23,0-25.79-8.52-25.79-26.52V188.26h90.49v99.93c0,42.62,21.57,77.19,73.14,77.19,21.17,0,32.44-2.5,46.09-6.56a8,8,0,0,0,5.65-8.56Z"/><path class="cls-1" d="M1219.14,365.27c-28.49,0-49.51-10.92-62.87-35.86a6,6,0,0,0-11.19,2.84v82.83a7.93,7.93,0,0,1-7.94,7.94h-48.32a7.94,7.94,0,0,1-8-7.94V142.21a8,8,0,0,1,8-7.94h48.32a7.94,7.94,0,0,1,7.94,7.94v18.95c0,6.13,8.21,8.3,11.15,2.92,13.74-25.16,35.63-36,64.31-36,53.43,0,81.08,44,81.08,116.92C1301.62,320.78,1273,365.27,1219.14,365.27Zm19.21-119.76c0-37.39-14.06-59.17-46.4-59.17-29.53,0-46.87,20.35-46.87,57.28v4.26c0,36.45,17.34,59.17,46.87,59.17C1223.82,307.05,1238.35,284.33,1238.35,245.51Z"/><path class="cls-1" d="M394.41,102.12C394,45.31,346.61,0,289.8,0H104.69C48.31,0,1.09,44.6,0,101A103.07,103.07,0,0,0,103,205.92h82.7a6,6,0,0,1,2.39,11.42L61.31,272.91A103.09,103.09,0,0,0,0,367.83C.43,424.65,47.79,470,104.62,470H148c57.23,0,104.88-45.9,104.79-103.13a103.1,103.1,0,0,0-64.49-95.31,5.94,5.94,0,0,1-.1-10.94l145-63.58A103.08,103.08,0,0,0,394.41,102.12Z"/></g></g></svg>
|
|
||||||
|
Before Width: | Height: | Size: 2.9 KiB |
@ -1,5 +0,0 @@
|
|||||||
Here we maintain a database of installation methods, from which we generate
|
|
||||||
the installation section in docs. If you’d like add or update an installation method,
|
|
||||||
edit [methods.yml](./methods.yml), do not edit the main docs directly.
|
|
||||||
|
|
||||||
For HTTPie installation instructions see: <https://httpie.io/docs#installation>.
|
|
||||||
@ -1,85 +0,0 @@
|
|||||||
import re
|
|
||||||
import sys
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Dict
|
|
||||||
|
|
||||||
import yaml
|
|
||||||
from jinja2 import Template
|
|
||||||
|
|
||||||
Database = Dict[str, dict]
|
|
||||||
|
|
||||||
# Files
|
|
||||||
HERE = Path(__file__).parent
|
|
||||||
DB_FILE = HERE / 'methods.yml'
|
|
||||||
DOC_FILE = HERE.parent / 'README.md'
|
|
||||||
TPL_FILE = HERE / 'installation.jinja2'
|
|
||||||
|
|
||||||
# Database keys
|
|
||||||
KEY_DOC_STRUCTURE = 'docs-structure'
|
|
||||||
KEY_TOOLS = 'tools'
|
|
||||||
|
|
||||||
# Markers in-between content will be put.
|
|
||||||
MARKER_START = '<div data-installation-instructions>'
|
|
||||||
MARKER_END = '</div>'
|
|
||||||
|
|
||||||
|
|
||||||
def generate_documentation() -> str:
|
|
||||||
database = load_database()
|
|
||||||
structure = build_docs_structure(database)
|
|
||||||
template = Template(source=TPL_FILE.read_text(encoding='utf-8'))
|
|
||||||
output = template.render(structure=structure)
|
|
||||||
output = clean_template_output(output)
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
def save_doc_file(content: str) -> None:
|
|
||||||
current_doc = load_doc_file()
|
|
||||||
marker_start = current_doc.find(MARKER_START) + len(MARKER_START)
|
|
||||||
assert marker_start > 0, 'cannot find the start marker'
|
|
||||||
marker_end = current_doc.find(MARKER_END, marker_start)
|
|
||||||
assert marker_start < marker_end, f'{marker_end=} < {marker_start=}'
|
|
||||||
updated_doc = (
|
|
||||||
current_doc[:marker_start]
|
|
||||||
+ '\n\n'
|
|
||||||
+ content
|
|
||||||
+ '\n\n'
|
|
||||||
+ current_doc[marker_end:]
|
|
||||||
)
|
|
||||||
if current_doc != updated_doc:
|
|
||||||
DOC_FILE.write_text(updated_doc, encoding='utf-8')
|
|
||||||
|
|
||||||
|
|
||||||
def build_docs_structure(database: Database):
|
|
||||||
tools = database[KEY_TOOLS]
|
|
||||||
assert len(tools) == len({tool['title'] for tool in tools.values()}), 'tool titles need to be unique'
|
|
||||||
tree = database[KEY_DOC_STRUCTURE]
|
|
||||||
structure = []
|
|
||||||
for platform, tools_ids in tree.items():
|
|
||||||
assert platform.isalnum(), f'{platform=} must be alpha-numeric for generated links to work'
|
|
||||||
platform_tools = [tools[tool_id] for tool_id in tools_ids]
|
|
||||||
structure.append((platform, platform_tools))
|
|
||||||
return structure
|
|
||||||
|
|
||||||
|
|
||||||
def clean_template_output(output):
|
|
||||||
output = '\n'.join(line.strip() for line in output.strip().splitlines())
|
|
||||||
output = re.sub('\n{3,}', '\n\n', output)
|
|
||||||
return output
|
|
||||||
|
|
||||||
|
|
||||||
def load_database() -> Database:
|
|
||||||
return yaml.safe_load(DB_FILE.read_text(encoding='utf-8'))
|
|
||||||
|
|
||||||
|
|
||||||
def load_doc_file() -> str:
|
|
||||||
return DOC_FILE.read_text(encoding='utf-8')
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> int:
|
|
||||||
content = generate_documentation()
|
|
||||||
save_doc_file(content)
|
|
||||||
return 0
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
sys.exit(main())
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
<!--
|
|
||||||
THE INSTALLATION SECTION IS GENERATED
|
|
||||||
|
|
||||||
Do not edit here, but in docs/installation/.
|
|
||||||
|
|
||||||
-->
|
|
||||||
{% for platform, tools in structure %}
|
|
||||||
- [{{ platform }}](#{{ platform.lower() }}){% endfor %} {# <= keep `endfor` here to prevent unwanted `\n` #}
|
|
||||||
|
|
||||||
{% for platform, tools in structure %}
|
|
||||||
|
|
||||||
### {{ platform }}
|
|
||||||
|
|
||||||
{% for tool in tools %}
|
|
||||||
#### {{ tool.title }}
|
|
||||||
|
|
||||||
{% if tool.note %}
|
|
||||||
{{ tool.note }}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if tool.links.setup %}
|
|
||||||
To install [{{ tool.name }}]({{ tool.links.homepage }}) follow [installation instructions]({{ tool.links.setup }}).
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install
|
|
||||||
$ {{ tool.commands.install|join('\n$ ') }}
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Upgrade
|
|
||||||
$ {{ tool.commands.upgrade|join('\n$ ') }}
|
|
||||||
```
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
{% endfor %}
|
|
||||||
<!-- /GENERATED SECTION -->
|
|
||||||
@ -1,269 +0,0 @@
|
|||||||
# Database of HTTPie installation methods. Used to build the docs.
|
|
||||||
#
|
|
||||||
# We currently only include here methods for popular systems where we take care of the package,
|
|
||||||
# or have a good relationship with the maintainers.
|
|
||||||
#
|
|
||||||
# Each tool name should be unique (it becomes a linkable header).
|
|
||||||
# If a tools have `links.setup`, it also needs `links.homepage`.
|
|
||||||
# Some tools are available on multiple platforms, take into account when editing.
|
|
||||||
#
|
|
||||||
|
|
||||||
docs-structure:
|
|
||||||
Universal:
|
|
||||||
- pypi
|
|
||||||
macOS:
|
|
||||||
- brew-mac
|
|
||||||
- port
|
|
||||||
- snap-mac
|
|
||||||
- spack-mac
|
|
||||||
Windows:
|
|
||||||
- chocolatey
|
|
||||||
Linux:
|
|
||||||
- snap-linux
|
|
||||||
- brew-linux
|
|
||||||
- apt
|
|
||||||
- dnf
|
|
||||||
- yum
|
|
||||||
- apk
|
|
||||||
- emerge
|
|
||||||
- pacman
|
|
||||||
- xbps-install
|
|
||||||
- spack-linux
|
|
||||||
FreeBSD:
|
|
||||||
- pkg
|
|
||||||
|
|
||||||
tools:
|
|
||||||
apk:
|
|
||||||
title: Alpine Linux
|
|
||||||
name: apk
|
|
||||||
links:
|
|
||||||
homepage: https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management
|
|
||||||
package: https://pkgs.alpinelinux.org/package/edge/community/x86/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- apk update
|
|
||||||
- apk add httpie
|
|
||||||
upgrade:
|
|
||||||
- apk update
|
|
||||||
- apk add --upgrade httpie
|
|
||||||
|
|
||||||
apt:
|
|
||||||
title: Debian and Ubuntu
|
|
||||||
note: Also works for other Debian-derived distributions like MX Linux, Linux Mint, deepin, Pop!_OS, KDE neon, Zorin OS, elementary OS, Kubuntu, Devuan, Linux Lite, Peppermint OS, Lubuntu, antiX, Xubuntu, etc.
|
|
||||||
name: APT
|
|
||||||
links:
|
|
||||||
homepage: https://en.wikipedia.org/wiki/APT_(software)
|
|
||||||
package: https://packages.debian.org/sid/web/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- apt update
|
|
||||||
- apt install httpie
|
|
||||||
upgrade:
|
|
||||||
- apt update
|
|
||||||
- apt upgrade httpie
|
|
||||||
|
|
||||||
brew-mac:
|
|
||||||
title: Homebrew
|
|
||||||
name: Homebrew
|
|
||||||
links:
|
|
||||||
homepage: https://brew.sh/
|
|
||||||
setup: https://docs.brew.sh/Installation
|
|
||||||
package: https://formulae.brew.sh/formula/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- brew update
|
|
||||||
- brew install httpie
|
|
||||||
upgrade:
|
|
||||||
- brew update
|
|
||||||
- brew upgrade httpie
|
|
||||||
|
|
||||||
brew-linux:
|
|
||||||
title: Linuxbrew
|
|
||||||
name: Linuxbrew
|
|
||||||
links:
|
|
||||||
homepage: https://docs.brew.sh/Homebrew-on-Linux
|
|
||||||
setup: https://docs.brew.sh/Homebrew-on-Linux#install
|
|
||||||
package: https://formulae.brew.sh/formula/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- brew update
|
|
||||||
- brew install httpie
|
|
||||||
upgrade:
|
|
||||||
- brew update
|
|
||||||
- brew upgrade httpie
|
|
||||||
|
|
||||||
chocolatey:
|
|
||||||
title: Chocolatey
|
|
||||||
name: Chocolatey
|
|
||||||
links:
|
|
||||||
homepage: https://chocolatey.org/
|
|
||||||
setup: https://chocolatey.org/install
|
|
||||||
package: https://community.chocolatey.org/packages/httpie/
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- choco install httpie
|
|
||||||
upgrade:
|
|
||||||
- choco upgrade httpie
|
|
||||||
|
|
||||||
dnf:
|
|
||||||
title: Fedora
|
|
||||||
name: DNF
|
|
||||||
links:
|
|
||||||
homepage: https://fedoraproject.org/wiki/DNF
|
|
||||||
package: https://src.fedoraproject.org/rpms/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- dnf update
|
|
||||||
- dnf install httpie
|
|
||||||
upgrade:
|
|
||||||
- dnf update
|
|
||||||
- dnf upgrade httpie
|
|
||||||
|
|
||||||
emerge:
|
|
||||||
title: Gentoo
|
|
||||||
name: Portage
|
|
||||||
links:
|
|
||||||
homepage: https://wiki.gentoo.org/wiki/Portage
|
|
||||||
package: https://packages.gentoo.org/packages/net-misc/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- emerge --sync
|
|
||||||
- emerge httpie
|
|
||||||
upgrade:
|
|
||||||
- emerge --sync
|
|
||||||
- emerge --update httpie
|
|
||||||
|
|
||||||
pacman:
|
|
||||||
title: Arch Linux
|
|
||||||
name: pacman
|
|
||||||
note: Also works for other Arch-derived distributions like ArcoLinux, EndeavourOS, Artix Linux, etc.
|
|
||||||
links:
|
|
||||||
homepage: https://archlinux.org/pacman/
|
|
||||||
package: https://archlinux.org/packages/community/any/httpie/
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- pacman -Sy httpie
|
|
||||||
upgrade:
|
|
||||||
- pacman -Syu httpie
|
|
||||||
|
|
||||||
pkg:
|
|
||||||
title: FreshPorts
|
|
||||||
name: FreshPorts
|
|
||||||
links:
|
|
||||||
homepage: https://www.freebsd.org/cgi/man.cgi?query=pkg&sektion=8&n=1
|
|
||||||
package: https://www.freshports.org/www/py-httpie/
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- pkg install www/py-httpie
|
|
||||||
upgrade:
|
|
||||||
- pkg upgrade www/py-httpie
|
|
||||||
|
|
||||||
port:
|
|
||||||
title: MacPorts
|
|
||||||
name: MacPorts
|
|
||||||
links:
|
|
||||||
homepage: https://www.macports.org/
|
|
||||||
setup: https://www.macports.org/install.php
|
|
||||||
package: https://ports.macports.org/port/httpie/
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- port selfupdate
|
|
||||||
- port install httpie
|
|
||||||
upgrade:
|
|
||||||
- port selfupdate
|
|
||||||
- port upgrade httpie
|
|
||||||
|
|
||||||
pypi:
|
|
||||||
title: PyPi
|
|
||||||
name: pip
|
|
||||||
note: Please make sure you have Python 3.6 or newer (`python --version`).
|
|
||||||
links:
|
|
||||||
homepage: https://pypi.org/
|
|
||||||
# setup: https://pip.pypa.io/en/stable/installation/
|
|
||||||
package: https://pypi.org/project/httpie/
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- python -m pip install --upgrade pip wheel
|
|
||||||
- python -m pip install httpie
|
|
||||||
upgrade:
|
|
||||||
- python -m pip install --upgrade pip wheel
|
|
||||||
- python -m pip install --upgrade httpie
|
|
||||||
|
|
||||||
snap-linux:
|
|
||||||
title: Snapcraft (Linux)
|
|
||||||
name: Snapcraft
|
|
||||||
links:
|
|
||||||
homepage: https://snapcraft.io/
|
|
||||||
setup: https://snapcraft.io/docs/installing-snapd
|
|
||||||
package: https://snapcraft.io/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- snap install httpie
|
|
||||||
upgrade:
|
|
||||||
- snap refresh httpie
|
|
||||||
|
|
||||||
snap-mac:
|
|
||||||
title: Snapcraft (macOS)
|
|
||||||
name: Snapcraft
|
|
||||||
links:
|
|
||||||
homepage: https://snapcraft.io/
|
|
||||||
setup: https://snapcraft.io/docs/installing-snapd
|
|
||||||
package: https://snapcraft.io/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- snap install httpie
|
|
||||||
upgrade:
|
|
||||||
- snap refresh httpie
|
|
||||||
|
|
||||||
spack-linux:
|
|
||||||
title: Spack (Linux)
|
|
||||||
name: Spack
|
|
||||||
links:
|
|
||||||
homepage: https://spack.readthedocs.io/en/latest/index.html
|
|
||||||
setup: https://spack.readthedocs.io/en/latest/getting_started.html#installation
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- spack install httpie
|
|
||||||
upgrade:
|
|
||||||
- spack install httpie
|
|
||||||
|
|
||||||
spack-mac:
|
|
||||||
title: Spack (macOS)
|
|
||||||
name: Spack
|
|
||||||
links:
|
|
||||||
homepage: https://spack.readthedocs.io/en/latest/index.html
|
|
||||||
setup: https://spack.readthedocs.io/en/latest/getting_started.html#installation
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- spack install httpie
|
|
||||||
upgrade:
|
|
||||||
- spack install httpie
|
|
||||||
|
|
||||||
xbps-install:
|
|
||||||
title: Void Linux
|
|
||||||
name: XBPS
|
|
||||||
links:
|
|
||||||
homepage: https://docs.voidlinux.org/xbps/index.html
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- xbps-install -Su
|
|
||||||
- xbps-install -S httpie
|
|
||||||
upgrade:
|
|
||||||
- xbps-install -Su
|
|
||||||
- xbps-install -Su httpie
|
|
||||||
|
|
||||||
yum:
|
|
||||||
title: CentOS and RHEL
|
|
||||||
name: Yum
|
|
||||||
note: Also works for other RHEL-derived distributions like ClearOS, Oracle Linux, etc.
|
|
||||||
links:
|
|
||||||
homepage: http://yum.baseurl.org/
|
|
||||||
package: https://src.fedoraproject.org/rpms/httpie
|
|
||||||
commands:
|
|
||||||
install:
|
|
||||||
- yum update
|
|
||||||
- yum install epel-release
|
|
||||||
- yum install httpie
|
|
||||||
upgrade:
|
|
||||||
- yum update
|
|
||||||
- yum upgrade httpie
|
|
||||||
@ -1,41 +0,0 @@
|
|||||||
# Rules for <https://github.com/markdownlint/markdownlint>
|
|
||||||
|
|
||||||
# Load all rules by default
|
|
||||||
all
|
|
||||||
|
|
||||||
#
|
|
||||||
# Tweak rules
|
|
||||||
#
|
|
||||||
|
|
||||||
# MD002 First header should be a top level header
|
|
||||||
# Because we use HTML to hide them on the website.
|
|
||||||
exclude_rule 'MD002'
|
|
||||||
|
|
||||||
# MD013 Line length
|
|
||||||
exclude_rule 'MD013'
|
|
||||||
|
|
||||||
# MD014 Dollar signs used before commands without showing output
|
|
||||||
exclude_rule 'MD014'
|
|
||||||
|
|
||||||
# Tell the linter to use ordered lists:
|
|
||||||
# 1. Foo
|
|
||||||
# 2. Bar
|
|
||||||
# 3. Baz
|
|
||||||
#
|
|
||||||
# Instead of:
|
|
||||||
# 1. Foo
|
|
||||||
# 1. Bar
|
|
||||||
# 1. Baz
|
|
||||||
rule 'MD029', :style => :ordered
|
|
||||||
|
|
||||||
# MD033 Inline HTML
|
|
||||||
# TODO: Tweak elements when https://github.com/markdownlint/markdownlint/issues/118 will be done?
|
|
||||||
exclude_rule 'MD033'
|
|
||||||
|
|
||||||
# MD034 Bare URL used
|
|
||||||
# TODO: Remove when https://github.com/markdownlint/markdownlint/issues/328 will be fixed.
|
|
||||||
exclude_rule 'MD034'
|
|
||||||
|
|
||||||
# MD041 First line in file should be a top level header
|
|
||||||
# Because we use HTML to hide them on the website.
|
|
||||||
exclude_rule 'MD041'
|
|
||||||
@ -1,49 +0,0 @@
|
|||||||
# HTTPie release process
|
|
||||||
|
|
||||||
Welcome on the documentation part of the **HTTPie release process**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions, then you can find all you need for your OS on [that page](https://httpie.io/docs#installation). In the case you do not find your OS, [let us know](https://github.com/httpie/httpie/issues/).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging, then you are at the good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
You are looking at the HTTPie packaging documentation, where you will find valuable information about how we manage to release HTTPie to lots of OSes, including technical data that may be worth reading if you are a package maintainer.
|
|
||||||
|
|
||||||
The overall release process starts simple:
|
|
||||||
|
|
||||||
1. Do the [PyPi](https://pypi.org/project/httpie/) publication.
|
|
||||||
2. Then, handle company-related tasks.
|
|
||||||
3. Finally, follow OS-specific steps, described in documents below, to send patches downstream.
|
|
||||||
|
|
||||||
## First, PyPi
|
|
||||||
|
|
||||||
Let's do the release on [PyPi](https://pypi.org/project/httpie/).
|
|
||||||
That is done quite easily by manually triggering the [release workflow](https://github.com/httpie/httpie/actions/workflows/release.yml).
|
|
||||||
|
|
||||||
## Then, company-specific tasks
|
|
||||||
|
|
||||||
- Update the HTTPie version bundled into termible ([example](https://github.com/httpie/termible/pull/1)).
|
|
||||||
|
|
||||||
## Finally, spread dowstream
|
|
||||||
|
|
||||||
Find out how we do release new versions for each and every supported OS in the following table.
|
|
||||||
A more complete state of deployment can be found on [repology](https://repology.org/project/httpie/versions), including unofficial packages.
|
|
||||||
|
|
||||||
| OS | Maintainer |
|
|
||||||
| -------------------------------------------: | -------------- |
|
|
||||||
| [Alpine](linux-alpine/) | **HTTPie** |
|
|
||||||
| [Arch Linux, and derived](linux-arch/) | trusted person |
|
|
||||||
| :construction: [AOSC OS](linux-aosc/) | **HTTPie** |
|
|
||||||
| [CentOS, RHEL, and derived](linux-centos/) | trusted person |
|
|
||||||
| [Debian, Ubuntu, and derived](linux-debian/) | trusted person |
|
|
||||||
| [Fedora](linux-fedora/) | trusted person |
|
|
||||||
| [Gentoo](linux-gentoo/) | **HTTPie** |
|
|
||||||
| :construction: [Homebrew, Linuxbrew](brew/) | **HTTPie** |
|
|
||||||
| :construction: [MacPorts](mac-ports/) | **HTTPie** |
|
|
||||||
| [Snapcraft](snapcraft/) | **HTTPie** |
|
|
||||||
| [Spack](spack/) | **HTTPie** |
|
|
||||||
| [Void Linux](linux-void/) | **HTTPie** |
|
|
||||||
| [Windows — Chocolatey](windows-chocolatey/) | **HTTPie** |
|
|
||||||
|
|
||||||
:new: You do not find your system or you would like to see HTTPie supported on another OS? Then [let us know](https://github.com/httpie/httpie/issues/).
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
# HTTPie on Homebrew, and Linuxbrew
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Homebrew**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Homebrew, then you can find them on [that page](https://httpie.io/docs#homebrew) ([that one](https://httpie.io/docs#linuxbrew) for Linuxbrew).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Homebrew, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Homebrew. They apply to Linuxbrew as well.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
:construction: Work in progress.
|
|
||||||
|
|
||||||
First, update the current Formula:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make brew-deps
|
|
||||||
# Copy-paste content into downstream/mac/brew/httpie.rb
|
|
||||||
git add downstream/mac/brew/httpie.rb
|
|
||||||
git commit -s -m 'Update brew formula to XXX'
|
|
||||||
```
|
|
||||||
|
|
||||||
That [GitHub workflow](https://github.com/httpie/httpie/actions/workflows/test-package-mac-brew.yml) will test the formula when `downstream/mac/brew/httpie.rb` is changed in a pull request.
|
|
||||||
|
|
||||||
Then, open a pull request with those changes to the [downstream file]([ file](https://github.com/Homebrew/homebrew-core/blob/master/Formula/httpie.rb)).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
:construction: Work in progress.
|
|
||||||
@ -1,80 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""
|
|
||||||
Generate Ruby code with URLs and file hashes for packages from PyPi
|
|
||||||
(i.e., httpie itself as well as its dependencies) to be included
|
|
||||||
in the Homebrew formula after a new release of HTTPie has been published
|
|
||||||
on PyPi.
|
|
||||||
|
|
||||||
<https://github.com/Homebrew/homebrew-core/blob/master/Formula/httpie.rb>
|
|
||||||
|
|
||||||
"""
|
|
||||||
import hashlib
|
|
||||||
import requests
|
|
||||||
|
|
||||||
|
|
||||||
VERSIONS = {
|
|
||||||
# By default, we use the latest packages. But sometimes Requests has a maximum supported versions.
|
|
||||||
# Take a look here before making a release: <https://github.com/psf/requests/blob/master/setup.py>
|
|
||||||
'idna': '3.2',
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# Note: Keep that list sorted.
|
|
||||||
PACKAGES = [
|
|
||||||
'certifi',
|
|
||||||
'charset-normalizer',
|
|
||||||
'defusedxml',
|
|
||||||
'httpie',
|
|
||||||
'idna',
|
|
||||||
'Pygments',
|
|
||||||
'PySocks',
|
|
||||||
'requests',
|
|
||||||
'requests-toolbelt',
|
|
||||||
'urllib3',
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def get_package_meta(package_name):
|
|
||||||
api_url = f'https://pypi.org/pypi/{package_name}/json'
|
|
||||||
resp = requests.get(api_url).json()
|
|
||||||
hasher = hashlib.sha256()
|
|
||||||
version = VERSIONS.get(package_name)
|
|
||||||
if package_name not in VERSIONS:
|
|
||||||
# Latest version
|
|
||||||
release_bundle = resp['urls']
|
|
||||||
else:
|
|
||||||
release_bundle = resp['releases'][version]
|
|
||||||
|
|
||||||
for release in release_bundle:
|
|
||||||
download_url = release['url']
|
|
||||||
if download_url.endswith('.tar.gz'):
|
|
||||||
hasher.update(requests.get(download_url).content)
|
|
||||||
return {
|
|
||||||
'name': package_name,
|
|
||||||
'url': download_url,
|
|
||||||
'sha256': hasher.hexdigest(),
|
|
||||||
}
|
|
||||||
else:
|
|
||||||
raise RuntimeError(f'{package_name}: download not found: {resp}')
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
package_meta_map = {
|
|
||||||
package_name: get_package_meta(package_name)
|
|
||||||
for package_name in PACKAGES
|
|
||||||
}
|
|
||||||
httpie_meta = package_meta_map.pop('httpie')
|
|
||||||
print()
|
|
||||||
print(' url "{url}"'.format(url=httpie_meta['url']))
|
|
||||||
print(' sha256 "{sha256}"'.format(sha256=httpie_meta['sha256']))
|
|
||||||
print()
|
|
||||||
for dep_meta in package_meta_map.values():
|
|
||||||
print(' resource "{name}" do'.format(name=dep_meta['name']))
|
|
||||||
print(' url "{url}"'.format(url=dep_meta['url']))
|
|
||||||
print(' sha256 "{sha256}"'.format(sha256=dep_meta['sha256']))
|
|
||||||
print(' end')
|
|
||||||
print('')
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
main()
|
|
||||||
@ -1,74 +0,0 @@
|
|||||||
class Httpie < Formula
|
|
||||||
include Language::Python::Virtualenv
|
|
||||||
|
|
||||||
desc "User-friendly cURL replacement (command-line HTTP client)"
|
|
||||||
homepage "https://httpie.io/"
|
|
||||||
url "https://files.pythonhosted.org/packages/90/64/7ea8066309970f787653bdc8c5328272a5c4d06cbce3a07a6a5c3199c3d7/httpie-2.5.0.tar.gz"
|
|
||||||
sha256 "fe6a8bc50fb0635a84ebe1296a732e39357c3e1354541bf51a7057b4877e47f9"
|
|
||||||
license "BSD-3-Clause"
|
|
||||||
head "https://github.com/httpie/httpie.git"
|
|
||||||
|
|
||||||
bottle do
|
|
||||||
sha256 cellar: :any_skip_relocation, arm64_big_sur: "01115f69aff0399b3f73af09899a42a14343638a4624a35749059cc732c49cdc"
|
|
||||||
sha256 cellar: :any_skip_relocation, big_sur: "53f07157f00edf8193b7d4f74f247f53e1796fbc3e675cd2fbaa4b9dc2bad62c"
|
|
||||||
sha256 cellar: :any_skip_relocation, catalina: "7cf216fdee98208856d654060fdcad3968623d7ed27fcdeba27d3120354c9a9f"
|
|
||||||
sha256 cellar: :any_skip_relocation, mojave: "28adb5aed8c1c2b39c51789f242ff0dffde39073e161deb379c79184d787d063"
|
|
||||||
sha256 cellar: :any_skip_relocation, x86_64_linux: "91cb8c332c643bd8b1d0a8f3ec0acd4770b407991f6de1fd320d675f2b2e95ec"
|
|
||||||
end
|
|
||||||
|
|
||||||
depends_on "python@3.9"
|
|
||||||
|
|
||||||
resource "certifi" do
|
|
||||||
url "https://files.pythonhosted.org/packages/6d/78/f8db8d57f520a54f0b8a438319c342c61c22759d8f9a1cd2e2180b5e5ea9/certifi-2021.5.30.tar.gz"
|
|
||||||
sha256 "2bbf76fd432960138b3ef6dda3dde0544f27cbf8546c458e60baf371917ba9ee"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "charset-normalizer" do
|
|
||||||
url "https://files.pythonhosted.org/packages/e7/4e/2af0238001648ded297fb54ceb425ca26faa15b341b4fac5371d3938666e/charset-normalizer-2.0.4.tar.gz"
|
|
||||||
sha256 "f23667ebe1084be45f6ae0538e4a5a865206544097e4e8bbcacf42cd02a348f3"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "defusedxml" do
|
|
||||||
url "https://files.pythonhosted.org/packages/0f/d5/c66da9b79e5bdb124974bfe172b4daf3c984ebd9c2a06e2b8a4dc7331c72/defusedxml-0.7.1.tar.gz"
|
|
||||||
sha256 "1bb3032db185915b62d7c6209c5a8792be6a32ab2fedacc84e01b52c51aa3e69"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "idna" do
|
|
||||||
url "https://files.pythonhosted.org/packages/cb/38/4c4d00ddfa48abe616d7e572e02a04273603db446975ab46bbcd36552005/idna-3.2.tar.gz"
|
|
||||||
sha256 "467fbad99067910785144ce333826c71fb0e63a425657295239737f7ecd125f3"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "Pygments" do
|
|
||||||
url "https://files.pythonhosted.org/packages/b7/b3/5cba26637fe43500d4568d0ee7b7362de1fb29c0e158d50b4b69e9a40422/Pygments-2.10.0.tar.gz"
|
|
||||||
sha256 "f398865f7eb6874156579fdf36bc840a03cab64d1cde9e93d68f46a425ec52c6"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "PySocks" do
|
|
||||||
url "https://files.pythonhosted.org/packages/bd/11/293dd436aea955d45fc4e8a35b6ae7270f5b8e00b53cf6c024c83b657a11/PySocks-1.7.1.tar.gz"
|
|
||||||
sha256 "3f8804571ebe159c380ac6de37643bb4685970655d3bba243530d6558b799aa0"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "requests" do
|
|
||||||
url "https://files.pythonhosted.org/packages/e7/01/3569e0b535fb2e4a6c384bdbed00c55b9d78b5084e0fb7f4d0bf523d7670/requests-2.26.0.tar.gz"
|
|
||||||
sha256 "b8aa58f8cf793ffd8782d3d8cb19e66ef36f7aba4353eec859e74678b01b07a7"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "requests-toolbelt" do
|
|
||||||
url "https://files.pythonhosted.org/packages/28/30/7bf7e5071081f761766d46820e52f4b16c8a08fef02d2eb4682ca7534310/requests-toolbelt-0.9.1.tar.gz"
|
|
||||||
sha256 "968089d4584ad4ad7c171454f0a5c6dac23971e9472521ea3b6d49d610aa6fc0"
|
|
||||||
end
|
|
||||||
|
|
||||||
resource "urllib3" do
|
|
||||||
url "https://files.pythonhosted.org/packages/4f/5a/597ef5911cb8919efe4d86206aa8b2658616d676a7088f0825ca08bd7cb8/urllib3-1.26.6.tar.gz"
|
|
||||||
sha256 "f57b4c16c62fa2760b7e3d97c35b255512fb6b59a259730f36ba32ce9f8e342f"
|
|
||||||
end
|
|
||||||
|
|
||||||
def install
|
|
||||||
virtualenv_install_with_resources
|
|
||||||
end
|
|
||||||
|
|
||||||
test do
|
|
||||||
raw_url = "https://raw.githubusercontent.com/Homebrew/homebrew-core/HEAD/Formula/httpie.rb"
|
|
||||||
assert_match "PYTHONPATH", shell_output("#{bin}/http --ignore-stdin #{raw_url}")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
# Contributor: Fabian Affolter <fabian@affolter-engineering.ch>
|
|
||||||
# Maintainer: Fabian Affolter <fabian@affolter-engineering.ch>
|
|
||||||
# Contributor: Daniel Isaksen <d@duniel.no>
|
|
||||||
# Contributor: Mickaël Schoentgen <mickael@apible.io>
|
|
||||||
pkgname=httpie
|
|
||||||
pkgver=2.5.0
|
|
||||||
pkgrel=0
|
|
||||||
pkgdesc="CLI, cURL-like tool"
|
|
||||||
url="https://httpie.org/"
|
|
||||||
arch="noarch"
|
|
||||||
license="BSD-3-Clause"
|
|
||||||
depends="python3 py3-setuptools py3-requests py3-pygments py3-requests-toolbelt py3-pysocks py3-defusedxml"
|
|
||||||
makedepends="py3-setuptools"
|
|
||||||
checkdepends="py3-pytest py3-pytest-httpbin py3-responses"
|
|
||||||
source="https://files.pythonhosted.org/packages/source/h/httpie/httpie-$pkgver.tar.gz"
|
|
||||||
|
|
||||||
# secfixes:
|
|
||||||
# 1.0.3-r0:
|
|
||||||
# - CVE-2019-10751
|
|
||||||
|
|
||||||
build() {
|
|
||||||
python3 setup.py build
|
|
||||||
}
|
|
||||||
|
|
||||||
check() {
|
|
||||||
python3 -m pytest ./httpie ./tests
|
|
||||||
}
|
|
||||||
|
|
||||||
package() {
|
|
||||||
python3 setup.py install --prefix=/usr --root="$pkgdir"
|
|
||||||
}
|
|
||||||
|
|
||||||
sha512sums="3bfe572b03bfde87d5a02f9ba238f9493b32e587c33fd30600a4dd6a45082eedcb2b507c7f1e3e75a423cbdcc1ff0556138897dffb7888d191834994eae9a2aa httpie-2.5.0.tar.gz"
|
|
||||||
@ -1,67 +0,0 @@
|
|||||||
# HTTPie on Alpine Linux
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Alpine Linux**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Alpine Linux, then you can find them on [that page](https://httpie.io/docs#alpine-linux).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Alpine Linux, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Alpine Linux.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a pull request to update the [downstream file](https://gitlab.alpinelinux.org/alpine/aports/-/blob/master/community/httpie/APKBUILD) ([example](https://gitlab.alpinelinux.org/alpine/aports/-/merge_requests/25075)).
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
- The `pkgrel` value must be set to `0`.
|
|
||||||
- The commit message must be `community/httpie: upgrade to XXX`.
|
|
||||||
- The commit must be signed-off (`git commit -s`).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
Launch the docker image:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull alpine
|
|
||||||
docker run -it --rm alpine
|
|
||||||
```
|
|
||||||
|
|
||||||
From inside the container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install tools
|
|
||||||
apk add alpine-sdk sudo
|
|
||||||
|
|
||||||
# Add a user (password required)
|
|
||||||
adduser me
|
|
||||||
addgroup me abuild
|
|
||||||
echo "me ALL=(ALL) ALL" >> /etc/sudoers
|
|
||||||
|
|
||||||
# Switch user
|
|
||||||
su - me
|
|
||||||
|
|
||||||
# Create a private key (not used but required)
|
|
||||||
abuild-keygen -a -i
|
|
||||||
|
|
||||||
# Clone
|
|
||||||
git clone --depth=1 https://gitlab.alpinelinux.org/alpine/aports.git
|
|
||||||
cd aports/community/httpie
|
|
||||||
|
|
||||||
# Retrieve the patch of the latest HTTPie version
|
|
||||||
curl https://raw.githubusercontent.com/httpie/httpie/master/docs/packaging/linux-alpine/APKBUILD \
|
|
||||||
-o APKBUILD
|
|
||||||
|
|
||||||
# Build the package
|
|
||||||
abuild -r
|
|
||||||
|
|
||||||
# Install the package
|
|
||||||
sudo apk add --repository ~/packages/community httpie
|
|
||||||
|
|
||||||
# And test it!
|
|
||||||
http --version
|
|
||||||
https --version
|
|
||||||
```
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
# HTTPie on AOSC OS
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for AOSC OS**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on AOSC OS, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for AOSC OS.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a pull request to update the [downstream file](https://github.com/AOSC-Dev/aosc-os-abbs/blob/stable/extra-web/httpie/spec) ([example](https://github.com/AOSC-Dev/aosc-os-abbs/commit/d0d3ba0bcea347387bb582a1b0b1b4e518720c80)).
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
- The commit message must be `httpie: update to XXX`.
|
|
||||||
- The commit must be signed-off (`git commit -s`).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
:construction: Work in progress.
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
VER=2.5.0
|
|
||||||
SRCS="tbl::https://github.com/httpie/httpie/archive/$VER.tar.gz"
|
|
||||||
CHKSUMS="sha256::66af56e0efc1ca6237323f1186ba34bca1be24e67a4319fd5df7228ab986faea"
|
|
||||||
REL=1
|
|
||||||
CHKUPDATE="anitya::id=1337"
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
# Maintainer: Jelle van der Waa <jelle@archlinux.org>
|
|
||||||
# Maintainer: daurnimator <daurnimator@archlinux.org>
|
|
||||||
# Contributor: Daniel Micay <danielmicay@gmail.com>
|
|
||||||
# Contributor: Thomas Weißschuh <thomas_weissschuh lavabit com>
|
|
||||||
|
|
||||||
pkgname=httpie
|
|
||||||
pkgver=2.5.0
|
|
||||||
pkgrel=1
|
|
||||||
pkgdesc="human-friendly CLI HTTP client for the API era"
|
|
||||||
url="https://github.com/httpie/httpie"
|
|
||||||
depends=('python-defusedxml'
|
|
||||||
'python-pygments'
|
|
||||||
'python-pysocks'
|
|
||||||
'python-requests'
|
|
||||||
'python-requests-toolbelt')
|
|
||||||
makedepends=('python-setuptools')
|
|
||||||
checkdepends=('python-pytest'
|
|
||||||
'python-pytest-httpbin'
|
|
||||||
'python-responses')
|
|
||||||
conflicts=(python-httpie)
|
|
||||||
replaces=(python-httpie python2-httpie)
|
|
||||||
license=('BSD')
|
|
||||||
arch=('any')
|
|
||||||
source=($pkgname-$pkgver.tar.gz::"https://github.com/httpie/httpie/archive/$pkgver.tar.gz")
|
|
||||||
sha256sums=('66af56e0efc1ca6237323f1186ba34bca1be24e67a4319fd5df7228ab986faea')
|
|
||||||
|
|
||||||
build() {
|
|
||||||
cd $pkgname-$pkgver
|
|
||||||
python3 setup.py build
|
|
||||||
}
|
|
||||||
|
|
||||||
package() {
|
|
||||||
cd $pkgname-$pkgver
|
|
||||||
install -Dm644 LICENSE "$pkgdir/usr/share/licenses/httpie/LICENSE"
|
|
||||||
python3 setup.py install --root="$pkgdir" --optimize=1
|
|
||||||
|
|
||||||
# Fix upstream, include them in MANIFEST.in and use data_files in setup.py to install them automatically
|
|
||||||
# TODO: add zsh support
|
|
||||||
install -Dm644 extras/httpie-completion.bash "$pkgdir"/usr/share/bash-completion/completions/http
|
|
||||||
install -Dm644 extras/httpie-completion.fish "$pkgdir"/usr/share/fish/vendor_completions.d/http.fish
|
|
||||||
}
|
|
||||||
|
|
||||||
check() {
|
|
||||||
cd $pkgname-$pkgver
|
|
||||||
PYTHONDONTWRITEBYTECODE=1 python3 setup.py test
|
|
||||||
}
|
|
||||||
@ -1,22 +0,0 @@
|
|||||||
# HTTPie on Arch Linux, and derived
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Arch Linux**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Arch Linux, then you can find them on [that page](https://httpie.io/docs#arch-linux).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Arch Linux, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Arch Linux. They apply to Arch-derived distributions as well, like ArcoLinux, EndeavourOS, Artix Linux, etc.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Note: Sending patches downstream does not seem easy. We failed to find where is located the package file on <https://gitlab.archlinux.org>. So we are relying on the last maintainer, daurnimator, and it works pretty well so far.
|
|
||||||
|
|
||||||
Check <https://archlinux.org/packages/community/any/httpie/> and if the version is outdated, simply [report it](https://archlinux.org/packages/community/any/httpie/flag/).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
Left blank on purpose, we will fill that section when we will have access to the downstream repository.
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
# HTTPie on CentOS, RHEL, and derived
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for CentOS and RHEL**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on CentOS, then you can find them on [that page](https://httpie.io/docs#centos-and-rhel).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on CentOS, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for CentOS. They apply to RHEL as well, and any RHEL-derived distributions like ClearOS, Oracle Linux, etc.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
The current maintainer is [Mikel Olasagasti](https://github.com/kaxero).
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Same as [Fedora](../linux-fedora/README.md#overall-process).
|
|
||||||
|
|
||||||
## Q/A with Mikel
|
|
||||||
|
|
||||||
Q: What should we do to help seeing a new version on CentOS?
|
|
||||||
|
|
||||||
A: When a new release is published Miro and I get notified by [release-monitoring](https://release-monitoring.org/project/1337/), that fills a BugZilla ticket reporting a new version being available.
|
|
||||||
|
|
||||||
The system also tries to create a simple patch to update the spec file, but in the case of CentOS it needs some manual revision. For example for 2.5.0 `defuxedxml` dep is required. Maybe with CentOS-9 and some new macros that are available now in Fedora it can be automated same way. But even the bump can be automated, maintainers should check for license changes, new binaries/docs/ and so on.
|
|
||||||
@ -1,29 +0,0 @@
|
|||||||
# HTTPie on Debian, Ubuntu, and derived
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Debian GNU/Linux**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Debian GNU/Linux, then you can find them on [that page](https://httpie.io/docs#debian-and-ubuntu).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Debian GNU/Linux, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Debian GNU/Linux. They apply to Ubuntu as well, and any Debian-derived distributions like MX Linux, Linux Mint, deepin, Pop!_OS, KDE neon, Zorin OS, elementary OS, Kubuntu, Devuan, Linux Lite, Peppermint OS, Lubuntu, antiX, Xubuntu, etc.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
The current maintainer is Bartosz Fenski.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a new bug on the Debian Bug Tracking System by sending an email:
|
|
||||||
|
|
||||||
- To: `Debian Bug Tracking System <submit@bugs.debian.org>`
|
|
||||||
- Subject: `httpie: Version XXX available`
|
|
||||||
- Message template ([example](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=993937)):
|
|
||||||
|
|
||||||
```email
|
|
||||||
Package: httpie
|
|
||||||
Severity: wishlist
|
|
||||||
|
|
||||||
<MESSAGE>
|
|
||||||
```
|
|
||||||
@ -1,48 +0,0 @@
|
|||||||
# HTTPie on Fedora
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Fedora**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Fedora, then you can find them on [that page](https://httpie.io/docs#fedora).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Fedora, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Fedora.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
The current maintainer is [Miro Hrončok](https://github.com/hroncok).
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
We added the [.packit.yaml](https://github.com/httpie/httpie/blob/master/.packit.yaml) local file.
|
|
||||||
It unlocks real-time Fedora checks on pull requests and new releases.
|
|
||||||
|
|
||||||
So there is nothing to do on our side: `Packit` will see the new release and open a pull request [there](https://src.fedoraproject.org/rpms/httpie). Then, the Fedora maintainer will review and merge.
|
|
||||||
|
|
||||||
It is also possible to follow [user feedbacks](https://bodhi.fedoraproject.org/updates/?packages=httpie) for all builds.
|
|
||||||
|
|
||||||
## Q/A with Miro
|
|
||||||
|
|
||||||
Q: What would the command to install the latest stable version look like?
|
|
||||||
|
|
||||||
A: Assuming the latest stable version is already propagated to Fedora:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Note that yum is an alias to dnf.
|
|
||||||
$ sudo dnf install httpie
|
|
||||||
```
|
|
||||||
|
|
||||||
Q: Will dnf/yum upgrade then update to the latest?
|
|
||||||
|
|
||||||
A: Yes, assuming the same as above.
|
|
||||||
|
|
||||||
Q: Are new versions backported automatically?
|
|
||||||
|
|
||||||
A: No. The process is:
|
|
||||||
|
|
||||||
1. A new HTTPie release is created on Github.
|
|
||||||
2. A pull request for Fedora `rawhide` (the development version of Fedora, currently Fedora 35) is created.
|
|
||||||
3. A Fedora packager (usually Miro) sanity checks the pull request and merges, builds. HTTPie is updated in `rawhide` within 24 hours (sometimes more, for unrelated issues).
|
|
||||||
4. A Fedora packager decides whether the upgrade is suitable for stable Fedora releases (currently 34, 33), if so, merges the changes there.
|
|
||||||
5. (if the above is yes) The new version of HTTPie lands in `updates-testing` repo where it waits for user feedback and lands within ~1 week for broad availability.
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
DIST httpie-2.4.0.tar.gz 1772537 BLAKE2B 111451cc7dc353d5b586554f98ac715a3198f03e74d261944a5f021d2dcc948455500800222b323d182a2a067d0549bda7c318ab3a6c934b9a9beec64aff2db2 SHA512 44cc7ff4fe0f3d8c53a7dd750465f6b56c36f5bbac06d22b760579bd60949039e82313845699669a659ec91adc69dbeac22c06ddd63af64e6f2e0edecf3e732a
|
|
||||||
DIST httpie-2.5.0.tar.gz 1105177 BLAKE2B 6e16868c81522d4e6d2fc0a4e093c190f18ced720b35217930865ae3f8e168193cc33dfecc13c5d310f52647d6e79d17b247f56e56e8586d633a2d9502be66a7 SHA512 f14aa23fea7578181b9bd6ededea04de9ddf0b2f697b23f76d2d96e2c17b95617318c711750bad6af550400dbc03732ab17fdf84e59d577f33f073e600a55330
|
|
||||||
@ -1,78 +0,0 @@
|
|||||||
# HTTPie on Gentoo
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Gentoo**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Gentoo, then you can find them on [that page](https://httpie.io/docs#gentoo).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Gentoo, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Gentoo.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a pull request to create `httpie-XXX.ebuild` and update `Manifest`.
|
|
||||||
|
|
||||||
- Here is how to calculate the size and checksum (replace `2.5.0` with the correct version):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Download
|
|
||||||
$ wget https://github.com/httpie/httpie/archive/2.5.0.tar.gz
|
|
||||||
|
|
||||||
# Size
|
|
||||||
$ stat --printf="%s\n" 2.5.0.tar.gz
|
|
||||||
1105177
|
|
||||||
|
|
||||||
# Checksum
|
|
||||||
$ openssl dgst -blake2b512 2.5.0.tar.gz
|
|
||||||
BLAKE2b512(2.5.0.tar.gz)= 6e16868c81522d4e6d2fc0a4e093c190f18ced720b35217930865ae3f8e168193cc33dfecc13c5d310f52647d6e79d17b247f56e56e8586d633a2d9502be66a7
|
|
||||||
```
|
|
||||||
|
|
||||||
- The commit message must be `net-misc/httpie: version bump to XXX`.
|
|
||||||
- The commit must be signed-off (`git commit -s`).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
Launch the docker image:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull gentoo/stage3
|
|
||||||
docker run -it --rm gentoo/stage3
|
|
||||||
```
|
|
||||||
|
|
||||||
From inside the container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install tools
|
|
||||||
emerge --sync
|
|
||||||
emerge pkgcheck repoman
|
|
||||||
|
|
||||||
# Go to the package location
|
|
||||||
cd /var/db/repos/gentoo/net-misc/httpie
|
|
||||||
|
|
||||||
# Retrieve the patch of the latest HTTPie version
|
|
||||||
# (only files that were modified since the previous release)
|
|
||||||
curl https://raw.githubusercontent.com/httpie/httpie/master/docs/packaging/linux-gentoo/httpie-XXX.ebuild \
|
|
||||||
-o httpie-XXX.ebuild
|
|
||||||
curl https://raw.githubusercontent.com/httpie/httpie/master/docs/packaging/linux-gentoo/Manifest \
|
|
||||||
-o Manifest
|
|
||||||
curl https://raw.githubusercontent.com/httpie/httpie/master/docs/packaging/linux-gentoo/metadata.xml \
|
|
||||||
-o metadata.xml
|
|
||||||
|
|
||||||
# Basic checks
|
|
||||||
repoman manifest
|
|
||||||
repoman full -d -x
|
|
||||||
pkgcheck scan
|
|
||||||
|
|
||||||
# Build and install the package
|
|
||||||
emerge --with-test-deps httpie-XXX.ebuild
|
|
||||||
|
|
||||||
# Run the tests suite
|
|
||||||
ebuild httpie-XXX.ebuild clean test
|
|
||||||
|
|
||||||
# And test it!
|
|
||||||
http --version
|
|
||||||
https --version
|
|
||||||
```
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
# Copyright 1999-2021 Gentoo Authors
|
|
||||||
# Distributed under the terms of the GNU General Public License v2
|
|
||||||
|
|
||||||
EAPI=7
|
|
||||||
|
|
||||||
DISTUTILS_USE_SETUPTOOLS=rdepend
|
|
||||||
PYTHON_COMPAT=( python3_{8,9,10} )
|
|
||||||
PYTHON_REQ_USE="ssl(+)"
|
|
||||||
|
|
||||||
inherit bash-completion-r1 distutils-r1
|
|
||||||
|
|
||||||
DESCRIPTION="Modern command line HTTP client"
|
|
||||||
HOMEPAGE="https://httpie.io/ https://pypi.org/project/httpie/"
|
|
||||||
SRC_URI="https://github.com/httpie/httpie/archive/${PV}.tar.gz -> ${P}.tar.gz"
|
|
||||||
|
|
||||||
LICENSE="BSD"
|
|
||||||
SLOT="0"
|
|
||||||
KEYWORDS="~amd64 ~x86"
|
|
||||||
|
|
||||||
RDEPEND="
|
|
||||||
dev-python/defusedxml[${PYTHON_USEDEP}]
|
|
||||||
dev-python/pygments[${PYTHON_USEDEP}]
|
|
||||||
>=dev-python/requests-2.22.0[${PYTHON_USEDEP}]
|
|
||||||
>=dev-python/requests-toolbelt-0.9.1[${PYTHON_USEDEP}]
|
|
||||||
"
|
|
||||||
BDEPEND="
|
|
||||||
test? (
|
|
||||||
${RDEPEND}
|
|
||||||
dev-python/pyopenssl[${PYTHON_USEDEP}]
|
|
||||||
dev-python/pytest-httpbin[${PYTHON_USEDEP}]
|
|
||||||
dev-python/responses[${PYTHON_USEDEP}]
|
|
||||||
)
|
|
||||||
"
|
|
||||||
|
|
||||||
distutils_enable_tests pytest
|
|
||||||
|
|
||||||
python_install_all() {
|
|
||||||
newbashcomp extras/httpie-completion.bash http
|
|
||||||
insinto /usr/share/fish/vendor_completions.d
|
|
||||||
newins extras/httpie-completion.fish http.fish
|
|
||||||
distutils-r1_python_install_all
|
|
||||||
}
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
|
|
||||||
<pkgmetadata>
|
|
||||||
<maintainer type="person" proxied="yes">
|
|
||||||
<email>mickael@apible.io</email>
|
|
||||||
<name>Mickaël Schoentgen</name>
|
|
||||||
</maintainer>
|
|
||||||
<maintainer type="project" proxied="proxy">
|
|
||||||
<email>proxy-maint@gentoo.org</email>
|
|
||||||
<name>Proxy Maintainers</name>
|
|
||||||
</maintainer>
|
|
||||||
<longdescription lang="en">
|
|
||||||
HTTPie (pronounced aitch-tee-tee-pie) is a command line HTTP
|
|
||||||
client. Its goal is to make CLI interaction with web services as
|
|
||||||
human-friendly as possible. It provides a simple http command
|
|
||||||
that allows for sending arbitrary HTTP requests using a simple
|
|
||||||
and natural syntax, and displays colorized output. HTTPie can be
|
|
||||||
used for testing, debugging, and generally interacting with HTTP
|
|
||||||
servers.
|
|
||||||
</longdescription>
|
|
||||||
<upstream>
|
|
||||||
<bugs-to>https://github.com/httpie/httpie/issues</bugs-to>
|
|
||||||
<changelog>https://raw.githubusercontent.com/httpie/httpie/master/CHANGELOG.md</changelog>
|
|
||||||
<doc>https://httpie.io/docs</doc>
|
|
||||||
<remote-id type="github">httpie/httpie</remote-id>
|
|
||||||
<remote-id type="pypi">httpie</remote-id>
|
|
||||||
</upstream>
|
|
||||||
</pkgmetadata>
|
|
||||||
@ -1,68 +0,0 @@
|
|||||||
# HTTPie on Void Linux
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Void Linux**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Void Linux, then you can find them on [that page](https://httpie.io/docs#void-linux).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Void Linux, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Void Linux.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a pull request to update the [downstream file](https://github.com/void-linux/void-packages/blob/master/srcpkgs/httpie/template) ([example](https://github.com/void-linux/void-packages/pull/32905)).
|
|
||||||
|
|
||||||
- The commit message must be `httpie: update to XXX.`.
|
|
||||||
- The commit must be signed-off (`git commit -s`).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
Launch the docker image:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull voidlinux/voidlinux
|
|
||||||
docker run -it --rm voidlinux/voidlinux
|
|
||||||
```
|
|
||||||
|
|
||||||
From inside the container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Sync and upgrade once, assume error comes from xbps update
|
|
||||||
xbps-install -Syu
|
|
||||||
# Install tools
|
|
||||||
xbps-install -y git xtools file util-linux binutils bsdtar coreutils
|
|
||||||
|
|
||||||
# Clone
|
|
||||||
git clone --depth=1 git://github.com/void-linux/void-packages.git void-packages-src
|
|
||||||
cd void-packages-src
|
|
||||||
|
|
||||||
# Retrieve the patch of the latest HTTPie version
|
|
||||||
curl https://raw.githubusercontent.com/httpie/httpie/master/docs/packaging/linux-void/template \
|
|
||||||
-o srcpkgs/httpie/template
|
|
||||||
|
|
||||||
# Check the package
|
|
||||||
xlint srcpkgs/httpie/template
|
|
||||||
|
|
||||||
# Link / to /masterdir
|
|
||||||
ln -s / masterdir
|
|
||||||
|
|
||||||
# Enable ethereal chroot-style
|
|
||||||
export XBPS_ALLOW_CHROOT_BREAKOUT=yes
|
|
||||||
./xbps-src binary-bootstrap
|
|
||||||
./xbps-src chroot
|
|
||||||
|
|
||||||
# Build the package
|
|
||||||
cd void-packages
|
|
||||||
export SOURCE_DATE_EPOCH=0
|
|
||||||
./xbps-src pkg httpie
|
|
||||||
|
|
||||||
# Install the package
|
|
||||||
xbps-install --repository=hostdir/binpkgs httpie
|
|
||||||
|
|
||||||
# And finally test it!
|
|
||||||
http --version
|
|
||||||
https --version
|
|
||||||
```
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
# Template file for 'httpie'
|
|
||||||
pkgname=httpie
|
|
||||||
version=2.5.0
|
|
||||||
revision=1
|
|
||||||
build_style=python3-module
|
|
||||||
hostmakedepends="python3-setuptools"
|
|
||||||
depends="python3-setuptools python3-requests python3-requests-toolbelt
|
|
||||||
python3-Pygments python3-pysocks python3-defusedxml"
|
|
||||||
short_desc="Human-friendly command line HTTP client"
|
|
||||||
maintainer="Mickaël Schoentgen <mickael@apible.io>"
|
|
||||||
license="BSD-3-Clause"
|
|
||||||
homepage="https://httpie.io/"
|
|
||||||
changelog="https://raw.githubusercontent.com/httpie/httpie/${version}/CHANGELOG.md"
|
|
||||||
distfiles="https://github.com/httpie/httpie/archive/${version}.tar.gz"
|
|
||||||
checksum=66af56e0efc1ca6237323f1186ba34bca1be24e67a4319fd5df7228ab986faea
|
|
||||||
make_check=no # needs pytest_httpbin which is not packaged
|
|
||||||
|
|
||||||
post_install() {
|
|
||||||
vcompletion extras/httpie-completion.bash bash http
|
|
||||||
vcompletion extras/httpie-completion.fish fish http
|
|
||||||
vlicense LICENSE
|
|
||||||
}
|
|
||||||
|
|
||||||
python3-httpie_package() {
|
|
||||||
build_style=meta
|
|
||||||
short_desc+=" (transitional dummy package)"
|
|
||||||
depends="httpie>=${version}_${revision}"
|
|
||||||
}
|
|
||||||
@ -1,49 +0,0 @@
|
|||||||
# -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8::et:sw=4:ts=4:sts=4
|
|
||||||
|
|
||||||
PortSystem 1.0
|
|
||||||
PortGroup github 1.0
|
|
||||||
PortGroup python 1.0
|
|
||||||
|
|
||||||
github.setup httpie httpie 2.5.0
|
|
||||||
|
|
||||||
maintainers {g5pw @g5pw} openmaintainer
|
|
||||||
categories net
|
|
||||||
description HTTPie is a command line HTTP client, a user-friendly cURL replacement.
|
|
||||||
long_description HTTPie (pronounced aych-tee-tee-pie) is a command line HTTP \
|
|
||||||
client. Its goal is to make CLI interaction with web \
|
|
||||||
services as human-friendly as possible. It provides a simple \
|
|
||||||
http command that allows for sending arbitrary HTTP requests \
|
|
||||||
using a simple and natural syntax, and displays colorized \
|
|
||||||
responses. HTTPie can be used for testing, debugging, and \
|
|
||||||
generally interacting with HTTP servers.
|
|
||||||
platforms darwin
|
|
||||||
license BSD
|
|
||||||
homepage https://httpie.io/
|
|
||||||
|
|
||||||
variant python36 conflicts python37 python38 python39 description "Use Python 3.6" {}
|
|
||||||
variant python37 conflicts python36 python38 python39 description "Use Python 3.7" {}
|
|
||||||
variant python38 conflicts python36 python37 python39 description "Use Python 3.8" {}
|
|
||||||
variant python39 conflicts python36 python37 python38 description "Use Python 3.9" {}
|
|
||||||
|
|
||||||
if {[variant_isset python36]} {
|
|
||||||
python.default_version 36
|
|
||||||
} elseif {[variant_isset python37]} {
|
|
||||||
python.default_version 37
|
|
||||||
} elseif {[variant_isset python39]} {
|
|
||||||
python.default_version 39
|
|
||||||
} else {
|
|
||||||
default_variants +python38
|
|
||||||
python.default_version 38
|
|
||||||
}
|
|
||||||
|
|
||||||
depends_lib-append port:py${python.version}-requests \
|
|
||||||
port:py${python.version}-requests-toolbelt \
|
|
||||||
port:py${python.version}-pygments \
|
|
||||||
port:py${python.version}-socks \
|
|
||||||
port:py${python.version}-defusedxml
|
|
||||||
|
|
||||||
checksums rmd160 88d227d52199c232c0ddf704a219d1781b1e77ee \
|
|
||||||
sha256 00c4b7bbe7f65abe1473f37b39d9d9f8f53f44069a430ad143a404c01c2179fc \
|
|
||||||
size 1105185
|
|
||||||
|
|
||||||
python.link_binaries_suffix
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
# HTTPie on MacPorts
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for MacPorts**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on MacPorts, then you can find them on [that page](https://httpie.io/docs#macports).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on MacPorts, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for MacPorts.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a pull request to update the [downstream file](https://github.com/macports/macports-ports/blob/master/net/httpie/Portfile) ([example](https://github.com/macports/macports-ports/pull/12167)).
|
|
||||||
|
|
||||||
- Here is how to calculate the size and checksums (replace `2.5.0` with the correct version):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Download the archive
|
|
||||||
$ wget https://api.github.com/repos/httpie/httpie/tarball/2.5.0
|
|
||||||
|
|
||||||
# Size
|
|
||||||
$ stat --printf="%s\n" 2.5.0
|
|
||||||
1105185
|
|
||||||
|
|
||||||
# Checksums
|
|
||||||
$ openssl dgst -rmd160 2.5.0
|
|
||||||
RIPEMD160(2.5.0)= 88d227d52199c232c0ddf704a219d1781b1e77ee
|
|
||||||
$ openssl dgst -sha256 2.5.0
|
|
||||||
SHA256(2.5.0)= 00c4b7bbe7f65abe1473f37b39d9d9f8f53f44069a430ad143a404c01c2179fc
|
|
||||||
```
|
|
||||||
|
|
||||||
- The commit message must be `httpie: update to XXX`.
|
|
||||||
- The commit must be signed-off (`git commit -s`).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
:construction: Work in progress.
|
|
||||||
@ -1,51 +0,0 @@
|
|||||||
# HTTPie on Snapcraft
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Snapcraft**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Snapcraft, then you can find them on [that page](https://httpie.io/docs#snapcraft-linux) ([that one](https://httpie.io/docs#snapcraft-macos) for macOS).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Snapcraft, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Snapcraft. They apply to Snapcraft on Linux, macOS, and Windows.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Trigger a new [build](https://snapcraft.io/httpie/builds), then [promote it](https://snapcraft.io/httpie/releases). If more management is needed: [revisions supervision](https://dashboard.snapcraft.io/snaps/httpie/revisions/).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
Launch the docker image:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull ubuntu/latest
|
|
||||||
docker run -it --rm ubuntu/latest
|
|
||||||
```
|
|
||||||
|
|
||||||
From inside the container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Clone
|
|
||||||
git clone --depth=1 https://github.com/httpie/httpie.git
|
|
||||||
cd httpie
|
|
||||||
|
|
||||||
# Build
|
|
||||||
export SNAPCRAFT_BUILD_ENVIRONMENT_CPU=8
|
|
||||||
export SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=16G
|
|
||||||
snapcraft --debug
|
|
||||||
|
|
||||||
# Install
|
|
||||||
sudo snap install --dangerous httpie_XXX_amd64.snap
|
|
||||||
|
|
||||||
# Test
|
|
||||||
httpie.http --version
|
|
||||||
httpie.https --version
|
|
||||||
# Auto-aliases cannot be tested when installing a snap outside the store.
|
|
||||||
# http --version
|
|
||||||
# https --version
|
|
||||||
|
|
||||||
# Remove
|
|
||||||
sudo snap remove httpie
|
|
||||||
```
|
|
||||||
@ -1,54 +0,0 @@
|
|||||||
# HTTPie on Spack
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Spack**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Spack, then you can find them on [that page](https://httpie.io/docs#spack-linux) ([that one](https://httpie.io/docs#spack-macos) for macOS).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Spack, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Spack. They apply to Spack on Linux, and macOS.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
Open a pull request to update the [downstream file](https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/httpie/package.py) ([example](https://github.com/spack/spack/pull/25888)).
|
|
||||||
|
|
||||||
- The commit message must be `httpie: add vXXX`.
|
|
||||||
- The commit must be signed-off (`git commit -s`).
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
Launch the docker image:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull spack/centos7
|
|
||||||
docker run -it --rm spack/centos7
|
|
||||||
```
|
|
||||||
|
|
||||||
From inside the container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Clone
|
|
||||||
git clone --depth=1 https://github.com/spack/spack.git
|
|
||||||
cd spack
|
|
||||||
|
|
||||||
# Retrieve the patch of the latest HTTPie version
|
|
||||||
curl https://raw.githubusercontent.com/httpie/httpie/master/docs/packaging/spack/package.py \
|
|
||||||
-o var/spack/repos/builtin/packages/httpie/package.py
|
|
||||||
|
|
||||||
# Check the package
|
|
||||||
spack spec httpie
|
|
||||||
|
|
||||||
# Check available versions (it should show the new version)
|
|
||||||
spack versions httpie
|
|
||||||
|
|
||||||
# Install the package
|
|
||||||
spack install httpie@XXX
|
|
||||||
spack load httpie
|
|
||||||
|
|
||||||
# And test it!
|
|
||||||
http --version
|
|
||||||
https --version
|
|
||||||
```
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
# Copyright 2013-2021 Lawrence Livermore National Security, LLC and other
|
|
||||||
# Spack Project Developers. See the top-level COPYRIGHT file for details.
|
|
||||||
#
|
|
||||||
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
|
|
||||||
|
|
||||||
from spack import *
|
|
||||||
|
|
||||||
|
|
||||||
class Httpie(PythonPackage):
|
|
||||||
"""Modern command line HTTP client."""
|
|
||||||
|
|
||||||
homepage = "https://httpie.io/"
|
|
||||||
pypi = "httpie/httpie-2.5.0.tar.gz"
|
|
||||||
|
|
||||||
version('2.5.0', sha256='fe6a8bc50fb0635a84ebe1296a732e39357c3e1354541bf51a7057b4877e47f9')
|
|
||||||
version('0.9.9', sha256='f1202e6fa60367e2265284a53f35bfa5917119592c2ab08277efc7fffd744fcb')
|
|
||||||
version('0.9.8', sha256='515870b15231530f56fe2164190581748e8799b66ef0fe36ec9da3396f0df6e1')
|
|
||||||
|
|
||||||
variant('socks', default=True,
|
|
||||||
description='Enable SOCKS proxy support')
|
|
||||||
|
|
||||||
depends_on('py-setuptools', type=('build', 'run'))
|
|
||||||
depends_on('py-defusedxml', type=('build', 'run'))
|
|
||||||
depends_on('py-pygments', type=('build', 'run'))
|
|
||||||
depends_on('py-requests', type=('build', 'run'))
|
|
||||||
depends_on('py-requests-toolbelt', type=('build', 'run'))
|
|
||||||
depends_on('py-pysocks', type=('build', 'run'), when="+socks")
|
|
||||||
# Concretization problem breaks this. Unconditional for now...
|
|
||||||
# https://github.com/spack/spack/issues/3628
|
|
||||||
# depends_on('py-argparse@1.2.1:', type=('build', 'run'),
|
|
||||||
# when='^python@:2.6,3.0:3.1')
|
|
||||||
depends_on('py-argparse@1.2.1:', type=('build', 'run'), when='^python@:2.6')
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
# HTTPie on Chocolatey
|
|
||||||
|
|
||||||
Welcome to the documentation about **packaging HTTPie for Chocolatey**.
|
|
||||||
|
|
||||||
- If you do not know HTTPie, have a look [here](https://httpie.io/cli).
|
|
||||||
- If you are looking for HTTPie installation or upgrade instructions on Chocolatey, then you can find them on [that page](https://httpie.io/docs#chocolatey).
|
|
||||||
- If you are looking for technical information about the HTTPie packaging on Chocolatey, then you are in a good place.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
This document contains technical details, where we describe how to create a patch for the latest HTTPie version for Chocolatey.
|
|
||||||
We will discuss setting up the environment, installing development tools, installing and testing changes before submitting a patch downstream.
|
|
||||||
|
|
||||||
## Overall process
|
|
||||||
|
|
||||||
After having successfully [built and tested](#hacking) the package, push it:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Replace 2.5.0 with the correct version
|
|
||||||
choco push httpie.2.5.0.nupkg -s https://push.chocolatey.org/ --api-key=API_KEY
|
|
||||||
```
|
|
||||||
|
|
||||||
## Hacking
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Clone
|
|
||||||
git clone --depth=1 https://github.com/httpie/httpie.git
|
|
||||||
cd httpie/docs/packaging/windows-chocolatey
|
|
||||||
|
|
||||||
# Build
|
|
||||||
choco pack
|
|
||||||
|
|
||||||
# Check metadata
|
|
||||||
choco info httpie -s .
|
|
||||||
|
|
||||||
# Install
|
|
||||||
choco install httpie -y -dv -s "'.;https://community.chocolatey.org/api/v2/'"
|
|
||||||
|
|
||||||
# Test
|
|
||||||
http --version
|
|
||||||
https --version
|
|
||||||
|
|
||||||
# Remove
|
|
||||||
choco uninstall -y httpie
|
|
||||||
```
|
|
||||||
@ -1,50 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
|
|
||||||
<metadata>
|
|
||||||
<id>httpie</id>
|
|
||||||
<version>2.5.0</version>
|
|
||||||
<summary>Modern, user-friendly command-line HTTP client for the API era.</summary>
|
|
||||||
<description>
|
|
||||||
HTTPie *aitch-tee-tee-pie* is a user-friendly command-line HTTP client for the API era.
|
|
||||||
It comes with JSON support, syntax highlighting, persistent sessions, wget-like downloads, plugins, and more.
|
|
||||||
|
|
||||||
The project's goal is to make CLI interaction with web services as human-friendly as possible. HTTPie is designed for testing, debugging, and generally interacting with APIs and HTTP servers.
|
|
||||||
The `http` and `https` commands allow for creating and sending arbitrary HTTP requests. They use simple and natural syntax and provide formatted and colorized output.
|
|
||||||
|
|
||||||
Main features:
|
|
||||||
|
|
||||||
- Built-in JSON support
|
|
||||||
- Colorized and formatted terminal output
|
|
||||||
- Sensible defaults for the API era
|
|
||||||
- Persistent sessions
|
|
||||||
- Forms and file uploads
|
|
||||||
- HTTPS, proxies, and authentication support
|
|
||||||
- Support for arbitrary request data and headers
|
|
||||||
- Wget-like downloads
|
|
||||||
- Extensions API
|
|
||||||
- Expressive and intuitive syntax
|
|
||||||
- Linux, macOS, Windows, and FreeBSD support
|
|
||||||
- All that and more in 2 simple commands: `http` + `https`
|
|
||||||
</description>
|
|
||||||
<title>HTTPie</title>
|
|
||||||
<authors>HTTPie</authors>
|
|
||||||
<owners>Tiger-222</owners>
|
|
||||||
<copyright>2012-2021 Jakub Roztocil</copyright>
|
|
||||||
<licenseUrl>https://raw.githubusercontent.com/httpie/httpie/master/LICENSE</licenseUrl>
|
|
||||||
<iconUrl>https://pie-assets.s3.eu-central-1.amazonaws.com/LogoIcons/GB.png</iconUrl>
|
|
||||||
<requireLicenseAcceptance>false</requireLicenseAcceptance>
|
|
||||||
<releaseNotes>See the [changelog](https://github.com/httpie/httpie/blob/2.5.0/CHANGELOG.md).</releaseNotes>
|
|
||||||
<tags>httpie http https rest api client curl python ssl cli foss oss url</tags>
|
|
||||||
<projectUrl>https://httpie.io</projectUrl>
|
|
||||||
<packageSourceUrl>https://github.com/httpie/httpie</packageSourceUrl>
|
|
||||||
<projectSourceUrl>https://github.com/httpie/httpie</projectSourceUrl>
|
|
||||||
<docsUrl>https://httpie.io/docs</docsUrl>
|
|
||||||
<bugTrackerUrl>https://github.com/httpie/httpie/issues</bugTrackerUrl>
|
|
||||||
<dependencies>
|
|
||||||
<dependency id="python3" version="3.6" />
|
|
||||||
</dependencies>
|
|
||||||
</metadata>
|
|
||||||
<files>
|
|
||||||
<file src="tools\**" target="tools" />
|
|
||||||
</files>
|
|
||||||
</package>
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
$ErrorActionPreference = 'Stop';
|
|
||||||
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
|
|
||||||
$nuspecPath = "$(Join-Path (Split-Path -parent $toolsDir) ($env:ChocolateyPackageName + ".nuspec"))"
|
|
||||||
[XML]$nuspec = Get-Content $nuspecPath
|
|
||||||
$pipVersion = $nuspec.package.metadata.version
|
|
||||||
py -m pip install "$($env:ChocolateyPackageName)==$($pipVersion)" --disable-pip-version-check
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
$ErrorActionPreference = 'Stop';
|
|
||||||
py -m pip uninstall -y $env:ChocolateyPackageName --disable-pip-version-check
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
_http_complete() {
|
|
||||||
local cur_word=${COMP_WORDS[COMP_CWORD]}
|
|
||||||
local prev_word=${COMP_WORDS[COMP_CWORD - 1]}
|
|
||||||
|
|
||||||
if [[ "$cur_word" == -* ]]; then
|
|
||||||
_http_complete_options "$cur_word"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
complete -o default -F _http_complete http
|
|
||||||
|
|
||||||
_http_complete_options() {
|
|
||||||
local cur_word=$1
|
|
||||||
local options="-j --json -f --form --pretty -s --style -p --print
|
|
||||||
-v --verbose -h --headers -b --body -S --stream -o --output -d --download
|
|
||||||
-c --continue --session --session-read-only -a --auth --auth-type --proxy
|
|
||||||
--follow --verify --cert --cert-key --timeout --check-status --ignore-stdin
|
|
||||||
--help --version --traceback --debug --raw"
|
|
||||||
COMPREPLY=( $( compgen -W "$options" -- "$cur_word" ) )
|
|
||||||
}
|
|
||||||
@ -1,137 +0,0 @@
|
|||||||
function __fish_httpie_styles
|
|
||||||
echo "
|
|
||||||
abap
|
|
||||||
algol
|
|
||||||
algol_nu
|
|
||||||
arduino
|
|
||||||
auto
|
|
||||||
autumn
|
|
||||||
borland
|
|
||||||
bw
|
|
||||||
colorful
|
|
||||||
default
|
|
||||||
emacs
|
|
||||||
friendly
|
|
||||||
fruity
|
|
||||||
gruvbox-dark
|
|
||||||
gruvbox-light
|
|
||||||
igor
|
|
||||||
inkpot
|
|
||||||
lovelace
|
|
||||||
manni
|
|
||||||
material
|
|
||||||
monokai
|
|
||||||
murphy
|
|
||||||
native
|
|
||||||
paraiso-dark
|
|
||||||
paraiso-light
|
|
||||||
pastie
|
|
||||||
perldoc
|
|
||||||
rainbow_dash
|
|
||||||
rrt
|
|
||||||
sas
|
|
||||||
solarized
|
|
||||||
solarized-dark
|
|
||||||
solarized-light
|
|
||||||
stata
|
|
||||||
stata-dark
|
|
||||||
stata-light
|
|
||||||
tango
|
|
||||||
trac
|
|
||||||
vim
|
|
||||||
vs
|
|
||||||
xcode
|
|
||||||
zenburn"
|
|
||||||
end
|
|
||||||
|
|
||||||
function __fish_httpie_auth_types
|
|
||||||
echo -e "basic\tBasic HTTP auth"
|
|
||||||
echo -e "digest\tDigest HTTP auth"
|
|
||||||
end
|
|
||||||
|
|
||||||
function __fish_http_verify_options
|
|
||||||
echo -e "yes\tEnable cert verification"
|
|
||||||
echo -e "no\tDisable cert verification"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Predefined Content Types
|
|
||||||
|
|
||||||
complete -c http -s j -l json -d 'Data items are serialized as a JSON object'
|
|
||||||
complete -c http -s f -l form -d 'Data items are serialized as form fields'
|
|
||||||
complete -c http -l multipart -d 'Always sends a multipart/form-data request'
|
|
||||||
complete -c http -l boundary -x -d 'Custom boundary string for multipart/form-data requests'
|
|
||||||
complete -c http -l raw -x -d 'Pass raw request data without extra processing'
|
|
||||||
|
|
||||||
|
|
||||||
# Content Processing Options
|
|
||||||
|
|
||||||
complete -c http -s x -l compress -d 'Content compressed with Deflate algorithm'
|
|
||||||
|
|
||||||
|
|
||||||
# Output Processing
|
|
||||||
|
|
||||||
complete -c http -l pretty -xa "all colors format none" -d 'Controls output processing'
|
|
||||||
complete -c http -s s -l style -xa "(__fish_httpie_styles)" -d 'Output coloring style'
|
|
||||||
complete -c http -l unsorted -d 'Disables all sorting while formatting output'
|
|
||||||
complete -c http -l sorted -d 'Re-enables all sorting options while formatting output'
|
|
||||||
complete -c http -l format-options -x -d 'Controls output formatting'
|
|
||||||
|
|
||||||
|
|
||||||
# Output Options
|
|
||||||
|
|
||||||
complete -c http -s p -l print -x -d 'String specifying what the output should contain'
|
|
||||||
complete -c http -s h -l headers -d 'Print only the response headers'
|
|
||||||
complete -c http -s b -l body -d 'Print only the response body'
|
|
||||||
complete -c http -s v -l verbose -d 'Print the whole request as well as the response'
|
|
||||||
complete -c http -l all -d 'Show any intermediary requests/responses'
|
|
||||||
complete -c http -s P -l history-print -x -d 'The same as --print but applies only to intermediary requests/responses'
|
|
||||||
complete -c http -s S -l stream -d 'Always stream the response body by line'
|
|
||||||
complete -c http -s o -l output -F -d 'Save output to FILE'
|
|
||||||
complete -c http -s d -l download -d 'Download a file'
|
|
||||||
complete -c http -s c -l continue -d 'Resume an interrupted download'
|
|
||||||
complete -c http -s q -l quiet -d 'Do not print to stdout or stderr'
|
|
||||||
|
|
||||||
|
|
||||||
# Sessions
|
|
||||||
|
|
||||||
complete -c http -l session -F -d 'Create, or reuse and update a session'
|
|
||||||
complete -c http -l session-read-only -F -d 'Create or read a session without updating it'
|
|
||||||
|
|
||||||
|
|
||||||
# Authentication
|
|
||||||
|
|
||||||
complete -c http -s a -l auth -x -d 'Username and password for authentication'
|
|
||||||
complete -c http -s A -l auth-type -xa "(__fish_httpie_auth_types)" -d 'The authentication mechanism to be used'
|
|
||||||
complete -c http -l ignore-netrc -d 'Ignore credentials from .netrc'
|
|
||||||
|
|
||||||
|
|
||||||
# Network
|
|
||||||
|
|
||||||
complete -c http -l offline -d 'Build the request and print it but don\'t actually send it'
|
|
||||||
complete -c http -l proxy -x -d 'String mapping protocol to the URL of the proxy'
|
|
||||||
complete -c http -s F -l follow -d 'Follow 30x Location redirects'
|
|
||||||
complete -c http -l max-redirects -x -d 'Set maximum number of redirects'
|
|
||||||
complete -c http -l max-headers -x -d 'Maximum number of response headers to be read before giving up'
|
|
||||||
complete -c http -l timeout -x -d 'Connection timeout in seconds'
|
|
||||||
complete -c http -l check-status -d 'Error with non-200 HTTP status code'
|
|
||||||
complete -c http -l path-as-is -d 'Bypass dot segment URL squashing'
|
|
||||||
complete -c http -l chunked -d ''
|
|
||||||
|
|
||||||
|
|
||||||
# SSL
|
|
||||||
|
|
||||||
complete -c http -l verify -xa "(__fish_http_verify_options)" -d 'Enable/disable cert verification'
|
|
||||||
complete -c http -l ssl -x -d 'Desired protocol version to use'
|
|
||||||
complete -c http -l ciphers -x -d 'String in the OpenSSL cipher list format'
|
|
||||||
complete -c http -l cert -F -d 'Client side SSL certificate'
|
|
||||||
complete -c http -l cert-key -F -d 'Private key to use with SSL'
|
|
||||||
|
|
||||||
|
|
||||||
# Troubleshooting
|
|
||||||
|
|
||||||
complete -c http -s I -l ignore-stdin -d 'Do not attempt to read stdin'
|
|
||||||
complete -c http -l help -d 'Show help'
|
|
||||||
complete -c http -l version -d 'Show version'
|
|
||||||
complete -c http -l traceback -d 'Prints exception traceback should one occur'
|
|
||||||
complete -c http -l default-scheme -x -d 'The default scheme to use'
|
|
||||||
complete -c http -l debug -d 'Show debugging output'
|
|
||||||
BIN
httpie.png
Normal file
BIN
httpie.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 182 KiB |
@ -1,8 +1,19 @@
|
|||||||
"""
|
"""
|
||||||
HTTPie: command-line HTTP client for the API era.
|
HTTPie - a CLI, cURL-like tool for humans.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
__version__ = '2.6.0.dev0'
|
|
||||||
__author__ = 'Jakub Roztocil'
|
__author__ = 'Jakub Roztocil'
|
||||||
|
__version__ = '0.9.2'
|
||||||
__licence__ = 'BSD'
|
__licence__ = 'BSD'
|
||||||
|
|
||||||
|
|
||||||
|
class ExitStatus:
|
||||||
|
"""Exit status code constants."""
|
||||||
|
OK = 0
|
||||||
|
ERROR = 1
|
||||||
|
ERROR_TIMEOUT = 2
|
||||||
|
|
||||||
|
# Used only when requested with --check-status:
|
||||||
|
ERROR_HTTP_3XX = 3
|
||||||
|
ERROR_HTTP_4XX = 4
|
||||||
|
ERROR_HTTP_5XX = 5
|
||||||
|
|||||||
@ -1,19 +1,10 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
"""The main entry point. Invoke as `http' or `python -m httpie'.
|
"""The main entry point. Invoke as `http' or `python -m httpie'.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
import sys
|
||||||
|
from .core import main
|
||||||
|
|
||||||
|
|
||||||
def main():
|
if __name__ == '__main__':
|
||||||
try:
|
|
||||||
from httpie.core import main
|
|
||||||
exit_status = main()
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
from httpie.status import ExitStatus
|
|
||||||
exit_status = ExitStatus.ERROR_CTRL_C
|
|
||||||
|
|
||||||
return exit_status.value
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__': # pragma: nocover
|
|
||||||
import sys
|
|
||||||
sys.exit(main())
|
sys.exit(main())
|
||||||
|
|||||||
570
httpie/cli.py
Normal file
570
httpie/cli.py
Normal file
@ -0,0 +1,570 @@
|
|||||||
|
"""CLI arguments definition.
|
||||||
|
|
||||||
|
NOTE: the CLI interface may change before reaching v1.0.
|
||||||
|
|
||||||
|
"""
|
||||||
|
from textwrap import dedent, wrap
|
||||||
|
#noinspection PyCompatibility
|
||||||
|
from argparse import (RawDescriptionHelpFormatter, FileType,
|
||||||
|
OPTIONAL, ZERO_OR_MORE, SUPPRESS)
|
||||||
|
|
||||||
|
from httpie import __doc__, __version__
|
||||||
|
from httpie.plugins.builtin import BuiltinAuthPlugin
|
||||||
|
from httpie.plugins import plugin_manager
|
||||||
|
from httpie.sessions import DEFAULT_SESSIONS_DIR
|
||||||
|
from httpie.output.formatters.colors import AVAILABLE_STYLES, DEFAULT_STYLE
|
||||||
|
from httpie.input import (Parser, AuthCredentialsArgType, KeyValueArgType,
|
||||||
|
SEP_PROXY, SEP_CREDENTIALS, SEP_GROUP_ALL_ITEMS,
|
||||||
|
OUT_REQ_HEAD, OUT_REQ_BODY, OUT_RESP_HEAD,
|
||||||
|
OUT_RESP_BODY, OUTPUT_OPTIONS,
|
||||||
|
OUTPUT_OPTIONS_DEFAULT, PRETTY_MAP,
|
||||||
|
PRETTY_STDOUT_TTY_ONLY, SessionNameValidator,
|
||||||
|
readable_file_arg)
|
||||||
|
|
||||||
|
|
||||||
|
class HTTPieHelpFormatter(RawDescriptionHelpFormatter):
|
||||||
|
"""A nicer help formatter.
|
||||||
|
|
||||||
|
Help for arguments can be indented and contain new lines.
|
||||||
|
It will be de-dented and arguments in the help
|
||||||
|
will be separated by a blank line for better readability.
|
||||||
|
|
||||||
|
|
||||||
|
"""
|
||||||
|
def __init__(self, max_help_position=6, *args, **kwargs):
|
||||||
|
# A smaller indent for args help.
|
||||||
|
kwargs['max_help_position'] = max_help_position
|
||||||
|
super(HTTPieHelpFormatter, self).__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
def _split_lines(self, text, width):
|
||||||
|
text = dedent(text).strip() + '\n\n'
|
||||||
|
return text.splitlines()
|
||||||
|
|
||||||
|
parser = Parser(
|
||||||
|
formatter_class=HTTPieHelpFormatter,
|
||||||
|
description='%s <http://httpie.org>' % __doc__.strip(),
|
||||||
|
epilog=dedent("""
|
||||||
|
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/jakubroztocil/httpie/issues
|
||||||
|
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Positional arguments.
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
positional = parser.add_argument_group(
|
||||||
|
title='Positional Arguments',
|
||||||
|
description=dedent("""
|
||||||
|
These arguments come after any flags and in the order they are listed here.
|
||||||
|
Only URL is required.
|
||||||
|
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
positional.add_argument(
|
||||||
|
'method',
|
||||||
|
metavar='METHOD',
|
||||||
|
nargs=OPTIONAL,
|
||||||
|
default=None,
|
||||||
|
help="""
|
||||||
|
The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).
|
||||||
|
|
||||||
|
This argument can be omitted in which case HTTPie will use POST if there
|
||||||
|
is some data to be sent, otherwise GET:
|
||||||
|
|
||||||
|
$ http example.org # => GET
|
||||||
|
$ http example.org hello=world # => POST
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
positional.add_argument(
|
||||||
|
'url',
|
||||||
|
metavar='URL',
|
||||||
|
help="""
|
||||||
|
The scheme defaults to 'http://' if the URL does not include one.
|
||||||
|
|
||||||
|
You can also use a shorthand for localhost
|
||||||
|
|
||||||
|
$ http :3000 # => http://localhost:3000
|
||||||
|
$ http :/foo # => http://localhost/foo
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
positional.add_argument(
|
||||||
|
'items',
|
||||||
|
metavar='REQUEST_ITEM',
|
||||||
|
nargs=ZERO_OR_MORE,
|
||||||
|
type=KeyValueArgType(*SEP_GROUP_ALL_ITEMS),
|
||||||
|
help=r"""
|
||||||
|
Optional key-value pairs to be included in the request. The separator used
|
||||||
|
determines the type:
|
||||||
|
|
||||||
|
':' HTTP headers:
|
||||||
|
|
||||||
|
Referer:http://httpie.org Cookie:foo=bar User-Agent:bacon/1.0
|
||||||
|
|
||||||
|
'==' URL parameters to be appended to the request URI:
|
||||||
|
|
||||||
|
search==httpie
|
||||||
|
|
||||||
|
'=' Data fields to be serialized into a JSON object (with --json, -j)
|
||||||
|
or form data (with --form, -f):
|
||||||
|
|
||||||
|
name=HTTPie language=Python description='CLI HTTP client'
|
||||||
|
|
||||||
|
':=' Non-string JSON data fields (only with --json, -j):
|
||||||
|
|
||||||
|
awesome:=true amount:=42 colors:='["red", "green", "blue"]'
|
||||||
|
|
||||||
|
'@' Form file fields (only with --form, -f):
|
||||||
|
|
||||||
|
cs@~/Documents/CV.pdf
|
||||||
|
|
||||||
|
'=@' A data field like '=', but takes a file path and embeds its content:
|
||||||
|
|
||||||
|
essay=@Documents/essay.txt
|
||||||
|
|
||||||
|
':=@' 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\:colon=value
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Content type.
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
content_type = parser.add_argument_group(
|
||||||
|
title='Predefined Content Types',
|
||||||
|
description=None
|
||||||
|
)
|
||||||
|
|
||||||
|
content_type.add_argument(
|
||||||
|
'--json', '-j',
|
||||||
|
action='store_true',
|
||||||
|
help="""
|
||||||
|
(default) Data items from the command line are serialized as a JSON object.
|
||||||
|
The Content-Type and Accept headers are set to application/json
|
||||||
|
(if not specified).
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
content_type.add_argument(
|
||||||
|
'--form', '-f',
|
||||||
|
action='store_true',
|
||||||
|
help="""
|
||||||
|
Data items from the command line are serialized as form fields.
|
||||||
|
|
||||||
|
The Content-Type is set to application/x-www-form-urlencoded (if not
|
||||||
|
specified). The presence of any file fields results in a
|
||||||
|
multipart/form-data request.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Output processing
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
output_processing = parser.add_argument_group(title='Output Processing')
|
||||||
|
|
||||||
|
output_processing.add_argument(
|
||||||
|
'--pretty',
|
||||||
|
dest='prettify',
|
||||||
|
default=PRETTY_STDOUT_TTY_ONLY,
|
||||||
|
choices=sorted(PRETTY_MAP.keys()),
|
||||||
|
help="""
|
||||||
|
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".
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
output_processing.add_argument(
|
||||||
|
'--style', '-s',
|
||||||
|
dest='style',
|
||||||
|
metavar='STYLE',
|
||||||
|
default=DEFAULT_STYLE,
|
||||||
|
choices=AVAILABLE_STYLES,
|
||||||
|
help="""
|
||||||
|
Output coloring style (default is "{default}"). One of:
|
||||||
|
|
||||||
|
{available}
|
||||||
|
|
||||||
|
For this option to work properly, please make sure that the $TERM
|
||||||
|
environment variable is set to "xterm-256color" or similar
|
||||||
|
(e.g., via `export TERM=xterm-256color' in your ~/.bashrc).
|
||||||
|
|
||||||
|
""".format(
|
||||||
|
default=DEFAULT_STYLE,
|
||||||
|
available='\n'.join(
|
||||||
|
'{0}{1}'.format(8*' ', line.strip())
|
||||||
|
for line in wrap(', '.join(sorted(AVAILABLE_STYLES)), 60)
|
||||||
|
).rstrip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Output options
|
||||||
|
#######################################################################
|
||||||
|
output_options = parser.add_argument_group(title='Output Options')
|
||||||
|
|
||||||
|
output_options.add_argument(
|
||||||
|
'--print', '-p',
|
||||||
|
dest='output_options',
|
||||||
|
metavar='WHAT',
|
||||||
|
help="""
|
||||||
|
String specifying what the output should contain:
|
||||||
|
|
||||||
|
'{req_head}' request headers
|
||||||
|
'{req_body}' request body
|
||||||
|
'{res_head}' response headers
|
||||||
|
'{res_body}' response body
|
||||||
|
|
||||||
|
The default behaviour is '{default}' (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.
|
||||||
|
|
||||||
|
"""
|
||||||
|
.format(
|
||||||
|
req_head=OUT_REQ_HEAD,
|
||||||
|
req_body=OUT_REQ_BODY,
|
||||||
|
res_head=OUT_RESP_HEAD,
|
||||||
|
res_body=OUT_RESP_BODY,
|
||||||
|
default=OUTPUT_OPTIONS_DEFAULT,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
output_options.add_argument(
|
||||||
|
'--verbose', '-v',
|
||||||
|
dest='output_options',
|
||||||
|
action='store_const',
|
||||||
|
const=''.join(OUTPUT_OPTIONS),
|
||||||
|
help="""
|
||||||
|
Print the whole request as well as the response. Shortcut for --print={0}.
|
||||||
|
|
||||||
|
"""
|
||||||
|
.format(''.join(OUTPUT_OPTIONS))
|
||||||
|
)
|
||||||
|
output_options.add_argument(
|
||||||
|
'--headers', '-h',
|
||||||
|
dest='output_options',
|
||||||
|
action='store_const',
|
||||||
|
const=OUT_RESP_HEAD,
|
||||||
|
help="""
|
||||||
|
Print only the response headers. Shortcut for --print={0}.
|
||||||
|
|
||||||
|
"""
|
||||||
|
.format(OUT_RESP_HEAD)
|
||||||
|
)
|
||||||
|
output_options.add_argument(
|
||||||
|
'--body', '-b',
|
||||||
|
dest='output_options',
|
||||||
|
action='store_const',
|
||||||
|
const=OUT_RESP_BODY,
|
||||||
|
help="""
|
||||||
|
Print only the response body. Shortcut for --print={0}.
|
||||||
|
|
||||||
|
"""
|
||||||
|
.format(OUT_RESP_BODY)
|
||||||
|
)
|
||||||
|
|
||||||
|
output_options.add_argument(
|
||||||
|
'--stream', '-S',
|
||||||
|
action='store_true',
|
||||||
|
default=False,
|
||||||
|
help="""
|
||||||
|
Always stream the output by line, i.e., behave like `tail -f'.
|
||||||
|
|
||||||
|
Without --stream and with --pretty (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 --pretty: It ensures that the output is flushed
|
||||||
|
more often and in smaller chunks.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
output_options.add_argument(
|
||||||
|
'--output', '-o',
|
||||||
|
type=FileType('a+b'),
|
||||||
|
dest='output_file',
|
||||||
|
metavar='FILE',
|
||||||
|
help="""
|
||||||
|
Save output to FILE. If --download is set, then only the response body is
|
||||||
|
saved to the file. Other parts of the HTTP exchange are printed to stderr.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
)
|
||||||
|
|
||||||
|
output_options.add_argument(
|
||||||
|
'--download', '-d',
|
||||||
|
action='store_true',
|
||||||
|
default=False,
|
||||||
|
help="""
|
||||||
|
Do not print the response body to stdout. Rather, download it and store it
|
||||||
|
in a file. The filename is guessed unless specified with --output
|
||||||
|
[filename]. This action is similar to the default behaviour of wget.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
output_options.add_argument(
|
||||||
|
'--continue', '-c',
|
||||||
|
dest='download_resume',
|
||||||
|
action='store_true',
|
||||||
|
default=False,
|
||||||
|
help="""
|
||||||
|
Resume an interrupted download. Note that the --output option needs to be
|
||||||
|
specified as well.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Sessions
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
sessions = parser.add_argument_group(title='Sessions')\
|
||||||
|
.add_mutually_exclusive_group(required=False)
|
||||||
|
|
||||||
|
session_name_validator = SessionNameValidator(
|
||||||
|
'Session name contains invalid characters.'
|
||||||
|
)
|
||||||
|
|
||||||
|
sessions.add_argument(
|
||||||
|
'--session',
|
||||||
|
metavar='SESSION_NAME_OR_PATH',
|
||||||
|
type=session_name_validator,
|
||||||
|
help="""
|
||||||
|
Create, or reuse and update a session. Within a session, custom headers,
|
||||||
|
auth credential, as well as any cookies sent by the server persist between
|
||||||
|
requests.
|
||||||
|
|
||||||
|
Session files are stored in:
|
||||||
|
|
||||||
|
{session_dir}/<HOST>/<SESSION_NAME>.json.
|
||||||
|
|
||||||
|
"""
|
||||||
|
.format(session_dir=DEFAULT_SESSIONS_DIR)
|
||||||
|
)
|
||||||
|
sessions.add_argument(
|
||||||
|
'--session-read-only',
|
||||||
|
metavar='SESSION_NAME_OR_PATH',
|
||||||
|
type=session_name_validator,
|
||||||
|
help="""
|
||||||
|
Create or read a session without updating it form the request/response
|
||||||
|
exchange.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Authentication
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
# ``requests.request`` keyword arguments.
|
||||||
|
auth = parser.add_argument_group(title='Authentication')
|
||||||
|
auth.add_argument(
|
||||||
|
'--auth', '-a',
|
||||||
|
metavar='USER[:PASS]',
|
||||||
|
type=AuthCredentialsArgType(SEP_CREDENTIALS),
|
||||||
|
help="""
|
||||||
|
If only the username is provided (-a username), HTTPie will prompt
|
||||||
|
for the password.
|
||||||
|
|
||||||
|
""",
|
||||||
|
)
|
||||||
|
|
||||||
|
_auth_plugins = plugin_manager.get_auth_plugins()
|
||||||
|
auth.add_argument(
|
||||||
|
'--auth-type',
|
||||||
|
choices=[plugin.auth_type for plugin in _auth_plugins],
|
||||||
|
default=_auth_plugins[0].auth_type,
|
||||||
|
help="""
|
||||||
|
The authentication mechanism to be used. Defaults to "{default}".
|
||||||
|
|
||||||
|
{types}
|
||||||
|
|
||||||
|
"""
|
||||||
|
.format(default=_auth_plugins[0].auth_type, types='\n '.join(
|
||||||
|
'"{type}": {name}{package}{description}'.format(
|
||||||
|
type=plugin.auth_type,
|
||||||
|
name=plugin.name,
|
||||||
|
package=(
|
||||||
|
'' if issubclass(plugin, BuiltinAuthPlugin)
|
||||||
|
else ' (provided by %s)' % plugin.package_name
|
||||||
|
),
|
||||||
|
description=(
|
||||||
|
'' if not plugin.description else
|
||||||
|
'\n ' + ('\n '.join(wrap(plugin.description)))
|
||||||
|
)
|
||||||
|
)
|
||||||
|
for plugin in _auth_plugins
|
||||||
|
)),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Network
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
network = parser.add_argument_group(title='Network')
|
||||||
|
|
||||||
|
network.add_argument(
|
||||||
|
'--proxy',
|
||||||
|
default=[],
|
||||||
|
action='append',
|
||||||
|
metavar='PROTOCOL:PROXY_URL',
|
||||||
|
type=KeyValueArgType(SEP_PROXY),
|
||||||
|
help="""
|
||||||
|
String mapping protocol to the URL of the proxy
|
||||||
|
(e.g. http:http://foo.bar:3128). You can specify multiple proxies with
|
||||||
|
different protocols.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
network.add_argument(
|
||||||
|
'--follow',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help="""
|
||||||
|
Set this flag if full redirects are allowed (e.g. re-POST-ing of data at
|
||||||
|
new Location).
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
network.add_argument(
|
||||||
|
'--verify',
|
||||||
|
default='yes',
|
||||||
|
help="""
|
||||||
|
Set to "no" to skip checking the host's SSL certificate. You can also pass
|
||||||
|
the path to a CA_BUNDLE file for private certs. You can also set the
|
||||||
|
REQUESTS_CA_BUNDLE environment variable. Defaults to "yes".
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
network.add_argument(
|
||||||
|
'--cert',
|
||||||
|
default=None,
|
||||||
|
type=readable_file_arg,
|
||||||
|
help="""
|
||||||
|
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 --cert-key separately.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
network.add_argument(
|
||||||
|
'--cert-key',
|
||||||
|
default=None,
|
||||||
|
type=readable_file_arg,
|
||||||
|
help="""
|
||||||
|
The private key to use with SSL. Only needed if --cert is given and the
|
||||||
|
certificate file does not contain the private key.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
network.add_argument(
|
||||||
|
'--timeout',
|
||||||
|
type=float,
|
||||||
|
default=30,
|
||||||
|
metavar='SECONDS',
|
||||||
|
help="""
|
||||||
|
The connection timeout of the request in seconds. The default value is
|
||||||
|
30 seconds.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
network.add_argument(
|
||||||
|
'--check-status',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help="""
|
||||||
|
By default, HTTPie exits with 0 when no network or other fatal errors
|
||||||
|
occur. This flag instructs HTTPie to also check the HTTP status code and
|
||||||
|
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 --follow hasn't been set, then the exit status is 3.
|
||||||
|
Also an error message is written to stderr if stdout is redirected.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
#######################################################################
|
||||||
|
# Troubleshooting
|
||||||
|
#######################################################################
|
||||||
|
|
||||||
|
troubleshooting = parser.add_argument_group(title='Troubleshooting')
|
||||||
|
|
||||||
|
troubleshooting.add_argument(
|
||||||
|
'--ignore-stdin',
|
||||||
|
action='store_true',
|
||||||
|
default=False,
|
||||||
|
help="""
|
||||||
|
Do not attempt to read stdin.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
troubleshooting.add_argument(
|
||||||
|
'--help',
|
||||||
|
action='help',
|
||||||
|
default=SUPPRESS,
|
||||||
|
help="""
|
||||||
|
Show this help message and exit.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
troubleshooting.add_argument(
|
||||||
|
'--version',
|
||||||
|
action='version',
|
||||||
|
version=__version__,
|
||||||
|
help="""
|
||||||
|
Show version and exit.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
troubleshooting.add_argument(
|
||||||
|
'--traceback',
|
||||||
|
action='store_true',
|
||||||
|
default=False,
|
||||||
|
help="""
|
||||||
|
Prints exception traceback should one occur.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
troubleshooting.add_argument(
|
||||||
|
'--debug',
|
||||||
|
action='store_true',
|
||||||
|
default=False,
|
||||||
|
help="""
|
||||||
|
Prints exception traceback should one occur, and also other information
|
||||||
|
that is useful for debugging HTTPie itself and for reporting bugs.
|
||||||
|
|
||||||
|
"""
|
||||||
|
)
|
||||||
@ -1,466 +0,0 @@
|
|||||||
import argparse
|
|
||||||
import errno
|
|
||||||
import os
|
|
||||||
import re
|
|
||||||
import sys
|
|
||||||
from argparse import RawDescriptionHelpFormatter
|
|
||||||
from textwrap import dedent
|
|
||||||
from urllib.parse import urlsplit
|
|
||||||
|
|
||||||
from requests.utils import get_netrc_auth
|
|
||||||
|
|
||||||
from .argtypes import (
|
|
||||||
AuthCredentials, KeyValueArgType, PARSED_DEFAULT_FORMAT_OPTIONS,
|
|
||||||
parse_auth,
|
|
||||||
parse_format_options,
|
|
||||||
)
|
|
||||||
from .constants import (
|
|
||||||
HTTP_GET, HTTP_POST, OUTPUT_OPTIONS, OUTPUT_OPTIONS_DEFAULT,
|
|
||||||
OUTPUT_OPTIONS_DEFAULT_OFFLINE, OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED,
|
|
||||||
OUT_RESP_BODY, PRETTY_MAP, PRETTY_STDOUT_TTY_ONLY, RequestType,
|
|
||||||
SEPARATOR_CREDENTIALS,
|
|
||||||
SEPARATOR_GROUP_ALL_ITEMS, SEPARATOR_GROUP_DATA_ITEMS, URL_SCHEME_RE,
|
|
||||||
)
|
|
||||||
from .exceptions import ParseError
|
|
||||||
from .requestitems import RequestItems
|
|
||||||
from ..context import Environment
|
|
||||||
from ..plugins.registry import plugin_manager
|
|
||||||
from ..utils import ExplicitNullAuth, get_content_type
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPieHelpFormatter(RawDescriptionHelpFormatter):
|
|
||||||
"""A nicer help formatter.
|
|
||||||
|
|
||||||
Help for arguments can be indented and contain new lines.
|
|
||||||
It will be de-dented and arguments in the help
|
|
||||||
will be separated by a blank line for better readability.
|
|
||||||
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, max_help_position=6, *args, **kwargs):
|
|
||||||
# A smaller indent for args help.
|
|
||||||
kwargs['max_help_position'] = max_help_position
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
|
|
||||||
def _split_lines(self, text, width):
|
|
||||||
text = dedent(text).strip() + '\n\n'
|
|
||||||
return text.splitlines()
|
|
||||||
|
|
||||||
|
|
||||||
# TODO: refactor and design type-annotated data structures
|
|
||||||
# for raw args + parsed args and keep things immutable.
|
|
||||||
class HTTPieArgumentParser(argparse.ArgumentParser):
|
|
||||||
"""Adds additional logic to `argparse.ArgumentParser`.
|
|
||||||
|
|
||||||
Handles all input (CLI args, file args, stdin), applies defaults,
|
|
||||||
and performs extra validation.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, *args, formatter_class=HTTPieHelpFormatter, **kwargs):
|
|
||||||
kwargs['add_help'] = False
|
|
||||||
super().__init__(*args, formatter_class=formatter_class, **kwargs)
|
|
||||||
self.env = None
|
|
||||||
self.args = None
|
|
||||||
self.has_stdin_data = False
|
|
||||||
self.has_input_data = False
|
|
||||||
|
|
||||||
# noinspection PyMethodOverriding
|
|
||||||
def parse_args(
|
|
||||||
self,
|
|
||||||
env: Environment,
|
|
||||||
args=None,
|
|
||||||
namespace=None
|
|
||||||
) -> argparse.Namespace:
|
|
||||||
self.env = env
|
|
||||||
self.args, no_options = super().parse_known_args(args, namespace)
|
|
||||||
if self.args.prompt:
|
|
||||||
return self.args
|
|
||||||
if self.args.debug:
|
|
||||||
self.args.traceback = True
|
|
||||||
self.has_stdin_data = (
|
|
||||||
self.env.stdin
|
|
||||||
and not self.args.ignore_stdin
|
|
||||||
and not self.env.stdin_isatty
|
|
||||||
)
|
|
||||||
self.has_input_data = self.has_stdin_data or self.args.raw is not None
|
|
||||||
# Arguments processing and environment setup.
|
|
||||||
self._apply_no_options(no_options)
|
|
||||||
self._process_request_type()
|
|
||||||
self._process_download_options()
|
|
||||||
self._setup_standard_streams()
|
|
||||||
self._process_output_options()
|
|
||||||
self._process_pretty_options()
|
|
||||||
self._process_format_options()
|
|
||||||
self._guess_method()
|
|
||||||
self._parse_items()
|
|
||||||
self._process_url()
|
|
||||||
self._process_auth()
|
|
||||||
|
|
||||||
if self.args.raw is not None:
|
|
||||||
self._body_from_input(self.args.raw)
|
|
||||||
elif self.has_stdin_data:
|
|
||||||
self._body_from_file(self.env.stdin)
|
|
||||||
|
|
||||||
if self.args.compress:
|
|
||||||
# TODO: allow --compress with --chunked / --multipart
|
|
||||||
if self.args.chunked:
|
|
||||||
self.error('cannot combine --compress and --chunked')
|
|
||||||
if self.args.multipart:
|
|
||||||
self.error('cannot combine --compress and --multipart')
|
|
||||||
|
|
||||||
return self.args
|
|
||||||
|
|
||||||
def _process_request_type(self):
|
|
||||||
request_type = self.args.request_type
|
|
||||||
self.args.json = request_type is RequestType.JSON
|
|
||||||
self.args.multipart = request_type is RequestType.MULTIPART
|
|
||||||
self.args.form = request_type in {
|
|
||||||
RequestType.FORM,
|
|
||||||
RequestType.MULTIPART,
|
|
||||||
}
|
|
||||||
|
|
||||||
def _process_url(self):
|
|
||||||
if not URL_SCHEME_RE.match(self.args.url):
|
|
||||||
if os.path.basename(self.env.program_name) == 'https':
|
|
||||||
scheme = 'https://'
|
|
||||||
else:
|
|
||||||
scheme = self.args.default_scheme + '://'
|
|
||||||
|
|
||||||
# See if we're using curl style shorthand for localhost (:3000/foo)
|
|
||||||
shorthand = re.match(r'^:(?!:)(\d*)(/?.*)$', self.args.url)
|
|
||||||
if shorthand:
|
|
||||||
port = shorthand.group(1)
|
|
||||||
rest = shorthand.group(2)
|
|
||||||
self.args.url = scheme + 'localhost'
|
|
||||||
if port:
|
|
||||||
self.args.url += ':' + port
|
|
||||||
self.args.url += rest
|
|
||||||
else:
|
|
||||||
self.args.url = scheme + self.args.url
|
|
||||||
|
|
||||||
# noinspection PyShadowingBuiltins
|
|
||||||
def _print_message(self, message, file=None):
|
|
||||||
# Sneak in our stderr/stdout.
|
|
||||||
file = {
|
|
||||||
sys.stdout: self.env.stdout,
|
|
||||||
sys.stderr: self.env.stderr,
|
|
||||||
None: self.env.stderr
|
|
||||||
}.get(file, file)
|
|
||||||
if not hasattr(file, 'buffer') and isinstance(message, str):
|
|
||||||
message = message.encode(self.env.stdout_encoding)
|
|
||||||
super()._print_message(message, file)
|
|
||||||
|
|
||||||
def _setup_standard_streams(self):
|
|
||||||
"""
|
|
||||||
Modify `env.stdout` and `env.stdout_isatty` based on args, if needed.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
self.args.output_file_specified = bool(self.args.output_file)
|
|
||||||
if self.args.download:
|
|
||||||
# FIXME: Come up with a cleaner solution.
|
|
||||||
if not self.args.output_file and not self.env.stdout_isatty:
|
|
||||||
# Use stdout as the download output file.
|
|
||||||
self.args.output_file = self.env.stdout
|
|
||||||
# With `--download`, we write everything that would normally go to
|
|
||||||
# `stdout` to `stderr` instead. Let's replace the stream so that
|
|
||||||
# we don't have to use many `if`s throughout the codebase.
|
|
||||||
# The response body will be treated separately.
|
|
||||||
self.env.stdout = self.env.stderr
|
|
||||||
self.env.stdout_isatty = self.env.stderr_isatty
|
|
||||||
|
|
||||||
elif self.args.output_file:
|
|
||||||
# When not `--download`ing, then `--output` simply replaces
|
|
||||||
# `stdout`. The file is opened for appending, which isn't what
|
|
||||||
# we want in this case.
|
|
||||||
self.args.output_file.seek(0)
|
|
||||||
try:
|
|
||||||
self.args.output_file.truncate()
|
|
||||||
except OSError as e:
|
|
||||||
if e.errno == errno.EINVAL:
|
|
||||||
# E.g. /dev/null on Linux.
|
|
||||||
pass
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
self.env.stdout = self.args.output_file
|
|
||||||
self.env.stdout_isatty = False
|
|
||||||
|
|
||||||
if self.args.quiet:
|
|
||||||
self.env.stderr = self.env.devnull
|
|
||||||
if not (self.args.output_file_specified and not self.args.download):
|
|
||||||
self.env.stdout = self.env.devnull
|
|
||||||
|
|
||||||
def _process_auth(self):
|
|
||||||
# TODO: refactor & simplify this method.
|
|
||||||
self.args.auth_plugin = None
|
|
||||||
default_auth_plugin = plugin_manager.get_auth_plugins()[0]
|
|
||||||
auth_type_set = self.args.auth_type is not None
|
|
||||||
url = urlsplit(self.args.url)
|
|
||||||
|
|
||||||
if self.args.auth is None and not auth_type_set:
|
|
||||||
if url.username is not None:
|
|
||||||
# Handle http://username:password@hostname/
|
|
||||||
username = url.username
|
|
||||||
password = url.password or ''
|
|
||||||
self.args.auth = AuthCredentials(
|
|
||||||
key=username,
|
|
||||||
value=password,
|
|
||||||
sep=SEPARATOR_CREDENTIALS,
|
|
||||||
orig=SEPARATOR_CREDENTIALS.join([username, password])
|
|
||||||
)
|
|
||||||
|
|
||||||
if self.args.auth is not None or auth_type_set:
|
|
||||||
if not self.args.auth_type:
|
|
||||||
self.args.auth_type = default_auth_plugin.auth_type
|
|
||||||
plugin = plugin_manager.get_auth_plugin(self.args.auth_type)()
|
|
||||||
|
|
||||||
if (not self.args.ignore_netrc
|
|
||||||
and self.args.auth is None
|
|
||||||
and plugin.netrc_parse):
|
|
||||||
# Only host needed, so it’s OK URL not finalized.
|
|
||||||
netrc_credentials = get_netrc_auth(self.args.url)
|
|
||||||
if netrc_credentials:
|
|
||||||
self.args.auth = AuthCredentials(
|
|
||||||
key=netrc_credentials[0],
|
|
||||||
value=netrc_credentials[1],
|
|
||||||
sep=SEPARATOR_CREDENTIALS,
|
|
||||||
orig=SEPARATOR_CREDENTIALS.join(netrc_credentials)
|
|
||||||
)
|
|
||||||
|
|
||||||
if plugin.auth_require and self.args.auth is None:
|
|
||||||
self.error('--auth required')
|
|
||||||
|
|
||||||
plugin.raw_auth = self.args.auth
|
|
||||||
self.args.auth_plugin = plugin
|
|
||||||
already_parsed = isinstance(self.args.auth, AuthCredentials)
|
|
||||||
|
|
||||||
if self.args.auth is None or not plugin.auth_parse:
|
|
||||||
self.args.auth = plugin.get_auth()
|
|
||||||
else:
|
|
||||||
if already_parsed:
|
|
||||||
# from the URL
|
|
||||||
credentials = self.args.auth
|
|
||||||
else:
|
|
||||||
credentials = parse_auth(self.args.auth)
|
|
||||||
|
|
||||||
if (not credentials.has_password()
|
|
||||||
and plugin.prompt_password):
|
|
||||||
if self.args.ignore_stdin:
|
|
||||||
# Non-tty stdin read by now
|
|
||||||
self.error(
|
|
||||||
'Unable to prompt for passwords because'
|
|
||||||
' --ignore-stdin is set.'
|
|
||||||
)
|
|
||||||
credentials.prompt_password(url.netloc)
|
|
||||||
self.args.auth = plugin.get_auth(
|
|
||||||
username=credentials.key,
|
|
||||||
password=credentials.value,
|
|
||||||
)
|
|
||||||
if not self.args.auth and self.args.ignore_netrc:
|
|
||||||
# Set a no-op auth to force requests to ignore .netrc
|
|
||||||
# <https://github.com/psf/requests/issues/2773#issuecomment-174312831>
|
|
||||||
self.args.auth = ExplicitNullAuth()
|
|
||||||
|
|
||||||
def _apply_no_options(self, no_options):
|
|
||||||
"""For every `--no-OPTION` in `no_options`, set `args.OPTION` to
|
|
||||||
its default value. This allows for un-setting of options, e.g.,
|
|
||||||
specified in config.
|
|
||||||
|
|
||||||
"""
|
|
||||||
invalid = []
|
|
||||||
|
|
||||||
for option in no_options:
|
|
||||||
if not option.startswith('--no-'):
|
|
||||||
invalid.append(option)
|
|
||||||
continue
|
|
||||||
|
|
||||||
# --no-option => --option
|
|
||||||
inverted = '--' + option[5:]
|
|
||||||
for action in self._actions:
|
|
||||||
if inverted in action.option_strings:
|
|
||||||
setattr(self.args, action.dest, action.default)
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
invalid.append(option)
|
|
||||||
|
|
||||||
if invalid:
|
|
||||||
self.error(f'unrecognized arguments: {" ".join(invalid)}')
|
|
||||||
|
|
||||||
def _body_from_file(self, fd):
|
|
||||||
"""Read the data from a file-like object.
|
|
||||||
|
|
||||||
Bytes are always read.
|
|
||||||
|
|
||||||
"""
|
|
||||||
self._ensure_one_data_source(self.args.data, self.args.files)
|
|
||||||
self.args.data = getattr(fd, 'buffer', fd)
|
|
||||||
|
|
||||||
def _body_from_input(self, data):
|
|
||||||
"""Read the data from the CLI.
|
|
||||||
|
|
||||||
"""
|
|
||||||
self._ensure_one_data_source(self.has_stdin_data, self.args.data,
|
|
||||||
self.args.files)
|
|
||||||
self.args.data = data.encode()
|
|
||||||
|
|
||||||
def _ensure_one_data_source(self, *other_sources):
|
|
||||||
"""There can only be one source of input request data.
|
|
||||||
|
|
||||||
"""
|
|
||||||
if any(other_sources):
|
|
||||||
self.error('Request body (from stdin, --raw or a file) and request '
|
|
||||||
'data (key=value) cannot be mixed. Pass '
|
|
||||||
'--ignore-stdin to let key/value take priority. '
|
|
||||||
'See https://httpie.io/docs#scripting for details.')
|
|
||||||
|
|
||||||
def _guess_method(self):
|
|
||||||
"""Set `args.method` if not specified to either POST or GET
|
|
||||||
based on whether the request has data or not.
|
|
||||||
|
|
||||||
"""
|
|
||||||
if self.args.method is None:
|
|
||||||
# Invoked as `http URL'.
|
|
||||||
assert not self.args.request_items
|
|
||||||
if self.has_input_data:
|
|
||||||
self.args.method = HTTP_POST
|
|
||||||
else:
|
|
||||||
self.args.method = HTTP_GET
|
|
||||||
|
|
||||||
# FIXME: False positive, e.g., "localhost" matches but is a valid URL.
|
|
||||||
elif not re.match('^[a-zA-Z]+$', self.args.method):
|
|
||||||
# Invoked as `http URL item+'. The URL is now in `args.method`
|
|
||||||
# and the first ITEM is now incorrectly in `args.url`.
|
|
||||||
try:
|
|
||||||
# Parse the URL as an ITEM and store it as the first ITEM arg.
|
|
||||||
self.args.request_items.insert(0, KeyValueArgType(
|
|
||||||
*SEPARATOR_GROUP_ALL_ITEMS).__call__(self.args.url))
|
|
||||||
|
|
||||||
except argparse.ArgumentTypeError as e:
|
|
||||||
if self.args.traceback:
|
|
||||||
raise
|
|
||||||
self.error(e.args[0])
|
|
||||||
|
|
||||||
else:
|
|
||||||
# Set the URL correctly
|
|
||||||
self.args.url = self.args.method
|
|
||||||
# Infer the method
|
|
||||||
has_data = (
|
|
||||||
self.has_input_data
|
|
||||||
or any(
|
|
||||||
item.sep in SEPARATOR_GROUP_DATA_ITEMS
|
|
||||||
for item in self.args.request_items)
|
|
||||||
)
|
|
||||||
self.args.method = HTTP_POST if has_data else HTTP_GET
|
|
||||||
|
|
||||||
def _parse_items(self):
|
|
||||||
"""
|
|
||||||
Parse `args.request_items` into `args.headers`, `args.data`,
|
|
||||||
`args.params`, and `args.files`.
|
|
||||||
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
request_items = RequestItems.from_args(
|
|
||||||
request_item_args=self.args.request_items,
|
|
||||||
as_form=self.args.form,
|
|
||||||
)
|
|
||||||
except ParseError as e:
|
|
||||||
if self.args.traceback:
|
|
||||||
raise
|
|
||||||
self.error(e.args[0])
|
|
||||||
else:
|
|
||||||
self.args.headers = request_items.headers
|
|
||||||
self.args.data = request_items.data
|
|
||||||
self.args.files = request_items.files
|
|
||||||
self.args.params = request_items.params
|
|
||||||
self.args.multipart_data = request_items.multipart_data
|
|
||||||
|
|
||||||
if self.args.files and not self.args.form:
|
|
||||||
# `http url @/path/to/file`
|
|
||||||
request_file = None
|
|
||||||
for key, file in self.args.files.items():
|
|
||||||
if key != '':
|
|
||||||
self.error(
|
|
||||||
'Invalid file fields (perhaps you meant --form?):'
|
|
||||||
f' {",".join(self.args.files.keys())}')
|
|
||||||
if request_file is not None:
|
|
||||||
self.error("Can't read request from multiple files")
|
|
||||||
request_file = file
|
|
||||||
|
|
||||||
fn, fd, ct = request_file
|
|
||||||
self.args.files = {}
|
|
||||||
|
|
||||||
self._body_from_file(fd)
|
|
||||||
|
|
||||||
if 'Content-Type' not in self.args.headers:
|
|
||||||
content_type = get_content_type(fn)
|
|
||||||
if content_type:
|
|
||||||
self.args.headers['Content-Type'] = content_type
|
|
||||||
|
|
||||||
def _process_output_options(self):
|
|
||||||
"""Apply defaults to output options, or validate the provided ones.
|
|
||||||
|
|
||||||
The default output options are stdout-type-sensitive.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
def check_options(value, option):
|
|
||||||
unknown = set(value) - OUTPUT_OPTIONS
|
|
||||||
if unknown:
|
|
||||||
self.error(f'Unknown output options: {option}={",".join(unknown)}')
|
|
||||||
|
|
||||||
if self.args.verbose:
|
|
||||||
self.args.all = True
|
|
||||||
|
|
||||||
if self.args.output_options is None:
|
|
||||||
if self.args.verbose:
|
|
||||||
self.args.output_options = ''.join(OUTPUT_OPTIONS)
|
|
||||||
elif self.args.offline:
|
|
||||||
self.args.output_options = OUTPUT_OPTIONS_DEFAULT_OFFLINE
|
|
||||||
elif not self.env.stdout_isatty:
|
|
||||||
self.args.output_options = OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED
|
|
||||||
else:
|
|
||||||
self.args.output_options = OUTPUT_OPTIONS_DEFAULT
|
|
||||||
|
|
||||||
if self.args.output_options_history is None:
|
|
||||||
self.args.output_options_history = self.args.output_options
|
|
||||||
|
|
||||||
check_options(self.args.output_options, '--print')
|
|
||||||
check_options(self.args.output_options_history, '--history-print')
|
|
||||||
|
|
||||||
if self.args.download and OUT_RESP_BODY in self.args.output_options:
|
|
||||||
# Response body is always downloaded with --download and it goes
|
|
||||||
# through a different routine, so we remove it.
|
|
||||||
self.args.output_options = str(
|
|
||||||
set(self.args.output_options) - set(OUT_RESP_BODY))
|
|
||||||
|
|
||||||
def _process_pretty_options(self):
|
|
||||||
if self.args.prettify == PRETTY_STDOUT_TTY_ONLY:
|
|
||||||
self.args.prettify = PRETTY_MAP[
|
|
||||||
'all' if self.env.stdout_isatty else 'none']
|
|
||||||
elif (self.args.prettify and self.env.is_windows
|
|
||||||
and self.args.output_file):
|
|
||||||
self.error('Only terminal output can be colorized on Windows.')
|
|
||||||
else:
|
|
||||||
# noinspection PyTypeChecker
|
|
||||||
self.args.prettify = PRETTY_MAP[self.args.prettify]
|
|
||||||
|
|
||||||
def _process_download_options(self):
|
|
||||||
if self.args.offline:
|
|
||||||
self.args.download = False
|
|
||||||
self.args.download_resume = False
|
|
||||||
return
|
|
||||||
if not self.args.download:
|
|
||||||
if self.args.download_resume:
|
|
||||||
self.error('--continue only works with --download')
|
|
||||||
if self.args.download_resume and not (
|
|
||||||
self.args.download and self.args.output_file):
|
|
||||||
self.error('--continue requires --output to be specified')
|
|
||||||
|
|
||||||
def _process_format_options(self):
|
|
||||||
format_options = self.args.format_options or []
|
|
||||||
parsed_options = PARSED_DEFAULT_FORMAT_OPTIONS
|
|
||||||
for options_group in format_options:
|
|
||||||
parsed_options = parse_format_options(options_group, defaults=parsed_options)
|
|
||||||
self.args.format_options = parsed_options
|
|
||||||
@ -1,260 +0,0 @@
|
|||||||
import argparse
|
|
||||||
import getpass
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
from copy import deepcopy
|
|
||||||
from typing import List, Optional, Union
|
|
||||||
|
|
||||||
from .constants import DEFAULT_FORMAT_OPTIONS, SEPARATOR_CREDENTIALS
|
|
||||||
from ..sessions import VALID_SESSION_NAME_PATTERN
|
|
||||||
|
|
||||||
|
|
||||||
class KeyValueArg:
|
|
||||||
"""Base key-value pair parsed from CLI."""
|
|
||||||
|
|
||||||
def __init__(self, key: str, value: Optional[str], sep: str, orig: str):
|
|
||||||
self.key = key
|
|
||||||
self.value = value
|
|
||||||
self.sep = sep
|
|
||||||
self.orig = orig
|
|
||||||
|
|
||||||
def __eq__(self, other: 'KeyValueArg'):
|
|
||||||
return self.__dict__ == other.__dict__
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return repr(self.__dict__)
|
|
||||||
|
|
||||||
|
|
||||||
class SessionNameValidator:
|
|
||||||
|
|
||||||
def __init__(self, error_message: str):
|
|
||||||
self.error_message = error_message
|
|
||||||
|
|
||||||
def __call__(self, value: str) -> str:
|
|
||||||
# Session name can be a path or just a name.
|
|
||||||
if (os.path.sep not in value
|
|
||||||
and not VALID_SESSION_NAME_PATTERN.search(value)):
|
|
||||||
raise argparse.ArgumentError(None, self.error_message)
|
|
||||||
return value
|
|
||||||
|
|
||||||
|
|
||||||
class Escaped(str):
|
|
||||||
"""Represents an escaped character."""
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return f"Escaped({repr(str(self))})"
|
|
||||||
|
|
||||||
|
|
||||||
class KeyValueArgType:
|
|
||||||
"""A key-value pair argument type used with `argparse`.
|
|
||||||
|
|
||||||
Parses a key-value arg and constructs a `KeyValueArg` instance.
|
|
||||||
Used for headers, form data, and other key-value pair types.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
key_value_class = KeyValueArg
|
|
||||||
|
|
||||||
def __init__(self, *separators: str):
|
|
||||||
self.separators = separators
|
|
||||||
self.special_characters = set('\\')
|
|
||||||
for separator in separators:
|
|
||||||
self.special_characters.update(separator)
|
|
||||||
|
|
||||||
def __call__(self, s: str) -> KeyValueArg:
|
|
||||||
"""Parse raw string arg and return `self.key_value_class` instance.
|
|
||||||
|
|
||||||
The best of `self.separators` is determined (first found, longest).
|
|
||||||
Back slash escaped characters aren't considered as separators
|
|
||||||
(or parts thereof). Literal back slash characters have to be escaped
|
|
||||||
as well (r'\\').
|
|
||||||
|
|
||||||
"""
|
|
||||||
tokens = self.tokenize(s)
|
|
||||||
|
|
||||||
# Sorting by length ensures that the longest one will be
|
|
||||||
# chosen as it will overwrite any shorter ones starting
|
|
||||||
# at the same position in the `found` dictionary.
|
|
||||||
separators = sorted(self.separators, key=len)
|
|
||||||
|
|
||||||
for i, token in enumerate(tokens):
|
|
||||||
|
|
||||||
if isinstance(token, Escaped):
|
|
||||||
continue
|
|
||||||
|
|
||||||
found = {}
|
|
||||||
for sep in separators:
|
|
||||||
pos = token.find(sep)
|
|
||||||
if pos != -1:
|
|
||||||
found[pos] = sep
|
|
||||||
|
|
||||||
if found:
|
|
||||||
# Starting first, longest separator found.
|
|
||||||
sep = found[min(found.keys())]
|
|
||||||
|
|
||||||
key, value = token.split(sep, 1)
|
|
||||||
|
|
||||||
# Any preceding tokens are part of the key.
|
|
||||||
key = ''.join(tokens[:i]) + key
|
|
||||||
|
|
||||||
# Any following tokens are part of the value.
|
|
||||||
value += ''.join(tokens[i + 1:])
|
|
||||||
|
|
||||||
break
|
|
||||||
|
|
||||||
else:
|
|
||||||
raise argparse.ArgumentTypeError(f'{s!r} is not a valid value')
|
|
||||||
|
|
||||||
return self.key_value_class(key=key, value=value, sep=sep, orig=s)
|
|
||||||
|
|
||||||
def tokenize(self, s: str) -> List[Union[str, Escaped]]:
|
|
||||||
r"""Tokenize the raw arg string
|
|
||||||
|
|
||||||
There are only two token types - strings and escaped characters:
|
|
||||||
|
|
||||||
>>> KeyValueArgType('=').tokenize(r'foo\=bar\\baz')
|
|
||||||
['foo', Escaped('='), 'bar', Escaped('\\'), 'baz']
|
|
||||||
|
|
||||||
"""
|
|
||||||
tokens = ['']
|
|
||||||
characters = iter(s)
|
|
||||||
for char in characters:
|
|
||||||
if char == '\\':
|
|
||||||
char = next(characters, '')
|
|
||||||
if char not in self.special_characters:
|
|
||||||
tokens[-1] += '\\' + char
|
|
||||||
else:
|
|
||||||
tokens.extend([Escaped(char), ''])
|
|
||||||
else:
|
|
||||||
tokens[-1] += char
|
|
||||||
return tokens
|
|
||||||
|
|
||||||
|
|
||||||
class AuthCredentials(KeyValueArg):
|
|
||||||
"""Represents parsed credentials."""
|
|
||||||
|
|
||||||
def has_password(self) -> bool:
|
|
||||||
return self.value is not None
|
|
||||||
|
|
||||||
def prompt_password(self, host: str):
|
|
||||||
prompt_text = f'http: password for {self.key}@{host}: '
|
|
||||||
try:
|
|
||||||
self.value = self._getpass(prompt_text)
|
|
||||||
except (EOFError, KeyboardInterrupt):
|
|
||||||
sys.stderr.write('\n')
|
|
||||||
sys.exit(0)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _getpass(prompt):
|
|
||||||
# To allow easy mocking.
|
|
||||||
return getpass.getpass(str(prompt))
|
|
||||||
|
|
||||||
|
|
||||||
class AuthCredentialsArgType(KeyValueArgType):
|
|
||||||
"""A key-value arg type that parses credentials."""
|
|
||||||
|
|
||||||
key_value_class = AuthCredentials
|
|
||||||
|
|
||||||
def __call__(self, s):
|
|
||||||
"""Parse credentials from `s`.
|
|
||||||
|
|
||||||
("username" or "username:password").
|
|
||||||
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
return super().__call__(s)
|
|
||||||
except argparse.ArgumentTypeError:
|
|
||||||
# No password provided, will prompt for it later.
|
|
||||||
return self.key_value_class(
|
|
||||||
key=s,
|
|
||||||
value=None,
|
|
||||||
sep=SEPARATOR_CREDENTIALS,
|
|
||||||
orig=s
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
parse_auth = AuthCredentialsArgType(SEPARATOR_CREDENTIALS)
|
|
||||||
|
|
||||||
|
|
||||||
def readable_file_arg(filename):
|
|
||||||
try:
|
|
||||||
with open(filename, 'rb'):
|
|
||||||
return filename
|
|
||||||
except OSError as ex:
|
|
||||||
raise argparse.ArgumentTypeError(f'{ex.filename}: {ex.strerror}')
|
|
||||||
|
|
||||||
|
|
||||||
def parse_format_options(s: str, defaults: Optional[dict]) -> dict:
|
|
||||||
"""
|
|
||||||
Parse `s` and update `defaults` with the parsed values.
|
|
||||||
|
|
||||||
>>> parse_format_options(
|
|
||||||
... defaults={'json': {'indent': 4, 'sort_keys': True}},
|
|
||||||
... s='json.indent:2,json.sort_keys:False',
|
|
||||||
... )
|
|
||||||
{'json': {'indent': 2, 'sort_keys': False}}
|
|
||||||
|
|
||||||
"""
|
|
||||||
value_map = {
|
|
||||||
'true': True,
|
|
||||||
'false': False,
|
|
||||||
}
|
|
||||||
options = deepcopy(defaults or {})
|
|
||||||
for option in s.split(','):
|
|
||||||
try:
|
|
||||||
path, value = option.lower().split(':')
|
|
||||||
section, key = path.split('.')
|
|
||||||
except ValueError:
|
|
||||||
raise argparse.ArgumentTypeError(f'invalid option {option!r}')
|
|
||||||
|
|
||||||
if value in value_map:
|
|
||||||
parsed_value = value_map[value]
|
|
||||||
else:
|
|
||||||
if value.isnumeric():
|
|
||||||
parsed_value = int(value)
|
|
||||||
else:
|
|
||||||
parsed_value = value
|
|
||||||
|
|
||||||
if defaults is None:
|
|
||||||
options.setdefault(section, {})
|
|
||||||
else:
|
|
||||||
try:
|
|
||||||
default_value = defaults[section][key]
|
|
||||||
except KeyError:
|
|
||||||
raise argparse.ArgumentTypeError(
|
|
||||||
f'invalid key {path!r}')
|
|
||||||
|
|
||||||
default_type, parsed_type = type(default_value), type(parsed_value)
|
|
||||||
if parsed_type is not default_type:
|
|
||||||
raise argparse.ArgumentTypeError(
|
|
||||||
'invalid value'
|
|
||||||
f' {value!r} in {option!r}'
|
|
||||||
f' (expected {default_type.__name__}'
|
|
||||||
f' got {parsed_type.__name__})'
|
|
||||||
)
|
|
||||||
|
|
||||||
options[section][key] = parsed_value
|
|
||||||
|
|
||||||
return options
|
|
||||||
|
|
||||||
|
|
||||||
PARSED_DEFAULT_FORMAT_OPTIONS = parse_format_options(
|
|
||||||
s=','.join(DEFAULT_FORMAT_OPTIONS),
|
|
||||||
defaults=None,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def response_charset_type(encoding: str) -> str:
|
|
||||||
try:
|
|
||||||
''.encode(encoding)
|
|
||||||
except LookupError:
|
|
||||||
raise argparse.ArgumentTypeError(
|
|
||||||
f'{encoding!r} is not a supported encoding')
|
|
||||||
return encoding
|
|
||||||
|
|
||||||
|
|
||||||
def response_mime_type(mime_type: str) -> str:
|
|
||||||
if mime_type.count('/') != 1:
|
|
||||||
raise argparse.ArgumentTypeError(
|
|
||||||
f'{mime_type!r} doesn’t look like a mime type; use type/subtype')
|
|
||||||
return mime_type
|
|
||||||
@ -1,113 +0,0 @@
|
|||||||
"""Parsing and processing of CLI input (args, auth credentials, files, stdin).
|
|
||||||
|
|
||||||
"""
|
|
||||||
import enum
|
|
||||||
import re
|
|
||||||
|
|
||||||
|
|
||||||
URL_SCHEME_RE = re.compile(r'^[a-z][a-z0-9.+-]*://', re.IGNORECASE)
|
|
||||||
|
|
||||||
HTTP_POST = 'POST'
|
|
||||||
HTTP_GET = 'GET'
|
|
||||||
|
|
||||||
# Various separators used in args
|
|
||||||
SEPARATOR_HEADER = ':'
|
|
||||||
SEPARATOR_HEADER_EMPTY = ';'
|
|
||||||
SEPARATOR_CREDENTIALS = ':'
|
|
||||||
SEPARATOR_PROXY = ':'
|
|
||||||
SEPARATOR_DATA_STRING = '='
|
|
||||||
SEPARATOR_DATA_RAW_JSON = ':='
|
|
||||||
SEPARATOR_FILE_UPLOAD = '@'
|
|
||||||
SEPARATOR_FILE_UPLOAD_TYPE = ';type=' # in already parsed file upload path only
|
|
||||||
SEPARATOR_DATA_EMBED_FILE_CONTENTS = '=@'
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE = ':=@'
|
|
||||||
SEPARATOR_QUERY_PARAM = '=='
|
|
||||||
|
|
||||||
# Separators that become request data
|
|
||||||
SEPARATOR_GROUP_DATA_ITEMS = frozenset({
|
|
||||||
SEPARATOR_DATA_STRING,
|
|
||||||
SEPARATOR_DATA_RAW_JSON,
|
|
||||||
SEPARATOR_FILE_UPLOAD,
|
|
||||||
SEPARATOR_DATA_EMBED_FILE_CONTENTS,
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE
|
|
||||||
})
|
|
||||||
|
|
||||||
SEPARATORS_GROUP_MULTIPART = frozenset({
|
|
||||||
SEPARATOR_DATA_STRING,
|
|
||||||
SEPARATOR_DATA_EMBED_FILE_CONTENTS,
|
|
||||||
SEPARATOR_FILE_UPLOAD,
|
|
||||||
})
|
|
||||||
|
|
||||||
# Separators for items whose value is a filename to be embedded
|
|
||||||
SEPARATOR_GROUP_DATA_EMBED_ITEMS = frozenset({
|
|
||||||
SEPARATOR_DATA_EMBED_FILE_CONTENTS,
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE,
|
|
||||||
})
|
|
||||||
|
|
||||||
# Separators for raw JSON items
|
|
||||||
SEPARATOR_GROUP_RAW_JSON_ITEMS = frozenset([
|
|
||||||
SEPARATOR_DATA_RAW_JSON,
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE,
|
|
||||||
])
|
|
||||||
|
|
||||||
# Separators allowed in ITEM arguments
|
|
||||||
SEPARATOR_GROUP_ALL_ITEMS = frozenset({
|
|
||||||
SEPARATOR_HEADER,
|
|
||||||
SEPARATOR_HEADER_EMPTY,
|
|
||||||
SEPARATOR_QUERY_PARAM,
|
|
||||||
SEPARATOR_DATA_STRING,
|
|
||||||
SEPARATOR_DATA_RAW_JSON,
|
|
||||||
SEPARATOR_FILE_UPLOAD,
|
|
||||||
SEPARATOR_DATA_EMBED_FILE_CONTENTS,
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE,
|
|
||||||
})
|
|
||||||
|
|
||||||
# Output options
|
|
||||||
OUT_REQ_HEAD = 'H'
|
|
||||||
OUT_REQ_BODY = 'B'
|
|
||||||
OUT_RESP_HEAD = 'h'
|
|
||||||
OUT_RESP_BODY = 'b'
|
|
||||||
|
|
||||||
OUTPUT_OPTIONS = frozenset({
|
|
||||||
OUT_REQ_HEAD,
|
|
||||||
OUT_REQ_BODY,
|
|
||||||
OUT_RESP_HEAD,
|
|
||||||
OUT_RESP_BODY
|
|
||||||
})
|
|
||||||
|
|
||||||
# Pretty
|
|
||||||
PRETTY_MAP = {
|
|
||||||
'all': ['format', 'colors'],
|
|
||||||
'colors': ['colors'],
|
|
||||||
'format': ['format'],
|
|
||||||
'none': []
|
|
||||||
}
|
|
||||||
PRETTY_STDOUT_TTY_ONLY = object()
|
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_FORMAT_OPTIONS = [
|
|
||||||
'headers.sort:true',
|
|
||||||
'json.format:true',
|
|
||||||
'json.indent:4',
|
|
||||||
'json.sort_keys:true',
|
|
||||||
'xml.format:true',
|
|
||||||
'xml.indent:2',
|
|
||||||
]
|
|
||||||
SORTED_FORMAT_OPTIONS = [
|
|
||||||
'headers.sort:true',
|
|
||||||
'json.sort_keys:true',
|
|
||||||
]
|
|
||||||
SORTED_FORMAT_OPTIONS_STRING = ','.join(SORTED_FORMAT_OPTIONS)
|
|
||||||
UNSORTED_FORMAT_OPTIONS_STRING = ','.join(
|
|
||||||
option.replace('true', 'false') for option in SORTED_FORMAT_OPTIONS)
|
|
||||||
|
|
||||||
# Defaults
|
|
||||||
OUTPUT_OPTIONS_DEFAULT = OUT_RESP_HEAD + OUT_RESP_BODY
|
|
||||||
OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED = OUT_RESP_BODY
|
|
||||||
OUTPUT_OPTIONS_DEFAULT_OFFLINE = OUT_REQ_HEAD + OUT_REQ_BODY
|
|
||||||
|
|
||||||
|
|
||||||
class RequestType(enum.Enum):
|
|
||||||
FORM = enum.auto()
|
|
||||||
MULTIPART = enum.auto()
|
|
||||||
JSON = enum.auto()
|
|
||||||
@ -1,852 +0,0 @@
|
|||||||
"""
|
|
||||||
CLI arguments definition.
|
|
||||||
|
|
||||||
"""
|
|
||||||
from argparse import FileType, OPTIONAL, SUPPRESS, ZERO_OR_MORE
|
|
||||||
from textwrap import dedent, wrap
|
|
||||||
|
|
||||||
from .. import __doc__, __version__
|
|
||||||
from .argparser import HTTPieArgumentParser
|
|
||||||
from .argtypes import (
|
|
||||||
KeyValueArgType, SessionNameValidator,
|
|
||||||
readable_file_arg, response_charset_type, response_mime_type,
|
|
||||||
)
|
|
||||||
from .constants import (
|
|
||||||
DEFAULT_FORMAT_OPTIONS, OUTPUT_OPTIONS,
|
|
||||||
OUTPUT_OPTIONS_DEFAULT, OUT_REQ_BODY, OUT_REQ_HEAD,
|
|
||||||
OUT_RESP_BODY, OUT_RESP_HEAD, PRETTY_MAP, PRETTY_STDOUT_TTY_ONLY,
|
|
||||||
RequestType, SEPARATOR_GROUP_ALL_ITEMS, SEPARATOR_PROXY,
|
|
||||||
SORTED_FORMAT_OPTIONS_STRING,
|
|
||||||
UNSORTED_FORMAT_OPTIONS_STRING,
|
|
||||||
)
|
|
||||||
from ..output.formatters.colors import (
|
|
||||||
AUTO_STYLE, AVAILABLE_STYLES, DEFAULT_STYLE,
|
|
||||||
)
|
|
||||||
from ..plugins.builtin import BuiltinAuthPlugin
|
|
||||||
from ..plugins.registry import plugin_manager
|
|
||||||
from ..sessions import DEFAULT_SESSIONS_DIR
|
|
||||||
from ..ssl import AVAILABLE_SSL_VERSION_ARG_MAPPING, DEFAULT_SSL_CIPHERS
|
|
||||||
|
|
||||||
|
|
||||||
parser = HTTPieArgumentParser(
|
|
||||||
prog='http',
|
|
||||||
description=f'{__doc__.strip()} <https://httpie.io>',
|
|
||||||
epilog=dedent('''
|
|
||||||
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
|
|
||||||
|
|
||||||
'''),
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Positional arguments.
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
positional = parser.add_argument_group(
|
|
||||||
title='Positional Arguments',
|
|
||||||
description=dedent('''
|
|
||||||
These arguments come after any flags and in the order they are listed here.
|
|
||||||
Only URL is required.
|
|
||||||
|
|
||||||
''')
|
|
||||||
)
|
|
||||||
positional.add_argument(
|
|
||||||
dest='method',
|
|
||||||
metavar='METHOD',
|
|
||||||
nargs=OPTIONAL,
|
|
||||||
default=None,
|
|
||||||
help='''
|
|
||||||
The HTTP method to be used for the request (GET, POST, PUT, DELETE, ...).
|
|
||||||
|
|
||||||
This argument can be omitted in which case HTTPie will use POST if there
|
|
||||||
is some data to be sent, otherwise GET:
|
|
||||||
|
|
||||||
$ http example.org # => GET
|
|
||||||
$ http example.org hello=world # => POST
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
positional.add_argument(
|
|
||||||
dest='url',
|
|
||||||
metavar='URL',
|
|
||||||
nargs=OPTIONAL,
|
|
||||||
help='''
|
|
||||||
The scheme defaults to 'http://' if the URL does not include one.
|
|
||||||
(You can override this with: --default-scheme=https)
|
|
||||||
|
|
||||||
You can also use a shorthand for localhost
|
|
||||||
|
|
||||||
$ http :3000 # => http://localhost:3000
|
|
||||||
$ http :/foo # => http://localhost/foo
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
positional.add_argument(
|
|
||||||
dest='request_items',
|
|
||||||
metavar='REQUEST_ITEM',
|
|
||||||
nargs=ZERO_OR_MORE,
|
|
||||||
default=None,
|
|
||||||
type=KeyValueArgType(*SEPARATOR_GROUP_ALL_ITEMS),
|
|
||||||
help=r'''
|
|
||||||
Optional key-value pairs to be included in the request. The separator used
|
|
||||||
determines the type:
|
|
||||||
|
|
||||||
':' HTTP headers:
|
|
||||||
|
|
||||||
Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0
|
|
||||||
|
|
||||||
'==' URL parameters to be appended to the request URI:
|
|
||||||
|
|
||||||
search==httpie
|
|
||||||
|
|
||||||
'=' Data fields to be serialized into a JSON object (with --json, -j)
|
|
||||||
or form data (with --form, -f):
|
|
||||||
|
|
||||||
name=HTTPie language=Python description='CLI HTTP client'
|
|
||||||
|
|
||||||
':=' Non-string JSON data fields (only with --json, -j):
|
|
||||||
|
|
||||||
awesome:=true amount:=42 colors:='["red", "green", "blue"]'
|
|
||||||
|
|
||||||
'@' Form file fields (only with --form or --multipart):
|
|
||||||
|
|
||||||
cv@~/Documents/CV.pdf
|
|
||||||
cv@'~/Documents/CV.pdf;type=application/pdf'
|
|
||||||
|
|
||||||
'=@' A data field like '=', but takes a file path and embeds its content:
|
|
||||||
|
|
||||||
essay=@Documents/essay.txt
|
|
||||||
|
|
||||||
':=@' 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\:colon=value
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Content type.
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
content_type = parser.add_argument_group(
|
|
||||||
title='Predefined Content Types',
|
|
||||||
description=None
|
|
||||||
)
|
|
||||||
|
|
||||||
content_type.add_argument(
|
|
||||||
'--json', '-j',
|
|
||||||
action='store_const',
|
|
||||||
const=RequestType.JSON,
|
|
||||||
dest='request_type',
|
|
||||||
help='''
|
|
||||||
(default) Data items from the command line are serialized as a JSON object.
|
|
||||||
The Content-Type and Accept headers are set to application/json
|
|
||||||
(if not specified).
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
content_type.add_argument(
|
|
||||||
'--form', '-f',
|
|
||||||
action='store_const',
|
|
||||||
const=RequestType.FORM,
|
|
||||||
dest='request_type',
|
|
||||||
help='''
|
|
||||||
Data items from the command line are serialized as form fields.
|
|
||||||
|
|
||||||
The Content-Type is set to application/x-www-form-urlencoded (if not
|
|
||||||
specified). The presence of any file fields results in a
|
|
||||||
multipart/form-data request.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
content_type.add_argument(
|
|
||||||
'--multipart',
|
|
||||||
action='store_const',
|
|
||||||
const=RequestType.MULTIPART,
|
|
||||||
dest='request_type',
|
|
||||||
help='''
|
|
||||||
Similar to --form, but always sends a multipart/form-data
|
|
||||||
request (i.e., even without files).
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
content_type.add_argument(
|
|
||||||
'--boundary',
|
|
||||||
help='''
|
|
||||||
Specify a custom boundary string for multipart/form-data requests.
|
|
||||||
Only has effect only together with --form.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
content_type.add_argument(
|
|
||||||
'--raw',
|
|
||||||
help='''
|
|
||||||
This option allows you to pass raw request data without extra processing
|
|
||||||
(as opposed to the structured request items syntax):
|
|
||||||
|
|
||||||
$ http --raw='data' pie.dev/post
|
|
||||||
|
|
||||||
You can achieve the same by piping the data via stdin:
|
|
||||||
|
|
||||||
$ echo data | http pie.dev/post
|
|
||||||
|
|
||||||
Or have HTTPie load the raw data from a file:
|
|
||||||
|
|
||||||
$ http pie.dev/post @data.txt
|
|
||||||
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Content processing.
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
content_processing = parser.add_argument_group(
|
|
||||||
title='Content Processing Options',
|
|
||||||
description=None
|
|
||||||
)
|
|
||||||
|
|
||||||
content_processing.add_argument(
|
|
||||||
'--compress', '-x',
|
|
||||||
action='count',
|
|
||||||
default=0,
|
|
||||||
help='''
|
|
||||||
Content compressed (encoded) with Deflate algorithm.
|
|
||||||
The Content-Encoding header is set to deflate.
|
|
||||||
|
|
||||||
Compression is skipped if it appears that compression ratio is
|
|
||||||
negative. Compression can be forced by repeating the argument.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Output processing
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
output_processing = parser.add_argument_group(title='Output Processing')
|
|
||||||
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--pretty',
|
|
||||||
dest='prettify',
|
|
||||||
default=PRETTY_STDOUT_TTY_ONLY,
|
|
||||||
choices=sorted(PRETTY_MAP.keys()),
|
|
||||||
help='''
|
|
||||||
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".
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--style', '-s',
|
|
||||||
dest='style',
|
|
||||||
metavar='STYLE',
|
|
||||||
default=DEFAULT_STYLE,
|
|
||||||
choices=sorted(AVAILABLE_STYLES),
|
|
||||||
help='''
|
|
||||||
Output coloring style (default is "{default}"). It can be One of:
|
|
||||||
|
|
||||||
{available_styles}
|
|
||||||
|
|
||||||
The "{auto_style}" style follows your terminal's ANSI color styles.
|
|
||||||
|
|
||||||
For non-{auto_style} styles to work properly, please make sure that the
|
|
||||||
$TERM environment variable is set to "xterm-256color" or similar
|
|
||||||
(e.g., via `export TERM=xterm-256color' in your ~/.bashrc).
|
|
||||||
|
|
||||||
'''.format(
|
|
||||||
default=DEFAULT_STYLE,
|
|
||||||
available_styles='\n'.join(
|
|
||||||
f' {line.strip()}'
|
|
||||||
for line in wrap(', '.join(sorted(AVAILABLE_STYLES)), 60)
|
|
||||||
).strip(),
|
|
||||||
auto_style=AUTO_STYLE,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
_sorted_kwargs = {
|
|
||||||
'action': 'append_const',
|
|
||||||
'const': SORTED_FORMAT_OPTIONS_STRING,
|
|
||||||
'dest': 'format_options'
|
|
||||||
}
|
|
||||||
_unsorted_kwargs = {
|
|
||||||
'action': 'append_const',
|
|
||||||
'const': UNSORTED_FORMAT_OPTIONS_STRING,
|
|
||||||
'dest': 'format_options'
|
|
||||||
}
|
|
||||||
# The closest approx. of the documented resetting to default via --no-<option>.
|
|
||||||
# We hide them from the doc because they act only as low-level aliases here.
|
|
||||||
output_processing.add_argument('--no-unsorted', **_sorted_kwargs, help=SUPPRESS)
|
|
||||||
output_processing.add_argument('--no-sorted', **_unsorted_kwargs, help=SUPPRESS)
|
|
||||||
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--unsorted',
|
|
||||||
**_unsorted_kwargs,
|
|
||||||
help=f'''
|
|
||||||
Disables all sorting while formatting output. It is a shortcut for:
|
|
||||||
|
|
||||||
--format-options={UNSORTED_FORMAT_OPTIONS_STRING}
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--sorted',
|
|
||||||
**_sorted_kwargs,
|
|
||||||
help=f'''
|
|
||||||
Re-enables all sorting options while formatting output. It is a shortcut for:
|
|
||||||
|
|
||||||
--format-options={SORTED_FORMAT_OPTIONS_STRING}
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--response-charset',
|
|
||||||
metavar='ENCODING',
|
|
||||||
type=response_charset_type,
|
|
||||||
help='''
|
|
||||||
Override the response encoding for terminal display purposes, e.g.:
|
|
||||||
|
|
||||||
--response-charset=utf8
|
|
||||||
--response-charset=big5
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--response-mime',
|
|
||||||
metavar='MIME_TYPE',
|
|
||||||
type=response_mime_type,
|
|
||||||
help='''
|
|
||||||
Override the response mime type for coloring and formatting for the terminal, e.g.:
|
|
||||||
|
|
||||||
--response-mime=application/json
|
|
||||||
--response-mime=text/xml
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
output_processing.add_argument(
|
|
||||||
'--format-options',
|
|
||||||
action='append',
|
|
||||||
help='''
|
|
||||||
Controls output formatting. Only relevant when formatting is enabled
|
|
||||||
through (explicit or implied) --pretty=all or --pretty=format.
|
|
||||||
The following are the default options:
|
|
||||||
|
|
||||||
{option_list}
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
--format-options json.sort_keys:false,json.indent:2
|
|
||||||
|
|
||||||
This is something you will typically put into your config file.
|
|
||||||
|
|
||||||
'''.format(
|
|
||||||
option_list='\n'.join(
|
|
||||||
f' {option}' for option in DEFAULT_FORMAT_OPTIONS).strip()
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Output options
|
|
||||||
#######################################################################
|
|
||||||
output_options = parser.add_argument_group(title='Output Options')
|
|
||||||
|
|
||||||
output_options.add_argument(
|
|
||||||
'--print', '-p',
|
|
||||||
dest='output_options',
|
|
||||||
metavar='WHAT',
|
|
||||||
help=f'''
|
|
||||||
String specifying what the output should contain:
|
|
||||||
|
|
||||||
'{OUT_REQ_HEAD}' request headers
|
|
||||||
'{OUT_REQ_BODY}' request body
|
|
||||||
'{OUT_RESP_HEAD}' response headers
|
|
||||||
'{OUT_RESP_BODY}' response body
|
|
||||||
|
|
||||||
The default behaviour is '{OUTPUT_OPTIONS_DEFAULT}' (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.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_options.add_argument(
|
|
||||||
'--headers', '-h',
|
|
||||||
dest='output_options',
|
|
||||||
action='store_const',
|
|
||||||
const=OUT_RESP_HEAD,
|
|
||||||
help=f'''
|
|
||||||
Print only the response headers. Shortcut for --print={OUT_RESP_HEAD}.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_options.add_argument(
|
|
||||||
'--body', '-b',
|
|
||||||
dest='output_options',
|
|
||||||
action='store_const',
|
|
||||||
const=OUT_RESP_BODY,
|
|
||||||
help=f'''
|
|
||||||
Print only the response body. Shortcut for --print={OUT_RESP_BODY}.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
output_options.add_argument(
|
|
||||||
'--verbose', '-v',
|
|
||||||
dest='verbose',
|
|
||||||
action='store_true',
|
|
||||||
help=f'''
|
|
||||||
Verbose output. Print the whole request as well as the response. Also print
|
|
||||||
any intermediary requests/responses (such as redirects).
|
|
||||||
It's a shortcut for: --all --print={''.join(OUTPUT_OPTIONS)}
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_options.add_argument(
|
|
||||||
'--all',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
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 --follow), the first unauthorized request when
|
|
||||||
Digest auth is used (--auth=digest), etc.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_options.add_argument(
|
|
||||||
'--history-print', '-P',
|
|
||||||
dest='output_options_history',
|
|
||||||
metavar='WHAT',
|
|
||||||
help='''
|
|
||||||
The same as --print, -p but applies only to intermediary requests/responses
|
|
||||||
(such as redirects) when their inclusion is enabled with --all. If this
|
|
||||||
options is not specified, then they are formatted the same way as the final
|
|
||||||
response.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_options.add_argument(
|
|
||||||
'--stream', '-S',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Always stream the response body by line, i.e., behave like `tail -f'.
|
|
||||||
|
|
||||||
Without --stream and with --pretty (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 --pretty: It ensures that the output is flushed
|
|
||||||
more often and in smaller chunks.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
output_options.add_argument(
|
|
||||||
'--output', '-o',
|
|
||||||
type=FileType('a+b'),
|
|
||||||
dest='output_file',
|
|
||||||
metavar='FILE',
|
|
||||||
help='''
|
|
||||||
Save output to FILE instead of stdout. If --download is also set, then only
|
|
||||||
the response body is saved to FILE. Other parts of the HTTP exchange are
|
|
||||||
printed to stderr.
|
|
||||||
|
|
||||||
'''
|
|
||||||
|
|
||||||
)
|
|
||||||
|
|
||||||
output_options.add_argument(
|
|
||||||
'--download', '-d',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Do not print the response body to stdout. Rather, download it and store it
|
|
||||||
in a file. The filename is guessed unless specified with --output
|
|
||||||
[filename]. This action is similar to the default behaviour of wget.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
output_options.add_argument(
|
|
||||||
'--continue', '-c',
|
|
||||||
dest='download_resume',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Resume an interrupted download. Note that the --output option needs to be
|
|
||||||
specified as well.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
output_options.add_argument(
|
|
||||||
'--quiet', '-q',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Do not print to stdout or stderr.
|
|
||||||
stdout is still redirected if --output is specified.
|
|
||||||
Flag doesn't affect behaviour of download beyond not printing to terminal.
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Sessions
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
sessions = parser.add_argument_group(title='Sessions') \
|
|
||||||
.add_mutually_exclusive_group(required=False)
|
|
||||||
|
|
||||||
session_name_validator = SessionNameValidator(
|
|
||||||
'Session name contains invalid characters.'
|
|
||||||
)
|
|
||||||
|
|
||||||
sessions.add_argument(
|
|
||||||
'--session',
|
|
||||||
metavar='SESSION_NAME_OR_PATH',
|
|
||||||
type=session_name_validator,
|
|
||||||
help=f'''
|
|
||||||
Create, or reuse and update a session. Within a session, custom headers,
|
|
||||||
auth credential, as well as any cookies sent by the server persist between
|
|
||||||
requests.
|
|
||||||
|
|
||||||
Session files are stored in:
|
|
||||||
|
|
||||||
{DEFAULT_SESSIONS_DIR}/<HOST>/<SESSION_NAME>.json.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
sessions.add_argument(
|
|
||||||
'--session-read-only',
|
|
||||||
metavar='SESSION_NAME_OR_PATH',
|
|
||||||
type=session_name_validator,
|
|
||||||
help='''
|
|
||||||
Create or read a session without updating it form the request/response
|
|
||||||
exchange.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Authentication
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
# ``requests.request`` keyword arguments.
|
|
||||||
auth = parser.add_argument_group(title='Authentication')
|
|
||||||
auth.add_argument(
|
|
||||||
'--auth', '-a',
|
|
||||||
default=None,
|
|
||||||
metavar='USER[:PASS]',
|
|
||||||
help='''
|
|
||||||
If only the username is provided (-a username), HTTPie will prompt
|
|
||||||
for the password.
|
|
||||||
|
|
||||||
''',
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class _AuthTypeLazyChoices:
|
|
||||||
# Needed for plugin testing
|
|
||||||
|
|
||||||
def __contains__(self, item):
|
|
||||||
return item in plugin_manager.get_auth_plugin_mapping()
|
|
||||||
|
|
||||||
def __iter__(self):
|
|
||||||
return iter(sorted(plugin_manager.get_auth_plugin_mapping().keys()))
|
|
||||||
|
|
||||||
|
|
||||||
_auth_plugins = plugin_manager.get_auth_plugins()
|
|
||||||
auth.add_argument(
|
|
||||||
'--auth-type', '-A',
|
|
||||||
choices=_AuthTypeLazyChoices(),
|
|
||||||
default=None,
|
|
||||||
help='''
|
|
||||||
The authentication mechanism to be used. Defaults to "{default}".
|
|
||||||
|
|
||||||
{types}
|
|
||||||
|
|
||||||
'''.format(default=_auth_plugins[0].auth_type, types='\n '.join(
|
|
||||||
'"{type}": {name}{package}{description}'.format(
|
|
||||||
type=plugin.auth_type,
|
|
||||||
name=plugin.name,
|
|
||||||
package=(
|
|
||||||
'' if issubclass(plugin, BuiltinAuthPlugin)
|
|
||||||
else f' (provided by {plugin.package_name})'
|
|
||||||
),
|
|
||||||
description=(
|
|
||||||
'' if not plugin.description else
|
|
||||||
'\n ' + ('\n '.join(wrap(plugin.description)))
|
|
||||||
)
|
|
||||||
)
|
|
||||||
for plugin in _auth_plugins
|
|
||||||
)),
|
|
||||||
)
|
|
||||||
auth.add_argument(
|
|
||||||
'--ignore-netrc',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
Ignore credentials from .netrc.
|
|
||||||
|
|
||||||
''',
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Network
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
network = parser.add_argument_group(title='Network')
|
|
||||||
|
|
||||||
network.add_argument(
|
|
||||||
'--offline',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
Build the request and print it but don’t actually send it.
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
network.add_argument(
|
|
||||||
'--proxy',
|
|
||||||
default=[],
|
|
||||||
action='append',
|
|
||||||
metavar='PROTOCOL:PROXY_URL',
|
|
||||||
type=KeyValueArgType(SEPARATOR_PROXY),
|
|
||||||
help='''
|
|
||||||
String mapping protocol to the URL of the proxy
|
|
||||||
(e.g. http:http://foo.bar:3128). You can specify multiple proxies with
|
|
||||||
different protocols. The environment variables $ALL_PROXY, $HTTP_PROXY,
|
|
||||||
and $HTTPS_proxy are supported as well.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
network.add_argument(
|
|
||||||
'--follow', '-F',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
Follow 30x Location redirects.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
network.add_argument(
|
|
||||||
'--max-redirects',
|
|
||||||
type=int,
|
|
||||||
default=30,
|
|
||||||
help='''
|
|
||||||
By default, requests have a limit of 30 redirects (works with --follow).
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
network.add_argument(
|
|
||||||
'--max-headers',
|
|
||||||
type=int,
|
|
||||||
default=0,
|
|
||||||
help='''
|
|
||||||
The maximum number of response headers to be read before giving up
|
|
||||||
(default 0, i.e., no limit).
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
network.add_argument(
|
|
||||||
'--timeout',
|
|
||||||
type=float,
|
|
||||||
default=0,
|
|
||||||
metavar='SECONDS',
|
|
||||||
help='''
|
|
||||||
The connection timeout of the request in seconds.
|
|
||||||
The default value is 0, i.e., there is no timeout limit.
|
|
||||||
This is not a time limit on the entire response download;
|
|
||||||
rather, an error is reported if the server has not issued a response for
|
|
||||||
timeout seconds (more precisely, if no bytes have been received on
|
|
||||||
the underlying socket for timeout seconds).
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
network.add_argument(
|
|
||||||
'--check-status',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
By default, HTTPie exits with 0 when no network or other fatal errors
|
|
||||||
occur. This flag instructs HTTPie to also check the HTTP status code and
|
|
||||||
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 --follow hasn't been set, then the exit status is 3.
|
|
||||||
Also an error message is written to stderr if stdout is redirected.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
network.add_argument(
|
|
||||||
'--path-as-is',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
Bypass dot segment (/../ or /./) URL squashing.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
network.add_argument(
|
|
||||||
'--chunked',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='''
|
|
||||||
Enable streaming via chunked transfer encoding.
|
|
||||||
The Transfer-Encoding header is set to chunked.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# SSL
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
ssl = parser.add_argument_group(title='SSL')
|
|
||||||
ssl.add_argument(
|
|
||||||
'--verify',
|
|
||||||
default='yes',
|
|
||||||
help='''
|
|
||||||
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.)
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
ssl.add_argument(
|
|
||||||
'--ssl',
|
|
||||||
dest='ssl_version',
|
|
||||||
choices=sorted(AVAILABLE_SSL_VERSION_ARG_MAPPING.keys()),
|
|
||||||
help='''
|
|
||||||
The desired protocol version to use. This will default to
|
|
||||||
SSL v2.3 which will negotiate the highest protocol that both
|
|
||||||
the server and your installation of OpenSSL support. Available protocols
|
|
||||||
may vary depending on OpenSSL installation (only the supported ones
|
|
||||||
are shown here).
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
ssl.add_argument(
|
|
||||||
'--ciphers',
|
|
||||||
help=f'''
|
|
||||||
|
|
||||||
A string in the OpenSSL cipher list format. By default, the following
|
|
||||||
is used:
|
|
||||||
|
|
||||||
{DEFAULT_SSL_CIPHERS}
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
ssl.add_argument(
|
|
||||||
'--cert',
|
|
||||||
default=None,
|
|
||||||
type=readable_file_arg,
|
|
||||||
help='''
|
|
||||||
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 --cert-key separately.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
ssl.add_argument(
|
|
||||||
'--cert-key',
|
|
||||||
default=None,
|
|
||||||
type=readable_file_arg,
|
|
||||||
help='''
|
|
||||||
The private key to use with SSL. Only needed if --cert is given and the
|
|
||||||
certificate file does not contain the private key.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
#######################################################################
|
|
||||||
# Troubleshooting
|
|
||||||
#######################################################################
|
|
||||||
|
|
||||||
troubleshooting = parser.add_argument_group(title='Troubleshooting')
|
|
||||||
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--ignore-stdin', '-I',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Do not attempt to read stdin.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--help',
|
|
||||||
action='help',
|
|
||||||
default=SUPPRESS,
|
|
||||||
help='''
|
|
||||||
Show this help message and exit.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--version',
|
|
||||||
action='version',
|
|
||||||
version=__version__,
|
|
||||||
help='''
|
|
||||||
Show version and exit.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--traceback',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Prints the exception traceback should one occur.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--default-scheme',
|
|
||||||
default="http",
|
|
||||||
help='''
|
|
||||||
The default scheme to use if not specified in the URL.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--debug',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Prints the exception traceback should one occur, as well as other
|
|
||||||
information useful for debugging HTTPie itself and for reporting bugs.
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
troubleshooting.add_argument(
|
|
||||||
'--prompt',
|
|
||||||
action='store_true',
|
|
||||||
default=False,
|
|
||||||
help='''
|
|
||||||
Start the shell!
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
@ -1,58 +0,0 @@
|
|||||||
from collections import OrderedDict
|
|
||||||
|
|
||||||
from requests.structures import CaseInsensitiveDict
|
|
||||||
|
|
||||||
|
|
||||||
class RequestHeadersDict(CaseInsensitiveDict):
|
|
||||||
"""
|
|
||||||
Headers are case-insensitive and multiple values are currently not supported.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
class RequestJSONDataDict(OrderedDict):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class MultiValueOrderedDict(OrderedDict):
|
|
||||||
"""Multi-value dict for URL parameters and form data."""
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
"""
|
|
||||||
If `key` is assigned more than once, `self[key]` holds a
|
|
||||||
`list` of all the values.
|
|
||||||
|
|
||||||
This allows having multiple fields with the same name in form
|
|
||||||
data and URL params.
|
|
||||||
|
|
||||||
"""
|
|
||||||
assert not isinstance(value, list)
|
|
||||||
if key not in self:
|
|
||||||
super().__setitem__(key, value)
|
|
||||||
else:
|
|
||||||
if not isinstance(self[key], list):
|
|
||||||
super().__setitem__(key, [self[key]])
|
|
||||||
self[key].append(value)
|
|
||||||
|
|
||||||
def items(self):
|
|
||||||
for key, values in super().items():
|
|
||||||
if not isinstance(values, list):
|
|
||||||
values = [values]
|
|
||||||
for value in values:
|
|
||||||
yield key, value
|
|
||||||
|
|
||||||
|
|
||||||
class RequestQueryParamsDict(MultiValueOrderedDict):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class RequestDataDict(MultiValueOrderedDict):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class MultipartRequestDataDict(MultiValueOrderedDict):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class RequestFilesDict(RequestDataDict):
|
|
||||||
pass
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
class ParseError(Exception):
|
|
||||||
pass
|
|
||||||
@ -1,155 +0,0 @@
|
|||||||
import os
|
|
||||||
from typing import Callable, Dict, IO, List, Optional, Tuple, Union
|
|
||||||
|
|
||||||
from .argtypes import KeyValueArg
|
|
||||||
from .constants import (
|
|
||||||
SEPARATORS_GROUP_MULTIPART, SEPARATOR_DATA_EMBED_FILE_CONTENTS,
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE,
|
|
||||||
SEPARATOR_DATA_RAW_JSON, SEPARATOR_DATA_STRING, SEPARATOR_FILE_UPLOAD,
|
|
||||||
SEPARATOR_FILE_UPLOAD_TYPE, SEPARATOR_HEADER, SEPARATOR_HEADER_EMPTY,
|
|
||||||
SEPARATOR_QUERY_PARAM,
|
|
||||||
)
|
|
||||||
from .dicts import (
|
|
||||||
MultipartRequestDataDict, RequestDataDict, RequestFilesDict,
|
|
||||||
RequestHeadersDict, RequestJSONDataDict,
|
|
||||||
RequestQueryParamsDict,
|
|
||||||
)
|
|
||||||
from .exceptions import ParseError
|
|
||||||
from ..utils import get_content_type, load_json_preserve_order_and_dupe_keys
|
|
||||||
|
|
||||||
|
|
||||||
class RequestItems:
|
|
||||||
|
|
||||||
def __init__(self, as_form=False):
|
|
||||||
self.headers = RequestHeadersDict()
|
|
||||||
self.data = RequestDataDict() if as_form else RequestJSONDataDict()
|
|
||||||
self.files = RequestFilesDict()
|
|
||||||
self.params = RequestQueryParamsDict()
|
|
||||||
# To preserve the order of fields in file upload multipart requests.
|
|
||||||
self.multipart_data = MultipartRequestDataDict()
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def from_args(
|
|
||||||
cls,
|
|
||||||
request_item_args: List[KeyValueArg],
|
|
||||||
as_form=False,
|
|
||||||
) -> 'RequestItems':
|
|
||||||
instance = cls(as_form=as_form)
|
|
||||||
rules: Dict[str, Tuple[Callable, dict]] = {
|
|
||||||
SEPARATOR_HEADER: (
|
|
||||||
process_header_arg,
|
|
||||||
instance.headers,
|
|
||||||
),
|
|
||||||
SEPARATOR_HEADER_EMPTY: (
|
|
||||||
process_empty_header_arg,
|
|
||||||
instance.headers,
|
|
||||||
),
|
|
||||||
SEPARATOR_QUERY_PARAM: (
|
|
||||||
process_query_param_arg,
|
|
||||||
instance.params,
|
|
||||||
),
|
|
||||||
SEPARATOR_FILE_UPLOAD: (
|
|
||||||
process_file_upload_arg,
|
|
||||||
instance.files,
|
|
||||||
),
|
|
||||||
SEPARATOR_DATA_STRING: (
|
|
||||||
process_data_item_arg,
|
|
||||||
instance.data,
|
|
||||||
),
|
|
||||||
SEPARATOR_DATA_EMBED_FILE_CONTENTS: (
|
|
||||||
process_data_embed_file_contents_arg,
|
|
||||||
instance.data,
|
|
||||||
),
|
|
||||||
SEPARATOR_DATA_RAW_JSON: (
|
|
||||||
process_data_raw_json_embed_arg,
|
|
||||||
instance.data,
|
|
||||||
),
|
|
||||||
SEPARATOR_DATA_EMBED_RAW_JSON_FILE: (
|
|
||||||
process_data_embed_raw_json_file_arg,
|
|
||||||
instance.data,
|
|
||||||
),
|
|
||||||
}
|
|
||||||
|
|
||||||
for arg in request_item_args:
|
|
||||||
processor_func, target_dict = rules[arg.sep]
|
|
||||||
value = processor_func(arg)
|
|
||||||
target_dict[arg.key] = value
|
|
||||||
|
|
||||||
if arg.sep in SEPARATORS_GROUP_MULTIPART:
|
|
||||||
instance.multipart_data[arg.key] = value
|
|
||||||
|
|
||||||
return instance
|
|
||||||
|
|
||||||
|
|
||||||
JSONType = Union[str, bool, int, list, dict]
|
|
||||||
|
|
||||||
|
|
||||||
def process_header_arg(arg: KeyValueArg) -> Optional[str]:
|
|
||||||
return arg.value or None
|
|
||||||
|
|
||||||
|
|
||||||
def process_empty_header_arg(arg: KeyValueArg) -> str:
|
|
||||||
if not arg.value:
|
|
||||||
return arg.value
|
|
||||||
raise ParseError(
|
|
||||||
f'Invalid item {arg.orig!r} (to specify an empty header use `Header;`)'
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def process_query_param_arg(arg: KeyValueArg) -> str:
|
|
||||||
return arg.value
|
|
||||||
|
|
||||||
|
|
||||||
def process_file_upload_arg(arg: KeyValueArg) -> Tuple[str, IO, str]:
|
|
||||||
parts = arg.value.split(SEPARATOR_FILE_UPLOAD_TYPE)
|
|
||||||
filename = parts[0]
|
|
||||||
mime_type = parts[1] if len(parts) > 1 else None
|
|
||||||
try:
|
|
||||||
f = open(os.path.expanduser(filename), 'rb')
|
|
||||||
except OSError as e:
|
|
||||||
raise ParseError(f'{arg.orig!r}: {e}')
|
|
||||||
return (
|
|
||||||
os.path.basename(filename),
|
|
||||||
f,
|
|
||||||
mime_type or get_content_type(filename),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def process_data_item_arg(arg: KeyValueArg) -> str:
|
|
||||||
return arg.value
|
|
||||||
|
|
||||||
|
|
||||||
def process_data_embed_file_contents_arg(arg: KeyValueArg) -> str:
|
|
||||||
return load_text_file(arg)
|
|
||||||
|
|
||||||
|
|
||||||
def process_data_embed_raw_json_file_arg(arg: KeyValueArg) -> JSONType:
|
|
||||||
contents = load_text_file(arg)
|
|
||||||
value = load_json(arg, contents)
|
|
||||||
return value
|
|
||||||
|
|
||||||
|
|
||||||
def process_data_raw_json_embed_arg(arg: KeyValueArg) -> JSONType:
|
|
||||||
value = load_json(arg, arg.value)
|
|
||||||
return value
|
|
||||||
|
|
||||||
|
|
||||||
def load_text_file(item: KeyValueArg) -> str:
|
|
||||||
path = item.value
|
|
||||||
try:
|
|
||||||
with open(os.path.expanduser(path), 'rb') as f:
|
|
||||||
return f.read().decode()
|
|
||||||
except OSError as e:
|
|
||||||
raise ParseError(f'{item.orig!r}: {e}')
|
|
||||||
except UnicodeDecodeError:
|
|
||||||
raise ParseError(
|
|
||||||
f'{item.orig!r}: cannot embed the content of {item.value!r},'
|
|
||||||
' not a UTF-8 or ASCII-encoded text file'
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def load_json(arg: KeyValueArg, contents: str) -> JSONType:
|
|
||||||
try:
|
|
||||||
return load_json_preserve_order_and_dupe_keys(contents)
|
|
||||||
except ValueError as e:
|
|
||||||
raise ParseError(f'{arg.orig!r}: {e}')
|
|
||||||
351
httpie/client.py
351
httpie/client.py
@ -1,257 +1,98 @@
|
|||||||
import argparse
|
|
||||||
import http.client
|
|
||||||
import json
|
import json
|
||||||
import sys
|
import sys
|
||||||
from contextlib import contextmanager
|
from pprint import pformat
|
||||||
from pathlib import Path
|
|
||||||
from typing import Callable, Iterable, Union
|
|
||||||
from urllib.parse import urlparse, urlunparse
|
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
# noinspection PyPackageRequirements
|
from requests.packages import urllib3
|
||||||
import urllib3
|
|
||||||
from . import __version__
|
from httpie import sessions
|
||||||
from .cli.dicts import RequestHeadersDict
|
from httpie import __version__
|
||||||
from .encoding import UTF8
|
from httpie.compat import str
|
||||||
from .plugins.registry import plugin_manager
|
from httpie.plugins import plugin_manager
|
||||||
from .sessions import get_httpie_session
|
|
||||||
from .ssl import AVAILABLE_SSL_VERSION_ARG_MAPPING, HTTPieHTTPSAdapter
|
|
||||||
from .uploads import (
|
|
||||||
compress_request, prepare_request_body,
|
|
||||||
get_multipart_data_and_content_type,
|
|
||||||
)
|
|
||||||
from .utils import get_expired_cookies, repr_dict
|
|
||||||
|
|
||||||
|
|
||||||
|
# https://urllib3.readthedocs.org/en/latest/security.html
|
||||||
urllib3.disable_warnings()
|
urllib3.disable_warnings()
|
||||||
|
|
||||||
FORM_CONTENT_TYPE = f'application/x-www-form-urlencoded; charset={UTF8}'
|
|
||||||
JSON_CONTENT_TYPE = 'application/json'
|
FORM = 'application/x-www-form-urlencoded; charset=utf-8'
|
||||||
JSON_ACCEPT = f'{JSON_CONTENT_TYPE}, */*;q=0.5'
|
JSON = 'application/json'
|
||||||
DEFAULT_UA = f'HTTPie/{__version__}'
|
DEFAULT_UA = 'HTTPie/%s' % __version__
|
||||||
|
|
||||||
|
|
||||||
def collect_messages(
|
def get_requests_session():
|
||||||
args: argparse.Namespace,
|
|
||||||
config_dir: Path,
|
|
||||||
request_body_read_callback: Callable[[bytes], None] = None,
|
|
||||||
) -> Iterable[Union[requests.PreparedRequest, requests.Response]]:
|
|
||||||
httpie_session = None
|
|
||||||
httpie_session_headers = None
|
|
||||||
if args.session or args.session_read_only:
|
|
||||||
httpie_session = get_httpie_session(
|
|
||||||
config_dir=config_dir,
|
|
||||||
session_name=args.session or args.session_read_only,
|
|
||||||
host=args.headers.get('Host'),
|
|
||||||
url=args.url,
|
|
||||||
)
|
|
||||||
httpie_session_headers = httpie_session.headers
|
|
||||||
|
|
||||||
request_kwargs = make_request_kwargs(
|
|
||||||
args=args,
|
|
||||||
base_headers=httpie_session_headers,
|
|
||||||
request_body_read_callback=request_body_read_callback
|
|
||||||
)
|
|
||||||
send_kwargs = make_send_kwargs(args)
|
|
||||||
send_kwargs_mergeable_from_env = make_send_kwargs_mergeable_from_env(args)
|
|
||||||
requests_session = build_requests_session(
|
|
||||||
ssl_version=args.ssl_version,
|
|
||||||
ciphers=args.ciphers,
|
|
||||||
verify=bool(send_kwargs_mergeable_from_env['verify'])
|
|
||||||
)
|
|
||||||
|
|
||||||
if httpie_session:
|
|
||||||
httpie_session.update_headers(request_kwargs['headers'])
|
|
||||||
requests_session.cookies = httpie_session.cookies
|
|
||||||
if args.auth_plugin:
|
|
||||||
# Save auth from CLI to HTTPie session.
|
|
||||||
httpie_session.auth = {
|
|
||||||
'type': args.auth_plugin.auth_type,
|
|
||||||
'raw_auth': args.auth_plugin.raw_auth,
|
|
||||||
}
|
|
||||||
elif httpie_session.auth:
|
|
||||||
# Apply auth from HTTPie session
|
|
||||||
request_kwargs['auth'] = httpie_session.auth
|
|
||||||
|
|
||||||
if args.debug:
|
|
||||||
# TODO: reflect the split between request and send kwargs.
|
|
||||||
dump_request(request_kwargs)
|
|
||||||
|
|
||||||
request = requests.Request(**request_kwargs)
|
|
||||||
prepared_request = requests_session.prepare_request(request)
|
|
||||||
if args.path_as_is:
|
|
||||||
prepared_request.url = ensure_path_as_is(
|
|
||||||
orig_url=args.url,
|
|
||||||
prepped_url=prepared_request.url,
|
|
||||||
)
|
|
||||||
if args.compress and prepared_request.body:
|
|
||||||
compress_request(
|
|
||||||
request=prepared_request,
|
|
||||||
always=args.compress > 1,
|
|
||||||
)
|
|
||||||
response_count = 0
|
|
||||||
expired_cookies = []
|
|
||||||
while prepared_request:
|
|
||||||
yield prepared_request
|
|
||||||
if not args.offline:
|
|
||||||
send_kwargs_merged = requests_session.merge_environment_settings(
|
|
||||||
url=prepared_request.url,
|
|
||||||
**send_kwargs_mergeable_from_env,
|
|
||||||
)
|
|
||||||
with max_headers(args.max_headers):
|
|
||||||
response = requests_session.send(
|
|
||||||
request=prepared_request,
|
|
||||||
**send_kwargs_merged,
|
|
||||||
**send_kwargs,
|
|
||||||
)
|
|
||||||
|
|
||||||
expired_cookies += get_expired_cookies(
|
|
||||||
response.headers.get('Set-Cookie', '')
|
|
||||||
)
|
|
||||||
|
|
||||||
response_count += 1
|
|
||||||
if response.next:
|
|
||||||
if args.max_redirects and response_count == args.max_redirects:
|
|
||||||
raise requests.TooManyRedirects
|
|
||||||
if args.follow:
|
|
||||||
prepared_request = response.next
|
|
||||||
if args.all:
|
|
||||||
yield response
|
|
||||||
continue
|
|
||||||
yield response
|
|
||||||
break
|
|
||||||
|
|
||||||
if httpie_session:
|
|
||||||
if httpie_session.is_new() or not args.session_read_only:
|
|
||||||
httpie_session.cookies = requests_session.cookies
|
|
||||||
httpie_session.remove_cookies(
|
|
||||||
# TODO: take path & domain into account?
|
|
||||||
cookie['name'] for cookie in expired_cookies
|
|
||||||
)
|
|
||||||
httpie_session.save()
|
|
||||||
|
|
||||||
|
|
||||||
# noinspection PyProtectedMember
|
|
||||||
@contextmanager
|
|
||||||
def max_headers(limit):
|
|
||||||
# <https://github.com/httpie/httpie/issues/802>
|
|
||||||
# noinspection PyUnresolvedReferences
|
|
||||||
orig = http.client._MAXHEADERS
|
|
||||||
http.client._MAXHEADERS = limit or float('Inf')
|
|
||||||
try:
|
|
||||||
yield
|
|
||||||
finally:
|
|
||||||
http.client._MAXHEADERS = orig
|
|
||||||
|
|
||||||
|
|
||||||
def build_requests_session(
|
|
||||||
verify: bool,
|
|
||||||
ssl_version: str = None,
|
|
||||||
ciphers: str = None,
|
|
||||||
) -> requests.Session:
|
|
||||||
requests_session = requests.Session()
|
requests_session = requests.Session()
|
||||||
|
for cls in plugin_manager.get_trasnsport_plugins():
|
||||||
# Install our adapter.
|
transport_plugin = cls()
|
||||||
https_adapter = HTTPieHTTPSAdapter(
|
requests_session.mount(prefix=transport_plugin.prefix,
|
||||||
ciphers=ciphers,
|
adapter=transport_plugin.get_adapter())
|
||||||
verify=verify,
|
|
||||||
ssl_version=(
|
|
||||||
AVAILABLE_SSL_VERSION_ARG_MAPPING[ssl_version]
|
|
||||||
if ssl_version else None
|
|
||||||
),
|
|
||||||
)
|
|
||||||
requests_session.mount('https://', https_adapter)
|
|
||||||
|
|
||||||
# Install adapters from plugins.
|
|
||||||
for plugin_cls in plugin_manager.get_transport_plugins():
|
|
||||||
transport_plugin = plugin_cls()
|
|
||||||
requests_session.mount(
|
|
||||||
prefix=transport_plugin.prefix,
|
|
||||||
adapter=transport_plugin.get_adapter(),
|
|
||||||
)
|
|
||||||
|
|
||||||
return requests_session
|
return requests_session
|
||||||
|
|
||||||
|
|
||||||
def dump_request(kwargs: dict):
|
def get_response(args, config_dir):
|
||||||
sys.stderr.write(
|
"""Send the request and return a `request.Response`."""
|
||||||
f'\n>>> requests.request(**{repr_dict(kwargs)})\n\n')
|
|
||||||
|
requests_session = get_requests_session()
|
||||||
|
|
||||||
|
if not args.session and not args.session_read_only:
|
||||||
|
kwargs = get_requests_kwargs(args)
|
||||||
|
if args.debug:
|
||||||
|
dump_request(kwargs)
|
||||||
|
response = requests_session.request(**kwargs)
|
||||||
|
else:
|
||||||
|
response = sessions.get_response(
|
||||||
|
requests_session=requests_session,
|
||||||
|
args=args,
|
||||||
|
config_dir=config_dir,
|
||||||
|
session_name=args.session or args.session_read_only,
|
||||||
|
read_only=bool(args.session_read_only),
|
||||||
|
)
|
||||||
|
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
def finalize_headers(headers: RequestHeadersDict) -> RequestHeadersDict:
|
def dump_request(kwargs):
|
||||||
final_headers = RequestHeadersDict()
|
sys.stderr.write('\n>>> requests.request(%s)\n\n'
|
||||||
for name, value in headers.items():
|
% pformat(kwargs))
|
||||||
if value is not None:
|
|
||||||
# “leading or trailing LWS MAY be removed without
|
|
||||||
# changing the semantics of the field value”
|
|
||||||
# <https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html>
|
|
||||||
# Also, requests raises `InvalidHeader` for leading spaces.
|
|
||||||
value = value.strip()
|
|
||||||
if isinstance(value, str):
|
|
||||||
# See <https://github.com/httpie/httpie/issues/212>
|
|
||||||
value = value.encode()
|
|
||||||
final_headers[name] = value
|
|
||||||
return final_headers
|
|
||||||
|
|
||||||
|
|
||||||
def make_default_headers(args: argparse.Namespace) -> RequestHeadersDict:
|
def encode_headers(headers):
|
||||||
default_headers = RequestHeadersDict({
|
# This allows for unicode headers which is non-standard but practical.
|
||||||
|
# See: https://github.com/jakubroztocil/httpie/issues/212
|
||||||
|
return dict(
|
||||||
|
(name, value.encode('utf8') if isinstance(value, str) else value)
|
||||||
|
for name, value in headers.items()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_default_headers(args):
|
||||||
|
default_headers = {
|
||||||
'User-Agent': DEFAULT_UA
|
'User-Agent': DEFAULT_UA
|
||||||
})
|
}
|
||||||
|
|
||||||
auto_json = args.data and not args.form
|
auto_json = args.data and not args.form
|
||||||
|
# FIXME: Accept is set to JSON with `http url @./file.txt`.
|
||||||
if args.json or auto_json:
|
if args.json or auto_json:
|
||||||
default_headers['Accept'] = JSON_ACCEPT
|
default_headers['Accept'] = 'application/json'
|
||||||
if args.json or (auto_json and args.data):
|
if args.json or (auto_json and args.data):
|
||||||
default_headers['Content-Type'] = JSON_CONTENT_TYPE
|
default_headers['Content-Type'] = JSON
|
||||||
|
|
||||||
elif args.form and not args.files:
|
elif args.form and not args.files:
|
||||||
# If sending files, `requests` will set
|
# If sending files, `requests` will set
|
||||||
# the `Content-Type` for us.
|
# the `Content-Type` for us.
|
||||||
default_headers['Content-Type'] = FORM_CONTENT_TYPE
|
default_headers['Content-Type'] = FORM
|
||||||
return default_headers
|
return default_headers
|
||||||
|
|
||||||
|
|
||||||
def make_send_kwargs(args: argparse.Namespace) -> dict:
|
def get_requests_kwargs(args, base_headers=None):
|
||||||
return {
|
|
||||||
'timeout': args.timeout or None,
|
|
||||||
'allow_redirects': False,
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def make_send_kwargs_mergeable_from_env(args: argparse.Namespace) -> dict:
|
|
||||||
cert = None
|
|
||||||
if args.cert:
|
|
||||||
cert = args.cert
|
|
||||||
if args.cert_key:
|
|
||||||
cert = cert, args.cert_key
|
|
||||||
return {
|
|
||||||
'proxies': {p.key: p.value for p in args.proxy},
|
|
||||||
'stream': True,
|
|
||||||
'verify': {
|
|
||||||
'yes': True,
|
|
||||||
'true': True,
|
|
||||||
'no': False,
|
|
||||||
'false': False,
|
|
||||||
}.get(args.verify.lower(), args.verify),
|
|
||||||
'cert': cert,
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def make_request_kwargs(
|
|
||||||
args: argparse.Namespace,
|
|
||||||
base_headers: RequestHeadersDict = None,
|
|
||||||
request_body_read_callback=lambda chunk: chunk
|
|
||||||
) -> dict:
|
|
||||||
"""
|
"""
|
||||||
Translate our `args` into `requests.Request` keyword arguments.
|
Translate our `args` into `requests.request` keyword arguments.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
files = args.files
|
|
||||||
# Serialize JSON data, if needed.
|
# Serialize JSON data, if needed.
|
||||||
data = args.data
|
data = args.data
|
||||||
auto_json = data and not args.form
|
auto_json = data and not args.form
|
||||||
if (args.json or auto_json) and isinstance(data, dict):
|
if args.json or auto_json and isinstance(data, dict):
|
||||||
if data:
|
if data:
|
||||||
data = json.dumps(data)
|
data = json.dumps(data)
|
||||||
else:
|
else:
|
||||||
@ -260,60 +101,40 @@ def make_request_kwargs(
|
|||||||
data = ''
|
data = ''
|
||||||
|
|
||||||
# Finalize headers.
|
# Finalize headers.
|
||||||
headers = make_default_headers(args)
|
headers = get_default_headers(args)
|
||||||
if base_headers:
|
if base_headers:
|
||||||
headers.update(base_headers)
|
headers.update(base_headers)
|
||||||
headers.update(args.headers)
|
headers.update(args.headers)
|
||||||
if args.offline and args.chunked and 'Transfer-Encoding' not in headers:
|
headers = encode_headers(headers)
|
||||||
# When online, we let requests set the header instead to be able more
|
|
||||||
# easily verify chunking is taking place.
|
|
||||||
headers['Transfer-Encoding'] = 'chunked'
|
|
||||||
headers = finalize_headers(headers)
|
|
||||||
|
|
||||||
if (args.form and files) or args.multipart:
|
credentials = None
|
||||||
data, headers['Content-Type'] = get_multipart_data_and_content_type(
|
if args.auth:
|
||||||
data=args.multipart_data,
|
auth_plugin = plugin_manager.get_auth_plugin(args.auth_type)()
|
||||||
boundary=args.boundary,
|
credentials = auth_plugin.get_auth(args.auth.key, args.auth.value)
|
||||||
content_type=args.headers.get('Content-Type'),
|
|
||||||
)
|
|
||||||
|
|
||||||
return {
|
cert = None
|
||||||
|
if args.cert:
|
||||||
|
cert = args.cert
|
||||||
|
if args.cert_key:
|
||||||
|
cert = cert, args.cert_key
|
||||||
|
|
||||||
|
kwargs = {
|
||||||
|
'stream': True,
|
||||||
'method': args.method.lower(),
|
'method': args.method.lower(),
|
||||||
'url': args.url,
|
'url': args.url,
|
||||||
'headers': headers,
|
'headers': headers,
|
||||||
'data': prepare_request_body(
|
'data': data,
|
||||||
body=data,
|
'verify': {
|
||||||
body_read_callback=request_body_read_callback,
|
'yes': True,
|
||||||
chunked=args.chunked,
|
'no': False
|
||||||
offline=args.offline,
|
}.get(args.verify, args.verify),
|
||||||
content_length_header_value=headers.get('Content-Length'),
|
'cert': cert,
|
||||||
),
|
'timeout': args.timeout,
|
||||||
'auth': args.auth,
|
'auth': credentials,
|
||||||
'params': args.params.items(),
|
'proxies': dict((p.key, p.value) for p in args.proxy),
|
||||||
|
'files': args.files,
|
||||||
|
'allow_redirects': args.follow,
|
||||||
|
'params': args.params,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return kwargs
|
||||||
def ensure_path_as_is(orig_url: str, prepped_url: str) -> str:
|
|
||||||
"""
|
|
||||||
Handle `--path-as-is` by replacing the path component of the prepared
|
|
||||||
URL with the path component from the original URL. Other parts stay
|
|
||||||
untouched because other (welcome) processing on the URL might have
|
|
||||||
taken place.
|
|
||||||
|
|
||||||
<https://github.com/httpie/httpie/issues/895>
|
|
||||||
|
|
||||||
|
|
||||||
<https://ec.haxx.se/http/http-basics#path-as-is>
|
|
||||||
<https://curl.haxx.se/libcurl/c/CURLOPT_PATH_AS_IS.html>
|
|
||||||
|
|
||||||
>>> ensure_path_as_is('http://foo/../', 'http://foo/?foo=bar')
|
|
||||||
'http://foo/../?foo=bar'
|
|
||||||
|
|
||||||
"""
|
|
||||||
parsed_orig, parsed_prepped = urlparse(orig_url), urlparse(prepped_url)
|
|
||||||
final_dict = {
|
|
||||||
# noinspection PyProtectedMember
|
|
||||||
**parsed_prepped._asdict(),
|
|
||||||
'path': parsed_orig.path,
|
|
||||||
}
|
|
||||||
return urlunparse(tuple(final_dict.values()))
|
|
||||||
|
|||||||
207
httpie/compat.py
207
httpie/compat.py
@ -1,54 +1,175 @@
|
|||||||
|
"""
|
||||||
|
Python 2.6, 2.7, and 3.x compatibility.
|
||||||
|
|
||||||
|
"""
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
|
||||||
|
# Taken from `requests.compat`
|
||||||
|
_ver = sys.version_info
|
||||||
|
is_py2 = (_ver[0] == 2)
|
||||||
|
is_py26 = (is_py2 and _ver[1] == 6)
|
||||||
|
is_py27 = (is_py2 and _ver[1] == 7)
|
||||||
|
is_py3 = (_ver[0] == 3)
|
||||||
|
is_pypy = ('pypy' in _ver)
|
||||||
is_windows = 'win32' in str(sys.platform).lower()
|
is_windows = 'win32' in str(sys.platform).lower()
|
||||||
|
|
||||||
|
|
||||||
try:
|
if is_py2:
|
||||||
from functools import cached_property
|
bytes = str
|
||||||
except ImportError:
|
str = unicode
|
||||||
# Can be removed once we drop Python <3.8 support.
|
elif is_py3:
|
||||||
# Taken from `django.utils.functional.cached_property`.
|
str = str
|
||||||
class cached_property:
|
bytes = bytes
|
||||||
"""
|
|
||||||
Decorator that converts a method with a single self argument into a
|
|
||||||
property cached on the instance.
|
|
||||||
|
|
||||||
A cached property can be made out of an existing method:
|
|
||||||
(e.g. ``url = cached_property(get_absolute_url)``).
|
|
||||||
The optional ``name`` argument is obsolete as of Python 3.6 and will be
|
|
||||||
deprecated in Django 4.0 (#30127).
|
|
||||||
"""
|
|
||||||
name = None
|
|
||||||
|
|
||||||
@staticmethod
|
try: # pragma: no cover
|
||||||
def func(instance):
|
# noinspection PyUnresolvedReferences,PyCompatibility
|
||||||
raise TypeError(
|
from urllib.parse import urlsplit
|
||||||
'Cannot use cached_property instance without calling '
|
except ImportError: # pragma: no cover
|
||||||
'__set_name__() on it.'
|
# noinspection PyUnresolvedReferences,PyCompatibility
|
||||||
)
|
from urlparse import urlsplit
|
||||||
|
|
||||||
def __init__(self, func, name=None):
|
try: # pragma: no cover
|
||||||
self.real_func = func
|
# noinspection PyCompatibility
|
||||||
self.__doc__ = getattr(func, '__doc__')
|
from urllib.request import urlopen
|
||||||
|
except ImportError: # pragma: no cover
|
||||||
|
# noinspection PyCompatibility
|
||||||
|
from urllib2 import urlopen
|
||||||
|
|
||||||
def __set_name__(self, owner, name):
|
try: # pragma: no cover
|
||||||
if self.name is None:
|
from collections import OrderedDict
|
||||||
self.name = name
|
except ImportError: # pragma: no cover
|
||||||
self.func = self.real_func
|
# Python 2.6 OrderedDict class, needed for headers, parameters, etc .###
|
||||||
elif name != self.name:
|
# <https://pypi.python.org/pypi/ordereddict/1.1>
|
||||||
raise TypeError(
|
# noinspection PyCompatibility
|
||||||
"Cannot assign the same cached_property to two different names "
|
from UserDict import DictMixin
|
||||||
"(%r and %r)." % (self.name, name)
|
|
||||||
)
|
|
||||||
|
|
||||||
def __get__(self, instance, cls=None):
|
# noinspection PyShadowingBuiltins
|
||||||
"""
|
class OrderedDict(dict, DictMixin):
|
||||||
Call the function and put the return value in instance.__dict__ so that
|
# Copyright (c) 2009 Raymond Hettinger
|
||||||
subsequent attribute access on the instance returns the cached value
|
#
|
||||||
instead of calling cached_property.__get__().
|
# Permission is hereby granted, free of charge, to any person
|
||||||
"""
|
# obtaining a copy of this software and associated documentation files
|
||||||
if instance is None:
|
# (the "Software"), to deal in the Software without restriction,
|
||||||
return self
|
# including without limitation the rights to use, copy, modify, merge,
|
||||||
res = instance.__dict__[self.name] = self.func(instance)
|
# publish, distribute, sublicense, and/or sell copies of the Software,
|
||||||
return res
|
# and to permit persons to whom the Software is furnished to do so,
|
||||||
|
# subject to the following conditions:
|
||||||
|
#
|
||||||
|
# The above copyright notice and this permission notice shall be
|
||||||
|
# included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||||
|
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||||
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||||
|
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||||
|
# OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
# noinspection PyMissingConstructor
|
||||||
|
def __init__(self, *args, **kwds):
|
||||||
|
if len(args) > 1:
|
||||||
|
raise TypeError('expected at most 1 arguments, got %d'
|
||||||
|
% len(args))
|
||||||
|
try:
|
||||||
|
self.__end
|
||||||
|
except AttributeError:
|
||||||
|
self.clear()
|
||||||
|
self.update(*args, **kwds)
|
||||||
|
|
||||||
|
def clear(self):
|
||||||
|
self.__end = end = []
|
||||||
|
# noinspection PyUnusedLocal
|
||||||
|
end += [None, end, end] # sentinel node for doubly linked list
|
||||||
|
self.__map = {} # key --> [key, prev, next]
|
||||||
|
dict.clear(self)
|
||||||
|
|
||||||
|
def __setitem__(self, key, value):
|
||||||
|
if key not in self:
|
||||||
|
end = self.__end
|
||||||
|
curr = end[1]
|
||||||
|
curr[2] = end[1] = self.__map[key] = [key, curr, end]
|
||||||
|
dict.__setitem__(self, key, value)
|
||||||
|
|
||||||
|
def __delitem__(self, key):
|
||||||
|
dict.__delitem__(self, key)
|
||||||
|
key, prev, next = self.__map.pop(key)
|
||||||
|
prev[2] = next
|
||||||
|
next[1] = prev
|
||||||
|
|
||||||
|
def __iter__(self):
|
||||||
|
end = self.__end
|
||||||
|
curr = end[2]
|
||||||
|
while curr is not end:
|
||||||
|
yield curr[0]
|
||||||
|
curr = curr[2]
|
||||||
|
|
||||||
|
def __reversed__(self):
|
||||||
|
end = self.__end
|
||||||
|
curr = end[1]
|
||||||
|
while curr is not end:
|
||||||
|
yield curr[0]
|
||||||
|
curr = curr[1]
|
||||||
|
|
||||||
|
def popitem(self, last=True):
|
||||||
|
if not self:
|
||||||
|
raise KeyError('dictionary is empty')
|
||||||
|
if last:
|
||||||
|
key = reversed(self).next()
|
||||||
|
else:
|
||||||
|
key = iter(self).next()
|
||||||
|
value = self.pop(key)
|
||||||
|
return key, value
|
||||||
|
|
||||||
|
def __reduce__(self):
|
||||||
|
items = [[k, self[k]] for k in self]
|
||||||
|
tmp = self.__map, self.__end
|
||||||
|
del self.__map, self.__end
|
||||||
|
inst_dict = vars(self).copy()
|
||||||
|
self.__map, self.__end = tmp
|
||||||
|
if inst_dict:
|
||||||
|
return self.__class__, (items,), inst_dict
|
||||||
|
return self.__class__, (items,)
|
||||||
|
|
||||||
|
def keys(self):
|
||||||
|
return list(self)
|
||||||
|
|
||||||
|
setdefault = DictMixin.setdefault
|
||||||
|
update = DictMixin.update
|
||||||
|
pop = DictMixin.pop
|
||||||
|
values = DictMixin.values
|
||||||
|
items = DictMixin.items
|
||||||
|
iterkeys = DictMixin.iterkeys
|
||||||
|
itervalues = DictMixin.itervalues
|
||||||
|
iteritems = DictMixin.iteritems
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
if not self:
|
||||||
|
return '%s()' % (self.__class__.__name__,)
|
||||||
|
return '%s(%r)' % (self.__class__.__name__, self.items())
|
||||||
|
|
||||||
|
def copy(self):
|
||||||
|
return self.__class__(self)
|
||||||
|
|
||||||
|
# noinspection PyMethodOverriding
|
||||||
|
@classmethod
|
||||||
|
def fromkeys(cls, iterable, value=None):
|
||||||
|
d = cls()
|
||||||
|
for key in iterable:
|
||||||
|
d[key] = value
|
||||||
|
return d
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
if isinstance(other, OrderedDict):
|
||||||
|
if len(self) != len(other):
|
||||||
|
return False
|
||||||
|
for p, q in zip(self.items(), other.items()):
|
||||||
|
if p != q:
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
return dict.__eq__(self, other)
|
||||||
|
|
||||||
|
def __ne__(self, other):
|
||||||
|
return not self == other
|
||||||
|
|||||||
143
httpie/config.py
143
httpie/config.py
@ -1,97 +1,59 @@
|
|||||||
import json
|
|
||||||
import os
|
import os
|
||||||
from pathlib import Path
|
import json
|
||||||
from typing import Union
|
import errno
|
||||||
|
|
||||||
from . import __version__
|
from httpie import __version__
|
||||||
from .compat import is_windows
|
from httpie.compat import is_windows
|
||||||
from .encoding import UTF8
|
|
||||||
|
|
||||||
|
|
||||||
ENV_XDG_CONFIG_HOME = 'XDG_CONFIG_HOME'
|
DEFAULT_CONFIG_DIR = os.environ.get(
|
||||||
ENV_HTTPIE_CONFIG_DIR = 'HTTPIE_CONFIG_DIR'
|
'HTTPIE_CONFIG_DIR',
|
||||||
DEFAULT_CONFIG_DIRNAME = 'httpie'
|
os.path.expanduser('~/.httpie') if not is_windows else
|
||||||
DEFAULT_RELATIVE_XDG_CONFIG_HOME = Path('.config')
|
os.path.expandvars(r'%APPDATA%\\httpie')
|
||||||
DEFAULT_RELATIVE_LEGACY_CONFIG_DIR = Path('.httpie')
|
)
|
||||||
DEFAULT_WINDOWS_CONFIG_DIR = Path(
|
|
||||||
os.path.expandvars('%APPDATA%')) / DEFAULT_CONFIG_DIRNAME
|
|
||||||
|
|
||||||
|
|
||||||
def get_default_config_dir() -> Path:
|
|
||||||
"""
|
|
||||||
Return the path to the httpie configuration directory.
|
|
||||||
|
|
||||||
This directory isn't guaranteed to exist, and nor are any of its
|
|
||||||
ancestors (only the legacy ~/.httpie, if returned, is guaranteed to exist).
|
|
||||||
|
|
||||||
XDG Base Directory Specification support:
|
|
||||||
|
|
||||||
<https://wiki.archlinux.org/index.php/XDG_Base_Directory>
|
|
||||||
|
|
||||||
$XDG_CONFIG_HOME is supported; $XDG_CONFIG_DIRS is not
|
|
||||||
|
|
||||||
"""
|
|
||||||
# 1. explicitly set through env
|
|
||||||
env_config_dir = os.environ.get(ENV_HTTPIE_CONFIG_DIR)
|
|
||||||
if env_config_dir:
|
|
||||||
return Path(env_config_dir)
|
|
||||||
|
|
||||||
# 2. Windows
|
|
||||||
if is_windows:
|
|
||||||
return DEFAULT_WINDOWS_CONFIG_DIR
|
|
||||||
|
|
||||||
home_dir = Path.home()
|
|
||||||
|
|
||||||
# 3. legacy ~/.httpie
|
|
||||||
legacy_config_dir = home_dir / DEFAULT_RELATIVE_LEGACY_CONFIG_DIR
|
|
||||||
if legacy_config_dir.exists():
|
|
||||||
return legacy_config_dir
|
|
||||||
|
|
||||||
# 4. XDG
|
|
||||||
xdg_config_home_dir = os.environ.get(
|
|
||||||
ENV_XDG_CONFIG_HOME, # 4.1. explicit
|
|
||||||
home_dir / DEFAULT_RELATIVE_XDG_CONFIG_HOME # 4.2. default
|
|
||||||
)
|
|
||||||
return Path(xdg_config_home_dir) / DEFAULT_CONFIG_DIRNAME
|
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_CONFIG_DIR = get_default_config_dir()
|
|
||||||
|
|
||||||
|
|
||||||
class ConfigFileError(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class BaseConfigDict(dict):
|
class BaseConfigDict(dict):
|
||||||
|
|
||||||
name = None
|
name = None
|
||||||
helpurl = None
|
helpurl = None
|
||||||
about = None
|
about = None
|
||||||
|
|
||||||
def __init__(self, path: Path):
|
def __getattr__(self, item):
|
||||||
super().__init__()
|
return self[item]
|
||||||
self.path = path
|
|
||||||
|
|
||||||
def ensure_directory(self):
|
def _get_path(self):
|
||||||
self.path.parent.mkdir(mode=0o700, parents=True, exist_ok=True)
|
"""Return the config file path without side-effects."""
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
def is_new(self) -> bool:
|
@property
|
||||||
return not self.path.exists()
|
def path(self):
|
||||||
|
"""Return the config file path creating basedir, if needed."""
|
||||||
|
path = self._get_path()
|
||||||
|
try:
|
||||||
|
os.makedirs(os.path.dirname(path), mode=0o700)
|
||||||
|
except OSError as e:
|
||||||
|
if e.errno != errno.EEXIST:
|
||||||
|
raise
|
||||||
|
return path
|
||||||
|
|
||||||
|
def is_new(self):
|
||||||
|
return not os.path.exists(self._get_path())
|
||||||
|
|
||||||
def load(self):
|
def load(self):
|
||||||
config_type = type(self).__name__.lower()
|
|
||||||
try:
|
try:
|
||||||
with self.path.open(encoding=UTF8) as f:
|
with open(self.path, 'rt') as f:
|
||||||
try:
|
try:
|
||||||
data = json.load(f)
|
data = json.load(f)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise ConfigFileError(
|
raise ValueError(
|
||||||
f'invalid {config_type} file: {e} [{self.path}]'
|
'Invalid %s JSON: %s [%s]' %
|
||||||
|
(type(self).__name__, str(e), self.path)
|
||||||
)
|
)
|
||||||
self.update(data)
|
self.update(data)
|
||||||
except FileNotFoundError:
|
except IOError as e:
|
||||||
pass
|
if e.errno != errno.ENOENT:
|
||||||
except OSError as e:
|
raise
|
||||||
raise ConfigFileError(f'cannot read {config_type} file: {e}')
|
|
||||||
|
|
||||||
def save(self):
|
def save(self):
|
||||||
self['__meta__'] = {
|
self['__meta__'] = {
|
||||||
@ -103,28 +65,33 @@ class BaseConfigDict(dict):
|
|||||||
if self.about:
|
if self.about:
|
||||||
self['__meta__']['about'] = self.about
|
self['__meta__']['about'] = self.about
|
||||||
|
|
||||||
self.ensure_directory()
|
with open(self.path, 'w') as f:
|
||||||
|
json.dump(self, f, indent=4, sort_keys=True, ensure_ascii=True)
|
||||||
|
f.write('\n')
|
||||||
|
|
||||||
json_string = json.dumps(
|
def delete(self):
|
||||||
obj=self,
|
try:
|
||||||
indent=4,
|
os.unlink(self.path)
|
||||||
sort_keys=True,
|
except OSError as e:
|
||||||
ensure_ascii=True,
|
if e.errno != errno.ENOENT:
|
||||||
)
|
raise
|
||||||
self.path.write_text(json_string + '\n', encoding=UTF8)
|
|
||||||
|
|
||||||
|
|
||||||
class Config(BaseConfigDict):
|
class Config(BaseConfigDict):
|
||||||
FILENAME = 'config.json'
|
|
||||||
|
name = 'config'
|
||||||
|
helpurl = 'https://github.com/jakubroztocil/httpie#config'
|
||||||
|
about = 'HTTPie configuration file'
|
||||||
|
|
||||||
DEFAULTS = {
|
DEFAULTS = {
|
||||||
|
'implicit_content_type': 'json',
|
||||||
'default_options': []
|
'default_options': []
|
||||||
}
|
}
|
||||||
|
|
||||||
def __init__(self, directory: Union[str, Path] = DEFAULT_CONFIG_DIR):
|
def __init__(self, directory=DEFAULT_CONFIG_DIR):
|
||||||
self.directory = Path(directory)
|
super(Config, self).__init__()
|
||||||
super().__init__(path=self.directory / self.FILENAME)
|
|
||||||
self.update(self.DEFAULTS)
|
self.update(self.DEFAULTS)
|
||||||
|
self.directory = directory
|
||||||
|
|
||||||
@property
|
def _get_path(self):
|
||||||
def default_options(self) -> list:
|
return os.path.join(self.directory, self.name + '.json')
|
||||||
return self['default_options']
|
|
||||||
|
|||||||
@ -1,22 +1,10 @@
|
|||||||
import sys
|
import sys
|
||||||
import os
|
|
||||||
from pathlib import Path
|
from httpie.compat import is_windows
|
||||||
from typing import IO, Optional
|
from httpie.config import DEFAULT_CONFIG_DIR, Config
|
||||||
|
|
||||||
|
|
||||||
try:
|
class Environment(object):
|
||||||
import curses
|
|
||||||
except ImportError:
|
|
||||||
curses = None # Compiled w/o curses
|
|
||||||
|
|
||||||
from .compat import is_windows
|
|
||||||
from .config import DEFAULT_CONFIG_DIR, Config, ConfigFileError
|
|
||||||
from .encoding import UTF8
|
|
||||||
|
|
||||||
from .utils import repr_dict
|
|
||||||
|
|
||||||
|
|
||||||
class Environment:
|
|
||||||
"""
|
"""
|
||||||
Information about the execution context
|
Information about the execution context
|
||||||
(standard streams, config directory, etc).
|
(standard streams, config directory, etc).
|
||||||
@ -26,25 +14,29 @@ class Environment:
|
|||||||
is used by the test suite to simulate various scenarios.
|
is used by the test suite to simulate various scenarios.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
is_windows: bool = is_windows
|
is_windows = is_windows
|
||||||
config_dir: Path = DEFAULT_CONFIG_DIR
|
config_dir = DEFAULT_CONFIG_DIR
|
||||||
stdin: Optional[IO] = sys.stdin # `None` when closed fd (#791)
|
stdin = sys.stdin
|
||||||
stdin_isatty: bool = stdin.isatty() if stdin else False
|
stdin_isatty = stdin.isatty()
|
||||||
stdin_encoding: str = None
|
stdin_encoding = None
|
||||||
stdout: IO = sys.stdout
|
stdout = sys.stdout
|
||||||
stdout_isatty: bool = stdout.isatty()
|
stdout_isatty = stdout.isatty()
|
||||||
stdout_encoding: str = None
|
stdout_encoding = None
|
||||||
stderr: IO = sys.stderr
|
stderr = sys.stderr
|
||||||
stderr_isatty: bool = stderr.isatty()
|
stderr_isatty = stderr.isatty()
|
||||||
colors = 256
|
colors = 256
|
||||||
program_name: str = 'http'
|
|
||||||
if not is_windows:
|
if not is_windows:
|
||||||
if curses:
|
import curses
|
||||||
|
try:
|
||||||
|
curses.setupterm()
|
||||||
try:
|
try:
|
||||||
curses.setupterm()
|
|
||||||
colors = curses.tigetnum('colors')
|
colors = curses.tigetnum('colors')
|
||||||
except curses.error:
|
except TypeError:
|
||||||
pass
|
# pypy3 (2.4.0)
|
||||||
|
colors = curses.tigetnum(b'colors')
|
||||||
|
except curses.error:
|
||||||
|
pass
|
||||||
|
del curses
|
||||||
else:
|
else:
|
||||||
# noinspection PyUnresolvedReferences
|
# noinspection PyUnresolvedReferences
|
||||||
import colorama.initialise
|
import colorama.initialise
|
||||||
@ -58,7 +50,7 @@ class Environment:
|
|||||||
)
|
)
|
||||||
del colorama
|
del colorama
|
||||||
|
|
||||||
def __init__(self, devnull=None, **kwargs):
|
def __init__(self, **kwargs):
|
||||||
"""
|
"""
|
||||||
Use keyword arguments to overwrite
|
Use keyword arguments to overwrite
|
||||||
any of the class attributes for this instance.
|
any of the class attributes for this instance.
|
||||||
@ -67,59 +59,26 @@ class Environment:
|
|||||||
assert all(hasattr(type(self), attr) for attr in kwargs.keys())
|
assert all(hasattr(type(self), attr) for attr in kwargs.keys())
|
||||||
self.__dict__.update(**kwargs)
|
self.__dict__.update(**kwargs)
|
||||||
|
|
||||||
# The original STDERR unaffected by --quiet’ing.
|
# Keyword arguments > stream.encoding > default utf8
|
||||||
self._orig_stderr = self.stderr
|
if self.stdin_encoding is None:
|
||||||
self._devnull = devnull
|
|
||||||
|
|
||||||
# Keyword arguments > stream.encoding > default UTF-8
|
|
||||||
if self.stdin and self.stdin_encoding is None:
|
|
||||||
self.stdin_encoding = getattr(
|
self.stdin_encoding = getattr(
|
||||||
self.stdin, 'encoding', None) or UTF8
|
self.stdin, 'encoding', None) or 'utf8'
|
||||||
if self.stdout_encoding is None:
|
if self.stdout_encoding is None:
|
||||||
actual_stdout = self.stdout
|
actual_stdout = self.stdout
|
||||||
if is_windows:
|
if is_windows:
|
||||||
# noinspection PyUnresolvedReferences
|
# noinspection PyUnresolvedReferences
|
||||||
from colorama import AnsiToWin32
|
from colorama import AnsiToWin32
|
||||||
if isinstance(self.stdout, AnsiToWin32):
|
if isinstance(self.stdout, AnsiToWin32):
|
||||||
# noinspection PyUnresolvedReferences
|
|
||||||
actual_stdout = self.stdout.wrapped
|
actual_stdout = self.stdout.wrapped
|
||||||
self.stdout_encoding = getattr(
|
self.stdout_encoding = getattr(
|
||||||
actual_stdout, 'encoding', None) or UTF8
|
actual_stdout, 'encoding', None) or 'utf8'
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
defaults = dict(type(self).__dict__)
|
|
||||||
actual = dict(defaults)
|
|
||||||
actual.update(self.__dict__)
|
|
||||||
actual['config'] = self.config
|
|
||||||
return repr_dict({
|
|
||||||
key: value
|
|
||||||
for key, value in actual.items()
|
|
||||||
if not key.startswith('_')
|
|
||||||
})
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return f'<{type(self).__name__} {self}>'
|
|
||||||
|
|
||||||
_config: Config = None
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def config(self) -> Config:
|
def config(self):
|
||||||
config = self._config
|
if not hasattr(self, '_config'):
|
||||||
if not config:
|
self._config = Config(directory=self.config_dir)
|
||||||
self._config = config = Config(directory=self.config_dir)
|
if self._config.is_new():
|
||||||
if not config.is_new():
|
self._config.save()
|
||||||
try:
|
else:
|
||||||
config.load()
|
self._config.load()
|
||||||
except ConfigFileError as e:
|
return self._config
|
||||||
self.log_error(e, level='warning')
|
|
||||||
return config
|
|
||||||
|
|
||||||
@property
|
|
||||||
def devnull(self) -> IO:
|
|
||||||
if self._devnull is None:
|
|
||||||
self._devnull = open(os.devnull, 'w+')
|
|
||||||
return self._devnull
|
|
||||||
|
|
||||||
def log_error(self, msg, level='error'):
|
|
||||||
assert level in ['error', 'warning']
|
|
||||||
self._orig_stderr.write(f'\n{self.program_name}: {level}: {msg}\n\n')
|
|
||||||
|
|||||||
401
httpie/core.py
401
httpie/core.py
@ -1,252 +1,193 @@
|
|||||||
import argparse
|
"""This module provides the main functionality of HTTPie.
|
||||||
import os
|
|
||||||
import platform
|
Invocation flow:
|
||||||
|
|
||||||
|
1. Read, validate and process the input (args, `stdin`).
|
||||||
|
2. Create and send a request.
|
||||||
|
3. Stream, and possibly process and format, the parts
|
||||||
|
of the request-response exchange selected by output options.
|
||||||
|
4. Simultaneously write to `stdout`
|
||||||
|
5. Exit.
|
||||||
|
|
||||||
|
"""
|
||||||
import sys
|
import sys
|
||||||
from typing import List, Optional, Tuple, Union
|
import errno
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
from pygments import __version__ as pygments_version
|
|
||||||
from requests import __version__ as requests_version
|
from requests import __version__ as requests_version
|
||||||
|
from pygments import __version__ as pygments_version
|
||||||
|
|
||||||
from . import __version__ as httpie_version
|
from httpie import __version__ as httpie_version, ExitStatus
|
||||||
from .cli.constants import OUT_REQ_BODY, OUT_REQ_HEAD, OUT_RESP_BODY, OUT_RESP_HEAD
|
from httpie.compat import str, bytes, is_py3
|
||||||
from .client import collect_messages
|
from httpie.client import get_response
|
||||||
from .context import Environment
|
from httpie.downloads import Download
|
||||||
from .downloads import Downloader
|
from httpie.context import Environment
|
||||||
from .output.writer import write_message, write_stream, MESSAGE_SEPARATOR_BYTES
|
from httpie.plugins import plugin_manager
|
||||||
from .plugins.registry import plugin_manager
|
from httpie.output.streams import (
|
||||||
from .status import ExitStatus, http_status_to_exit_status
|
build_output_stream,
|
||||||
|
write, write_with_colors_win_py3
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
# noinspection PyDefaultArgument
|
def get_exit_status(http_status, follow=False):
|
||||||
def main(args: List[Union[str, bytes]] = sys.argv, env=Environment()) -> ExitStatus:
|
"""Translate HTTP status code to exit status code."""
|
||||||
"""
|
if 300 <= http_status <= 399 and not follow:
|
||||||
The main function.
|
# Redirect
|
||||||
|
return ExitStatus.ERROR_HTTP_3XX
|
||||||
Pre-process args, handle some special types of invocations,
|
elif 400 <= http_status <= 499:
|
||||||
and run the main program with error handling.
|
# Client Error
|
||||||
|
return ExitStatus.ERROR_HTTP_4XX
|
||||||
Return exit status code.
|
elif 500 <= http_status <= 599:
|
||||||
|
# Server Error
|
||||||
"""
|
return ExitStatus.ERROR_HTTP_5XX
|
||||||
if '--prompt' in args:
|
|
||||||
from .prompt.cli import cli
|
|
||||||
return cli(sys.argv[2:])
|
|
||||||
|
|
||||||
program_name, *args = args
|
|
||||||
env.program_name = os.path.basename(program_name)
|
|
||||||
args = decode_raw_args(args, env.stdin_encoding)
|
|
||||||
plugin_manager.load_installed_plugins()
|
|
||||||
|
|
||||||
from .cli.definition import parser
|
|
||||||
|
|
||||||
if env.config.default_options:
|
|
||||||
args = env.config.default_options + args
|
|
||||||
|
|
||||||
include_debug_info = '--debug' in args
|
|
||||||
include_traceback = include_debug_info or '--traceback' in args
|
|
||||||
|
|
||||||
if include_debug_info:
|
|
||||||
print_debug_info(env)
|
|
||||||
if args == ['--debug']:
|
|
||||||
return ExitStatus.SUCCESS
|
|
||||||
|
|
||||||
exit_status = ExitStatus.SUCCESS
|
|
||||||
|
|
||||||
try:
|
|
||||||
parsed_args = parser.parse_args(
|
|
||||||
args=args,
|
|
||||||
env=env,
|
|
||||||
)
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
env.stderr.write('\n')
|
|
||||||
if include_traceback:
|
|
||||||
raise
|
|
||||||
exit_status = ExitStatus.ERROR_CTRL_C
|
|
||||||
except SystemExit as e:
|
|
||||||
if e.code != ExitStatus.SUCCESS:
|
|
||||||
env.stderr.write('\n')
|
|
||||||
if include_traceback:
|
|
||||||
raise
|
|
||||||
exit_status = ExitStatus.ERROR
|
|
||||||
else:
|
else:
|
||||||
try:
|
return ExitStatus.OK
|
||||||
exit_status = program(
|
|
||||||
args=parsed_args,
|
|
||||||
env=env,
|
|
||||||
)
|
|
||||||
except KeyboardInterrupt:
|
|
||||||
env.stderr.write('\n')
|
|
||||||
if include_traceback:
|
|
||||||
raise
|
|
||||||
exit_status = ExitStatus.ERROR_CTRL_C
|
|
||||||
except SystemExit as e:
|
|
||||||
if e.code != ExitStatus.SUCCESS:
|
|
||||||
env.stderr.write('\n')
|
|
||||||
if include_traceback:
|
|
||||||
raise
|
|
||||||
exit_status = ExitStatus.ERROR
|
|
||||||
except requests.Timeout:
|
|
||||||
exit_status = ExitStatus.ERROR_TIMEOUT
|
|
||||||
env.log_error(f'Request timed out ({parsed_args.timeout}s).')
|
|
||||||
except requests.TooManyRedirects:
|
|
||||||
exit_status = ExitStatus.ERROR_TOO_MANY_REDIRECTS
|
|
||||||
env.log_error(
|
|
||||||
f'Too many redirects'
|
|
||||||
f' (--max-redirects={parsed_args.max_redirects}).'
|
|
||||||
)
|
|
||||||
except Exception as e:
|
|
||||||
# TODO: Further distinction between expected and unexpected errors.
|
|
||||||
msg = str(e)
|
|
||||||
if hasattr(e, 'request'):
|
|
||||||
request = e.request
|
|
||||||
if hasattr(request, 'url'):
|
|
||||||
msg = (
|
|
||||||
f'{msg} while doing a {request.method}'
|
|
||||||
f' request to URL: {request.url}'
|
|
||||||
)
|
|
||||||
env.log_error(f'{type(e).__name__}: {msg}')
|
|
||||||
if include_traceback:
|
|
||||||
raise
|
|
||||||
exit_status = ExitStatus.ERROR
|
|
||||||
|
|
||||||
return exit_status
|
|
||||||
|
|
||||||
|
|
||||||
def get_output_options(
|
def print_debug_info(env):
|
||||||
args: argparse.Namespace,
|
|
||||||
message: Union[requests.PreparedRequest, requests.Response]
|
|
||||||
) -> Tuple[bool, bool]:
|
|
||||||
return {
|
|
||||||
requests.PreparedRequest: (
|
|
||||||
OUT_REQ_HEAD in args.output_options,
|
|
||||||
OUT_REQ_BODY in args.output_options,
|
|
||||||
),
|
|
||||||
requests.Response: (
|
|
||||||
OUT_RESP_HEAD in args.output_options,
|
|
||||||
OUT_RESP_BODY in args.output_options,
|
|
||||||
),
|
|
||||||
}[type(message)]
|
|
||||||
|
|
||||||
|
|
||||||
def program(args: argparse.Namespace, env: Environment) -> ExitStatus:
|
|
||||||
"""
|
|
||||||
The main program without error handling.
|
|
||||||
|
|
||||||
"""
|
|
||||||
# TODO: Refactor and drastically simplify, especially so that the separator logic is elsewhere.
|
|
||||||
exit_status = ExitStatus.SUCCESS
|
|
||||||
downloader = None
|
|
||||||
initial_request: Optional[requests.PreparedRequest] = None
|
|
||||||
final_response: Optional[requests.Response] = None
|
|
||||||
|
|
||||||
def separate():
|
|
||||||
getattr(env.stdout, 'buffer', env.stdout).write(MESSAGE_SEPARATOR_BYTES)
|
|
||||||
|
|
||||||
def request_body_read_callback(chunk: bytes):
|
|
||||||
should_pipe_to_stdout = bool(
|
|
||||||
# Request body output desired
|
|
||||||
OUT_REQ_BODY in args.output_options
|
|
||||||
# & not `.read()` already pre-request (e.g., for compression)
|
|
||||||
and initial_request
|
|
||||||
# & non-EOF chunk
|
|
||||||
and chunk
|
|
||||||
)
|
|
||||||
if should_pipe_to_stdout:
|
|
||||||
msg = requests.PreparedRequest()
|
|
||||||
msg.is_body_upload_chunk = True
|
|
||||||
msg.body = chunk
|
|
||||||
msg.headers = initial_request.headers
|
|
||||||
write_message(requests_message=msg, env=env, args=args, with_body=True, with_headers=False)
|
|
||||||
|
|
||||||
try:
|
|
||||||
if args.download:
|
|
||||||
args.follow = True # --download implies --follow.
|
|
||||||
downloader = Downloader(output_file=args.output_file, progress_file=env.stderr, resume=args.download_resume)
|
|
||||||
downloader.pre_request(args.headers)
|
|
||||||
messages = collect_messages(args=args, config_dir=env.config.directory,
|
|
||||||
request_body_read_callback=request_body_read_callback)
|
|
||||||
force_separator = False
|
|
||||||
prev_with_body = False
|
|
||||||
|
|
||||||
# Process messages as they’re generated
|
|
||||||
for message in messages:
|
|
||||||
is_request = isinstance(message, requests.PreparedRequest)
|
|
||||||
with_headers, with_body = get_output_options(args=args, message=message)
|
|
||||||
do_write_body = with_body
|
|
||||||
if prev_with_body and (with_headers or with_body) and (force_separator or not env.stdout_isatty):
|
|
||||||
# Separate after a previous message with body, if needed. See test_tokens.py.
|
|
||||||
separate()
|
|
||||||
force_separator = False
|
|
||||||
if is_request:
|
|
||||||
if not initial_request:
|
|
||||||
initial_request = message
|
|
||||||
if with_body:
|
|
||||||
is_streamed_upload = not isinstance(message.body, (str, bytes))
|
|
||||||
do_write_body = not is_streamed_upload
|
|
||||||
force_separator = is_streamed_upload and env.stdout_isatty
|
|
||||||
else:
|
|
||||||
final_response = message
|
|
||||||
if args.check_status or downloader:
|
|
||||||
exit_status = http_status_to_exit_status(http_status=message.status_code, follow=args.follow)
|
|
||||||
if exit_status != ExitStatus.SUCCESS and (not env.stdout_isatty or args.quiet):
|
|
||||||
env.log_error(f'HTTP {message.raw.status} {message.raw.reason}', level='warning')
|
|
||||||
write_message(requests_message=message, env=env, args=args, with_headers=with_headers,
|
|
||||||
with_body=do_write_body)
|
|
||||||
prev_with_body = with_body
|
|
||||||
|
|
||||||
# Cleanup
|
|
||||||
if force_separator:
|
|
||||||
separate()
|
|
||||||
if downloader and exit_status == ExitStatus.SUCCESS:
|
|
||||||
# Last response body download.
|
|
||||||
download_stream, download_to = downloader.start(
|
|
||||||
initial_url=initial_request.url,
|
|
||||||
final_response=final_response,
|
|
||||||
)
|
|
||||||
write_stream(stream=download_stream, outfile=download_to, flush=False)
|
|
||||||
downloader.finish()
|
|
||||||
if downloader.interrupted:
|
|
||||||
exit_status = ExitStatus.ERROR
|
|
||||||
env.log_error(
|
|
||||||
f'Incomplete download: size={downloader.status.total_size};'
|
|
||||||
f' downloaded={downloader.status.downloaded}'
|
|
||||||
)
|
|
||||||
return exit_status
|
|
||||||
|
|
||||||
finally:
|
|
||||||
if downloader and not downloader.finished:
|
|
||||||
downloader.failed()
|
|
||||||
if args.output_file and args.output_file_specified:
|
|
||||||
args.output_file.close()
|
|
||||||
|
|
||||||
|
|
||||||
def print_debug_info(env: Environment):
|
|
||||||
env.stderr.writelines([
|
env.stderr.writelines([
|
||||||
f'HTTPie {httpie_version}\n',
|
'HTTPie %s\n' % httpie_version,
|
||||||
f'Requests {requests_version}\n',
|
'HTTPie data: %s\n' % env.config.directory,
|
||||||
f'Pygments {pygments_version}\n',
|
'Requests %s\n' % requests_version,
|
||||||
f'Python {sys.version}\n{sys.executable}\n',
|
'Pygments %s\n' % pygments_version,
|
||||||
f'{platform.system()} {platform.release()}',
|
'Python %s %s\n' % (sys.version, sys.platform)
|
||||||
])
|
])
|
||||||
env.stderr.write('\n\n')
|
|
||||||
env.stderr.write(repr(env))
|
|
||||||
env.stderr.write('\n\n')
|
|
||||||
env.stderr.write(repr(plugin_manager))
|
|
||||||
env.stderr.write('\n')
|
|
||||||
|
|
||||||
|
|
||||||
def decode_raw_args(
|
def decode_args(args, stdin_encoding):
|
||||||
args: List[Union[str, bytes]],
|
|
||||||
stdin_encoding: str
|
|
||||||
) -> List[str]:
|
|
||||||
"""
|
"""
|
||||||
Convert all bytes args to str
|
Convert all bytes ags to str
|
||||||
by decoding them using stdin encoding.
|
by decoding them using stdin encoding.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return [
|
return [
|
||||||
arg.decode(stdin_encoding)
|
arg.decode(stdin_encoding)
|
||||||
if type(arg) is bytes else arg
|
if type(arg) == bytes else arg
|
||||||
for arg in args
|
for arg in args
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def main(args=sys.argv[1:], env=Environment()):
|
||||||
|
"""Run the main program and write the output to ``env.stdout``.
|
||||||
|
|
||||||
|
Return exit status code.
|
||||||
|
|
||||||
|
"""
|
||||||
|
args = decode_args(args, env.stdin_encoding)
|
||||||
|
plugin_manager.load_installed_plugins()
|
||||||
|
|
||||||
|
from httpie.cli import parser
|
||||||
|
|
||||||
|
if env.config.default_options:
|
||||||
|
args = env.config.default_options + args
|
||||||
|
|
||||||
|
def error(msg, *args, **kwargs):
|
||||||
|
msg = msg % args
|
||||||
|
level = kwargs.get('level', 'error')
|
||||||
|
env.stderr.write('\nhttp: %s: %s\n' % (level, msg))
|
||||||
|
|
||||||
|
debug = '--debug' in args
|
||||||
|
traceback = debug or '--traceback' in args
|
||||||
|
exit_status = ExitStatus.OK
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print_debug_info(env)
|
||||||
|
if args == ['--debug']:
|
||||||
|
return exit_status
|
||||||
|
|
||||||
|
download = None
|
||||||
|
|
||||||
|
try:
|
||||||
|
args = parser.parse_args(args=args, env=env)
|
||||||
|
|
||||||
|
if args.download:
|
||||||
|
args.follow = True # --download implies --follow.
|
||||||
|
download = Download(
|
||||||
|
output_file=args.output_file,
|
||||||
|
progress_file=env.stderr,
|
||||||
|
resume=args.download_resume
|
||||||
|
)
|
||||||
|
download.pre_request(args.headers)
|
||||||
|
|
||||||
|
response = get_response(args, config_dir=env.config.directory)
|
||||||
|
|
||||||
|
if args.check_status or download:
|
||||||
|
|
||||||
|
exit_status = get_exit_status(
|
||||||
|
http_status=response.status_code,
|
||||||
|
follow=args.follow
|
||||||
|
)
|
||||||
|
|
||||||
|
if not env.stdout_isatty and exit_status != ExitStatus.OK:
|
||||||
|
error('HTTP %s %s',
|
||||||
|
response.raw.status,
|
||||||
|
response.raw.reason,
|
||||||
|
level='warning')
|
||||||
|
|
||||||
|
write_kwargs = {
|
||||||
|
'stream': build_output_stream(
|
||||||
|
args, env, response.request, response),
|
||||||
|
|
||||||
|
# This will in fact be `stderr` with `--download`
|
||||||
|
'outfile': env.stdout,
|
||||||
|
|
||||||
|
'flush': env.stdout_isatty or args.stream
|
||||||
|
}
|
||||||
|
|
||||||
|
try:
|
||||||
|
|
||||||
|
if env.is_windows and is_py3 and 'colors' in args.prettify:
|
||||||
|
write_with_colors_win_py3(**write_kwargs)
|
||||||
|
else:
|
||||||
|
write(**write_kwargs)
|
||||||
|
|
||||||
|
if download and exit_status == ExitStatus.OK:
|
||||||
|
# Response body download.
|
||||||
|
download_stream, download_to = download.start(response)
|
||||||
|
write(
|
||||||
|
stream=download_stream,
|
||||||
|
outfile=download_to,
|
||||||
|
flush=False,
|
||||||
|
)
|
||||||
|
download.finish()
|
||||||
|
if download.interrupted:
|
||||||
|
exit_status = ExitStatus.ERROR
|
||||||
|
error('Incomplete download: size=%d; downloaded=%d' % (
|
||||||
|
download.status.total_size,
|
||||||
|
download.status.downloaded
|
||||||
|
))
|
||||||
|
|
||||||
|
except IOError as e:
|
||||||
|
if not traceback and e.errno == errno.EPIPE:
|
||||||
|
# Ignore broken pipes unless --traceback.
|
||||||
|
env.stderr.write('\n')
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
if traceback:
|
||||||
|
raise
|
||||||
|
env.stderr.write('\n')
|
||||||
|
exit_status = ExitStatus.ERROR
|
||||||
|
except SystemExit as e:
|
||||||
|
if e.code != ExitStatus.OK:
|
||||||
|
if traceback:
|
||||||
|
raise
|
||||||
|
env.stderr.write('\n')
|
||||||
|
exit_status = ExitStatus.ERROR
|
||||||
|
except requests.Timeout:
|
||||||
|
exit_status = ExitStatus.ERROR_TIMEOUT
|
||||||
|
error('Request timed out (%ss).', args.timeout)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
# TODO: Better distinction between expected and unexpected errors.
|
||||||
|
# Network errors vs. bugs, etc.
|
||||||
|
if traceback:
|
||||||
|
raise
|
||||||
|
error('%s: %s', type(e).__name__, str(e))
|
||||||
|
exit_status = ExitStatus.ERROR
|
||||||
|
|
||||||
|
finally:
|
||||||
|
if download and not download.finished:
|
||||||
|
download.failed()
|
||||||
|
|
||||||
|
return exit_status
|
||||||
|
|||||||
@ -1,26 +1,26 @@
|
|||||||
|
# coding=utf-8
|
||||||
"""
|
"""
|
||||||
Download mode implementation.
|
Download mode implementation.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
import mimetypes
|
from __future__ import division
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import sys
|
import sys
|
||||||
|
import mimetypes
|
||||||
import threading
|
import threading
|
||||||
|
from time import sleep, time
|
||||||
from mailbox import Message
|
from mailbox import Message
|
||||||
from time import sleep, monotonic
|
|
||||||
from typing import IO, Optional, Tuple
|
|
||||||
from urllib.parse import urlsplit
|
|
||||||
|
|
||||||
import requests
|
from httpie.output.streams import RawStream
|
||||||
|
from httpie.models import HTTPResponse
|
||||||
from .models import HTTPResponse
|
from httpie.utils import humanize_bytes
|
||||||
from .output.streams import RawStream
|
from httpie.compat import urlsplit
|
||||||
from .utils import humanize_bytes
|
|
||||||
|
|
||||||
|
|
||||||
PARTIAL_CONTENT = 206
|
PARTIAL_CONTENT = 206
|
||||||
|
|
||||||
|
|
||||||
CLEAR_LINE = '\r\033[K'
|
CLEAR_LINE = '\r\033[K'
|
||||||
PROGRESS = (
|
PROGRESS = (
|
||||||
'{percentage: 6.2f} %'
|
'{percentage: 6.2f} %'
|
||||||
@ -37,11 +37,11 @@ class ContentRangeError(ValueError):
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def parse_content_range(content_range: str, resumed_from: int) -> int:
|
def parse_content_range(content_range, resumed_from):
|
||||||
"""
|
"""
|
||||||
Parse and validate Content-Range header.
|
Parse and validate Content-Range header.
|
||||||
|
|
||||||
<https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html>
|
<http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html>
|
||||||
|
|
||||||
:param content_range: the value of a Content-Range response header
|
:param content_range: the value of a Content-Range response header
|
||||||
eg. "bytes 21010-47021/47022"
|
eg. "bytes 21010-47021/47022"
|
||||||
@ -53,14 +53,14 @@ def parse_content_range(content_range: str, resumed_from: int) -> int:
|
|||||||
raise ContentRangeError('Missing Content-Range')
|
raise ContentRangeError('Missing Content-Range')
|
||||||
|
|
||||||
pattern = (
|
pattern = (
|
||||||
r'^bytes (?P<first_byte_pos>\d+)-(?P<last_byte_pos>\d+)'
|
'^bytes (?P<first_byte_pos>\d+)-(?P<last_byte_pos>\d+)'
|
||||||
r'/(\*|(?P<instance_length>\d+))$'
|
'/(\*|(?P<instance_length>\d+))$'
|
||||||
)
|
)
|
||||||
match = re.match(pattern, content_range)
|
match = re.match(pattern, content_range)
|
||||||
|
|
||||||
if not match:
|
if not match:
|
||||||
raise ContentRangeError(
|
raise ContentRangeError(
|
||||||
f'Invalid Content-Range format {content_range!r}')
|
'Invalid Content-Range format %r' % content_range)
|
||||||
|
|
||||||
content_range_dict = match.groupdict()
|
content_range_dict = match.groupdict()
|
||||||
first_byte_pos = int(content_range_dict['first_byte_pos'])
|
first_byte_pos = int(content_range_dict['first_byte_pos'])
|
||||||
@ -77,27 +77,26 @@ def parse_content_range(content_range: str, resumed_from: int) -> int:
|
|||||||
# last-byte-pos value, is invalid. The recipient of an invalid
|
# last-byte-pos value, is invalid. The recipient of an invalid
|
||||||
# byte-content-range- spec MUST ignore it and any content
|
# byte-content-range- spec MUST ignore it and any content
|
||||||
# transferred along with it."
|
# transferred along with it."
|
||||||
if (first_byte_pos > last_byte_pos
|
if (first_byte_pos >= last_byte_pos
|
||||||
or (instance_length is not None
|
or (instance_length is not None
|
||||||
and instance_length <= last_byte_pos)):
|
and instance_length <= last_byte_pos)):
|
||||||
raise ContentRangeError(
|
raise ContentRangeError(
|
||||||
f'Invalid Content-Range returned: {content_range!r}')
|
'Invalid Content-Range returned: %r' % content_range)
|
||||||
|
|
||||||
if (first_byte_pos != resumed_from
|
if (first_byte_pos != resumed_from
|
||||||
or (instance_length is not None
|
or (instance_length is not None
|
||||||
and last_byte_pos + 1 != instance_length)):
|
and last_byte_pos + 1 != instance_length)):
|
||||||
# Not what we asked for.
|
# Not what we asked for.
|
||||||
raise ContentRangeError(
|
raise ContentRangeError(
|
||||||
f'Unexpected Content-Range returned ({content_range!r})'
|
'Unexpected Content-Range returned (%r)'
|
||||||
f' for the requested Range ("bytes={resumed_from}-")'
|
' for the requested Range ("bytes=%d-")'
|
||||||
|
% (content_range, resumed_from)
|
||||||
)
|
)
|
||||||
|
|
||||||
return last_byte_pos + 1
|
return last_byte_pos + 1
|
||||||
|
|
||||||
|
|
||||||
def filename_from_content_disposition(
|
def filename_from_content_disposition(content_disposition):
|
||||||
content_disposition: str
|
|
||||||
) -> Optional[str]:
|
|
||||||
"""
|
"""
|
||||||
Extract and validate filename from a Content-Disposition header.
|
Extract and validate filename from a Content-Disposition header.
|
||||||
|
|
||||||
@ -107,7 +106,7 @@ def filename_from_content_disposition(
|
|||||||
"""
|
"""
|
||||||
# attachment; filename=jakubroztocil-httpie-0.4.1-20-g40bd8f6.tar.gz
|
# attachment; filename=jakubroztocil-httpie-0.4.1-20-g40bd8f6.tar.gz
|
||||||
|
|
||||||
msg = Message(f'Content-Disposition: {content_disposition}')
|
msg = Message('Content-Disposition: %s' % content_disposition)
|
||||||
filename = msg.get_filename()
|
filename = msg.get_filename()
|
||||||
if filename:
|
if filename:
|
||||||
# Basic sanitation.
|
# Basic sanitation.
|
||||||
@ -116,7 +115,7 @@ def filename_from_content_disposition(
|
|||||||
return filename
|
return filename
|
||||||
|
|
||||||
|
|
||||||
def filename_from_url(url: str, content_type: Optional[str]) -> str:
|
def filename_from_url(url, content_type):
|
||||||
fn = urlsplit(url).path.rstrip('/')
|
fn = urlsplit(url).path.rstrip('/')
|
||||||
fn = os.path.basename(fn) if fn else 'index'
|
fn = os.path.basename(fn) if fn else 'index'
|
||||||
if '.' not in fn and content_type:
|
if '.' not in fn and content_type:
|
||||||
@ -127,7 +126,7 @@ def filename_from_url(url: str, content_type: Optional[str]) -> str:
|
|||||||
else:
|
else:
|
||||||
ext = mimetypes.guess_extension(content_type)
|
ext = mimetypes.guess_extension(content_type)
|
||||||
|
|
||||||
if ext == '.htm':
|
if ext == '.htm': # Python 3
|
||||||
ext = '.html'
|
ext = '.html'
|
||||||
|
|
||||||
if ext:
|
if ext:
|
||||||
@ -136,53 +135,23 @@ def filename_from_url(url: str, content_type: Optional[str]) -> str:
|
|||||||
return fn
|
return fn
|
||||||
|
|
||||||
|
|
||||||
def trim_filename(filename: str, max_len: int) -> str:
|
def get_unique_filename(filename, exists=os.path.exists):
|
||||||
if len(filename) > max_len:
|
|
||||||
trim_by = len(filename) - max_len
|
|
||||||
name, ext = os.path.splitext(filename)
|
|
||||||
if trim_by >= len(name):
|
|
||||||
filename = filename[:-trim_by]
|
|
||||||
else:
|
|
||||||
filename = name[:-trim_by] + ext
|
|
||||||
return filename
|
|
||||||
|
|
||||||
|
|
||||||
def get_filename_max_length(directory: str) -> int:
|
|
||||||
max_len = 255
|
|
||||||
if hasattr(os, 'pathconf') and 'PC_NAME_MAX' in os.pathconf_names:
|
|
||||||
max_len = os.pathconf(directory, 'PC_NAME_MAX')
|
|
||||||
return max_len
|
|
||||||
|
|
||||||
|
|
||||||
def trim_filename_if_needed(filename: str, directory='.', extra=0) -> str:
|
|
||||||
max_len = get_filename_max_length(directory) - extra
|
|
||||||
if len(filename) > max_len:
|
|
||||||
filename = trim_filename(filename, max_len)
|
|
||||||
return filename
|
|
||||||
|
|
||||||
|
|
||||||
def get_unique_filename(filename: str, exists=os.path.exists) -> str:
|
|
||||||
attempt = 0
|
attempt = 0
|
||||||
while True:
|
while True:
|
||||||
suffix = f'-{attempt}' if attempt > 0 else ''
|
suffix = '-' + str(attempt) if attempt > 0 else ''
|
||||||
try_filename = trim_filename_if_needed(filename, extra=len(suffix))
|
if not exists(filename + suffix):
|
||||||
try_filename += suffix
|
return filename + suffix
|
||||||
if not exists(try_filename):
|
|
||||||
return try_filename
|
|
||||||
attempt += 1
|
attempt += 1
|
||||||
|
|
||||||
|
|
||||||
class Downloader:
|
class Download(object):
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, output_file=None,
|
||||||
self,
|
resume=False, progress_file=sys.stderr):
|
||||||
output_file: IO = None,
|
|
||||||
resume: bool = False,
|
|
||||||
progress_file: IO = sys.stderr
|
|
||||||
):
|
|
||||||
"""
|
"""
|
||||||
:param resume: Should the download resume if partial download
|
:param resume: Should the download resume if partial download
|
||||||
already exists.
|
already exists.
|
||||||
|
:type resume: bool
|
||||||
|
|
||||||
:param output_file: The file to store response body in. If not
|
:param output_file: The file to store response body in. If not
|
||||||
provided, it will be guessed from the response.
|
provided, it will be guessed from the response.
|
||||||
@ -190,66 +159,57 @@ class Downloader:
|
|||||||
:param progress_file: Where to report download progress.
|
:param progress_file: Where to report download progress.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
self.finished = False
|
|
||||||
self.status = DownloadStatus()
|
|
||||||
self._output_file = output_file
|
self._output_file = output_file
|
||||||
self._resume = resume
|
self._resume = resume
|
||||||
self._resumed_from = 0
|
self._resumed_from = 0
|
||||||
|
self.finished = False
|
||||||
|
|
||||||
|
self.status = Status()
|
||||||
self._progress_reporter = ProgressReporterThread(
|
self._progress_reporter = ProgressReporterThread(
|
||||||
status=self.status,
|
status=self.status,
|
||||||
output=progress_file
|
output=progress_file
|
||||||
)
|
)
|
||||||
|
|
||||||
def pre_request(self, request_headers: dict):
|
def pre_request(self, request_headers):
|
||||||
"""Called just before the HTTP request is sent.
|
"""Called just before the HTTP request is sent.
|
||||||
|
|
||||||
Might alter `request_headers`.
|
Might alter `request_headers`.
|
||||||
|
|
||||||
|
:type request_headers: dict
|
||||||
|
|
||||||
"""
|
"""
|
||||||
# Ask the server not to encode the content so that we can resume, etc.
|
# Disable content encoding so that we can resume, etc.
|
||||||
request_headers['Accept-Encoding'] = 'identity'
|
request_headers['Accept-Encoding'] = None
|
||||||
if self._resume:
|
if self._resume:
|
||||||
bytes_have = os.path.getsize(self._output_file.name)
|
bytes_have = os.path.getsize(self._output_file.name)
|
||||||
if bytes_have:
|
if bytes_have:
|
||||||
# Set ``Range`` header to resume the download
|
# Set ``Range`` header to resume the download
|
||||||
# TODO: Use "If-Range: mtime" to make sure it's fresh?
|
# TODO: Use "If-Range: mtime" to make sure it's fresh?
|
||||||
request_headers['Range'] = f'bytes={bytes_have}-'
|
request_headers['Range'] = 'bytes=%d-' % bytes_have
|
||||||
self._resumed_from = bytes_have
|
self._resumed_from = bytes_have
|
||||||
|
|
||||||
def start(
|
def start(self, response):
|
||||||
self,
|
|
||||||
initial_url: str,
|
|
||||||
final_response: requests.Response
|
|
||||||
) -> Tuple[RawStream, IO]:
|
|
||||||
"""
|
"""
|
||||||
Initiate and return a stream for `response` body with progress
|
Initiate and return a stream for `response` body with progress
|
||||||
callback attached. Can be called only once.
|
callback attached. Can be called only once.
|
||||||
|
|
||||||
:param initial_url: The original requested URL
|
:param response: Initiated response object with headers already fetched
|
||||||
:param final_response: Initiated response object with headers already fetched
|
:type response: requests.models.Response
|
||||||
|
|
||||||
:return: RawStream, output_file
|
:return: RawStream, output_file
|
||||||
|
|
||||||
"""
|
"""
|
||||||
assert not self.status.time_started
|
assert not self.status.time_started
|
||||||
|
|
||||||
# FIXME: some servers still might sent Content-Encoding: gzip
|
|
||||||
# <https://github.com/httpie/httpie/issues/423>
|
|
||||||
try:
|
try:
|
||||||
total_size = int(final_response.headers['Content-Length'])
|
total_size = int(response.headers['Content-Length'])
|
||||||
except (KeyError, ValueError, TypeError):
|
except (KeyError, ValueError, TypeError):
|
||||||
total_size = None
|
total_size = None
|
||||||
|
|
||||||
if not self._output_file:
|
if self._output_file:
|
||||||
self._output_file = self._get_output_file_from_response(
|
if self._resume and response.status_code == PARTIAL_CONTENT:
|
||||||
initial_url=initial_url,
|
|
||||||
final_response=final_response,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
# `--output, -o` provided
|
|
||||||
if self._resume and final_response.status_code == PARTIAL_CONTENT:
|
|
||||||
total_size = parse_content_range(
|
total_size = parse_content_range(
|
||||||
final_response.headers.get('Content-Range'),
|
response.headers.get('Content-Range'),
|
||||||
self._resumed_from
|
self._resumed_from
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -258,8 +218,21 @@ class Downloader:
|
|||||||
try:
|
try:
|
||||||
self._output_file.seek(0)
|
self._output_file.seek(0)
|
||||||
self._output_file.truncate()
|
self._output_file.truncate()
|
||||||
except OSError:
|
except IOError:
|
||||||
pass # stdout
|
pass # stdout
|
||||||
|
else:
|
||||||
|
# TODO: Should the filename be taken from response.history[0].url?
|
||||||
|
# Output file not specified. Pick a name that doesn't exist yet.
|
||||||
|
filename = None
|
||||||
|
if 'Content-Disposition' in response.headers:
|
||||||
|
filename = filename_from_content_disposition(
|
||||||
|
response.headers['Content-Disposition'])
|
||||||
|
if not filename:
|
||||||
|
filename = filename_from_url(
|
||||||
|
url=response.url,
|
||||||
|
content_type=response.headers.get('Content-Type'),
|
||||||
|
)
|
||||||
|
self._output_file = open(get_unique_filename(filename), mode='a+b')
|
||||||
|
|
||||||
self.status.started(
|
self.status.started(
|
||||||
resumed_from=self._resumed_from,
|
resumed_from=self._resumed_from,
|
||||||
@ -267,7 +240,7 @@ class Downloader:
|
|||||||
)
|
)
|
||||||
|
|
||||||
stream = RawStream(
|
stream = RawStream(
|
||||||
msg=HTTPResponse(final_response),
|
msg=HTTPResponse(response),
|
||||||
with_headers=False,
|
with_headers=False,
|
||||||
with_body=True,
|
with_body=True,
|
||||||
on_body_chunk_downloaded=self.chunk_downloaded,
|
on_body_chunk_downloaded=self.chunk_downloaded,
|
||||||
@ -275,8 +248,12 @@ class Downloader:
|
|||||||
)
|
)
|
||||||
|
|
||||||
self._progress_reporter.output.write(
|
self._progress_reporter.output.write(
|
||||||
f'Downloading {humanize_bytes(total_size) + " " if total_size is not None else ""}'
|
'Downloading %sto "%s"\n' % (
|
||||||
f'to "{self._output_file.name}"\n'
|
(humanize_bytes(total_size) + ' '
|
||||||
|
if total_size is not None
|
||||||
|
else ''),
|
||||||
|
self._output_file.name
|
||||||
|
)
|
||||||
)
|
)
|
||||||
self._progress_reporter.start()
|
self._progress_reporter.start()
|
||||||
|
|
||||||
@ -291,44 +268,27 @@ class Downloader:
|
|||||||
self._progress_reporter.stop()
|
self._progress_reporter.stop()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def interrupted(self) -> bool:
|
def interrupted(self):
|
||||||
return (
|
return (
|
||||||
self.finished
|
self.finished
|
||||||
and self.status.total_size
|
and self.status.total_size
|
||||||
and self.status.total_size != self.status.downloaded
|
and self.status.total_size != self.status.downloaded
|
||||||
)
|
)
|
||||||
|
|
||||||
def chunk_downloaded(self, chunk: bytes):
|
def chunk_downloaded(self, chunk):
|
||||||
"""
|
"""
|
||||||
A download progress callback.
|
A download progress callback.
|
||||||
|
|
||||||
:param chunk: A chunk of response body data that has just
|
:param chunk: A chunk of response body data that has just
|
||||||
been downloaded and written to the output.
|
been downloaded and written to the output.
|
||||||
|
:type chunk: bytes
|
||||||
|
|
||||||
"""
|
"""
|
||||||
self.status.chunk_downloaded(len(chunk))
|
self.status.chunk_downloaded(len(chunk))
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _get_output_file_from_response(
|
|
||||||
initial_url: str,
|
|
||||||
final_response: requests.Response,
|
|
||||||
) -> IO:
|
|
||||||
# Output file not specified. Pick a name that doesn't exist yet.
|
|
||||||
filename = None
|
|
||||||
if 'Content-Disposition' in final_response.headers:
|
|
||||||
filename = filename_from_content_disposition(
|
|
||||||
final_response.headers['Content-Disposition'])
|
|
||||||
if not filename:
|
|
||||||
filename = filename_from_url(
|
|
||||||
url=initial_url,
|
|
||||||
content_type=final_response.headers.get('Content-Type'),
|
|
||||||
)
|
|
||||||
unique_filename = get_unique_filename(filename)
|
|
||||||
return open(unique_filename, mode='a+b')
|
|
||||||
|
|
||||||
|
class Status(object):
|
||||||
class DownloadStatus:
|
"""Holds details about the downland status."""
|
||||||
"""Holds details about the download status."""
|
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.downloaded = 0
|
self.downloaded = 0
|
||||||
@ -339,9 +299,10 @@ class DownloadStatus:
|
|||||||
|
|
||||||
def started(self, resumed_from=0, total_size=None):
|
def started(self, resumed_from=0, total_size=None):
|
||||||
assert self.time_started is None
|
assert self.time_started is None
|
||||||
self.total_size = total_size
|
if total_size is not None:
|
||||||
|
self.total_size = total_size
|
||||||
self.downloaded = self.resumed_from = resumed_from
|
self.downloaded = self.resumed_from = resumed_from
|
||||||
self.time_started = monotonic()
|
self.time_started = time()
|
||||||
|
|
||||||
def chunk_downloaded(self, size):
|
def chunk_downloaded(self, size):
|
||||||
assert self.time_finished is None
|
assert self.time_finished is None
|
||||||
@ -354,7 +315,7 @@ class DownloadStatus:
|
|||||||
def finished(self):
|
def finished(self):
|
||||||
assert self.time_started is not None
|
assert self.time_started is not None
|
||||||
assert self.time_finished is None
|
assert self.time_finished is None
|
||||||
self.time_finished = monotonic()
|
self.time_finished = time()
|
||||||
|
|
||||||
|
|
||||||
class ProgressReporterThread(threading.Thread):
|
class ProgressReporterThread(threading.Thread):
|
||||||
@ -364,15 +325,13 @@ class ProgressReporterThread(threading.Thread):
|
|||||||
Uses threading to periodically update the status (speed, ETA, etc.).
|
Uses threading to periodically update the status (speed, ETA, etc.).
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
def __init__(self, status, output, tick=.1, update_interval=1):
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(
|
:type status: Status
|
||||||
self,
|
:type output: file
|
||||||
status: DownloadStatus,
|
"""
|
||||||
output: IO,
|
super(ProgressReporterThread, self).__init__()
|
||||||
tick=.1,
|
|
||||||
update_interval=1
|
|
||||||
):
|
|
||||||
super().__init__()
|
|
||||||
self.status = status
|
self.status = status
|
||||||
self.output = output
|
self.output = output
|
||||||
self._tick = tick
|
self._tick = tick
|
||||||
@ -380,7 +339,7 @@ class ProgressReporterThread(threading.Thread):
|
|||||||
self._spinner_pos = 0
|
self._spinner_pos = 0
|
||||||
self._status_line = ''
|
self._status_line = ''
|
||||||
self._prev_bytes = 0
|
self._prev_bytes = 0
|
||||||
self._prev_time = monotonic()
|
self._prev_time = time()
|
||||||
self._should_stop = threading.Event()
|
self._should_stop = threading.Event()
|
||||||
|
|
||||||
def stop(self):
|
def stop(self):
|
||||||
@ -397,11 +356,16 @@ class ProgressReporterThread(threading.Thread):
|
|||||||
sleep(self._tick)
|
sleep(self._tick)
|
||||||
|
|
||||||
def report_speed(self):
|
def report_speed(self):
|
||||||
now = monotonic()
|
|
||||||
|
now = time()
|
||||||
|
|
||||||
if now - self._prev_time >= self._update_interval:
|
if now - self._prev_time >= self._update_interval:
|
||||||
downloaded = self.status.downloaded
|
downloaded = self.status.downloaded
|
||||||
speed = ((downloaded - self._prev_bytes)
|
try:
|
||||||
/ (now - self._prev_time))
|
speed = ((downloaded - self._prev_bytes)
|
||||||
|
/ (now - self._prev_time))
|
||||||
|
except ZeroDivisionError:
|
||||||
|
speed = 0
|
||||||
|
|
||||||
if not self.status.total_size:
|
if not self.status.total_size:
|
||||||
self._status_line = PROGRESS_NO_CONTENT_LENGTH.format(
|
self._status_line = PROGRESS_NO_CONTENT_LENGTH.format(
|
||||||
@ -409,9 +373,10 @@ class ProgressReporterThread(threading.Thread):
|
|||||||
speed=humanize_bytes(speed),
|
speed=humanize_bytes(speed),
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
percentage = (downloaded / self.status.total_size * 100
|
try:
|
||||||
if self.status.total_size
|
percentage = downloaded / self.status.total_size * 100
|
||||||
else 0)
|
except ZeroDivisionError:
|
||||||
|
percentage = 0
|
||||||
|
|
||||||
if not speed:
|
if not speed:
|
||||||
eta = '-:--:--'
|
eta = '-:--:--'
|
||||||
@ -419,7 +384,7 @@ class ProgressReporterThread(threading.Thread):
|
|||||||
s = int((self.status.total_size - downloaded) / speed)
|
s = int((self.status.total_size - downloaded) / speed)
|
||||||
h, s = divmod(s, 60 * 60)
|
h, s = divmod(s, 60 * 60)
|
||||||
m, s = divmod(s, 60)
|
m, s = divmod(s, 60)
|
||||||
eta = f'{h}:{m:0>2}:{s:0>2}'
|
eta = '{0}:{1:0>2}:{2:0>2}'.format(h, m, s)
|
||||||
|
|
||||||
self._status_line = PROGRESS.format(
|
self._status_line = PROGRESS.format(
|
||||||
percentage=percentage,
|
percentage=percentage,
|
||||||
@ -432,20 +397,33 @@ class ProgressReporterThread(threading.Thread):
|
|||||||
self._prev_bytes = downloaded
|
self._prev_bytes = downloaded
|
||||||
|
|
||||||
self.output.write(
|
self.output.write(
|
||||||
f'{CLEAR_LINE} {SPINNER[self._spinner_pos]} {self._status_line}'
|
CLEAR_LINE
|
||||||
|
+ ' '
|
||||||
|
+ SPINNER[self._spinner_pos]
|
||||||
|
+ ' '
|
||||||
|
+ self._status_line
|
||||||
)
|
)
|
||||||
self.output.flush()
|
self.output.flush()
|
||||||
|
|
||||||
self._spinner_pos = (self._spinner_pos + 1) % len(SPINNER)
|
self._spinner_pos = (self._spinner_pos + 1
|
||||||
|
if self._spinner_pos + 1 != len(SPINNER)
|
||||||
|
else 0)
|
||||||
|
|
||||||
def sum_up(self):
|
def sum_up(self):
|
||||||
actually_downloaded = (
|
actually_downloaded = (self.status.downloaded
|
||||||
self.status.downloaded - self.status.resumed_from)
|
- self.status.resumed_from)
|
||||||
time_taken = self.status.time_finished - self.status.time_started
|
time_taken = self.status.time_finished - self.status.time_started
|
||||||
speed = actually_downloaded / time_taken if time_taken else actually_downloaded
|
|
||||||
|
|
||||||
self.output.write(CLEAR_LINE)
|
self.output.write(CLEAR_LINE)
|
||||||
|
|
||||||
|
try:
|
||||||
|
speed = actually_downloaded / time_taken
|
||||||
|
except ZeroDivisionError:
|
||||||
|
# Either time is 0 (not all systems provide `time.time`
|
||||||
|
# with a better precision than 1 second), and/or nothing
|
||||||
|
# has been downloaded.
|
||||||
|
speed = actually_downloaded
|
||||||
|
|
||||||
self.output.write(SUMMARY.format(
|
self.output.write(SUMMARY.format(
|
||||||
downloaded=humanize_bytes(actually_downloaded),
|
downloaded=humanize_bytes(actually_downloaded),
|
||||||
total=(self.status.total_size
|
total=(self.status.total_size
|
||||||
|
|||||||
@ -1,50 +0,0 @@
|
|||||||
from typing import Union
|
|
||||||
|
|
||||||
from charset_normalizer import from_bytes
|
|
||||||
from charset_normalizer.constant import TOO_SMALL_SEQUENCE
|
|
||||||
|
|
||||||
UTF8 = 'utf-8'
|
|
||||||
|
|
||||||
ContentBytes = Union[bytearray, bytes]
|
|
||||||
|
|
||||||
|
|
||||||
def detect_encoding(content: ContentBytes) -> str:
|
|
||||||
"""
|
|
||||||
We default to UTF-8 if text too short, because the detection
|
|
||||||
can return a random encoding leading to confusing results
|
|
||||||
given the `charset_normalizer` version (< 2.0.5).
|
|
||||||
|
|
||||||
>>> too_short = ']"foo"'
|
|
||||||
>>> detected = from_bytes(too_short.encode()).best().encoding
|
|
||||||
>>> detected
|
|
||||||
'ascii'
|
|
||||||
>>> too_short.encode().decode(detected)
|
|
||||||
']"foo"'
|
|
||||||
"""
|
|
||||||
encoding = UTF8
|
|
||||||
if len(content) > TOO_SMALL_SEQUENCE:
|
|
||||||
match = from_bytes(bytes(content)).best()
|
|
||||||
if match:
|
|
||||||
encoding = match.encoding
|
|
||||||
return encoding
|
|
||||||
|
|
||||||
|
|
||||||
def smart_decode(content: ContentBytes, encoding: str) -> str:
|
|
||||||
"""Decode `content` using the given `encoding`.
|
|
||||||
If no `encoding` is provided, the best effort is to guess it from `content`.
|
|
||||||
|
|
||||||
Unicode errors are replaced.
|
|
||||||
|
|
||||||
"""
|
|
||||||
if not encoding:
|
|
||||||
encoding = detect_encoding(content)
|
|
||||||
return content.decode(encoding, 'replace')
|
|
||||||
|
|
||||||
|
|
||||||
def smart_encode(content: str, encoding: str) -> bytes:
|
|
||||||
"""Encode `content` using the given `encoding`.
|
|
||||||
|
|
||||||
Unicode errors are replaced.
|
|
||||||
|
|
||||||
"""
|
|
||||||
return content.encode(encoding, 'replace')
|
|
||||||
679
httpie/input.py
Normal file
679
httpie/input.py
Normal file
@ -0,0 +1,679 @@
|
|||||||
|
"""Parsing and processing of CLI input (args, auth credentials, files, stdin).
|
||||||
|
|
||||||
|
"""
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import re
|
||||||
|
import errno
|
||||||
|
import mimetypes
|
||||||
|
import getpass
|
||||||
|
from io import BytesIO
|
||||||
|
from collections import namedtuple, Iterable
|
||||||
|
# noinspection PyCompatibility
|
||||||
|
from argparse import ArgumentParser, ArgumentTypeError, ArgumentError
|
||||||
|
|
||||||
|
# TODO: Use MultiDict for headers once added to `requests`.
|
||||||
|
# https://github.com/jakubroztocil/httpie/issues/130
|
||||||
|
from requests.structures import CaseInsensitiveDict
|
||||||
|
|
||||||
|
from httpie.compat import OrderedDict, urlsplit, str, is_pypy, is_py27
|
||||||
|
from httpie.sessions import VALID_SESSION_NAME_PATTERN
|
||||||
|
from httpie.utils import load_json_preserve_order
|
||||||
|
|
||||||
|
|
||||||
|
# ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
|
||||||
|
# <http://tools.ietf.org/html/rfc3986#section-3.1>
|
||||||
|
URL_SCHEME_RE = re.compile(r'^[a-z][a-z0-9.+-]*://', re.IGNORECASE)
|
||||||
|
|
||||||
|
HTTP_POST = 'POST'
|
||||||
|
HTTP_GET = 'GET'
|
||||||
|
HTTP = 'http://'
|
||||||
|
HTTPS = 'https://'
|
||||||
|
|
||||||
|
|
||||||
|
# Various separators used in args
|
||||||
|
SEP_HEADERS = ':'
|
||||||
|
SEP_CREDENTIALS = ':'
|
||||||
|
SEP_PROXY = ':'
|
||||||
|
SEP_DATA = '='
|
||||||
|
SEP_DATA_RAW_JSON = ':='
|
||||||
|
SEP_FILES = '@'
|
||||||
|
SEP_DATA_EMBED_FILE = '=@'
|
||||||
|
SEP_DATA_EMBED_RAW_JSON_FILE = ':=@'
|
||||||
|
SEP_QUERY = '=='
|
||||||
|
|
||||||
|
# Separators that become request data
|
||||||
|
SEP_GROUP_DATA_ITEMS = frozenset([
|
||||||
|
SEP_DATA,
|
||||||
|
SEP_DATA_RAW_JSON,
|
||||||
|
SEP_FILES,
|
||||||
|
SEP_DATA_EMBED_FILE,
|
||||||
|
SEP_DATA_EMBED_RAW_JSON_FILE
|
||||||
|
])
|
||||||
|
|
||||||
|
# Separators for items whose value is a filename to be embedded
|
||||||
|
SEP_GROUP_DATA_EMBED_ITEMS = frozenset([
|
||||||
|
SEP_DATA_EMBED_FILE,
|
||||||
|
SEP_DATA_EMBED_RAW_JSON_FILE,
|
||||||
|
])
|
||||||
|
|
||||||
|
# Separators for raw JSON items
|
||||||
|
SEP_GROUP_RAW_JSON_ITEMS = frozenset([
|
||||||
|
SEP_DATA_RAW_JSON,
|
||||||
|
SEP_DATA_EMBED_RAW_JSON_FILE,
|
||||||
|
])
|
||||||
|
|
||||||
|
# Separators allowed in ITEM arguments
|
||||||
|
SEP_GROUP_ALL_ITEMS = frozenset([
|
||||||
|
SEP_HEADERS,
|
||||||
|
SEP_QUERY,
|
||||||
|
SEP_DATA,
|
||||||
|
SEP_DATA_RAW_JSON,
|
||||||
|
SEP_FILES,
|
||||||
|
SEP_DATA_EMBED_FILE,
|
||||||
|
SEP_DATA_EMBED_RAW_JSON_FILE,
|
||||||
|
])
|
||||||
|
|
||||||
|
|
||||||
|
# Output options
|
||||||
|
OUT_REQ_HEAD = 'H'
|
||||||
|
OUT_REQ_BODY = 'B'
|
||||||
|
OUT_RESP_HEAD = 'h'
|
||||||
|
OUT_RESP_BODY = 'b'
|
||||||
|
|
||||||
|
OUTPUT_OPTIONS = frozenset([
|
||||||
|
OUT_REQ_HEAD,
|
||||||
|
OUT_REQ_BODY,
|
||||||
|
OUT_RESP_HEAD,
|
||||||
|
OUT_RESP_BODY
|
||||||
|
])
|
||||||
|
|
||||||
|
# Pretty
|
||||||
|
PRETTY_MAP = {
|
||||||
|
'all': ['format', 'colors'],
|
||||||
|
'colors': ['colors'],
|
||||||
|
'format': ['format'],
|
||||||
|
'none': []
|
||||||
|
}
|
||||||
|
PRETTY_STDOUT_TTY_ONLY = object()
|
||||||
|
|
||||||
|
|
||||||
|
# Defaults
|
||||||
|
OUTPUT_OPTIONS_DEFAULT = OUT_RESP_HEAD + OUT_RESP_BODY
|
||||||
|
OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED = OUT_RESP_BODY
|
||||||
|
|
||||||
|
|
||||||
|
class Parser(ArgumentParser):
|
||||||
|
"""Adds additional logic to `argparse.ArgumentParser`.
|
||||||
|
|
||||||
|
Handles all input (CLI args, file args, stdin), applies defaults,
|
||||||
|
and performs extra validation.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
kwargs['add_help'] = False
|
||||||
|
super(Parser, self).__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
# noinspection PyMethodOverriding
|
||||||
|
def parse_args(self, env, args=None, namespace=None):
|
||||||
|
|
||||||
|
self.env = env
|
||||||
|
self.args, no_options = super(Parser, self)\
|
||||||
|
.parse_known_args(args, namespace)
|
||||||
|
|
||||||
|
if self.args.debug:
|
||||||
|
self.args.traceback = True
|
||||||
|
|
||||||
|
# Arguments processing and environment setup.
|
||||||
|
self._apply_no_options(no_options)
|
||||||
|
self._apply_config()
|
||||||
|
self._validate_download_options()
|
||||||
|
self._setup_standard_streams()
|
||||||
|
self._process_output_options()
|
||||||
|
self._process_pretty_options()
|
||||||
|
self._guess_method()
|
||||||
|
self._parse_items()
|
||||||
|
if not self.args.ignore_stdin and not env.stdin_isatty:
|
||||||
|
self._body_from_file(self.env.stdin)
|
||||||
|
if not URL_SCHEME_RE.match(self.args.url):
|
||||||
|
scheme = HTTP
|
||||||
|
|
||||||
|
# See if we're using curl style shorthand for localhost (:3000/foo)
|
||||||
|
shorthand = re.match(r'^:(?!:)(\d*)(/?.*)$', self.args.url)
|
||||||
|
if shorthand:
|
||||||
|
port = shorthand.group(1)
|
||||||
|
rest = shorthand.group(2)
|
||||||
|
self.args.url = scheme + 'localhost'
|
||||||
|
if port:
|
||||||
|
self.args.url += ':' + port
|
||||||
|
self.args.url += rest
|
||||||
|
else:
|
||||||
|
self.args.url = scheme + self.args.url
|
||||||
|
self._process_auth()
|
||||||
|
|
||||||
|
return self.args
|
||||||
|
|
||||||
|
# noinspection PyShadowingBuiltins
|
||||||
|
def _print_message(self, message, file=None):
|
||||||
|
# Sneak in our stderr/stdout.
|
||||||
|
file = {
|
||||||
|
sys.stdout: self.env.stdout,
|
||||||
|
sys.stderr: self.env.stderr,
|
||||||
|
None: self.env.stderr
|
||||||
|
}.get(file, file)
|
||||||
|
if not hasattr(file, 'buffer') and isinstance(message, str):
|
||||||
|
message = message.encode(self.env.stdout_encoding)
|
||||||
|
super(Parser, self)._print_message(message, file)
|
||||||
|
|
||||||
|
def _setup_standard_streams(self):
|
||||||
|
"""
|
||||||
|
Modify `env.stdout` and `env.stdout_isatty` based on args, if needed.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if not self.env.stdout_isatty and self.args.output_file:
|
||||||
|
self.error('Cannot use --output, -o with redirected output.')
|
||||||
|
|
||||||
|
if self.args.download:
|
||||||
|
# FIXME: Come up with a cleaner solution.
|
||||||
|
if not self.env.stdout_isatty:
|
||||||
|
# Use stdout as the download output file.
|
||||||
|
self.args.output_file = self.env.stdout
|
||||||
|
# With `--download`, we write everything that would normally go to
|
||||||
|
# `stdout` to `stderr` instead. Let's replace the stream so that
|
||||||
|
# we don't have to use many `if`s throughout the codebase.
|
||||||
|
# The response body will be treated separately.
|
||||||
|
self.env.stdout = self.env.stderr
|
||||||
|
self.env.stdout_isatty = self.env.stderr_isatty
|
||||||
|
elif self.args.output_file:
|
||||||
|
# When not `--download`ing, then `--output` simply replaces
|
||||||
|
# `stdout`. The file is opened for appending, which isn't what
|
||||||
|
# we want in this case.
|
||||||
|
self.args.output_file.seek(0)
|
||||||
|
try:
|
||||||
|
self.args.output_file.truncate()
|
||||||
|
except IOError as e:
|
||||||
|
if e.errno == errno.EINVAL:
|
||||||
|
# E.g. /dev/null on Linux.
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
self.env.stdout = self.args.output_file
|
||||||
|
self.env.stdout_isatty = False
|
||||||
|
|
||||||
|
def _apply_config(self):
|
||||||
|
if (not self.args.json
|
||||||
|
and self.env.config.implicit_content_type == 'form'):
|
||||||
|
self.args.form = True
|
||||||
|
|
||||||
|
def _process_auth(self):
|
||||||
|
"""
|
||||||
|
If only a username provided via --auth, then ask for a password.
|
||||||
|
Or, take credentials from the URL, if provided.
|
||||||
|
|
||||||
|
"""
|
||||||
|
url = urlsplit(self.args.url)
|
||||||
|
|
||||||
|
if self.args.auth:
|
||||||
|
if not self.args.auth.has_password():
|
||||||
|
# Stdin already read (if not a tty) so it's save to prompt.
|
||||||
|
if self.args.ignore_stdin:
|
||||||
|
self.error('Unable to prompt for passwords because'
|
||||||
|
' --ignore-stdin is set.')
|
||||||
|
self.args.auth.prompt_password(url.netloc)
|
||||||
|
|
||||||
|
elif url.username is not None:
|
||||||
|
# Handle http://username:password@hostname/
|
||||||
|
username = url.username
|
||||||
|
password = url.password or ''
|
||||||
|
self.args.auth = AuthCredentials(
|
||||||
|
key=username,
|
||||||
|
value=password,
|
||||||
|
sep=SEP_CREDENTIALS,
|
||||||
|
orig=SEP_CREDENTIALS.join([username, password])
|
||||||
|
)
|
||||||
|
|
||||||
|
def _apply_no_options(self, no_options):
|
||||||
|
"""For every `--no-OPTION` in `no_options`, set `args.OPTION` to
|
||||||
|
its default value. This allows for un-setting of options, e.g.,
|
||||||
|
specified in config.
|
||||||
|
|
||||||
|
"""
|
||||||
|
invalid = []
|
||||||
|
|
||||||
|
for option in no_options:
|
||||||
|
if not option.startswith('--no-'):
|
||||||
|
invalid.append(option)
|
||||||
|
continue
|
||||||
|
|
||||||
|
# --no-option => --option
|
||||||
|
inverted = '--' + option[5:]
|
||||||
|
for action in self._actions:
|
||||||
|
if inverted in action.option_strings:
|
||||||
|
setattr(self.args, action.dest, action.default)
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
invalid.append(option)
|
||||||
|
|
||||||
|
if invalid:
|
||||||
|
msg = 'unrecognized arguments: %s'
|
||||||
|
self.error(msg % ' '.join(invalid))
|
||||||
|
|
||||||
|
def _body_from_file(self, fd):
|
||||||
|
"""There can only be one source of request data.
|
||||||
|
|
||||||
|
Bytes are always read.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if self.args.data:
|
||||||
|
self.error('Request body (from stdin or a file) and request '
|
||||||
|
'data (key=value) cannot be mixed.')
|
||||||
|
self.args.data = getattr(fd, 'buffer', fd).read()
|
||||||
|
|
||||||
|
def _guess_method(self):
|
||||||
|
"""Set `args.method` if not specified to either POST or GET
|
||||||
|
based on whether the request has data or not.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if self.args.method is None:
|
||||||
|
# Invoked as `http URL'.
|
||||||
|
assert not self.args.items
|
||||||
|
if not self.args.ignore_stdin and not self.env.stdin_isatty:
|
||||||
|
self.args.method = HTTP_POST
|
||||||
|
else:
|
||||||
|
self.args.method = HTTP_GET
|
||||||
|
|
||||||
|
# FIXME: False positive, e.g., "localhost" matches but is a valid URL.
|
||||||
|
elif not re.match('^[a-zA-Z]+$', self.args.method):
|
||||||
|
# Invoked as `http URL item+'. The URL is now in `args.method`
|
||||||
|
# and the first ITEM is now incorrectly in `args.url`.
|
||||||
|
try:
|
||||||
|
# Parse the URL as an ITEM and store it as the first ITEM arg.
|
||||||
|
self.args.items.insert(0, KeyValueArgType(
|
||||||
|
*SEP_GROUP_ALL_ITEMS).__call__(self.args.url))
|
||||||
|
|
||||||
|
except ArgumentTypeError as e:
|
||||||
|
if self.args.traceback:
|
||||||
|
raise
|
||||||
|
self.error(e.args[0])
|
||||||
|
|
||||||
|
else:
|
||||||
|
# Set the URL correctly
|
||||||
|
self.args.url = self.args.method
|
||||||
|
# Infer the method
|
||||||
|
has_data = (
|
||||||
|
(not self.args.ignore_stdin and not self.env.stdin_isatty)
|
||||||
|
or any(item.sep in SEP_GROUP_DATA_ITEMS
|
||||||
|
for item in self.args.items)
|
||||||
|
)
|
||||||
|
self.args.method = HTTP_POST if has_data else HTTP_GET
|
||||||
|
|
||||||
|
def _parse_items(self):
|
||||||
|
"""Parse `args.items` into `args.headers`, `args.data`, `args.params`,
|
||||||
|
and `args.files`.
|
||||||
|
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
items = parse_items(
|
||||||
|
items=self.args.items,
|
||||||
|
data_class=ParamsDict if self.args.form else OrderedDict
|
||||||
|
)
|
||||||
|
except ParseError as e:
|
||||||
|
if self.args.traceback:
|
||||||
|
raise
|
||||||
|
self.error(e.args[0])
|
||||||
|
else:
|
||||||
|
self.args.headers = items.headers
|
||||||
|
self.args.data = items.data
|
||||||
|
self.args.files = items.files
|
||||||
|
self.args.params = items.params
|
||||||
|
|
||||||
|
if self.args.files and not self.args.form:
|
||||||
|
# `http url @/path/to/file`
|
||||||
|
file_fields = list(self.args.files.keys())
|
||||||
|
if file_fields != ['']:
|
||||||
|
self.error(
|
||||||
|
'Invalid file fields (perhaps you meant --form?): %s'
|
||||||
|
% ','.join(file_fields))
|
||||||
|
|
||||||
|
fn, fd = self.args.files['']
|
||||||
|
self.args.files = {}
|
||||||
|
|
||||||
|
self._body_from_file(fd)
|
||||||
|
|
||||||
|
if 'Content-Type' not in self.args.headers:
|
||||||
|
mime, encoding = mimetypes.guess_type(fn, strict=False)
|
||||||
|
if mime:
|
||||||
|
content_type = mime
|
||||||
|
if encoding:
|
||||||
|
content_type = '%s; charset=%s' % (mime, encoding)
|
||||||
|
self.args.headers['Content-Type'] = content_type
|
||||||
|
|
||||||
|
def _process_output_options(self):
|
||||||
|
"""Apply defaults to output options, or validate the provided ones.
|
||||||
|
|
||||||
|
The default output options are stdout-type-sensitive.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if not self.args.output_options:
|
||||||
|
self.args.output_options = (
|
||||||
|
OUTPUT_OPTIONS_DEFAULT
|
||||||
|
if self.env.stdout_isatty
|
||||||
|
else OUTPUT_OPTIONS_DEFAULT_STDOUT_REDIRECTED
|
||||||
|
)
|
||||||
|
|
||||||
|
unknown_output_options = set(self.args.output_options) - OUTPUT_OPTIONS
|
||||||
|
if unknown_output_options:
|
||||||
|
self.error(
|
||||||
|
'Unknown output options: %s' % ','.join(unknown_output_options)
|
||||||
|
)
|
||||||
|
|
||||||
|
if self.args.download and OUT_RESP_BODY in self.args.output_options:
|
||||||
|
# Response body is always downloaded with --download and it goes
|
||||||
|
# through a different routine, so we remove it.
|
||||||
|
self.args.output_options = str(
|
||||||
|
set(self.args.output_options) - set(OUT_RESP_BODY))
|
||||||
|
|
||||||
|
def _process_pretty_options(self):
|
||||||
|
if self.args.prettify == PRETTY_STDOUT_TTY_ONLY:
|
||||||
|
self.args.prettify = PRETTY_MAP[
|
||||||
|
'all' if self.env.stdout_isatty else 'none']
|
||||||
|
elif self.args.prettify and self.env.is_windows:
|
||||||
|
self.error('Only terminal output can be colorized on Windows.')
|
||||||
|
else:
|
||||||
|
# noinspection PyTypeChecker
|
||||||
|
self.args.prettify = PRETTY_MAP[self.args.prettify]
|
||||||
|
|
||||||
|
def _validate_download_options(self):
|
||||||
|
if not self.args.download:
|
||||||
|
if self.args.download_resume:
|
||||||
|
self.error('--continue only works with --download')
|
||||||
|
if self.args.download_resume and not (
|
||||||
|
self.args.download and self.args.output_file):
|
||||||
|
self.error('--continue requires --output to be specified')
|
||||||
|
|
||||||
|
|
||||||
|
class ParseError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class KeyValue(object):
|
||||||
|
"""Base key-value pair parsed from CLI."""
|
||||||
|
|
||||||
|
def __init__(self, key, value, sep, orig):
|
||||||
|
self.key = key
|
||||||
|
self.value = value
|
||||||
|
self.sep = sep
|
||||||
|
self.orig = orig
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
return self.__dict__ == other.__dict__
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return repr(self.__dict__)
|
||||||
|
|
||||||
|
|
||||||
|
class SessionNameValidator(object):
|
||||||
|
|
||||||
|
def __init__(self, error_message):
|
||||||
|
self.error_message = error_message
|
||||||
|
|
||||||
|
def __call__(self, value):
|
||||||
|
# Session name can be a path or just a name.
|
||||||
|
if (os.path.sep not in value
|
||||||
|
and not VALID_SESSION_NAME_PATTERN.search(value)):
|
||||||
|
raise ArgumentError(None, self.error_message)
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
class KeyValueArgType(object):
|
||||||
|
"""A key-value pair argument type used with `argparse`.
|
||||||
|
|
||||||
|
Parses a key-value arg and constructs a `KeyValue` instance.
|
||||||
|
Used for headers, form data, and other key-value pair types.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
key_value_class = KeyValue
|
||||||
|
|
||||||
|
def __init__(self, *separators):
|
||||||
|
self.separators = separators
|
||||||
|
self.special_characters = set('\\')
|
||||||
|
for separator in separators:
|
||||||
|
self.special_characters.update(separator)
|
||||||
|
|
||||||
|
def __call__(self, string):
|
||||||
|
"""Parse `string` and return `self.key_value_class()` instance.
|
||||||
|
|
||||||
|
The best of `self.separators` is determined (first found, longest).
|
||||||
|
Back slash escaped characters aren't considered as separators
|
||||||
|
(or parts thereof). Literal back slash characters have to be escaped
|
||||||
|
as well (r'\\').
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
class Escaped(str):
|
||||||
|
"""Represents an escaped character."""
|
||||||
|
|
||||||
|
def tokenize(string):
|
||||||
|
"""Tokenize `string`. There are only two token types - strings
|
||||||
|
and escaped characters:
|
||||||
|
|
||||||
|
tokenize(r'foo\=bar\\baz')
|
||||||
|
=> ['foo', Escaped('='), 'bar', Escaped('\\'), 'baz']
|
||||||
|
|
||||||
|
"""
|
||||||
|
tokens = ['']
|
||||||
|
characters = iter(string)
|
||||||
|
for char in characters:
|
||||||
|
if char == '\\':
|
||||||
|
char = next(characters, '')
|
||||||
|
if char not in self.special_characters:
|
||||||
|
tokens[-1] += '\\' + char
|
||||||
|
else:
|
||||||
|
tokens.extend([Escaped(char), ''])
|
||||||
|
else:
|
||||||
|
tokens[-1] += char
|
||||||
|
return tokens
|
||||||
|
|
||||||
|
tokens = tokenize(string)
|
||||||
|
|
||||||
|
# Sorting by length ensures that the longest one will be
|
||||||
|
# chosen as it will overwrite any shorter ones starting
|
||||||
|
# at the same position in the `found` dictionary.
|
||||||
|
separators = sorted(self.separators, key=len)
|
||||||
|
|
||||||
|
for i, token in enumerate(tokens):
|
||||||
|
|
||||||
|
if isinstance(token, Escaped):
|
||||||
|
continue
|
||||||
|
|
||||||
|
found = {}
|
||||||
|
for sep in separators:
|
||||||
|
pos = token.find(sep)
|
||||||
|
if pos != -1:
|
||||||
|
found[pos] = sep
|
||||||
|
|
||||||
|
if found:
|
||||||
|
# Starting first, longest separator found.
|
||||||
|
sep = found[min(found.keys())]
|
||||||
|
|
||||||
|
key, value = token.split(sep, 1)
|
||||||
|
|
||||||
|
# Any preceding tokens are part of the key.
|
||||||
|
key = ''.join(tokens[:i]) + key
|
||||||
|
|
||||||
|
# Any following tokens are part of the value.
|
||||||
|
value += ''.join(tokens[i + 1:])
|
||||||
|
|
||||||
|
break
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ArgumentTypeError(
|
||||||
|
u'"%s" is not a valid value' % string)
|
||||||
|
|
||||||
|
return self.key_value_class(
|
||||||
|
key=key, value=value, sep=sep, orig=string)
|
||||||
|
|
||||||
|
|
||||||
|
class AuthCredentials(KeyValue):
|
||||||
|
"""Represents parsed credentials."""
|
||||||
|
|
||||||
|
def _getpass(self, prompt):
|
||||||
|
# To allow mocking.
|
||||||
|
return getpass.getpass(prompt)
|
||||||
|
|
||||||
|
def has_password(self):
|
||||||
|
return self.value is not None
|
||||||
|
|
||||||
|
def prompt_password(self, host):
|
||||||
|
try:
|
||||||
|
self.value = self._getpass(
|
||||||
|
'http: password for %s@%s: ' % (self.key, host))
|
||||||
|
except (EOFError, KeyboardInterrupt):
|
||||||
|
sys.stderr.write('\n')
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
|
||||||
|
class AuthCredentialsArgType(KeyValueArgType):
|
||||||
|
"""A key-value arg type that parses credentials."""
|
||||||
|
|
||||||
|
key_value_class = AuthCredentials
|
||||||
|
|
||||||
|
def __call__(self, string):
|
||||||
|
"""Parse credentials from `string`.
|
||||||
|
|
||||||
|
("username" or "username:password").
|
||||||
|
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return super(AuthCredentialsArgType, self).__call__(string)
|
||||||
|
except ArgumentTypeError:
|
||||||
|
# No password provided, will prompt for it later.
|
||||||
|
return self.key_value_class(
|
||||||
|
key=string,
|
||||||
|
value=None,
|
||||||
|
sep=SEP_CREDENTIALS,
|
||||||
|
orig=string
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class RequestItemsDict(OrderedDict):
|
||||||
|
"""Multi-value dict for URL parameters and form data."""
|
||||||
|
|
||||||
|
if is_pypy and is_py27:
|
||||||
|
# Manually set keys when initialized with an iterable as PyPy
|
||||||
|
# doesn't call __setitem__ in such case (pypy3 does).
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
if len(args) == 1 and isinstance(args[0], Iterable):
|
||||||
|
super(RequestItemsDict, self).__init__(**kwargs)
|
||||||
|
for k, v in args[0]:
|
||||||
|
self[k] = v
|
||||||
|
else:
|
||||||
|
super(RequestItemsDict, self).__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
#noinspection PyMethodOverriding
|
||||||
|
def __setitem__(self, key, value):
|
||||||
|
""" If `key` is assigned more than once, `self[key]` holds a
|
||||||
|
`list` of all the values.
|
||||||
|
|
||||||
|
This allows having multiple fields with the same name in form
|
||||||
|
data and URL params.
|
||||||
|
|
||||||
|
"""
|
||||||
|
assert not isinstance(value, list)
|
||||||
|
if key not in self:
|
||||||
|
super(RequestItemsDict, self).__setitem__(key, value)
|
||||||
|
else:
|
||||||
|
if not isinstance(self[key], list):
|
||||||
|
super(RequestItemsDict, self).__setitem__(key, [self[key]])
|
||||||
|
self[key].append(value)
|
||||||
|
|
||||||
|
|
||||||
|
class ParamsDict(RequestItemsDict):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class DataDict(RequestItemsDict):
|
||||||
|
|
||||||
|
def items(self):
|
||||||
|
for key, values in super(RequestItemsDict, self).items():
|
||||||
|
if not isinstance(values, list):
|
||||||
|
values = [values]
|
||||||
|
for value in values:
|
||||||
|
yield key, value
|
||||||
|
|
||||||
|
|
||||||
|
RequestItems = namedtuple('RequestItems',
|
||||||
|
['headers', 'data', 'files', 'params'])
|
||||||
|
|
||||||
|
|
||||||
|
def parse_items(items,
|
||||||
|
headers_class=CaseInsensitiveDict,
|
||||||
|
data_class=OrderedDict,
|
||||||
|
files_class=DataDict,
|
||||||
|
params_class=ParamsDict):
|
||||||
|
"""Parse `KeyValue` `items` into `data`, `headers`, `files`,
|
||||||
|
and `params`.
|
||||||
|
|
||||||
|
"""
|
||||||
|
headers = []
|
||||||
|
data = []
|
||||||
|
files = []
|
||||||
|
params = []
|
||||||
|
|
||||||
|
for item in items:
|
||||||
|
value = item.value
|
||||||
|
|
||||||
|
if item.sep == SEP_HEADERS:
|
||||||
|
target = headers
|
||||||
|
elif item.sep == SEP_QUERY:
|
||||||
|
target = params
|
||||||
|
elif item.sep == SEP_FILES:
|
||||||
|
try:
|
||||||
|
with open(os.path.expanduser(value), 'rb') as f:
|
||||||
|
value = (os.path.basename(value),
|
||||||
|
BytesIO(f.read()))
|
||||||
|
except IOError as e:
|
||||||
|
raise ParseError('"%s": %s' % (item.orig, e))
|
||||||
|
target = files
|
||||||
|
|
||||||
|
elif item.sep in SEP_GROUP_DATA_ITEMS:
|
||||||
|
|
||||||
|
if item.sep in SEP_GROUP_DATA_EMBED_ITEMS:
|
||||||
|
try:
|
||||||
|
with open(os.path.expanduser(value), 'rb') as f:
|
||||||
|
value = f.read().decode('utf8')
|
||||||
|
except IOError as e:
|
||||||
|
raise ParseError('"%s": %s' % (item.orig, e))
|
||||||
|
except UnicodeDecodeError:
|
||||||
|
raise ParseError(
|
||||||
|
'"%s": cannot embed the content of "%s",'
|
||||||
|
' not a UTF8 or ASCII-encoded text file'
|
||||||
|
% (item.orig, item.value)
|
||||||
|
)
|
||||||
|
|
||||||
|
if item.sep in SEP_GROUP_RAW_JSON_ITEMS:
|
||||||
|
try:
|
||||||
|
value = load_json_preserve_order(value)
|
||||||
|
except ValueError as e:
|
||||||
|
raise ParseError('"%s": %s' % (item.orig, e))
|
||||||
|
target = data
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise TypeError(item)
|
||||||
|
|
||||||
|
target.append((item.key, value))
|
||||||
|
|
||||||
|
return RequestItems(headers_class(headers),
|
||||||
|
data_class(data),
|
||||||
|
files_class(files),
|
||||||
|
params_class(params))
|
||||||
|
|
||||||
|
|
||||||
|
def readable_file_arg(filename):
|
||||||
|
try:
|
||||||
|
open(filename, 'rb')
|
||||||
|
except IOError as ex:
|
||||||
|
raise ArgumentTypeError('%s: %s' % (filename, ex.args[1]))
|
||||||
|
return filename
|
||||||
103
httpie/models.py
103
httpie/models.py
@ -1,40 +1,41 @@
|
|||||||
from typing import Iterable
|
from httpie.compat import urlsplit, str
|
||||||
from urllib.parse import urlsplit
|
|
||||||
|
|
||||||
from .utils import split_cookies, parse_content_type_header
|
|
||||||
from .compat import cached_property
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPMessage:
|
class HTTPMessage(object):
|
||||||
"""Abstract class for HTTP messages."""
|
"""Abstract class for HTTP messages."""
|
||||||
|
|
||||||
def __init__(self, orig):
|
def __init__(self, orig):
|
||||||
self._orig = orig
|
self._orig = orig
|
||||||
|
|
||||||
def iter_body(self, chunk_size: int) -> Iterable[bytes]:
|
def iter_body(self, chunk_size):
|
||||||
"""Return an iterator over the body."""
|
"""Return an iterator over the body."""
|
||||||
raise NotImplementedError
|
raise NotImplementedError()
|
||||||
|
|
||||||
def iter_lines(self, chunk_size: int) -> Iterable[bytes]:
|
def iter_lines(self, chunk_size):
|
||||||
"""Return an iterator over the body yielding (`line`, `line_feed`)."""
|
"""Return an iterator over the body yielding (`line`, `line_feed`)."""
|
||||||
raise NotImplementedError
|
raise NotImplementedError()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def headers(self) -> str:
|
def headers(self):
|
||||||
"""Return a `str` with the message's headers."""
|
"""Return a `str` with the message's headers."""
|
||||||
raise NotImplementedError
|
raise NotImplementedError()
|
||||||
|
|
||||||
@cached_property
|
|
||||||
def encoding(self) -> str:
|
|
||||||
ct, params = parse_content_type_header(self.content_type)
|
|
||||||
return params.get('charset', '')
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def content_type(self) -> str:
|
def encoding(self):
|
||||||
|
"""Return a `str` with the message's encoding, if known."""
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def body(self):
|
||||||
|
"""Return a `bytes` with the message's body."""
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def content_type(self):
|
||||||
"""Return the message content type."""
|
"""Return the message content type."""
|
||||||
ct = self._orig.headers.get('Content-Type', '')
|
ct = self._orig.headers.get('Content-Type', '')
|
||||||
if not isinstance(ct, str):
|
if not isinstance(ct, str):
|
||||||
ct = ct.decode()
|
ct = ct.decode('utf8')
|
||||||
return ct
|
return ct
|
||||||
|
|
||||||
|
|
||||||
@ -47,35 +48,46 @@ class HTTPResponse(HTTPMessage):
|
|||||||
def iter_lines(self, chunk_size):
|
def iter_lines(self, chunk_size):
|
||||||
return ((line, b'\n') for line in self._orig.iter_lines(chunk_size))
|
return ((line, b'\n') for line in self._orig.iter_lines(chunk_size))
|
||||||
|
|
||||||
# noinspection PyProtectedMember
|
#noinspection PyProtectedMember
|
||||||
@property
|
@property
|
||||||
def headers(self):
|
def headers(self):
|
||||||
try:
|
original = self._orig.raw._original_response
|
||||||
raw_version = self._orig.raw._original_response.version
|
|
||||||
except AttributeError:
|
|
||||||
# Assume HTTP/1.1
|
|
||||||
raw_version = 11
|
|
||||||
version = {
|
version = {
|
||||||
9: '0.9',
|
9: '0.9',
|
||||||
10: '1.0',
|
10: '1.0',
|
||||||
11: '1.1',
|
11: '1.1',
|
||||||
20: '2',
|
20: '2',
|
||||||
}[raw_version]
|
}[original.version]
|
||||||
|
|
||||||
original = self._orig
|
status_line = 'HTTP/{version} {status} {reason}'.format(
|
||||||
status_line = f'HTTP/{version} {original.status_code} {original.reason}'
|
version=version,
|
||||||
|
status=original.status,
|
||||||
|
reason=original.reason
|
||||||
|
)
|
||||||
headers = [status_line]
|
headers = [status_line]
|
||||||
headers.extend(
|
try:
|
||||||
': '.join(header)
|
# `original.msg` is a `http.client.HTTPMessage` on Python 3
|
||||||
for header in original.headers.items()
|
# `_headers` is a 2-tuple
|
||||||
if header[0] != 'Set-Cookie'
|
headers.extend(
|
||||||
)
|
'%s: %s' % header for header in original.msg._headers)
|
||||||
headers.extend(
|
except AttributeError:
|
||||||
f'Set-Cookie: {cookie}'
|
# and a `httplib.HTTPMessage` on Python 2.x
|
||||||
for cookie in split_cookies(original.headers.get('Set-Cookie'))
|
# `headers` is a list of `name: val<CRLF>`.
|
||||||
)
|
headers.extend(h.strip() for h in original.msg.headers)
|
||||||
|
|
||||||
return '\r\n'.join(headers)
|
return '\r\n'.join(headers)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def encoding(self):
|
||||||
|
return self._orig.encoding or 'utf8'
|
||||||
|
|
||||||
|
@property
|
||||||
|
def body(self):
|
||||||
|
# Only now the response body is fetched.
|
||||||
|
# Shouldn't be touched unless the body is actually needed.
|
||||||
|
return self._orig.content
|
||||||
|
|
||||||
|
|
||||||
class HTTPRequest(HTTPMessage):
|
class HTTPRequest(HTTPMessage):
|
||||||
"""A :class:`requests.models.Request` wrapper."""
|
"""A :class:`requests.models.Request` wrapper."""
|
||||||
@ -93,7 +105,7 @@ class HTTPRequest(HTTPMessage):
|
|||||||
request_line = '{method} {path}{query} HTTP/1.1'.format(
|
request_line = '{method} {path}{query} HTTP/1.1'.format(
|
||||||
method=self._orig.method,
|
method=self._orig.method,
|
||||||
path=url.path or '/',
|
path=url.path or '/',
|
||||||
query=f'?{url.query}' if url.query else ''
|
query='?' + url.query if url.query else ''
|
||||||
)
|
)
|
||||||
|
|
||||||
headers = dict(self._orig.headers)
|
headers = dict(self._orig.headers)
|
||||||
@ -101,18 +113,29 @@ class HTTPRequest(HTTPMessage):
|
|||||||
headers['Host'] = url.netloc.split('@')[-1]
|
headers['Host'] = url.netloc.split('@')[-1]
|
||||||
|
|
||||||
headers = [
|
headers = [
|
||||||
f'{name}: {value if isinstance(value, str) else value.decode()}'
|
'%s: %s' % (
|
||||||
|
name,
|
||||||
|
value if isinstance(value, str) else value.decode('utf8')
|
||||||
|
)
|
||||||
for name, value in headers.items()
|
for name, value in headers.items()
|
||||||
]
|
]
|
||||||
|
|
||||||
headers.insert(0, request_line)
|
headers.insert(0, request_line)
|
||||||
headers = '\r\n'.join(headers).strip()
|
headers = '\r\n'.join(headers).strip()
|
||||||
|
|
||||||
|
if isinstance(headers, bytes):
|
||||||
|
# Python < 3
|
||||||
|
headers = headers.decode('utf8')
|
||||||
return headers
|
return headers
|
||||||
|
|
||||||
|
@property
|
||||||
|
def encoding(self):
|
||||||
|
return 'utf8'
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def body(self):
|
def body(self):
|
||||||
body = self._orig.body
|
body = self._orig.body
|
||||||
if isinstance(body, str):
|
if isinstance(body, str):
|
||||||
# Happens with JSON/form request data parsed from the command line.
|
# Happens with JSON/form request data parsed from the command line.
|
||||||
body = body.encode()
|
body = body.encode('utf8')
|
||||||
return body or b''
|
return body or b''
|
||||||
|
|||||||
@ -1,36 +1,20 @@
|
|||||||
import json
|
|
||||||
from typing import Optional, Type
|
|
||||||
|
|
||||||
import pygments.lexer
|
import pygments.lexer
|
||||||
|
import pygments.token
|
||||||
|
import pygments.styles
|
||||||
import pygments.lexers
|
import pygments.lexers
|
||||||
import pygments.style
|
import pygments.style
|
||||||
import pygments.styles
|
|
||||||
import pygments.token
|
|
||||||
from pygments.formatters.terminal import TerminalFormatter
|
from pygments.formatters.terminal import TerminalFormatter
|
||||||
from pygments.formatters.terminal256 import Terminal256Formatter
|
from pygments.formatters.terminal256 import Terminal256Formatter
|
||||||
from pygments.lexer import Lexer
|
|
||||||
from pygments.lexers.data import JsonLexer
|
|
||||||
from pygments.lexers.special import TextLexer
|
|
||||||
from pygments.lexers.text import HttpLexer as PygmentsHttpLexer
|
|
||||||
from pygments.util import ClassNotFound
|
from pygments.util import ClassNotFound
|
||||||
|
|
||||||
from ..lexers.json import EnhancedJsonLexer
|
from httpie.plugins import FormatterPlugin
|
||||||
from ...compat import is_windows
|
|
||||||
from ...context import Environment
|
|
||||||
from ...plugins import FormatterPlugin
|
|
||||||
|
|
||||||
|
|
||||||
AUTO_STYLE = 'auto' # Follows terminal ANSI color styles
|
# Colors on Windows via colorama don't look that
|
||||||
DEFAULT_STYLE = AUTO_STYLE
|
# great and fruity seems to give the best result there.
|
||||||
SOLARIZED_STYLE = 'solarized' # Bundled here
|
AVAILABLE_STYLES = set(pygments.styles.STYLE_MAP.keys())
|
||||||
if is_windows:
|
AVAILABLE_STYLES.add('solarized')
|
||||||
# Colors on Windows via colorama don't look that
|
DEFAULT_STYLE = 'solarized'
|
||||||
# great and fruity seems to give the best result there.
|
|
||||||
DEFAULT_STYLE = 'fruity'
|
|
||||||
|
|
||||||
AVAILABLE_STYLES = set(pygments.styles.get_all_styles())
|
|
||||||
AVAILABLE_STYLES.add(SOLARIZED_STYLE)
|
|
||||||
AVAILABLE_STYLES.add(AUTO_STYLE)
|
|
||||||
|
|
||||||
|
|
||||||
class ColorFormatter(FormatterPlugin):
|
class ColorFormatter(FormatterPlugin):
|
||||||
@ -43,94 +27,58 @@ class ColorFormatter(FormatterPlugin):
|
|||||||
"""
|
"""
|
||||||
group_name = 'colors'
|
group_name = 'colors'
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, env, color_scheme=DEFAULT_STYLE, **kwargs):
|
||||||
self,
|
super(ColorFormatter, self).__init__(**kwargs)
|
||||||
env: Environment,
|
|
||||||
explicit_json=False,
|
|
||||||
color_scheme=DEFAULT_STYLE,
|
|
||||||
**kwargs
|
|
||||||
):
|
|
||||||
super().__init__(**kwargs)
|
|
||||||
|
|
||||||
if not env.colors:
|
if not env.colors:
|
||||||
self.enabled = False
|
self.enabled = False
|
||||||
return
|
return
|
||||||
|
|
||||||
use_auto_style = color_scheme == AUTO_STYLE
|
# Cache to speed things up when we process streamed body by line.
|
||||||
has_256_colors = env.colors == 256
|
self.lexer_cache = {}
|
||||||
if use_auto_style or not has_256_colors:
|
|
||||||
http_lexer = PygmentsHttpLexer()
|
|
||||||
formatter = TerminalFormatter()
|
|
||||||
else:
|
|
||||||
from ..lexers.http import SimplifiedHTTPLexer
|
|
||||||
http_lexer = SimplifiedHTTPLexer()
|
|
||||||
formatter = Terminal256Formatter(
|
|
||||||
style=self.get_style_class(color_scheme)
|
|
||||||
)
|
|
||||||
|
|
||||||
self.explicit_json = explicit_json # --json
|
|
||||||
self.formatter = formatter
|
|
||||||
self.http_lexer = http_lexer
|
|
||||||
|
|
||||||
def format_headers(self, headers: str) -> str:
|
|
||||||
return pygments.highlight(
|
|
||||||
code=headers,
|
|
||||||
lexer=self.http_lexer,
|
|
||||||
formatter=self.formatter,
|
|
||||||
).strip()
|
|
||||||
|
|
||||||
def format_body(self, body: str, mime: str) -> str:
|
|
||||||
lexer = self.get_lexer_for_body(mime, body)
|
|
||||||
if lexer:
|
|
||||||
body = pygments.highlight(
|
|
||||||
code=body,
|
|
||||||
lexer=lexer,
|
|
||||||
formatter=self.formatter,
|
|
||||||
)
|
|
||||||
return body
|
|
||||||
|
|
||||||
def get_lexer_for_body(
|
|
||||||
self, mime: str,
|
|
||||||
body: str
|
|
||||||
) -> Optional[Type[Lexer]]:
|
|
||||||
return get_lexer(
|
|
||||||
mime=mime,
|
|
||||||
explicit_json=self.explicit_json,
|
|
||||||
body=body,
|
|
||||||
)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def get_style_class(color_scheme: str) -> Type[pygments.style.Style]:
|
|
||||||
try:
|
try:
|
||||||
return pygments.styles.get_style_by_name(color_scheme)
|
style_class = pygments.styles.get_style_by_name(color_scheme)
|
||||||
except ClassNotFound:
|
except ClassNotFound:
|
||||||
return Solarized256Style
|
style_class = Solarized256Style
|
||||||
|
|
||||||
|
if env.colors == 256:
|
||||||
|
fmt_class = Terminal256Formatter
|
||||||
|
else:
|
||||||
|
fmt_class = TerminalFormatter
|
||||||
|
self.formatter = fmt_class(style=style_class)
|
||||||
|
|
||||||
|
def format_headers(self, headers):
|
||||||
|
return pygments.highlight(headers, HTTPLexer(), self.formatter).strip()
|
||||||
|
|
||||||
|
def format_body(self, body, mime):
|
||||||
|
lexer = self.get_lexer(mime)
|
||||||
|
if lexer:
|
||||||
|
body = pygments.highlight(body, lexer, self.formatter)
|
||||||
|
return body.strip()
|
||||||
|
|
||||||
|
def get_lexer(self, mime):
|
||||||
|
if mime in self.lexer_cache:
|
||||||
|
return self.lexer_cache[mime]
|
||||||
|
self.lexer_cache[mime] = get_lexer(mime)
|
||||||
|
return self.lexer_cache[mime]
|
||||||
|
|
||||||
|
|
||||||
def get_lexer(
|
def get_lexer(mime):
|
||||||
mime: str,
|
|
||||||
explicit_json=False,
|
|
||||||
body=''
|
|
||||||
) -> Optional[Type[Lexer]]:
|
|
||||||
# Build candidate mime type and lexer names.
|
|
||||||
mime_types, lexer_names = [mime], []
|
mime_types, lexer_names = [mime], []
|
||||||
type_, subtype = mime.split('/', 1)
|
type_, subtype = mime.split('/')
|
||||||
if '+' not in subtype:
|
if '+' not in subtype:
|
||||||
lexer_names.append(subtype)
|
lexer_names.append(subtype)
|
||||||
else:
|
else:
|
||||||
subtype_name, subtype_suffix = subtype.split('+', 1)
|
subtype_name, subtype_suffix = subtype.split('+')
|
||||||
lexer_names.extend([subtype_name, subtype_suffix])
|
lexer_names.extend([subtype_name, subtype_suffix])
|
||||||
mime_types.extend([
|
mime_types.extend([
|
||||||
f'{type_}/{subtype_name}',
|
'%s/%s' % (type_, subtype_name),
|
||||||
f'{type_}/{subtype_suffix}',
|
'%s/%s' % (type_, subtype_suffix)
|
||||||
])
|
])
|
||||||
|
# as a last resort, if no lexer feels responsible, and
|
||||||
# As a last resort, if no lexer feels responsible, and
|
|
||||||
# the subtype contains 'json', take the JSON lexer
|
# the subtype contains 'json', take the JSON lexer
|
||||||
if 'json' in subtype:
|
if 'json' in subtype:
|
||||||
lexer_names.append('json')
|
lexer_names.append('json')
|
||||||
|
|
||||||
# Try to resolve the right lexer.
|
|
||||||
lexer = None
|
lexer = None
|
||||||
for mime_type in mime_types:
|
for mime_type in mime_types:
|
||||||
try:
|
try:
|
||||||
@ -144,24 +92,59 @@ def get_lexer(
|
|||||||
lexer = pygments.lexers.get_lexer_by_name(name)
|
lexer = pygments.lexers.get_lexer_by_name(name)
|
||||||
except ClassNotFound:
|
except ClassNotFound:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
if explicit_json and body and (not lexer or isinstance(lexer, TextLexer)):
|
|
||||||
# JSON response with an incorrect Content-Type?
|
|
||||||
try:
|
|
||||||
json.loads(body) # FIXME: the body also gets parsed in json.py
|
|
||||||
except ValueError:
|
|
||||||
pass # Nope
|
|
||||||
else:
|
|
||||||
lexer = pygments.lexers.get_lexer_by_name('json')
|
|
||||||
|
|
||||||
# Use our own JSON lexer: it supports JSON bodies preceded by non-JSON data
|
|
||||||
# as well as legit JSON bodies.
|
|
||||||
if isinstance(lexer, JsonLexer):
|
|
||||||
lexer = EnhancedJsonLexer()
|
|
||||||
|
|
||||||
return lexer
|
return lexer
|
||||||
|
|
||||||
|
|
||||||
|
class HTTPLexer(pygments.lexer.RegexLexer):
|
||||||
|
"""Simplified HTTP lexer for Pygments.
|
||||||
|
|
||||||
|
It only operates on headers and provides a stronger contrast between
|
||||||
|
their names and values than the original one bundled with Pygments
|
||||||
|
(:class:`pygments.lexers.text import HttpLexer`), especially when
|
||||||
|
Solarized color scheme is used.
|
||||||
|
|
||||||
|
"""
|
||||||
|
name = 'HTTP'
|
||||||
|
aliases = ['http']
|
||||||
|
filenames = ['*.http']
|
||||||
|
tokens = {
|
||||||
|
'root': [
|
||||||
|
# Request-Line
|
||||||
|
(r'([A-Z]+)( +)([^ ]+)( +)(HTTP)(/)(\d+\.\d+)',
|
||||||
|
pygments.lexer.bygroups(
|
||||||
|
pygments.token.Name.Function,
|
||||||
|
pygments.token.Text,
|
||||||
|
pygments.token.Name.Namespace,
|
||||||
|
pygments.token.Text,
|
||||||
|
pygments.token.Keyword.Reserved,
|
||||||
|
pygments.token.Operator,
|
||||||
|
pygments.token.Number
|
||||||
|
)),
|
||||||
|
# Response Status-Line
|
||||||
|
(r'(HTTP)(/)(\d+\.\d+)( +)(\d{3})( +)(.+)',
|
||||||
|
pygments.lexer.bygroups(
|
||||||
|
pygments.token.Keyword.Reserved, # 'HTTP'
|
||||||
|
pygments.token.Operator, # '/'
|
||||||
|
pygments.token.Number, # Version
|
||||||
|
pygments.token.Text,
|
||||||
|
pygments.token.Number, # Status code
|
||||||
|
pygments.token.Text,
|
||||||
|
pygments.token.Name.Exception, # Reason
|
||||||
|
)),
|
||||||
|
# Header
|
||||||
|
(r'(.*?)( *)(:)( *)(.+)', pygments.lexer.bygroups(
|
||||||
|
pygments.token.Name.Attribute, # Name
|
||||||
|
pygments.token.Text,
|
||||||
|
pygments.token.Operator, # Colon
|
||||||
|
pygments.token.Text,
|
||||||
|
pygments.token.String # Value
|
||||||
|
))
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# TODO: As Solarized is not the default theme any longer, it should be removed
|
||||||
|
# or bundled directly with Pygments so that we don't need to support it.
|
||||||
class Solarized256Style(pygments.style.Style):
|
class Solarized256Style(pygments.style.Style):
|
||||||
"""
|
"""
|
||||||
solarized256
|
solarized256
|
||||||
|
|||||||
@ -1,13 +1,9 @@
|
|||||||
from ...plugins import FormatterPlugin
|
from httpie.plugins import FormatterPlugin
|
||||||
|
|
||||||
|
|
||||||
class HeadersFormatter(FormatterPlugin):
|
class HeadersFormatter(FormatterPlugin):
|
||||||
|
|
||||||
def __init__(self, **kwargs):
|
def format_headers(self, headers):
|
||||||
super().__init__(**kwargs)
|
|
||||||
self.enabled = self.format_options['headers']['sort']
|
|
||||||
|
|
||||||
def format_headers(self, headers: str) -> str:
|
|
||||||
"""
|
"""
|
||||||
Sorts headers by name while retaining relative
|
Sorts headers by name while retaining relative
|
||||||
order of multiple headers with the same name.
|
order of multiple headers with the same name.
|
||||||
|
|||||||
@ -1,34 +1,26 @@
|
|||||||
|
from __future__ import absolute_import
|
||||||
import json
|
import json
|
||||||
|
|
||||||
from ...plugins import FormatterPlugin
|
from httpie.plugins import FormatterPlugin
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_INDENT = 4
|
||||||
|
|
||||||
|
|
||||||
class JSONFormatter(FormatterPlugin):
|
class JSONFormatter(FormatterPlugin):
|
||||||
|
|
||||||
def __init__(self, **kwargs):
|
def format_body(self, body, mime):
|
||||||
super().__init__(**kwargs)
|
if 'json' in mime:
|
||||||
self.enabled = self.format_options['json']['format']
|
|
||||||
|
|
||||||
def format_body(self, body: str, mime: str) -> str:
|
|
||||||
maybe_json = [
|
|
||||||
'json',
|
|
||||||
'javascript',
|
|
||||||
'text',
|
|
||||||
]
|
|
||||||
if (self.kwargs['explicit_json']
|
|
||||||
or any(token in mime for token in maybe_json)):
|
|
||||||
from ..utils import load_prefixed_json
|
|
||||||
try:
|
try:
|
||||||
data_prefix, json_obj = load_prefixed_json(body)
|
obj = json.loads(body)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
pass # Invalid JSON, ignore.
|
# Invalid JSON, ignore.
|
||||||
|
pass
|
||||||
else:
|
else:
|
||||||
# Indent, sort keys by name, and avoid
|
# Indent, sort keys by name, and avoid
|
||||||
# unicode escapes to improve readability.
|
# unicode escapes to improve readability.
|
||||||
body = data_prefix + json.dumps(
|
body = json.dumps(obj,
|
||||||
obj=json_obj,
|
sort_keys=True,
|
||||||
sort_keys=self.format_options['json']['sort_keys'],
|
ensure_ascii=False,
|
||||||
ensure_ascii=False,
|
indent=DEFAULT_INDENT)
|
||||||
indent=self.format_options['json']['indent']
|
|
||||||
)
|
|
||||||
return body
|
return body
|
||||||
|
|||||||
@ -1,59 +1,61 @@
|
|||||||
import sys
|
from __future__ import absolute_import
|
||||||
from typing import TYPE_CHECKING, Optional
|
import re
|
||||||
|
from xml.etree import ElementTree
|
||||||
|
|
||||||
from ...encoding import UTF8
|
from httpie.plugins import FormatterPlugin
|
||||||
from ...plugins import FormatterPlugin
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from xml.dom.minidom import Document
|
|
||||||
|
|
||||||
|
|
||||||
def parse_xml(data: str) -> 'Document':
|
DECLARATION_RE = re.compile('<\?xml[^\n]+?\?>', flags=re.I)
|
||||||
"""Parse given XML `data` string into an appropriate :class:`~xml.dom.minidom.Document` object."""
|
DOCTYPE_RE = re.compile('<!DOCTYPE[^\n]+?>', flags=re.I)
|
||||||
from defusedxml.minidom import parseString
|
|
||||||
return parseString(data)
|
|
||||||
|
|
||||||
|
|
||||||
def pretty_xml(document: 'Document',
|
DEFAULT_INDENT = 4
|
||||||
encoding: Optional[str] = UTF8,
|
|
||||||
indent: int = 2,
|
|
||||||
standalone: Optional[bool] = None) -> str:
|
|
||||||
"""Render the given :class:`~xml.dom.minidom.Document` `document` into a prettified string."""
|
|
||||||
kwargs = {
|
|
||||||
'encoding': encoding or UTF8,
|
|
||||||
'indent': ' ' * indent,
|
|
||||||
}
|
|
||||||
if standalone is not None and sys.version_info >= (3, 9):
|
|
||||||
kwargs['standalone'] = standalone
|
|
||||||
body = document.toprettyxml(**kwargs).decode(kwargs['encoding'])
|
|
||||||
|
|
||||||
# Remove blank lines automatically added by `toprettyxml()`.
|
|
||||||
return '\n'.join(line for line in body.splitlines() if line.strip())
|
def indent(elem, indent_text=' ' * DEFAULT_INDENT):
|
||||||
|
"""
|
||||||
|
In-place prettyprint formatter
|
||||||
|
C.f. http://effbot.org/zone/element-lib.htm#prettyprint
|
||||||
|
|
||||||
|
"""
|
||||||
|
def _indent(elem, level=0):
|
||||||
|
i = "\n" + level * indent_text
|
||||||
|
if len(elem):
|
||||||
|
if not elem.text or not elem.text.strip():
|
||||||
|
elem.text = i + indent_text
|
||||||
|
if not elem.tail or not elem.tail.strip():
|
||||||
|
elem.tail = i
|
||||||
|
for elem in elem:
|
||||||
|
_indent(elem, level + 1)
|
||||||
|
if not elem.tail or not elem.tail.strip():
|
||||||
|
elem.tail = i
|
||||||
|
else:
|
||||||
|
if level and (not elem.tail or not elem.tail.strip()):
|
||||||
|
elem.tail = i
|
||||||
|
|
||||||
|
return _indent(elem)
|
||||||
|
|
||||||
|
|
||||||
class XMLFormatter(FormatterPlugin):
|
class XMLFormatter(FormatterPlugin):
|
||||||
|
# TODO: tests
|
||||||
|
|
||||||
def __init__(self, **kwargs):
|
def format_body(self, body, mime):
|
||||||
super().__init__(**kwargs)
|
if 'xml' in mime:
|
||||||
self.enabled = self.format_options['xml']['format']
|
# FIXME: orig NS names get forgotten during the conversion, etc.
|
||||||
|
try:
|
||||||
def format_body(self, body: str, mime: str):
|
root = ElementTree.fromstring(body.encode('utf8'))
|
||||||
if 'xml' not in mime:
|
except ElementTree.ParseError:
|
||||||
return body
|
# Ignore invalid XML errors (skips attempting to pretty print)
|
||||||
|
pass
|
||||||
from xml.parsers.expat import ExpatError
|
else:
|
||||||
from defusedxml.common import DefusedXmlException
|
indent(root)
|
||||||
|
# Use the original declaration
|
||||||
try:
|
declaration = DECLARATION_RE.match(body)
|
||||||
parsed_body = parse_xml(body)
|
doctype = DOCTYPE_RE.match(body)
|
||||||
except ExpatError:
|
body = ElementTree.tostring(root, encoding='utf-8')\
|
||||||
pass # Invalid XML, ignore.
|
.decode('utf8')
|
||||||
except DefusedXmlException:
|
if doctype:
|
||||||
pass # Unsafe XML, ignore.
|
body = '%s\n%s' % (doctype.group(0), body)
|
||||||
else:
|
if declaration:
|
||||||
body = pretty_xml(parsed_body,
|
body = '%s\n%s' % (declaration.group(0), body)
|
||||||
encoding=parsed_body.encoding,
|
|
||||||
indent=self.format_options['xml']['indent'],
|
|
||||||
standalone=parsed_body.standalone)
|
|
||||||
|
|
||||||
return body
|
return body
|
||||||
|
|||||||
@ -1,49 +0,0 @@
|
|||||||
import pygments
|
|
||||||
|
|
||||||
|
|
||||||
class SimplifiedHTTPLexer(pygments.lexer.RegexLexer):
|
|
||||||
"""Simplified HTTP lexer for Pygments.
|
|
||||||
|
|
||||||
It only operates on headers and provides a stronger contrast between
|
|
||||||
their names and values than the original one bundled with Pygments
|
|
||||||
(:class:`pygments.lexers.text import HttpLexer`), especially when
|
|
||||||
Solarized color scheme is used.
|
|
||||||
|
|
||||||
"""
|
|
||||||
name = 'HTTP'
|
|
||||||
aliases = ['http']
|
|
||||||
filenames = ['*.http']
|
|
||||||
tokens = {
|
|
||||||
'root': [
|
|
||||||
# Request-Line
|
|
||||||
(r'([A-Z]+)( +)([^ ]+)( +)(HTTP)(/)(\d+\.\d+)',
|
|
||||||
pygments.lexer.bygroups(
|
|
||||||
pygments.token.Name.Function,
|
|
||||||
pygments.token.Text,
|
|
||||||
pygments.token.Name.Namespace,
|
|
||||||
pygments.token.Text,
|
|
||||||
pygments.token.Keyword.Reserved,
|
|
||||||
pygments.token.Operator,
|
|
||||||
pygments.token.Number
|
|
||||||
)),
|
|
||||||
# Response Status-Line
|
|
||||||
(r'(HTTP)(/)(\d+\.\d+)( +)(\d{3})( +)(.+)',
|
|
||||||
pygments.lexer.bygroups(
|
|
||||||
pygments.token.Keyword.Reserved, # 'HTTP'
|
|
||||||
pygments.token.Operator, # '/'
|
|
||||||
pygments.token.Number, # Version
|
|
||||||
pygments.token.Text,
|
|
||||||
pygments.token.Number, # Status code
|
|
||||||
pygments.token.Text,
|
|
||||||
pygments.token.Name.Exception, # Reason
|
|
||||||
)),
|
|
||||||
# Header
|
|
||||||
(r'(.*?)( *)(:)( *)(.+)', pygments.lexer.bygroups(
|
|
||||||
pygments.token.Name.Attribute, # Name
|
|
||||||
pygments.token.Text,
|
|
||||||
pygments.token.Operator, # Colon
|
|
||||||
pygments.token.Text,
|
|
||||||
pygments.token.String # Value
|
|
||||||
))
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
import re
|
|
||||||
|
|
||||||
from pygments.lexer import bygroups, using, RegexLexer
|
|
||||||
from pygments.lexers.data import JsonLexer
|
|
||||||
from pygments.token import Token
|
|
||||||
|
|
||||||
PREFIX_TOKEN = Token.Error
|
|
||||||
PREFIX_REGEX = r'[^{\["]+'
|
|
||||||
|
|
||||||
|
|
||||||
class EnhancedJsonLexer(RegexLexer):
|
|
||||||
"""
|
|
||||||
Enhanced JSON lexer for Pygments.
|
|
||||||
|
|
||||||
It adds support for eventual data prefixing the actual JSON body.
|
|
||||||
|
|
||||||
"""
|
|
||||||
name = 'JSON'
|
|
||||||
flags = re.IGNORECASE | re.DOTALL
|
|
||||||
tokens = {
|
|
||||||
'root': [
|
|
||||||
# Eventual non-JSON data prefix followed by actual JSON body.
|
|
||||||
# FIX: data prefix + number (integer or float) are not correctly handled.
|
|
||||||
(
|
|
||||||
fr'({PREFIX_REGEX})' + r'((?:[{\["]|true|false|null).+)',
|
|
||||||
bygroups(PREFIX_TOKEN, using(JsonLexer))
|
|
||||||
),
|
|
||||||
# JSON body.
|
|
||||||
(r'.+', using(JsonLexer)),
|
|
||||||
],
|
|
||||||
}
|
|
||||||
@ -1,9 +1,7 @@
|
|||||||
import re
|
import re
|
||||||
from typing import Optional, List
|
|
||||||
|
|
||||||
from ..plugins import ConverterPlugin
|
from httpie.plugins import plugin_manager
|
||||||
from ..plugins.registry import plugin_manager
|
from httpie.context import Environment
|
||||||
from ..context import Environment
|
|
||||||
|
|
||||||
|
|
||||||
MIME_RE = re.compile(r'^[^/]+/[^/]+$')
|
MIME_RE = re.compile(r'^[^/]+/[^/]+$')
|
||||||
@ -13,20 +11,19 @@ def is_valid_mime(mime):
|
|||||||
return mime and MIME_RE.match(mime)
|
return mime and MIME_RE.match(mime)
|
||||||
|
|
||||||
|
|
||||||
class Conversion:
|
class Conversion(object):
|
||||||
|
|
||||||
@staticmethod
|
def get_converter(self, mime):
|
||||||
def get_converter(mime: str) -> Optional[ConverterPlugin]:
|
|
||||||
if is_valid_mime(mime):
|
if is_valid_mime(mime):
|
||||||
for converter_class in plugin_manager.get_converters():
|
for converter_class in plugin_manager.get_converters():
|
||||||
if converter_class.supports(mime):
|
if converter_class.supports(mime):
|
||||||
return converter_class(mime)
|
return converter_class(mime)
|
||||||
|
|
||||||
|
|
||||||
class Formatting:
|
class Formatting(object):
|
||||||
"""A delegate class that invokes the actual processors."""
|
"""A delegate class that invokes the actual processors."""
|
||||||
|
|
||||||
def __init__(self, groups: List[str], env=Environment(), **kwargs):
|
def __init__(self, groups, env=Environment(), **kwargs):
|
||||||
"""
|
"""
|
||||||
:param groups: names of processor groups to be applied
|
:param groups: names of processor groups to be applied
|
||||||
:param env: Environment
|
:param env: Environment
|
||||||
@ -41,12 +38,12 @@ class Formatting:
|
|||||||
if p.enabled:
|
if p.enabled:
|
||||||
self.enabled_plugins.append(p)
|
self.enabled_plugins.append(p)
|
||||||
|
|
||||||
def format_headers(self, headers: str) -> str:
|
def format_headers(self, headers):
|
||||||
for p in self.enabled_plugins:
|
for p in self.enabled_plugins:
|
||||||
headers = p.format_headers(headers)
|
headers = p.format_headers(headers)
|
||||||
return headers
|
return headers
|
||||||
|
|
||||||
def format_body(self, content: str, mime: str) -> str:
|
def format_body(self, content, mime):
|
||||||
if is_valid_mime(mime):
|
if is_valid_mime(mime):
|
||||||
for p in self.enabled_plugins:
|
for p in self.enabled_plugins:
|
||||||
content = p.format_body(content, mime)
|
content = p.format_body(content, mime)
|
||||||
|
|||||||
@ -1,11 +1,12 @@
|
|||||||
from abc import ABCMeta, abstractmethod
|
|
||||||
from itertools import chain
|
from itertools import chain
|
||||||
from typing import Callable, Iterable, Union
|
from functools import partial
|
||||||
|
|
||||||
from .processing import Conversion, Formatting
|
from httpie.compat import str
|
||||||
from ..context import Environment
|
from httpie.context import Environment
|
||||||
from ..encoding import smart_decode, smart_encode, UTF8
|
from httpie.models import HTTPRequest, HTTPResponse
|
||||||
from ..models import HTTPMessage
|
from httpie.input import (OUT_REQ_BODY, OUT_REQ_HEAD,
|
||||||
|
OUT_RESP_HEAD, OUT_RESP_BODY)
|
||||||
|
from httpie.output.processing import Formatting, Conversion
|
||||||
|
|
||||||
|
|
||||||
BINARY_SUPPRESSED_NOTICE = (
|
BINARY_SUPPRESSED_NOTICE = (
|
||||||
@ -16,26 +17,115 @@ BINARY_SUPPRESSED_NOTICE = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
class DataSuppressedError(Exception):
|
class BinarySuppressedError(Exception):
|
||||||
message = None
|
|
||||||
|
|
||||||
|
|
||||||
class BinarySuppressedError(DataSuppressedError):
|
|
||||||
"""An error indicating that the body is binary and won't be written,
|
"""An error indicating that the body is binary and won't be written,
|
||||||
e.g., for terminal output)."""
|
e.g., for terminal output)."""
|
||||||
|
|
||||||
message = BINARY_SUPPRESSED_NOTICE
|
message = BINARY_SUPPRESSED_NOTICE
|
||||||
|
|
||||||
|
|
||||||
class BaseStream(metaclass=ABCMeta):
|
def write(stream, outfile, flush):
|
||||||
|
"""Write the output stream."""
|
||||||
|
try:
|
||||||
|
# Writing bytes so we use the buffer interface (Python 3).
|
||||||
|
buf = outfile.buffer
|
||||||
|
except AttributeError:
|
||||||
|
buf = outfile
|
||||||
|
|
||||||
|
for chunk in stream:
|
||||||
|
buf.write(chunk)
|
||||||
|
if flush:
|
||||||
|
outfile.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def write_with_colors_win_py3(stream, outfile, flush):
|
||||||
|
"""Like `write`, but colorized chunks are written as text
|
||||||
|
directly to `outfile` to ensure it gets processed by colorama.
|
||||||
|
Applies only to Windows with Python 3 and colorized terminal output.
|
||||||
|
|
||||||
|
"""
|
||||||
|
color = b'\x1b['
|
||||||
|
encoding = outfile.encoding
|
||||||
|
for chunk in stream:
|
||||||
|
if color in chunk:
|
||||||
|
outfile.write(chunk.decode(encoding))
|
||||||
|
else:
|
||||||
|
outfile.buffer.write(chunk)
|
||||||
|
if flush:
|
||||||
|
outfile.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def build_output_stream(args, env, request, response):
|
||||||
|
"""Build and return a chain of iterators over the `request`-`response`
|
||||||
|
exchange each of which yields `bytes` chunks.
|
||||||
|
|
||||||
|
"""
|
||||||
|
req_h = OUT_REQ_HEAD in args.output_options
|
||||||
|
req_b = OUT_REQ_BODY in args.output_options
|
||||||
|
resp_h = OUT_RESP_HEAD in args.output_options
|
||||||
|
resp_b = OUT_RESP_BODY in args.output_options
|
||||||
|
req = req_h or req_b
|
||||||
|
resp = resp_h or resp_b
|
||||||
|
|
||||||
|
output = []
|
||||||
|
Stream = get_stream_type(env, args)
|
||||||
|
|
||||||
|
if req:
|
||||||
|
output.append(Stream(
|
||||||
|
msg=HTTPRequest(request),
|
||||||
|
with_headers=req_h,
|
||||||
|
with_body=req_b))
|
||||||
|
|
||||||
|
if req_b and resp:
|
||||||
|
# Request/Response separator.
|
||||||
|
output.append([b'\n\n'])
|
||||||
|
|
||||||
|
if resp:
|
||||||
|
output.append(Stream(
|
||||||
|
msg=HTTPResponse(response),
|
||||||
|
with_headers=resp_h,
|
||||||
|
with_body=resp_b))
|
||||||
|
|
||||||
|
if env.stdout_isatty and resp_b:
|
||||||
|
# Ensure a blank line after the response body.
|
||||||
|
# For terminal output only.
|
||||||
|
output.append([b'\n\n'])
|
||||||
|
|
||||||
|
return chain(*output)
|
||||||
|
|
||||||
|
|
||||||
|
def get_stream_type(env, args):
|
||||||
|
"""Pick the right stream type based on `env` and `args`.
|
||||||
|
Wrap it in a partial with the type-specific args so that
|
||||||
|
we don't need to think what stream we are dealing with.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if not env.stdout_isatty and not args.prettify:
|
||||||
|
Stream = partial(
|
||||||
|
RawStream,
|
||||||
|
chunk_size=RawStream.CHUNK_SIZE_BY_LINE
|
||||||
|
if args.stream
|
||||||
|
else RawStream.CHUNK_SIZE
|
||||||
|
)
|
||||||
|
elif args.prettify:
|
||||||
|
Stream = partial(
|
||||||
|
PrettyStream if args.stream else BufferedPrettyStream,
|
||||||
|
env=env,
|
||||||
|
conversion=Conversion(),
|
||||||
|
formatting=Formatting(env=env, groups=args.prettify,
|
||||||
|
color_scheme=args.style),
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
Stream = partial(EncodedStream, env=env)
|
||||||
|
|
||||||
|
return Stream
|
||||||
|
|
||||||
|
|
||||||
|
class BaseStream(object):
|
||||||
"""Base HTTP message output stream class."""
|
"""Base HTTP message output stream class."""
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, msg, with_headers=True, with_body=True,
|
||||||
self,
|
on_body_chunk_downloaded=None):
|
||||||
msg: HTTPMessage,
|
|
||||||
with_headers=True,
|
|
||||||
with_body=True,
|
|
||||||
on_body_chunk_downloaded: Callable[[bytes], None] = None
|
|
||||||
):
|
|
||||||
"""
|
"""
|
||||||
:param msg: a :class:`models.HTTPMessage` subclass
|
:param msg: a :class:`models.HTTPMessage` subclass
|
||||||
:param with_headers: if `True`, headers will be included
|
:param with_headers: if `True`, headers will be included
|
||||||
@ -48,15 +138,15 @@ class BaseStream(metaclass=ABCMeta):
|
|||||||
self.with_body = with_body
|
self.with_body = with_body
|
||||||
self.on_body_chunk_downloaded = on_body_chunk_downloaded
|
self.on_body_chunk_downloaded = on_body_chunk_downloaded
|
||||||
|
|
||||||
def get_headers(self) -> bytes:
|
def get_headers(self):
|
||||||
"""Return the headers' bytes."""
|
"""Return the headers' bytes."""
|
||||||
return self.msg.headers.encode()
|
return self.msg.headers.encode('utf8')
|
||||||
|
|
||||||
@abstractmethod
|
def iter_body(self):
|
||||||
def iter_body(self) -> Iterable[bytes]:
|
|
||||||
"""Return an iterator over the message body."""
|
"""Return an iterator over the message body."""
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
def __iter__(self) -> Iterable[bytes]:
|
def __iter__(self):
|
||||||
"""Return an iterator over `self.msg`."""
|
"""Return an iterator over `self.msg`."""
|
||||||
if self.with_headers:
|
if self.with_headers:
|
||||||
yield self.get_headers()
|
yield self.get_headers()
|
||||||
@ -68,7 +158,7 @@ class BaseStream(metaclass=ABCMeta):
|
|||||||
yield chunk
|
yield chunk
|
||||||
if self.on_body_chunk_downloaded:
|
if self.on_body_chunk_downloaded:
|
||||||
self.on_body_chunk_downloaded(chunk)
|
self.on_body_chunk_downloaded(chunk)
|
||||||
except DataSuppressedError as e:
|
except BinarySuppressedError as e:
|
||||||
if self.with_headers:
|
if self.with_headers:
|
||||||
yield b'\n'
|
yield b'\n'
|
||||||
yield e.message
|
yield e.message
|
||||||
@ -81,10 +171,10 @@ class RawStream(BaseStream):
|
|||||||
CHUNK_SIZE_BY_LINE = 1
|
CHUNK_SIZE_BY_LINE = 1
|
||||||
|
|
||||||
def __init__(self, chunk_size=CHUNK_SIZE, **kwargs):
|
def __init__(self, chunk_size=CHUNK_SIZE, **kwargs):
|
||||||
super().__init__(**kwargs)
|
super(RawStream, self).__init__(**kwargs)
|
||||||
self.chunk_size = chunk_size
|
self.chunk_size = chunk_size
|
||||||
|
|
||||||
def iter_body(self) -> Iterable[bytes]:
|
def iter_body(self):
|
||||||
return self.msg.iter_body(self.chunk_size)
|
return self.msg.iter_body(self.chunk_size)
|
||||||
|
|
||||||
|
|
||||||
@ -98,31 +188,29 @@ class EncodedStream(BaseStream):
|
|||||||
"""
|
"""
|
||||||
CHUNK_SIZE = 1
|
CHUNK_SIZE = 1
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, env=Environment(), **kwargs):
|
||||||
self,
|
|
||||||
env=Environment(),
|
super(EncodedStream, self).__init__(**kwargs)
|
||||||
mime_overwrite: str = None,
|
|
||||||
encoding_overwrite: str = None,
|
|
||||||
**kwargs
|
|
||||||
):
|
|
||||||
super().__init__(**kwargs)
|
|
||||||
self.mime = mime_overwrite or self.msg.content_type
|
|
||||||
self.encoding = encoding_overwrite or self.msg.encoding
|
|
||||||
if env.stdout_isatty:
|
if env.stdout_isatty:
|
||||||
# Use the encoding supported by the terminal.
|
# Use the encoding supported by the terminal.
|
||||||
output_encoding = env.stdout_encoding
|
output_encoding = env.stdout_encoding
|
||||||
else:
|
else:
|
||||||
# Preserve the message encoding.
|
# Preserve the message encoding.
|
||||||
output_encoding = self.msg.encoding
|
output_encoding = self.msg.encoding
|
||||||
# Default to UTF-8 when unsure.
|
|
||||||
self.output_encoding = output_encoding or UTF8
|
|
||||||
|
|
||||||
def iter_body(self) -> Iterable[bytes]:
|
# Default to utf8 when unsure.
|
||||||
|
self.output_encoding = output_encoding or 'utf8'
|
||||||
|
|
||||||
|
def iter_body(self):
|
||||||
|
|
||||||
for line, lf in self.msg.iter_lines(self.CHUNK_SIZE):
|
for line, lf in self.msg.iter_lines(self.CHUNK_SIZE):
|
||||||
|
|
||||||
if b'\0' in line:
|
if b'\0' in line:
|
||||||
raise BinarySuppressedError()
|
raise BinarySuppressedError()
|
||||||
line = smart_decode(line, self.encoding)
|
|
||||||
yield smart_encode(line, self.output_encoding) + lf
|
yield line.decode(self.msg.encoding) \
|
||||||
|
.encode(self.output_encoding, 'replace') + lf
|
||||||
|
|
||||||
|
|
||||||
class PrettyStream(EncodedStream):
|
class PrettyStream(EncodedStream):
|
||||||
@ -136,20 +224,17 @@ class PrettyStream(EncodedStream):
|
|||||||
|
|
||||||
CHUNK_SIZE = 1
|
CHUNK_SIZE = 1
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, conversion, formatting, **kwargs):
|
||||||
self, conversion: Conversion,
|
super(PrettyStream, self).__init__(**kwargs)
|
||||||
formatting: Formatting,
|
|
||||||
**kwargs,
|
|
||||||
):
|
|
||||||
super().__init__(**kwargs)
|
|
||||||
self.formatting = formatting
|
self.formatting = formatting
|
||||||
self.conversion = conversion
|
self.conversion = conversion
|
||||||
|
self.mime = self.msg.content_type.split(';')[0]
|
||||||
|
|
||||||
def get_headers(self) -> bytes:
|
def get_headers(self):
|
||||||
return self.formatting.format_headers(
|
return self.formatting.format_headers(
|
||||||
self.msg.headers).encode(self.output_encoding)
|
self.msg.headers).encode(self.output_encoding)
|
||||||
|
|
||||||
def iter_body(self) -> Iterable[bytes]:
|
def iter_body(self):
|
||||||
first_chunk = True
|
first_chunk = True
|
||||||
iter_lines = self.msg.iter_lines(self.CHUNK_SIZE)
|
iter_lines = self.msg.iter_lines(self.CHUNK_SIZE)
|
||||||
for line, lf in iter_lines:
|
for line, lf in iter_lines:
|
||||||
@ -170,13 +255,13 @@ class PrettyStream(EncodedStream):
|
|||||||
yield self.process_body(line) + lf
|
yield self.process_body(line) + lf
|
||||||
first_chunk = False
|
first_chunk = False
|
||||||
|
|
||||||
def process_body(self, chunk: Union[str, bytes]) -> bytes:
|
def process_body(self, chunk):
|
||||||
if not isinstance(chunk, str):
|
if not isinstance(chunk, str):
|
||||||
# Text when a converter has been used,
|
# Text when a converter has been used,
|
||||||
# otherwise it will always be bytes.
|
# otherwise it will always be bytes.
|
||||||
chunk = smart_decode(chunk, self.encoding)
|
chunk = chunk.decode(self.msg.encoding, 'replace')
|
||||||
chunk = self.formatting.format_body(content=chunk, mime=self.mime)
|
chunk = self.formatting.format_body(content=chunk, mime=self.mime)
|
||||||
return smart_encode(chunk, self.output_encoding)
|
return chunk.encode(self.output_encoding, 'replace')
|
||||||
|
|
||||||
|
|
||||||
class BufferedPrettyStream(PrettyStream):
|
class BufferedPrettyStream(PrettyStream):
|
||||||
@ -189,7 +274,7 @@ class BufferedPrettyStream(PrettyStream):
|
|||||||
|
|
||||||
CHUNK_SIZE = 1024 * 10
|
CHUNK_SIZE = 1024 * 10
|
||||||
|
|
||||||
def iter_body(self) -> Iterable[bytes]:
|
def iter_body(self):
|
||||||
# Read the whole body before prettifying it,
|
# Read the whole body before prettifying it,
|
||||||
# but bail out immediately if the body is binary.
|
# but bail out immediately if the body is binary.
|
||||||
converter = None
|
converter = None
|
||||||
|
|||||||
@ -1,37 +0,0 @@
|
|||||||
import json
|
|
||||||
import re
|
|
||||||
from typing import Tuple
|
|
||||||
|
|
||||||
from ..utils import load_json_preserve_order_and_dupe_keys
|
|
||||||
from .lexers.json import PREFIX_REGEX
|
|
||||||
|
|
||||||
|
|
||||||
def load_prefixed_json(data: str) -> Tuple[str, json.JSONDecoder]:
|
|
||||||
"""Simple JSON loading from `data`.
|
|
||||||
|
|
||||||
"""
|
|
||||||
# First, the full data.
|
|
||||||
try:
|
|
||||||
return '', load_json_preserve_order_and_dupe_keys(data)
|
|
||||||
except ValueError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
# Then, try to find the start of the actual body.
|
|
||||||
data_prefix, body = parse_prefixed_json(data)
|
|
||||||
try:
|
|
||||||
return data_prefix, load_json_preserve_order_and_dupe_keys(body)
|
|
||||||
except ValueError:
|
|
||||||
raise ValueError('Invalid JSON')
|
|
||||||
|
|
||||||
|
|
||||||
def parse_prefixed_json(data: str) -> Tuple[str, str]:
|
|
||||||
"""Find the potential JSON body from `data`.
|
|
||||||
|
|
||||||
Sometimes the JSON body is prefixed with a XSSI magic string, specific to the server.
|
|
||||||
Return a tuple (data prefix, actual JSON body).
|
|
||||||
|
|
||||||
"""
|
|
||||||
matches = re.findall(PREFIX_REGEX, data)
|
|
||||||
data_prefix = matches[0] if matches else ''
|
|
||||||
body = data[len(data_prefix):]
|
|
||||||
return data_prefix, body
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user