geventhttpclient 2.2.1__tar.gz → 2.3.1__tar.gz

{geventhttpclient-2.2.1 → geventhttpclient-2.3.1}/MANIFEST.in

@@ -1,10 +1,9 @@
-include src/geventhttpclient/*.py
+include geventhttpclient/*.py
 include ext/*.c
 include ext/*.h
 recursive-include llhttp *.h *.c LICENSE-MIT
-recursive-include src/geventhttpclient/tests *
+recursive-exclude tests *
 global-exclude __pycache__
 global-exclude *.py[co]
 include pyproject.toml
-include LICENSE.txt
 include README.md

{geventhttpclient-2.2.1/src/geventhttpclient.egg-info → geventhttpclient-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: geventhttpclient
-Version: 2.2.1
+Version: 2.3.1
 Summary: HTTP client library for gevent
 Author-email: Antonin Amand <antonin.amand@gmail.com>
 License: This software is licensed under the MIT License.
@@ -68,67 +68,72 @@ Requires-Dist: oauth2; extra == "examples"
 
 # geventhttpclient
 
-A high performance, concurrent HTTP client library for python using 
+A [high performance](https://github.com/geventhttpclient/geventhttpclient/blob/master/README.md#Benchmarks),
+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.
+`gevent.httplib` support for patching `http.client` 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),
+`geventhttpclient` uses a fast [http parser](https://github.com/nodejs/llhttp),
 written in C.
 
-**geventhttpclient** has been specifically designed for high concurrency,
+`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
+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:
+Since version 2.3, `geventhttpclient` features a largely `requests`
+compatible interface. It covers basic HTTP usage including cookie
+management, form data encoding or decoding of compressed data,
+but otherwise isn't as feature rich as the original `requests`. For
+simple use-cases, it can serve as a drop-in replacement.
 
 ```python
-#!/usr/bin/python
+import geventhttpclient as requests
+requests.get("https://github.com").text
+requests.post("http://httpbingo.org/post", data="asdfasd").json()
+
+from geventhttpclient import Session
+s = Session()
+s.get("http://httpbingo.org/headers").json()
+s.get("https://github.com").content
+```
+
+This interface builds on top of the lower level `HTTPClient`.
 
+```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
+url = URL("http://gevent.org/")
+client = HTTPClient(url.host)
+response = client.get(url.request_uri)
 response.status_code
-
-# read response body
 body = response.read()
-
-# close connections
-http.close()
+client.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**.
+`geventhttpclient.httplib` module contains classes for drop in
+replacement of `http.client` connection and response objects.
+If you use http.client directly you can replace the `httplib` imports
+by `geventhttpclient.httplib`.
 
 ```python
-# from httplib import HTTPConnection
+# from http.client 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.
+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
@@ -139,12 +144,11 @@ 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.
+`HTTPClient` has a connection pool built in and is greenlet safe by design.
+You can use the same instance among several greenlets. It is the low
+level building block of this library.
 
 ```python
-#!/usr/bin/env python
-
 import gevent.pool
 import json
 
@@ -153,67 +157,63 @@ 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>'
+TOKEN = "<MY_DEV_TOKEN>"
 
-url = URL('https://graph.facebook.com/me/friends')
-url['access_token'] = TOKEN
+url = URL("https://graph.facebook.com/me/friends", params={"access_token": TOKEN})
 
 # setting the concurrency to 10 allow to create 10 connections and
 # reuse them.
-http = HTTPClient.from_url(url, concurrency=10)
+client = HTTPClient.from_url(url, concurrency=10)
 
-response = http.get(url.request_uri)
+response = client.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']
+data = json.load(response)["data"]
 
-def print_friend_username(http, friend_id):
-    friend_url = URL('/' + str(friend_id))
-    friend_url['access_token'] = TOKEN
+def print_friend_username(client, friend_id):
+    friend_url = URL(f"/{friend_id}", params={"access_token": TOKEN})
     # the greenlet will block until a connection is available
-    response = http.get(friend_url.request_uri)
+    response = client.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']))
+    if "username" in friend:
+        print(f"{friend['username']}: {friend['name']}")
     else:
-        print('%s has no username.' % friend['name'])
+        print(f"{friend['name']} has no username.")
 
 # 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)
+    friend_id = item["id"]
+    pool.spawn(print_friend_username, client, friend_id)
 
 pool.join()
-http.close()
+client.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.
+`geventhttpclient` supports streaming. Response objects have a `read(n)` and
+`readline()` method that read the stream incrementally.
+See [examples/twitter_streaming.py](https://github.com/geventhttpclient/geventhttpclient/blob/master/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)
+url = URL("http://127.0.0.1:80/100.dat")
+client = HTTPClient.from_url(url)
+response = client.get(url.query_string)
 assert response.status_code == 200
 
 CHUNK_SIZE = 1024 * 16 # 16KB
-with open('/tmp/100.dat', 'w') as f:
+with open("/tmp/100.dat", "w") as f:
     data = response.read(CHUNK_SIZE)
     while data:
         f.write(data)
@@ -222,11 +222,12 @@ with open('/tmp/100.dat', 'w') as f:
 
 ## Benchmarks
 
-The benchmark does 10000 get requests against a local nginx server in the default 
+The benchmark runs 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. Please read
 [benchmarks/README.md](https://github.com/geventhttpclient/geventhttpclient/blob/master/benchmarks/README.md)
-for mor details. Also note, HTTPX is better be used with asyncio, not gevent.
+for more details. Also note, [HTTPX](https://www.python-httpx.org/) is better be
+used with `asyncio`, not `gevent`.
 
 | HTTP Client        | RPS    |
 |--------------------|--------|
@@ -240,8 +241,8 @@ for mor details. Also note, HTTPX is better be used with asyncio, not gevent.
 
 ## License
 
-This package is distributed under the [MIT license](https://github.com/geventhttpclient/geventhttpclient/blob/master/LICENSE-MIT). 
-Previous versions of geventhttpclient 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. For more information, see 
-http://github.com/joyent/http-parser 
+This package is distributed under the [MIT license](https://github.com/geventhttpclient/geventhttpclient/blob/master/LICENSE-MIT).
+Previous versions of geventhttpclient used `http_parser.c`, which in turn was
+based on `http/ngx_http_parse.c` from [NGINX](https://nginx.org), copyright Igor
+Sysoev, Joyent, Inc., and other Node contributors. For more information, see
+http://github.com/joyent/http-parser

geventhttpclient-2.3.1/README.md

@@ -0,0 +1,185 @@
+[![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](https://github.com/geventhttpclient/geventhttpclient/blob/master/README.md#Benchmarks),
+concurrent HTTP client library for python using
+[gevent](http://gevent.org).
+
+`gevent.httplib` support for patching `http.client` 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.
+
+Since version 2.3, `geventhttpclient` features a largely `requests`
+compatible interface. It covers basic HTTP usage including cookie
+management, form data encoding or decoding of compressed data,
+but otherwise isn't as feature rich as the original `requests`. For
+simple use-cases, it can serve as a drop-in replacement.
+
+```python
+import geventhttpclient as requests
+requests.get("https://github.com").text
+requests.post("http://httpbingo.org/post", data="asdfasd").json()
+
+from geventhttpclient import Session
+s = Session()
+s.get("http://httpbingo.org/headers").json()
+s.get("https://github.com").content
+```
+
+This interface builds on top of the lower level `HTTPClient`.
+
+```python
+from geventhttpclient import HTTPClient
+from geventhttpclient.url import URL
+
+url = URL("http://gevent.org/")
+client = HTTPClient(url.host)
+response = client.get(url.request_uri)
+response.status_code
+body = response.read()
+client.close()
+```
+
+## httplib compatibility and monkey patch
+
+`geventhttpclient.httplib` module contains classes for drop in
+replacement of `http.client` connection and response objects.
+If you use http.client directly you can replace the `httplib` imports
+by `geventhttpclient.httplib`.
+
+```python
+# from http.client 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 a connection pool built in and is greenlet safe by design.
+You can use the same instance among several greenlets. It is the low
+level building block of this library.
+
+```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 = "<MY_DEV_TOKEN>"
+
+url = URL("https://graph.facebook.com/me/friends", params={"access_token": TOKEN})
+
+# setting the concurrency to 10 allow to create 10 connections and
+# reuse them.
+client = HTTPClient.from_url(url, concurrency=10)
+
+response = client.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(client, friend_id):
+    friend_url = URL(f"/{friend_id}", params={"access_token": TOKEN})
+    # the greenlet will block until a connection is available
+    response = client.get(friend_url.request_uri)
+    assert response.status_code == 200
+    friend = json.load(response)
+    if "username" in friend:
+        print(f"{friend['username']}: {friend['name']}")
+    else:
+        print(f"{friend['name']} has no username.")
+
+# 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, client, friend_id)
+
+pool.join()
+client.close()
+```
+
+## Streaming
+
+`geventhttpclient` supports streaming. Response objects have a `read(n)` and
+`readline()` method that read the stream incrementally.
+See [examples/twitter_streaming.py](https://github.com/geventhttpclient/geventhttpclient/blob/master/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
+from geventhttpclient import HTTPClient, URL
+
+url = URL("http://127.0.0.1:80/100.dat")
+client = HTTPClient.from_url(url)
+response = client.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 runs 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. Please read
+[benchmarks/README.md](https://github.com/geventhttpclient/geventhttpclient/blob/master/benchmarks/README.md)
+for more details. Also note, [HTTPX](https://www.python-httpx.org/) is better be
+used with `asyncio`, not `gevent`.
+
+| HTTP Client        | RPS    |
+|--------------------|--------|
+| GeventHTTPClient   | 7268.9 |
+| Httplib2 (patched) | 2323.9 |
+| Urllib3            | 2242.5 |
+| Requests           | 1046.1 |
+| Httpx              | 770.3  |
+
+*Linux(x86_64), Python 3.11.6 @ Intel i7-7560U*
+
+## License
+
+This package is distributed under the [MIT license](https://github.com/geventhttpclient/geventhttpclient/blob/master/LICENSE-MIT).
+Previous versions of geventhttpclient used `http_parser.c`, which in turn was
+based on `http/ngx_http_parse.c` from [NGINX](https://nginx.org), copyright Igor
+Sysoev, Joyent, Inc., and other Node contributors. For more information, see
+http://github.com/joyent/http-parser

{geventhttpclient-2.2.1 → geventhttpclient-2.3.1}/ext/_parser.c

@@ -23,9 +23,9 @@ typedef struct {
 static int on_message_begin(llhttp_t* parser)
 {
     int fail = 0;
-    PyObject* self = (PyObject*)parser->data;
-    if (PyObject_HasAttrString(self, "_on_message_begin")) {
-        PyObject* callable = PyObject_GetAttrString(self, "_on_message_begin");
+    PyHTTPResponseParser *self = (PyHTTPResponseParser*) parser->data;
+    PyObject* callable = PyObject_GetAttrString((PyObject*)self, "_on_message_begin");
+    if (callable) {
         PyObject* result = PyObject_CallObject(callable, NULL);
         PyObject* exception = PyErr_Occurred();
         if (exception != NULL) {
@@ -45,8 +45,8 @@ static int on_message_complete(llhttp_t* parser)
     int fail = 0;
     PyHTTPResponseParser *self = (PyHTTPResponseParser*) parser->data;
     self->should_keep_alive = llhttp_should_keep_alive(parser) ? KA_TRUE : KA_FALSE;
-    if (PyObject_HasAttrString(self, "_on_message_complete")) {
-        PyObject* callable = PyObject_GetAttrString(self, "_on_message_complete");
+    PyObject* callable = PyObject_GetAttrString((PyObject*)self, "_on_message_complete");
+    if (callable) {
         PyObject* result = PyObject_CallObject(callable, NULL);
         PyObject* exception = PyErr_Occurred();
         if (exception != NULL) {
@@ -65,9 +65,9 @@ static int on_headers_complete(llhttp_t* parser)
 {
     /* 1 => skip body, 2 => upgrade, 0 => continue, -1 => error */
     int skip_body = 0;
