geventhttpclient 2.1.0__tar.gz → 2.2.0__tar.gz

{geventhttpclient-2.1.0/src/geventhttpclient.egg-info → geventhttpclient-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: geventhttpclient
-Version: 2.1.0
+Version: 2.2.0
 Summary: HTTP client library for gevent
 Author-email: Antonin Amand <antonin.amand@gmail.com>
 License: Based on llhttp, copyright Fedor Indutny, 2018.
@@ -62,6 +62,8 @@ Requires-Dist: requests; extra == "benchmarks"
 Requires-Dist: httpx; extra == "benchmarks"
 Requires-Dist: urllib3; extra == "benchmarks"
 Requires-Dist: httplib2; extra == "benchmarks"
+Provides-Extra: examples
+Requires-Dist: oauth2; extra == "examples"
 
 [![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/)
@@ -226,13 +228,16 @@ with open('/tmp/100.dat', 'w') as f:
 
 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 |
+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.
+
+| 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*

{geventhttpclient-2.1.0 → geventhttpclient-2.2.0}/README.md

@@ -161,13 +161,16 @@ with open('/tmp/100.dat', 'w') as f:
 
 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 |
+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.
+
+| 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*

{geventhttpclient-2.1.0 → geventhttpclient-2.2.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "geventhttpclient"
-version = "2.1.0" # dont forget to update version __init__.py as well
+version = "2.2.0" # dont forget to update version __init__.py as well
 description = "HTTP client library for gevent"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -40,8 +40,12 @@ optional-dependencies.benchmarks = [
     "requests",
     "httpx",
     "urllib3",
-    "httplib2"
+    "httplib2",
 ]
+optional-dependencies.examples = [
+    "oauth2",
+]
+
 
 [project.urls]
 homepage = "http://github.com/geventhttpclient/geventhttpclient"

{geventhttpclient-2.1.0 → geventhttpclient-2.2.0}/setup.py

@@ -1,4 +1,5 @@
 from distutils.core import setup
+
 from setuptools.extension import Extension
 
 http_parser = Extension(

{geventhttpclient-2.1.0 → geventhttpclient-2.2.0}/src/geventhttpclient/__init__.py

@@ -1,6 +1,6 @@
 # package
 
-__version__ = "2.1.0"  # dont forget to update version in pyproject.toml as well
+__version__ = "2.2.0"  # dont forget to update version in pyproject.toml as well
 
 from geventhttpclient.client import HTTPClient
 from geventhttpclient.url import URL

{geventhttpclient-2.1.0 → geventhttpclient-2.2.0}/src/geventhttpclient/client.py

@@ -83,7 +83,7 @@ class HTTPClient:
         headers_type=Headers,
     ):
         if headers is None:
-            headers = {}
+            headers = headers_type()
         self.host = host
         self.port = port
         connection_host = self.host

{geventhttpclient-2.1.0 → geventhttpclient-2.2.0}/src/geventhttpclient/connectionpool.py

@@ -1,4 +1,5 @@
 import os
+from contextlib import contextmanager
 
 import gevent.queue
 import gevent.socket
@@ -184,8 +185,21 @@ class ConnectionPool:
             self._semaphore.release()
 
 
+def init_ssl_context(ssl_context_factory, ca_certs, check_hostname=True):
+    try:
+        ssl_context = ssl_context_factory(cafile=ca_certs)
+    except TypeError:
+        ssl_context = ssl_context_factory()
+        ssl_context.load_verify_locations(cafile=ca_certs)
+    ssl_context.check_hostname = check_hostname
+    if check_hostname:
+        ssl_context.verify_mode = gevent.ssl.CERT_REQUIRED
+    return ssl_context
+
+
 try:
     import gevent.ssl
+
     try:
         from gevent.ssl import create_default_context
     except ImportError:
@@ -228,21 +242,16 @@ else:
 
             ssl_context_factory = ssl_context_factory or create_default_context
             if ssl_context_factory is not None:
-                self.init_ssl_context(ssl_context_factory)
+                self.ssl_context = init_ssl_context(
+                    ssl_context_factory,
+                    self.ssl_options["ca_certs"],
+                    check_hostname=not self.insecure,
+                )
             else:
                 self.ssl_context = None
 
             super().__init__(connection_host, connection_port, request_host, request_port, **kw)
 
-        def init_ssl_context(self, ssl_context_factory):
-            ca_certs = self.ssl_options["ca_certs"]
-            try:
-                self.ssl_context = ssl_context_factory(cafile=ca_certs)
-            except TypeError:
-                self.ssl_context = ssl_context_factory()
-                self.ssl_context.load_verify_locations(cafile=ca_certs)
-            self.ssl_context.check_hostname = not self.insecure
-
         def _connect_socket(self, sock, address):
             sock = super()._connect_socket(sock, address)
 
@@ -251,3 +260,30 @@ else:
             else:
                 server_hostname = self.ssl_options.get("server_hostname", self._request_host)
                 return self.ssl_context.wrap_socket(sock, server_hostname=server_hostname)
+
+
+class ClientPool:
+    """
+    Pool implementation for HTTP clients, that weren't designed with concurrency in mind.
+    Usage example:
+
+    pool = ClientPool(MyHttpClient)
+    with pool.get() as client:
+        response = client.request("127.0.0.1")
+    """
+
+    def __init__(self, factory, concurrency=5):
+        self.factory = factory
+        self.queue = gevent.queue.Queue(concurrency)
+        for i in range(concurrency):
+            self.queue.put(factory())
+
+    @contextmanager
+    def get(self):
+        client = self.queue.get()
+        yield client
+        self.queue.put(client)
+
+    def close(self):
+        for client in self.queue:
+            client.close()

geventhttpclient-2.2.0/src/geventhttpclient/header.py

@@ -0,0 +1,277 @@
+from collections.abc import Mapping, MutableMapping
+
+_dict_setitem = dict.__setitem__
+_dict_getitem = dict.__getitem__
+_dict_delitem = dict.__delitem__
+_dict_contains = dict.__contains__
+_dict_setdefault = dict.setdefault
+_dict_items = dict.items
+_dict_values = dict.values
+
+
+class Headers(dict):
+    """
+    :param headers:
+        An iterable of field-value pairs.
+
+    :param kwargs:
+        Additional field-value pairs to pass in to ``Headers.extend``.
+
+    A ``dict`` like container for storing HTTP Headers.
+
+    According to RFC 7230, header field names have to be treated case-insentitive.
+    This means `SET-COOKIE` as header field denotes the same field as `set-cookie`.
+
+    In order to implement this behavior efficiently, all header names are lowered
+    and used as dictionary key for fast access of certain header lines. The original
+    case-sensitive header field is stored alongside the values under the hood.
+
+    Iterating over Header.items() returns all field-value pairs with the original
+    cases. The order of the returned items matches the input order, except that
+    headers with a matching header field are grouped.
+
+    Use Header.__setitem__() and Header.update() for overwriting the content
+    of matching header fields and .add() and .extend() for appending header
+    lines instead of overwriting them.
+
+    Note: b"asdf" and "asdf" are separate things. This class tries not to
+    enforce the one or the other.
+
+    >>> headers = Headers()
+    >>> headers.add('Set-Cookie', 'foo=bar')
+    >>> headers.add('set-cookie', 'baz=quxx')
+    >>> headers['SET-cookie']
+    ['foo=bar', 'baz=quxx']
+    >>> headers['content-length'] = '7'
+    >>> headers['Content-Length']
+    '7'
+    >>> headers
+    Headers({'Set-Cookie': 'foo=bar, baz=quxx', 'content-length': '7'})
+    """
+
+    def __init__(self, headers=None, **kwargs):
+        dict.__init__(self)
+        if headers is not None:
+            if isinstance(headers, type(self)):
+                self._copy_from(headers)
+            else:
+                self.extend(headers)
+        if kwargs:
+            self.extend(kwargs)
+
+    def __setitem__(self, field, value):
+        return _dict_setitem(self, field.lower(), (field, value))
+
+    def __getitem__(self, field):
+        vals = _dict_getitem(self, field.lower())
+        if isinstance(vals, tuple):
+            return vals[1]
+        return [val[1] for val in vals]
+
+    def __delitem__(self, field):
+        return _dict_delitem(self, field.lower())
+
+    def __contains__(self, field):
+        return _dict_contains(self, field.lower())
+
+    def __eq__(self, other):
+        if not isinstance(other, Mapping) and not hasattr(other, "keys"):
+            return False
+        if not isinstance(other, type(self)):
+            other = type(self)(other)
+        return {f1: self[f1] for f1 in self} == {f2: other[f2] for f2 in other}
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    values = MutableMapping.values
+    get = MutableMapping.get
+    keys = MutableMapping.keys
+
+    __marker = object()
+
+    def pop(self, field, default=__marker):
+        """D.pop(field[,default]) -> value, remove specified field and return the corresponding value.
+        If field is not found, d is returned if given, otherwise KeyError is raised.
+        """
+        # Using the MutableMapping function directly fails due to the private marker.
+        # Using ordinary dict.pop would expose the internal structures.
+        # So let's reinvent the wheel.
+        try:
+            value = self[field]
+        except KeyError:
+            if default is self.__marker:
+                raise
+            return default
+        del self[field]
+        return value
+
+    def discard(self, field):
+        try:
+            del self[field]
+        except KeyError:
+            pass
+
+    def add(self, field, value):
+        """Add a (field, value) pair without overwriting the value if it already
+        exists.
+
+        >>> headers = Headers(foo='bar')
+        >>> headers.add('Foo', 'baz')
+        >>> headers['foo']
+        'bar, baz'
+        """
+        field_lower = field.lower()
+        new_vals = field, value
+        # Keep the common case aka no item present as fast as possible
+        vals = _dict_setdefault(self, field_lower, new_vals)
+        if new_vals is not vals:
+            # new_vals was not inserted, as there was a previous one
+            if isinstance(vals, tuple):
+                # Only one item so far, create a list and append new_vals
+                _dict_setitem(self, field_lower, [vals, new_vals])
+            elif isinstance(vals, list):
+                # Already several items got inserted, we have a list
+                vals.append(new_vals)
+            else:
+                raise TypeError("invalid vals stored")
+
+    def extend(self, *args, **kwargs):
+        """Generic import function for any type of header-like object.
+        Adapted version of MutableMapping.update in order to insert items
+        with self.add instead of self.__setitem__
+        """
+        if len(args) > 1:
+            raise TypeError(f"extend() takes at most 1 positional argument ({len(args)} given)")
+        other = args[0] if len(args) >= 1 else ()
+
+        if isinstance(other, type(self)):
+            for field, value in other.items():
+                self.add(field, value)
+        elif isinstance(other, Mapping):
+            for field in other:
+                self.add(field, other[field])
+        elif hasattr(other, "keys"):
+            for field in other.fields():
+                self.add(field, other[field])
+        else:
+            for field, value in other:
+                self.add(field, value)
+
+        for field, value in kwargs.items():
+            self.add(field, value)
+
+    def update(self, *args, **kwargs):
+        """Generic import function for any type of header-like object.
+        Adapted version of MutableMapping.update in order to overwrite items
+        while preserving case-sensitive header fields.
+        """
+        if len(args) > 1:
+            raise TypeError(f"extend() takes at most 1 positional argument ({len(args)} given)")
+        other = args[0] if len(args) >= 1 else ()
+
+        if isinstance(other, type(self)):
+            for field, value in other.items():
+                self[field] = value
+        elif isinstance(other, Mapping):
+            for field in other:
+                self[field] = other[field]
+        elif hasattr(other, "keys"):
+            for field in other.keys():
+                self[field] = other[field]
+        else:
+            for field, value in other:
+                self[field] = value
+
+        for field, value in kwargs.items():
+            self[field] = value
+
+    def getlist(self, field):
+        """Returns a list of all the values for the named field. Returns an
+        empty list if the field doesn't exist.
+        """
+        try:
+            vals = _dict_getitem(self, field.lower())
+        except KeyError:
+            return []
+        if isinstance(vals, tuple):
+            return [vals[1]]
+        return [val[1] for val in vals]
+
+    def get_all(self, field, failobj=None):
+        values = self.getlist(field)
+        if not values:
+            return failobj
+        return values
+
+    def _copy_from(self, other):
+        for field in other:
+            vals = _dict_getitem(other, field)
+            if isinstance(vals, list):
+                # No need to clone immutable tuples, only lists
+                vals = list(vals)
+            _dict_setitem(self, field, vals)
+
+    def copy(self):
+        clone = type(self)()
+        clone._copy_from(self)
+        return clone
+
+    def __len__(self):
+        return sum(1 if isinstance(vals, tuple) else len(vals) for vals in _dict_values(self))
+
+    def __repr__(self):
+        return f"{type(self).__name__}({dict(self.itermerged())})"
+
+    def __str__(self):
+        """Return a similar string as the original HTTP text received for parsing. Lines with
+        matching header fields are grouped.
+        """
+        return "\n".join(f"{field}: {value}" for field, value in self.items())
+
+    def itermerged(self):
+        """Iterate over all headers, merging lines with duplicate header
+        fields together into one item. The case of the first header field
+        is preserved.
+        """
+        for field, vals in _dict_items(self):
+            if isinstance(vals, tuple):
+                yield vals
+            else:
+                # this should preserve either binary or string type
+                sep = ", " if isinstance(vals[0][0], str) else b", "
+                yield vals[0][0], sep.join(val[1] for val in vals)
+
+    def compatible_dict(self):
+        """Create a dictionary. Header lines with duplicate field names are
+        merged into one line. This can be used for exchange with other
+        libraries.
+        """
+        return dict(self.itermerged())
+
+    def iterlower(self):
+        """Iterate over all header lines, including duplicate ones.
+        The header fields are all lowered.
+        """
+        for field, vals in _dict_items(self):
+            if isinstance(vals, tuple):
+                yield field, vals[1]
+            else:
+                for val in vals:
+                    yield field, val[1]
+
+    def items(self):
+        """Iterate over all header lines, including duplicate ones."""
+        for field, vals in _dict_items(self):
+            if isinstance(vals, tuple):
+                yield vals
+            else:
+                yield from vals
+
+    # Backwards compatibility for httplib
+    getheaders = getlist
+    getallmatchingheaders = getlist
+    iget = getlist
+
+    # deprecated
+    iteroriginal = items