geventhttpclient 2.0.11__tar.gz → 2.1.0__tar.gz

{geventhttpclient-2.0.11 → geventhttpclient-2.1.0}/MANIFEST.in

@@ -5,7 +5,6 @@ recursive-include llhttp *.h *.c LICENSE-MIT
 recursive-include src/geventhttpclient/tests *
 global-exclude __pycache__
 global-exclude *.py[co]
-include LICENSE-MIT
-include README.mdown
-include CHANGELOG
-include pytest.ini
+include pyproject.toml
+include LICENSE.txt
+include README.md

geventhttpclient-2.1.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.1
+Name: geventhttpclient
+Version: 2.1.0
+Summary: HTTP client library for gevent
+Author-email: Antonin Amand <antonin.amand@gmail.com>
+License: Based on llhttp, copyright Fedor Indutny, 2018.
+        
+        Python extension is copyright Antonin Amand <antonin.amand@gmail.com>,
+        licensed under the same terms.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to
+        deal in the Software without restriction, including without limitation the
+        rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+        sell copies of the Software, 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.
+        
+        Note: Previous versions of gevenhttpclient used http_parser.c, which in turn 
+        was based on src/http/ngx_http_parse.c from NGINX, copyright Igor Sysoev, 
+        Joyent, Inc. and other Node contributors. See http://github.com/joyent/http-parser 
+        for more information
+        
+Project-URL: homepage, http://github.com/geventhttpclient/geventhttpclient
+Project-URL: issues, http://github.com/geventhttpclient/geventhttpclient/issues
+Project-URL: download, https://pypi.org/project/geventhttpclient/#files
+Keywords: http,gevent,client
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: gevent
+Requires-Dist: certifi
+Requires-Dist: brotli
+Requires-Dist: urllib3
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: dpkt; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Provides-Extra: benchmarks
+Requires-Dist: requests; extra == "benchmarks"
+Requires-Dist: httpx; extra == "benchmarks"
+Requires-Dist: urllib3; extra == "benchmarks"
+Requires-Dist: httplib2; extra == "benchmarks"
+
+[![GitHub Workflow CI Status](https://img.shields.io/github/actions/workflow/status/geventhttpclient/geventhttpclient/test.yml?branch=master&logo=github&style=flat)](https://github.com/geventhttpclient/geventhttpclient/actions)
+[![PyPI](https://img.shields.io/pypi/v/geventhttpclient.svg?style=flat)](https://pypi.org/project/geventhttpclient/)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fgeventhttpclient%2Fgeventhttpclient%2Fmaster%2Fpyproject.toml)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/geventhttpclient)
+
+# geventhttpclient
+
+A high performance, concurrent HTTP client library for python using 
+[gevent](http://gevent.org).
+
+`gevent.httplib` support was removed in [gevent 1.0](https://github.com/surfly/gevent/commit/b45b83b1bc4de14e3c4859362825044b8e3df7d6
+), **geventhttpclient** now provides that missing functionality.
+
+**geventhttpclient** uses a fast [http parser](https://github.com/nodejs/llhttp),
+written in C.
+
+**geventhttpclient** has been specifically designed for high concurrency,
+streaming and support HTTP 1.1 persistent connections. More generally it is
+designed for efficiently pulling from REST APIs and streaming APIs
+like Twitter's.
+
+Safe SSL support is provided by default. **geventhttpclient** depends on
+the certifi CA Bundle. This is the same CA Bundle which ships with the
+Requests codebase, and is derived from Mozilla Firefox's canonical set.
+
+As of version 2.1, only Python 3.9+ is fully supported (with prebuilt wheels).
+
+A simple example:
+
+```python
+#!/usr/bin/python
+
+from geventhttpclient import HTTPClient
+from geventhttpclient.url import URL
+
+url = URL('http://gevent.org/')
+
+http = HTTPClient(url.host)
+
+# issue a get request
+response = http.get(url.request_uri)
+
+# read status_code
+response.status_code
+
+# read response body
+body = response.read()
+
+# close connections
+http.close()
+```
+
+## httplib compatibility and monkey patch
+
+**geventhttpclient.httplib** module contains classes for drop in
+replacement of httplib connection and response objects.
+If you use httplib directly you can replace the **httplib** imports
+by **geventhttpclient.httplib**.
+
+```python
+# from httplib import HTTPConnection
+from geventhttpclient.httplib import HTTPConnection
+```
+
+If you use **httplib2**, **urllib** or **urllib2**; you can patch **httplib** to
+use the wrappers from **geventhttpclient**.
+For **httplib2**, make sure you patch before you import or the *super*
+calls will fail.
+
+```python
+import geventhttpclient.httplib
+geventhttpclient.httplib.patch()
+
+import httplib2
+```
+
+## High Concurrency
+
+HTTPClient has connection pool built in and is greenlet safe by design.
+You can use the same instance among several greenlets.
+
+```python
+#!/usr/bin/env python
+
+import gevent.pool
+import json
+
+from geventhttpclient import HTTPClient
+from geventhttpclient.url import URL
+
+
+# go to http://developers.facebook.com/tools/explorer and copy the access token
+TOKEN = '<go to http://developers.facebook.com/tools/explorer and copy the access token>'
+
+url = URL('https://graph.facebook.com/me/friends')
+url['access_token'] = TOKEN
+
+# setting the concurrency to 10 allow to create 10 connections and
+# reuse them.
+http = HTTPClient.from_url(url, concurrency=10)
+
+response = http.get(url.request_uri)
+assert response.status_code == 200
+
+# response comply to the read protocol. It passes the stream to
+# the json parser as it's being read.
+data = json.load(response)['data']
+
+def print_friend_username(http, friend_id):
+    friend_url = URL('/' + str(friend_id))
+    friend_url['access_token'] = TOKEN
+    # the greenlet will block until a connection is available
+    response = http.get(friend_url.request_uri)
+    assert response.status_code == 200
+    friend = json.load(response)
+    if 'username' in friend:
+        print('%s: %s' % (friend['username'], friend['name']))
+    else:
+        print('%s has no username.' % friend['name'])
+
+# allow to run 20 greenlet at a time, this is more than concurrency
+# of the http client but isn't a problem since the client has its own
+# connection pool.
+pool = gevent.pool.Pool(20)
+for item in data:
+    friend_id = item['id']
+    pool.spawn(print_friend_username, http, friend_id)
+
+pool.join()
+http.close()
+```
+
+## Streaming
+
+**geventhttpclient** supports streaming.
+Response objects have a read(N) and readline() method that read the stream
+incrementally.
+See *src/examples/twitter_streaming.py* for pulling twitter stream API.
+
+Here is an example on how to download a big file chunk by chunk to save memory:
+
+```python
+#!/usr/bin/env python
+
+from geventhttpclient import HTTPClient, URL
+
+url = URL('http://127.0.0.1:80/100.dat')
+http = HTTPClient.from_url(url)
+response = http.get(url.query_string)
+assert response.status_code == 200
+
+CHUNK_SIZE = 1024 * 16 # 16KB
+with open('/tmp/100.dat', 'w') as f:
+    data = response.read(CHUNK_SIZE)
+    while data:
+        f.write(data)
+        data = response.read(CHUNK_SIZE)
+```
+
+## Benchmarks
+
+The benchmark does 10000 get requests against a local nginx server in the default 
+configuration with a concurrency of 10. See `benchmarks` folder. The requests per
+second for a couple of popular clients is given in the table below.
+
+| HTTP Client          | RPS    |
+|----------------------|--------|
+| GeventHTTPClient     | 7181.2 |
+| Urllib3              | 2847.5 |
+| Httpx                | 1682.9 |
+| Requests             | 1186.4 |
+
+*Linux(x86_64), Python 3.11.6 @ Intel i7-7560U*

geventhttpclient-2.0.11/README.mdown → geventhttpclient-2.1.0/README.md

@@ -1,3 +1,8 @@
+[![GitHub Workflow CI Status](https://img.shields.io/github/actions/workflow/status/geventhttpclient/geventhttpclient/test.yml?branch=master&logo=github&style=flat)](https://github.com/geventhttpclient/geventhttpclient/actions)
+[![PyPI](https://img.shields.io/pypi/v/geventhttpclient.svg?style=flat)](https://pypi.org/project/geventhttpclient/)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fgeventhttpclient%2Fgeventhttpclient%2Fmaster%2Fpyproject.toml)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/geventhttpclient)
+
 # geventhttpclient
 
 A high performance, concurrent HTTP client library for python using 
@@ -18,10 +23,7 @@ Safe SSL support is provided by default. **geventhttpclient** depends on
 the certifi CA Bundle. This is the same CA Bundle which ships with the
 Requests codebase, and is derived from Mozilla Firefox's canonical set.
 
-As of version 1.5, only Python 3.6+ is fully supported (with prebuilt wheels), 
-but Python 2.7 and 3.5 *should* work too.
-
-Use of SSL/TLS with python 2.7.9 is not recommended and may be broken.
+As of version 2.1, only Python 3.9+ is fully supported (with prebuilt wheels).
 
 A simple example:
 
@@ -111,10 +113,10 @@ def print_friend_username(http, friend_id):
     response = http.get(friend_url.request_uri)
     assert response.status_code == 200
     friend = json.load(response)
-    if friend.has_key('username'):
-        print '%s: %s' % (friend['username'], friend['name'])
+    if 'username' in friend:
+        print('%s: %s' % (friend['username'], friend['name']))
     else:
-        print '%s has no username.' % friend['name']
+        print('%s has no username.' % friend['name'])
 
 # allow to run 20 greenlet at a time, this is more than concurrency
 # of the http client but isn't a problem since the client has its own
@@ -157,9 +159,15 @@ with open('/tmp/100.dat', 'w') as f:
 
 ## Benchmarks
 
-The benchmark does 1000 get requests against a local nginx server with
-a concurrency of 10. See *benchmarks* folder.
+The benchmark does 10000 get requests against a local nginx server in the default 
+configuration with a concurrency of 10. See `benchmarks` folder. The requests per
+second for a couple of popular clients is given in the table below.
 
-- httplib2 with geventhttpclient monkey patch (*benchmarks/httplib2_patched.py*): **~2500 req/s**
-- geventhttpclient.HTTPClient (*benchmarks/httpclient.py*): **~4000 req/s**
+| HTTP Client          | RPS    |
+|----------------------|--------|
+| GeventHTTPClient     | 7181.2 |
+| Urllib3              | 2847.5 |
+| Httpx                | 1682.9 |
+| Requests             | 1186.4 |
 
+*Linux(x86_64), Python 3.11.6 @ Intel i7-7560U*

{geventhttpclient-2.0.11 → geventhttpclient-2.1.0}/llhttp/include/llhttp.h

@@ -3,7 +3,7 @@
 
 #define LLHTTP_VERSION_MAJOR 6
 #define LLHTTP_VERSION_MINOR 0
-#define LLHTTP_VERSION_PATCH 10
+#define LLHTTP_VERSION_PATCH 11
 
 #ifndef LLHTTP_STRICT_MODE
 # define LLHTTP_STRICT_MODE 0