Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also .

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also .
base repository: psf/requests
Choose a Base Repository
psf/requests
5y/requests
Aramgutang/requests
Bluehorn/requests
EnTeQuAk/requests
Erickson-lopes-dev/requests
JDrosdeck/requests
Jonty/requests
JuhaS/requests
Mistobaan/requests
Osmose/requests
Pewpewarrows/requests
SSabev/requests
SiddharthaAnand/requests
Singletoned/requests
Telofy/requests
acdha/requests
acslater00/requests
albertz/requests
amalakar/requests
amrik/requests
andrewlouis93/requests
anfedorov/requests
aparo/requests
armykingw/requests
asciimoo/requests
asemx/requests
atdt/requests
aventurella/requests
bancek/requests
barberj/requests
bcwaldon/requests
benmao/requests
berg/requests
berndt/requests
bjedwards/requests
bluemoon/requests
btubbs/requests
cakebread/requests
chipx86/requests
chrisguitarguy/requests
christopherwright/requests
clsung/requests
danfairs/requests
danverbraganza/requests
dasevilla/requests
datajunkie007/requests
davidarkemp/requests
davidblewett/requests
daxreyes/requests
dbrgn/requests
dickon/requests
dongxi8/requests
drobertduke/requests
dstufft/requests
dumpforjunk/requests
duncm/requests
dvd0101/requests
dvogel/requests
dvska/requesocks
edsu/requests
erlichmen/requests
fahadbuddy/requests
fenomenog4/requests
flaper87/requests
floppym/requests
fmoo/requests
fredrik/requests
fwaechter/requests
garnaat/requests
gazpachoking/requests
ggarber/requests
gigigi/requests
goldenboy/requests
grncdr/requests
gulopine/requests
handloomweaver/requests
harchiko/requests
herbyme/requests
hlindset/requests
huzm/requests
ib-lundgren/requests
idan/requests
jakubroztocil/requests
james2468/requests
janrito/requests
javouhey/requests
jbochi/requests
jdyang/requests
jedie/requests
jerem/requests
jgorset/requests
jimfunk/requests
jinxcat/requests
jkleint/requests
jmshoffs0812/requests
johtso/requests
jonas-m/requests
joshimhoff/requests
juil/requests
kaesire/requests
kanarelo/requests
karlcow/requests
kenreitz42/requests
kislyuk/requests
kojit/requests
kracekumar/requests
kushaldas/requests
kuzmak/requests
lgastako/requests
lifepy/requests
linode/requests
lukecampbell/requests
machalekj/requests
mapmyfitness/requests
maraujop/requests
masgorji/requests
matthewyang/requests
maxcountryman/requests
maximbo/requests
medwards/requests
metawake/requests
methane/requests
mgiuca/requests
mhejrati/requests
mher/requests
miguelgrinberg/requests
mikemaccana/requests
millerdev/requests
miohtama/requests
mitsuhiko/requests
msabramo/requests
mthurman/requests
mvanveen/requests
mw44118/requests
ncoghlan/requests
neevor/requests
newsapps/requests
neyer/requests
nowells/requests
ojii/requests
ojno/requests
osman-masood/requests
pbrao/requests
pcdinh/requests-py3k
petermanser/requests
pmdarrow/requests
pnasrat/requests
pombredanne/requests
purepython/requests
pushpan/requests
pydanny/requests
rdbhost/yieldfromRequests
reclosedev/requests
revolunet/requests
rickmak/requests
robmadole/requests
rtucker-mozilla/requests
rushabh/requests
rwzehner/requests
sc999/requests
seacoastboy/requests
seanjensengrey/requests
shazow/requests
sigmavirus24/requests
singingwolfboy/requests
slingamn/requests
slyons/requests
smargonz/requests
smorin/requests
spulec/requests
sshyub/requests
steveklabnik/requests
sworddish/requests
tabletcorry/requests
tadeck/requests
tef/requests
tgebru/requests
thedaniel/requests
thomasw/requests
tidencatte/requests
tinnguyenz/requests
tkordas/requests
tml/requests
tmoertel/requests
tpe11etier/requests
tvaught/requests
twall/requests
tzuryby/requests
umbrae/requests
vickimo/requests
vivekpuri/requests
wasmith/requests
weskerfoot/requests
wwitzel3/requests
wynnw/requests
yoyossy/requests
zacharyvoase/requests
zed/requests
zsiciarz/requests
Nothing to show
base: v2.24.0
head repository: psf/requests
Choose a Head Repository
psf/requests
5y/requests
Aramgutang/requests
Bluehorn/requests
EnTeQuAk/requests
Erickson-lopes-dev/requests
JDrosdeck/requests
Jonty/requests
JuhaS/requests
Mistobaan/requests
Osmose/requests
Pewpewarrows/requests
SSabev/requests
SiddharthaAnand/requests
Singletoned/requests
Telofy/requests
acdha/requests
acslater00/requests
albertz/requests
amalakar/requests
amrik/requests
andrewlouis93/requests
anfedorov/requests
aparo/requests
armykingw/requests
asciimoo/requests
asemx/requests
atdt/requests
aventurella/requests
bancek/requests
barberj/requests
bcwaldon/requests
benmao/requests
berg/requests
berndt/requests
bjedwards/requests
bluemoon/requests
btubbs/requests
cakebread/requests
chipx86/requests
chrisguitarguy/requests
christopherwright/requests
clsung/requests
danfairs/requests
danverbraganza/requests
dasevilla/requests
datajunkie007/requests
davidarkemp/requests
davidblewett/requests
daxreyes/requests
dbrgn/requests
dickon/requests
dongxi8/requests
drobertduke/requests
dstufft/requests
dumpforjunk/requests
duncm/requests
dvd0101/requests
dvogel/requests
dvska/requesocks
edsu/requests
erlichmen/requests
fahadbuddy/requests
fenomenog4/requests
flaper87/requests
floppym/requests
fmoo/requests
fredrik/requests
fwaechter/requests
garnaat/requests
gazpachoking/requests
ggarber/requests
gigigi/requests
goldenboy/requests
grncdr/requests
gulopine/requests
handloomweaver/requests
harchiko/requests
herbyme/requests
hlindset/requests
huzm/requests
ib-lundgren/requests
idan/requests
jakubroztocil/requests
james2468/requests
janrito/requests
javouhey/requests
jbochi/requests
jdyang/requests
jedie/requests
jerem/requests
jgorset/requests
jimfunk/requests
jinxcat/requests
jkleint/requests
jmshoffs0812/requests
johtso/requests
jonas-m/requests
joshimhoff/requests
juil/requests
kaesire/requests
kanarelo/requests
karlcow/requests
kenreitz42/requests
kislyuk/requests
kojit/requests
kracekumar/requests
kushaldas/requests
kuzmak/requests
lgastako/requests
lifepy/requests
linode/requests
lukecampbell/requests
machalekj/requests
mapmyfitness/requests
maraujop/requests
masgorji/requests
matthewyang/requests
maxcountryman/requests
maximbo/requests
medwards/requests
metawake/requests
methane/requests
mgiuca/requests
mhejrati/requests
mher/requests
miguelgrinberg/requests
mikemaccana/requests
millerdev/requests
miohtama/requests
mitsuhiko/requests
msabramo/requests
mthurman/requests
mvanveen/requests
mw44118/requests
ncoghlan/requests
neevor/requests
newsapps/requests
neyer/requests
nowells/requests
ojii/requests
ojno/requests
osman-masood/requests
pbrao/requests
pcdinh/requests-py3k
petermanser/requests
pmdarrow/requests
pnasrat/requests
pombredanne/requests
purepython/requests
pushpan/requests
pydanny/requests
rdbhost/yieldfromRequests
reclosedev/requests
revolunet/requests
rickmak/requests
robmadole/requests
rtucker-mozilla/requests
rushabh/requests
rwzehner/requests
sc999/requests
seacoastboy/requests
seanjensengrey/requests
shazow/requests
sigmavirus24/requests
singingwolfboy/requests
slingamn/requests
slyons/requests
smargonz/requests
smorin/requests
spulec/requests
sshyub/requests
steveklabnik/requests
sworddish/requests
tabletcorry/requests
tadeck/requests
tef/requests
tgebru/requests
thedaniel/requests
thomasw/requests
tidencatte/requests
tinnguyenz/requests
tkordas/requests
tml/requests
tmoertel/requests
tpe11etier/requests
tvaught/requests
twall/requests
tzuryby/requests
umbrae/requests
vickimo/requests
vivekpuri/requests
wasmith/requests
weskerfoot/requests
wwitzel3/requests
wynnw/requests
yoyossy/requests
zacharyvoase/requests
zed/requests
zsiciarz/requests
Nothing to show
compare: v2.25.1
Commits on Jun 17, 2020
* Continuity: Google App Engine
Commits on Jun 19, 2020
Closes #5504
Clarify that PreparedRequests should not be manually created
Commits on Jun 26, 2020
Commits on Jul 24, 2020
* Docs: list CURL_CA_BUNDLE as supported
Commits on Aug 17, 2020
Commits on Aug 26, 2020
Update misleading text about python support
Commits on Aug 27, 2020
This follows instructions from the Apache Foundation. It also ensures
that the license will be correctly detected by license scanning tools.