-    PyObject* self = (PyObject*)parser->data;
-    if (PyObject_HasAttrString(self, "_on_headers_complete")) {
-        PyObject* callable = PyObject_GetAttrString(self, "_on_headers_complete");
+    PyHTTPResponseParser *self = (PyHTTPResponseParser*) parser->data;
+    PyObject* callable = PyObject_GetAttrString((PyObject*)self, "_on_headers_complete");
+    if (callable) {
         PyObject* result = PyObject_CallObject(callable, NULL);
         PyObject* exception = PyErr_Occurred();
         if (exception != NULL) {
@@ -84,9 +84,9 @@ static int on_headers_complete(llhttp_t* parser)
 static int on_http_data_cb(llhttp_t* parser, const char *at, size_t length, const char * python_cb)
 {
     int fail = 0;
-    PyObject* self = (PyObject*)parser->data;
-    if (PyObject_HasAttrString(self, python_cb)) {
-        PyObject* callable = PyObject_GetAttrString(self, python_cb);
+    PyHTTPResponseParser *self = (PyHTTPResponseParser*) parser->data;
+    PyObject* callable = PyObject_GetAttrString((PyObject*)self, python_cb);
+    if (callable) {
         PyObject* args = Py_BuildValue("(s#)", at, length);
         PyObject* result = PyObject_CallObject(callable, args);
         PyObject* exception = PyErr_Occurred();
@@ -100,7 +100,7 @@ static int on_http_data_cb(llhttp_t* parser, const char *at, size_t length, cons
         Py_DECREF(callable);
         Py_DECREF(args);
     }
-    return fail;    
+    return fail;
 }
 
 static int on_status(llhttp_t* parser, const char *at, size_t length)
@@ -121,9 +121,9 @@ static int on_header_value(llhttp_t* parser, const char *at, size_t length)
 static int on_body(llhttp_t* parser, const char *at, size_t length)
 {
     int fail = 0;
-    PyObject* self = (PyObject*)parser->data;
-    if (PyObject_HasAttrString(self, "_on_body")) {
-        PyObject* callable = PyObject_GetAttrString(self, "_on_body");
+    PyHTTPResponseParser *self = (PyHTTPResponseParser*) parser->data;
+    PyObject* callable = PyObject_GetAttrString((PyObject*)self, "_on_body");
+    if (callable) {
         PyObject* bytearray = PyByteArray_FromStringAndSize(at, length);
         PyObject* result = PyObject_CallFunctionObjArgs(
             callable, bytearray, NULL);
@@ -269,7 +269,7 @@ PyHTTPResponseParser_should_keep_alive(PyHTTPResponseParser* self)
     if (self->error != HPE_OK) {
         Py_RETURN_FALSE;
     }
-    int should_keep_alive;
+    int should_keep_alive = 0;
     switch (self->should_keep_alive) {
         case KA_INCOMPLETE:
             should_keep_alive = llhttp_should_keep_alive(self->parser);
@@ -305,7 +305,7 @@ static PyMethodDef PyHTTPResponseParser_methods[] = {
         "Get remaining content length to read"},
     {"should_keep_alive", (PyCFunction)PyHTTPResponseParser_should_keep_alive,
         METH_NOARGS,
-        "Tell wether the connection should stay connected (HTTP 1.1)"},
+        "Tell whether the connection should stay connected (HTTP 1.1)"},
     {"parser_failed", (PyCFunction)PyHTTPResponseParser_parser_failed,
         METH_NOARGS,
         "Tell if parser have failed."},

geventhttpclient-2.3.1/geventhttpclient/__init__.py

@@ -0,0 +1,9 @@
+# package
+
+__version__ = "2.3.1"  # dont forget to update version in pyproject.toml as well
+
+from geventhttpclient.api import delete, get, head, options, patch, post, put, request
+from geventhttpclient.client import HTTPClient
+from geventhttpclient.requests import Session
+from geventhttpclient.url import URL
+from geventhttpclient.useragent import UserAgent