http2py 0.1.37__tar.gz → 0.1.39__tar.gz

{http2py-0.1.37 → http2py-0.1.39}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: http2py
-Version: 0.1.37
+Version: 0.1.39
 Summary: Tools to create python binders to http web services.
 Project-URL: Homepage, https://github.com/i2mint/http2py
 Project-URL: Repository, https://github.com/i2mint/http2py

{http2py-0.1.37 → http2py-0.1.39}/http2py/api_pkg_maker.py

@@ -84,6 +84,9 @@ def {func_name}(*args, **kwargs):
     return api.routes[{func_name!r}](*args, **kwargs)
 """
 
+# The first http2py release with ``HttpClient.routes``, which generated packages call.
+MIN_HTTP2PY_VERSION = "0.1.37"
+
 SETUP_PY = """from setuptools import setup
 
 setup()
@@ -103,7 +106,7 @@ include_package_data = True
 zip_safe = False
 install_requires =
     i2
-    http2py
+    http2py>={min_http2py}
 
 [options.package_data]
 * = {spec_filename}
@@ -215,6 +218,7 @@ def api_pkg_files(
         author=_cfg_value(pkg_author or "API Package Maker"),
         license=_cfg_value(pkg_license or "Apache"),
         spec_filename=SPEC_FILENAME,
+        min_http2py=MIN_HTTP2PY_VERSION,
     )
     funcs_code = FUNCS_FILE_TPL.format(
         spec_filename=SPEC_FILENAME,

{http2py-0.1.37 → http2py-0.1.39}/http2py/client.py

@@ -115,7 +115,9 @@ class HttpClient:
         for pathname, path_spec in openapi_spec["paths"].items():
             url_template = self.base_url + pathname
             for http_method, openapi_method_spec in path_spec.items():
-                self.register_method(url_template, http_method, openapi_method_spec)
+                self.register_method(
+                    url_template, http_method, openapi_method_spec, pathname=pathname
+                )
 
     def init_security(self, openapi_spec, **auth_kwargs):
         security = openapi_spec["security"]
@@ -143,7 +145,9 @@ class HttpClient:
             if jwt:
                 self.set_header({"Authorization": f"Bearer {jwt}"})
 
-    def register_method(self, url_template, http_method, openapi_method_spec):
+    def register_method(
+        self, url_template, http_method, openapi_method_spec, *, pathname=None
+    ):
         content_type = None
         if "requestBody" in openapi_method_spec:
             content_type = next(
@@ -154,6 +158,7 @@ class HttpClient:
             method=http_method,
             url_template=url_template,
             content_type=content_type,
+            pathname=pathname,
         )
         func = mk_request_function(
             method_spec,

{http2py-0.1.37 → http2py-0.1.39}/http2py/py2request.py

@@ -33,11 +33,13 @@ There must be a better way...
 from functools import wraps
 from inspect import signature, Parameter
 import json
+import keyword
 import pickle
 from glom import glom
 from requests import request
 import string
 import urllib
+from urllib.parse import urlparse
 
 # import io
 import re
@@ -198,6 +200,11 @@ def mk_request_function(
 
     original_spec = method_spec
     method_spec = method_spec.copy()  # make a copy
+    if "url_template" in method_spec:
+        check_url_template(
+            method_spec["url_template"],
+            query_arg_names=_ensure_list(method_spec.get("query_arg_names", [])),
+        )
     method_spec["input_trans"] = method_spec.get("input_trans", None) or {}
 
     request_kwargs = method_spec.get("request_kwargs", {}).copy()
@@ -283,7 +290,7 @@ def mk_request_function(
                 _request_kwargs["data"] = json.dumps(json_kwargs)
             elif content_type == BINARY_CONTENT_TYPE:
                 _request_kwargs["data"] = binary_dumps(kwargs)
-        elif content_type == FORM_CONTENT_TYPE:
+        if content_type == FORM_CONTENT_TYPE:  # (it used to be sent with GET only)
             fields = json.dumps(json_kwargs).encode("utf-8")
             binaries = {k: (f"{k}.bin", v) for k, v in binary_kwargs.items()}
             files_data = dict(binaries, __fields=fields)
@@ -500,6 +507,44 @@ def _difference_conserving_order(a, b):
     return [x for x in a if x not in b]
 
 
+def _reads_into_arguments(field_name: str) -> bool:
+    """Whether a ``str.format`` field looks up an attribute or item of an argument;
+    any other name (``user-id``, ``0``...) only selects an argument."""
+    return "." in field_name or "[" in field_name
+
+
+def check_url_template(url_template: str, *, query_arg_names=()) -> str:
+    """Return ``url_template`` if no placeholder in it, nor any of the
+    ``query_arg_names`` (appended as ``?name={name}`` when calling), reads into an
+    argument.
+
+    A template is filled with ``str.format(**arguments)``, and it may come from a spec
+    fetched from a server. ``{a.__class__}`` or ``{a[0]}`` would read attributes or
+    items of the caller's arguments into the URL, so they are refused. Other names,
+    such as OpenAPI's hyphenated ``{user-id}``, are fine.
+
+    >>> check_url_template('http://h/u/{user-id}?q={q}')
+    'http://h/u/{user-id}?q={q}'
+    >>> check_url_template('http://h/{a.__init__.__globals__}')
+    Traceback (most recent call last):
+      ...
+    ValueError: URL template placeholder '{a.__init__.__globals__}' reads into an argument
+    """
+    fields = [
+        (field_name, format_spec)
+        for _, field_name, format_spec, _ in str_formatter.parse(url_template)
+        if field_name is not None
+    ]
+    fields += [(name, "") for name in query_arg_names]
+    for field_name, format_spec in fields:
+        if _reads_into_arguments(field_name) or "{" in (format_spec or ""):
+            raise ValueError(
+                f"URL template placeholder {'{' + field_name + '}'!r} reads into an "
+                "argument"
+            )
+    return url_template
+
+
 def extract_format_names(string_template):
     """
     Extracts the names of the fields in a string template, returning a list of
@@ -607,6 +652,30 @@ def raw_response_on_error(func):
     return _func
 
 
+def _identifier(text):
+    """``text`` as a public Python identifier: runs of other characters (and of ``_``) become ``_``,
+    a leading digit gets an ``op_`` prefix and a keyword a trailing ``_``."""
+    name = re.sub(r"[\W_]+", "_", text, flags=re.ASCII).strip("_")
+    if name[:1].isdigit():
+        name = f"op_{name}"
+    return f"{name}_" if keyword.iskeyword(name) else name
+
+
+def _route_name(openapi_method_spec, method, pathname, url_template):
+    """The name of the function for a route: its ``x-method_name``, else its
+    ``operationId``, else the http method and the path (``get /users/{id}`` gives
+    ``get_users_id``), so that routes without ``x-method_name`` do not all share a name.
+    ``pathname`` is the path as the spec gives it, so that a server's base url does not
+    change the names; it defaults to the path of ``url_template``.
+    """
+    if openapi_method_spec.get("x-method_name"):
+        return openapi_method_spec["x-method_name"]
+    name = _identifier(openapi_method_spec.get("operationId") or "")
+    if pathname is None:
+        pathname = urlparse(url_template).path
+    return name or default_path_to_func_name(method, pathname)
+
+
 def mk_method_spec_from_openapi_method_spec(
     openapi_method_spec,
     method="post",
@@ -614,6 +683,7 @@ def mk_method_spec_from_openapi_method_spec(
     content_type=JSON_CONTENT_TYPE,
     input_trans=None,
     output_trans=None,
+    pathname=None,
 ):
     path_arg_names = []
     query_arg_names = []
@@ -671,7 +741,7 @@ def mk_method_spec_from_openapi_method_spec(
         path_arg_names=path_arg_names,
         query_arg_names=query_arg_names,
         body_arg_names=body_arg_names,
-        method_name=openapi_method_spec.get("x-method_name", ""),
+        method_name=_route_name(openapi_method_spec, method, pathname, url_template),
         docstring=openapi_method_spec.get("description", ""),
         content_type=content_type,
         response_type=next(iter(glom(openapi_method_spec, f"responses.200.content"))),

{http2py-0.1.37 → http2py-0.1.39}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "http2py"
-version = "0.1.37"
+version = "0.1.39"
 description = "Tools to create python binders to http web services."
 readme = "README.md"
 requires-python = ">=3.10"

http2py-0.1.39/tests/test_response_decoding.py

@@ -0,0 +1,166 @@
+"""How responses are decoded (``http2py.decorators``) and how a client's requests are
+built from a spec it may have fetched from a server (``mk_request_function``)."""
+
+import pickle
+import warnings
+
+import pytest
+
+from http2py.decorators import (
+    BinaryResponseNotDecoded,
+    check_loads,
+    handle_binary_resp,
+    unsafe_pickle_loads,
+)
+from http2py.py2request import mk_request_function
+
+
+class Resp:
+    def __init__(self, content=b"", *, status_code=200, text="", reason="OK"):
+        self.content, self.status_code, self.text, self.reason = (
+            content,
+            status_code,
+            text,
+            reason,
+        )
+
+
+def _identity(x):
+    return x
+
+
+def test_binary_response_needs_an_explicit_decoder():
+    with pytest.raises(BinaryResponseNotDecoded):
+        handle_binary_resp(_identity)(Resp(pickle.dumps(1)))
+    assert handle_binary_resp(_identity, loads=bytes)(Resp(b"raw")) == b"raw"
+    trusted = handle_binary_resp(_identity, loads=unsafe_pickle_loads)
+    assert trusted(Resp(pickle.dumps({"a": 1}))) == {"a": 1}
+
+
+def test_check_loads():
+    check_loads(None)
+    check_loads(bytes)
+    with pytest.raises(TypeError):
+        check_loads("pickle.loads")
+    with pytest.warns(UserWarning, match="unsafe_pickle_loads"):
+        check_loads(pickle.loads)
+    with warnings.catch_warnings():
+        warnings.simplefilter("error")
+        check_loads(unsafe_pickle_loads)  # the explicit opt-in does not warn
+
+
+def test_non_200_binary_response_raises_the_mapped_error():
+    from i2.errors import NotFoundError
+
+    with pytest.raises(NotFoundError):
+        handle_binary_resp(_identity, loads=bytes)(Resp(status_code=404, text="no"))
+
+
+def _captured_request(method_spec, **call_kwargs):
+    """The (method, url, request kwargs) a request function would dispatch."""
+    calls = []
+
+    def dispatch(method, url, **kwargs):
+        calls.append((method, url, kwargs))
+        return Resp(b"{}")
+
+    func = mk_request_function(method_spec, dispatch=dispatch)
+    func(None, **call_kwargs)
+    return calls[0]
+
+
+def test_binary_request_bodies_use_binary_dumps():
+    spec = {
+        "method": "POST",
+        "url_template": "http://h/f",
+        "body_arg_names": ["x"],
+        "content_type": "application/octet-stream",
+        "output_trans": _identity,
+    }
+    _, _, kwargs = _captured_request(spec, x=1)
+    assert pickle.loads(kwargs["data"]) == {"x": 1}
+    calls = []
+    func = mk_request_function(
+        spec,
+        dispatch=lambda m, u, **kw: calls.append(kw) or Resp(),
+        binary_dumps=lambda d: b"custom",
+    )
+    func(None, x=1)
+    assert calls[0]["data"] == b"custom"
+
+
+def test_path_args_are_url_encoded():
+    spec = {
+        "method": "GET",
+        "url_template": "http://h/u/{uid}",
+        "path_arg_names": ["uid"],
+        "output_trans": _identity,
+    }
+    _, url, _ = _captured_request(spec, uid="a/b c")
+    assert url == "http://h/u/a%2Fb%20c"
+
+
+@pytest.mark.parametrize(
+    "template",
+    [
+        "http://h/{x.__class__}",
+        "http://h/{x[0]}",
+        "http://h/{x:{x.__class__}}",
+        "http://h/{x!r:{y}}",
+    ],
+)
+def test_url_templates_may_only_name_arguments(template):
+    """A spec served by a remote must not read attributes of the caller's
+    arguments into the URL."""
+    spec = {"method": "GET", "url_template": template, "path_arg_names": ["x"]}
+    with pytest.raises(ValueError, match="reads into an argument"):
+        mk_request_function(spec)
+
+
+def test_query_arg_names_may_only_name_arguments():
+    spec = {
+        "method": "GET",
+        "url_template": "http://h/x",
+        "query_arg_names": ["obj", "obj.token"],
+    }
+    with pytest.raises(ValueError, match="reads into an argument"):
+        mk_request_function(spec)
+
+
+def test_hyphenated_placeholders_still_work():
+    spec = {"method": "GET", "url_template": "http://h/u/{user-id}"}
+    calls = []
+    func = mk_request_function(
+        spec, dispatch=lambda m, u, **kw: calls.append(u) or Resp(b"")
+    )
+    func(None, **{"user-id": "42"})
+    assert calls == ["http://h/u/42"]
+
+
+def test_spec_with_attribute_placeholder_is_refused_by_the_client():
+    import copy
+    import sys
+    from pathlib import Path
+
+    sys.path.insert(0, str(Path(__file__).parent))
+    from spec_fixture import SPEC
+
+    from http2py import HttpClient
+
+    spec = copy.deepcopy(SPEC)
+    spec["paths"]["/x/{uid.__class__.__mro__}"] = spec["paths"].pop("/u/{uid}/p/{pid}")
+    with pytest.raises(ValueError, match="reads into an argument"):
+        HttpClient(spec, session_state={"session": object(), "refresh_inputs": {}})
+
+
+@pytest.mark.parametrize("method", ["GET", "POST"])
+def test_form_requests_send_their_fields_whatever_the_method(method):
+    spec = {
+        "method": method,
+        "url_template": "http://h/f",
+        "body_arg_names": ["x", "blob"],
+        "content_type": "multipart/form-data",
+        "output_trans": _identity,
+    }
+    _, _, kwargs = _captured_request(spec, x=1, blob=b"\x00")
+    assert set(kwargs["files"]) == {"blob", "__fields"}

{http2py-0.1.37 → http2py-0.1.39}/tests/test_route_namespace.py

@@ -83,6 +83,7 @@ def test_cli_calls_the_route_not_the_client_attribute(monkeypatch):
     spec = _spec_naming_plain("ensure_login")
     with pytest.warns(UserWarning):
         route = _client(spec).routes["ensure_login"]
+
     class Sent(Exception):
         pass
 
@@ -104,3 +105,72 @@ def test_subclass_skipping_init_can_register_routes():
     spec = SPEC["paths"]["/plain"]["get"]
     bare.register_method("https://example.com/plain", "get", spec)
     assert bare.routes["plain"] is bare.plain
+
+
+def _spec_without_names():
+    """A spec whose routes have no ``x-method_name`` (i2mint/http2py#26)."""
+    spec = copy.deepcopy(SPEC)
+    for path_item in spec["paths"].values():
+        for op in path_item.values():
+            op.pop("x-method_name", None)
+    return spec
+
+
+def test_routes_without_x_method_name_get_distinct_names_from_method_and_path():
+    import warnings
+
+    with warnings.catch_warnings():
+        warnings.simplefilter("error")
+        client = _client(_spec_without_names())
+    assert len(client.routes) == len(SPEC["paths"]) == 3
+    assert "get_plain" in client.routes
+    for name, route in client.routes.items():
+        assert route.__name__ == name != "request_func"
+
+
+def test_operation_id_names_a_route_without_x_method_name():
+    spec = _spec_without_names()
+    spec["paths"]["/plain"]["get"]["operationId"] = "list-plain.things"
+    assert "list_plain_things" in _client(spec).routes
+
+
+def test_x_method_name_wins_over_operation_id():
+    spec = _spec_naming_plain("mine")
+    spec["paths"]["/plain"]["get"]["operationId"] = "theirs"
+    assert "mine" in _client(spec).routes
+
+
+def test_api_pkg_for_a_spec_without_x_method_names():
+    files = api_pkg_files(_spec_without_names(), pkg_name="genpkg_d")
+    assert "def get_plain(" in files["genpkg_d/funcs.py"]
+
+
+def test_generated_package_pins_the_http2py_that_has_client_routes():
+    from http2py.api_pkg_maker import MIN_HTTP2PY_VERSION
+
+    files = api_pkg_files(SPEC, pkg_name="genpkg_e")
+    assert f"http2py>={MIN_HTTP2PY_VERSION}" in files["setup.cfg"]
+
+
+def test_derived_names_do_not_depend_on_the_server_url():
+    spec = _spec_without_names()
+    spec["servers"] = [{"url": "https://example.com/v1/api"}]
+    assert set(_client(spec).routes) == set(_client(_spec_without_names()).routes)
+
+
+@pytest.mark.parametrize("operation_id", ["-", "___", "日本"])
+def test_unusable_operation_id_falls_back_to_method_and_path(operation_id):
+    spec = _spec_without_names()
+    spec["paths"]["/plain"]["get"]["operationId"] = operation_id
+    assert "get_plain" in _client(spec).routes
+
+
+def test_a_second_route_of_the_same_name_replaces_the_first_with_a_warning():
+    spec = copy.deepcopy(SPEC)
+    other = copy.deepcopy(spec["paths"]["/plain"])
+    spec["paths"]["/plain2"] = other
+    with pytest.warns(UserWarning, match="Two routes are named"):
+        client = _client(spec)
+    name = other["get"]["x-method_name"]
+    assert client.routes[name].method_spec["url_template"].endswith("/plain2")
+    assert getattr(client, name) is client.routes[name]