Note that by adding a NOTICE file triggers Section 4.d of the license,
which is usually intended by users of the license.

The text that was in the LICENSE file before this change is intended
(by the authors of the license) to be used as a file header, and not as
a full license notice for a project, but it is commonly used this way,
so I would of course understand if this change is rejected.
Apply the Apache-2.0 license correctly
Commits on Sep 11, 2020
Commits on Sep 23, 2020
replaced reference to requests-async with httpx the replacement project
Commits on Sep 29, 2020
Commits on Sep 30, 2020
Add official Python 3.8 support on Appveyor
Commits on Oct 01, 2020
Commits on Oct 02, 2020
Remove proposed/3.0.0 branch, only ever run against Python sans matrix option
Create codeql-analysis.yml
Commits on Oct 05, 2020
a small typo was corrected.
small typo corrected.
Commits on Nov 01, 2020
Respect the NETRC environment variable
Commits on Nov 11, 2020
Commits on Nov 16, 2020
Remove reference to development philosophy
Commits on Nov 17, 2020
Update advanced.rst
Commits on Nov 18, 2020
`ubuntu-latest` points to 18.04 and will soon flip to 20.04.

However tests currently fail on 20.04, so let's explicitly pin to 18.04 for now.
Pin GHA to Ubuntu 18.04
Commits on Nov 27, 2020
Sylvain MARIE
…s in a more user friendly way"

This reverts commit 4b66260
Sylvain MARIE
Commits on Nov 28, 2020
Commits on Nov 29, 2020
…pe is set to application/json, following RFC 4627.

fixes #5667
updated `get_encoding_from_headers` to return utf-8 if the content type is set to application/json
Commits on Dec 04, 2020
Proxy related doc updates
Commits on Dec 09, 2020
PSF relaunched new sponsorship program and the URL has changed.
Commits on Dec 11, 2020
Commits on Dec 14, 2020
Upgrade to chardet 4.x
Commits on Dec 16, 2020
Showing with 501 additions and 1,675 deletions.
  1. +2 −5 .github/CONTRIBUTING.md
  2. +1 −1 .github/FUNDING.yml
  3. +66 −0 .github/workflows/codeql-analysis.yml
  4. +31 −0 .github/workflows/run-tests.yml
  5. +0 −26 .travis.yml
  6. +2 −1 AUTHORS.rst
  7. +29 −0 HISTORY.md
  8. +172 −10 LICENSE
  9. +1 −1 MANIFEST.in
  10. +7 −7 Makefile
  11. +2 −0 NOTICE
  12. +0 −25 Pipfile
  13. +0 −765 Pipfile.lock
  14. +27 −91 README.md
  15. +0 −229 _appveyor/install.ps1
  16. +0 −57 appveyor.yml
  17. +0 −116 docs/_static/konami.js
  18. BIN docs/_static/requests-logo-small.jpg
  19. BIN docs/_static/requests-sidebar.jpg
  20. +0 −30 docs/_templates/hacks.html
  21. +9 −15 docs/_templates/sidebarintro.html
  22. +19 −13 docs/_templates/sidebarlogo.html
  23. +2 −3 docs/community/faq.rst
  24. +0 −2 docs/community/out-there.rst
  25. +0 −2 docs/community/recommended.rst
  26. +0 −2 docs/community/release-process.rst
  27. +7 −30 docs/community/support.rst
  28. +0 −13 docs/community/updates.rst
  29. +0 −2 docs/community/vulnerabilities.rst
  30. +1 −1 docs/conf.py
  31. +0 −2 docs/dev/authors.rst
  32. +3 −11 docs/dev/contributing.rst
  33. +0 −47 docs/dev/philosophy.rst
  34. +0 −64 docs/dev/todo.rst
  35. +7 −7 docs/index.rst
  36. +57 −11 docs/user/advanced.rst
  37. +0 −2 docs/user/authentication.rst
  38. +4 −11 docs/user/install.rst
  39. +0 −47 docs/user/intro.rst
  40. +2 −3 docs/user/quickstart.rst
  41. +4 −6 requests/__init__.py
  42. +2 −2 requests/__version__.py
  43. +3 −1 requests/models.py
  44. +15 −3 requests/sessions.py
  45. +13 −3 requests/utils.py
  46. +6 −0 requirements-dev.txt
  47. +4 −5 setup.py
  48. +3 −3 tests/test_requests.py
@@ -1,10 +1,7 @@
# Contribution Guidelines

Before opening any issues or proposing any pull requests, please do the
following:

1. Read our [Contributor's Guide](https://requests.readthedocs.io/en/latest/dev/contributing/).
2. Understand our [development philosophy](https://requests.readthedocs.io/en/latest/dev/philosophy/).
Before opening any issues or proposing any pull requests, please read
our [Contributor's Guide](https://requests.readthedocs.io/en/latest/dev/contributing/).

To get the greatest chance of helpful responses, please also observe the
following additional notes.
@@ -1 +1 @@
custom: ['https://www.python.org/psf/forms/sponsor-application/']
custom: ['https://www.python.org/psf/sponsorship/']
@@ -0,0 +1,66 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
name: "CodeQL"

on:
push:
branches: [master]
pull_request:
# The branches below must be a subset of the branches above
branches: [master]
schedule:
- cron: '0 23 * * 0'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest

strategy:
fail-fast: false


steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2

# If this run was triggered by a pull request event, then checkout
# the head of the pull request instead of the merge commit.
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: "python"
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
@@ -0,0 +1,31 @@
name: Tests

on: [push, pull_request]

jobs:
build:
runs-on: ${{ matrix.os }}

strategy:
fail-fast: false
matrix:
python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9]
os: [ubuntu-18.04, macOS-latest, windows-latest]
include:
# pypy3 on Mac OS currently fails trying to compile
# brotlipy. Moving pypy3 to only test linux.
- python-version: pypy3
os: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
make
- name: Run tests
run: |
make ci

This file was deleted.

@@ -8,7 +8,7 @@ Keepers of the Crystals

Previous Keepers of Crystals
````````````````````````````
- Kenneth Reitz <me@kennethreitz.org> `@kennethreitz <https://github.com/kennethreitz>`_, reluctant Keeper of the Master Crystal.
- Kenneth Reitz <me@kennethreitz.org> `@ken-reitz <https://github.com/ken-reitz>`_, reluctant Keeper of the Master Crystal.
- Cory Benfield <cory@lukasa.co.uk> `@lukasa <https://github.com/lukasa>`_
- Ian Cordasco <graffatcolmingov@gmail.com> `@sigmavirus24 <https://github.com/sigmavirus24>`_.

@@ -190,3 +190,4 @@ Patches and Suggestions
- Antti Kaihola (`@akaihola <https://github.com/akaihola>`_)
- "Dull Bananas" <dull.bananas0@gmail.com> (`@dullbananas <https://github.com/dullbananas>`_)
- Alessio Izzo (`@aless10 <https://github.com/aless10>`_)
- Sylvain Marié (`@smarie <https://github.com/smarie>`_)
@@ -6,6 +6,35 @@ dev

- \[Short description of non-trivial change.\]

2.25.1 (2020-12-16)
-------------------

**Bugfixes**

- Requests now treats `application/json` as `utf8` by default. Resolving
inconsistencies between `r.text` and `r.json` output. (#5673)

**Dependencies**

- Requests now supports chardet v4.x.

2.25.0 (2020-11-11)
------------------

**Improvements**

- Added support for NETRC environment variable. (#5643)

**Dependencies**

- Requests now supports urllib3 v1.26.

**Deprecations**

- Requests v2.25.x will be the last release series with support for Python 3.5.
- The `requests[security]` extra is officially deprecated and will be removed
in Requests v2.26.0.

2.24.0 (2020-06-17)
-------------------

182 LICENSE
@@ -1,13 +1,175 @@
Copyright 2019 Kenneth Reitz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

https://www.apache.org/licenses/LICENSE-2.0
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
@@ -1,2 +1,2 @@
include README.md LICENSE NOTICE HISTORY.md pytest.ini requirements.txt Pipfile Pipfile.lock
include README.md LICENSE NOTICE HISTORY.md pytest.ini requirements-dev.txt
recursive-include tests *.py

Showing you all comments on commits in this comparison.

@k0ssi

This comment has been minimized.

Copy link

@k0ssi k0ssi commented on 5855dd7 Dec 19, 2020

The Response.json method already includes proper guessing of the JSON encoding based on the first four octets as explained in RFC 4627 section 3. This newly introduced simplification fully disables this more advanced detection, as it sets self.encoding, and break usage of exotic JSON APIs serving JSON encoded in UTF variations with Bit Order Mark. I would recommend to revert this change. Especially for a patch release (2.5.1) this change is an unexpected behaviour change.

@jjmaldonis

This comment has been minimized.

Copy link
Contributor Author

@jjmaldonis jjmaldonis commented on 5855dd7 Dec 19, 2020

As the contributor I don't know enough about the library to weigh in, but the reason for this PR was based on #5667. Can you take a look and see if there is another solution that will solve that issue?

In short, the issue is that the Response.text method does not default to utf-8 encoding when application/json is set as the content type. RFC 4627 says that utf-8 should be the default encoding, and like you said it's possible to detect if the encoding is instead utf-16 or utf-32 based on the first two octets. That said, the functionality that I encountered and want to contribute to fixing is that Response.text uses chardet to identify the encoding for the content even if application/json is set as the content type, rather than defaulting to utf-* based on RFC 4627.

I'm more than happy to create a different PR for a quick review based on what you would like.

To quickly reproduce the issue in #5667, you can run the following code:

import requests
import json

r = requests.get("https://api.covidtracking.com/v1/us/current.json")
r._content = b'{"name":"rd\xce\xba","uuid":"1234"}'
r.headers = {
    "Content-Type": "application/json",
}
print(r.json())            # Prints:  {'name': 'rdκ', 'uuid': '1234'}  which is perfect
print(json.loads(r.text))  # Prints:  {'name': 'rdκ', 'uuid': '1234'}

I would expect the 2nd print statement to be identical to the first -- i.e. r.json() and json.loads(r.text) to be identical -- provided that application/json is set in the response header.

@nateprewitt

This comment has been minimized.

Copy link
Member

@nateprewitt nateprewitt commented on 5855dd7 Dec 21, 2020

Thanks for bringing this to our attention, @k0ssi! It sounds like this needs some more work. We may need to move the json() content-type logic out into another function we can reuse. Would one of you mind opening a new issue to track the discussion? These comments don't have great discoverability here.

@k0ssi

This comment has been minimized.

Copy link

@k0ssi k0ssi commented on 5855dd7 Dec 21, 2020

Unfortunately I dont have much time to take a closer look at the this at the moment. I'll have a look at it on the weekend and then get back to you next week. At the moment we first have to figure out what causes the issue @jjmaldonis tells. At first glance this looks to me as a encoding error within text() not json()

@jjmaldonis by setting an charset within get_encoding_from_headers function which is used to build the response there is no guessing while using .json() since charset is already set. Since there is no guarantee everyone is using 'utf-8' we cannot simply assume it is.
In my case this causes an error since api im working with is using 'utf-8 bom'