8000 Added header for driver version and other info by tjoubert · Pull Request #228 · arangodb/python-arango · GitHub
[go: up one dir, main page]
Skip to content

Added header for driver version and other info #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 29, 2022
Merged

Added header for driver version and other info #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d8f9eff
Extended normalize_headers() in request.py
tjoubert Nov 21, 2022
1f95af4
Reformatted files
tjoubert Nov 21, 2022
0de7d51
Re-sorted imports
tjoubert Nov 21, 2022
2219954
Fixed parameter issues
tjoubert Nov 21, 2022
94ba3b2
Fixed test_request.py
tjoubert Nov 21, 2022
c30a767
Fixes based on review
tjoubert Nov 29, 2022
008947e
Fixes post-review
tjoubert Nov 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions arango/request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,22 @@

from typing import Any, MutableMapping, Optional

from arango.typings import Fields, Headers, Params


def normalize_headers(headers: Optional[Headers]) -> Headers:
from arango.typings import DriverFlags, Fields, Headers, Params
from arango.version import __version__


def normalize_headers(
headers: Optional[Headers], driver_flags: Optional[DriverFlags] = None
) -> Headers:
flags = ""
if driver_flags is not None:
for flag in driver_flags:
flags = flags + flag + ";"
driver_header = "python-arango/" + __version__ + " (" + flags + ")"
normalized_headers: Headers = {
"charset": "utf-8",
"content-type": "application/json",
"x-arango-driver": driver_header,
}
if headers is not None:
for key, value in headers.items():
Expand Down Expand Up @@ -53,6 +62,8 @@ class Request:
:type exclusive: str | [str] | None
:param deserialize: Whether the response body can be deserialized.
:type deserialize: bool
:param driver_flags: List of flags for the driver
:type driver_flags: list

:ivar method: HTTP method in lowercase (e.g. "post").
:vartype method: str
Expand All @@ -74,6 +85,8 @@ class Request:
:vartype exclusive: str | [str] | None
:ivar deserialize: Whether the response body can be deserialized.
:vartype deserialize: bool
:ivar driver_flags: List of flags for the driver
:vartype driver_flags: list
"""

__slots__ = (
Expand All @@ -86,6 +99,7 @@ class Request:
"write",
"exclusive",
"deserialize",
"driver_flags",
)

def __init__(
Expand All @@ -99,13 +113,15 @@ def __init__(
write: Optional[Fields] = None,
exclusive: Optional[Fields] = None,
deserialize: bool = True,
driver_flags: Optional[DriverFlags] = None,
) -> None:
self.method = method
self.endpoint = endpoint
self.headers: Headers = normalize_headers(headers)
self.headers: Headers = normalize_headers(headers, driver_flags)
self.params: MutableMapping[str, str] = normalize_params(params)
self.data = data
self.read = read
self.write = write
self.exclusive = exclusive
self.deserialize = deserialize
self.driver_flags = driver_flags
1 change: 1 addition & 0 deletions arango/typings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
Params = MutableMapping[str, Union[bool, int, str]]
Headers = MutableMapping[str, str]
Fields = Union[str, Sequence[str]]
DriverFlags = List[str]
40 changes: 16 additions & 24 deletions tests/test_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from arango.request import Request


def test_request_no_data():
def test_request_no_data() -> None:
request = Request(
1031C method="post",
endpoint="/_api/test",
Expand All @@ -11,15 +11,13 @@ def test_request_no_data():
assert request.method == "post"
assert request.endpoint == "/_api/test"
assert request.params == {"bool": "1"}
assert request.headers == {
"charset": "utf-8",
"content-type": "application/json",
"foo": "bar",
}
assert request.headers["charset"] == "utf-8"
assert request.headers["content-type"] == "application/json"
assert request.headers["foo"] == "bar"
assert request.data is None


def test_request_string_data():
def test_request_string_data() -> None:
request = Request(
method="post",
endpoint="/_api/test",
Expand All @@ -30,15 +28,13 @@ def test_request_string_data():
assert request.method == "post"
assert request.endpoint == "/_api/test"
assert request.params == {"bool": "1"}
assert request.headers == {
"charset": "utf-8",
"content-type": "application/json",
"foo": "bar",
}
assert request.headers["charset"] == "utf-8"
assert request.headers["content-type"] == "application/json"
assert request.headers["foo"] == "bar"
assert request.data == "test"


def test_request_json_data():
def test_request_json_data() -> None:
request = Request(
method="post",
endpoint="/_api/test",
Expand All @@ -49,15 +45,13 @@ def test_request_json_data():
assert request.method == "post"
assert request.endpoint == "/_api/test"
assert request.params == {"bool": "1"}
assert request.headers == {
"charset": "utf-8",
"content-type": "application/json",
"foo": "bar",
}
assert request.headers["charset"] == "utf-8"
assert request.headers["content-type"] == "application/json"
assert request.headers["foo"] == "bar"
assert request.data == {"baz": "qux"}


def test_request_transaction_data():
def test_request_transaction_data() -> None:
request = Request(
method="post",
endpoint="/_api/test",
Expand All @@ -68,9 +62,7 @@ def test_request_transaction_data():
assert request.method == "post"
assert request.endpoint == "/_api/test"
assert request.params == {"bool": "1"}
assert request.headers == {
"charset": "utf-8",
"content-type": "application/json",
"foo": "bar",
}
assert request.headers["charset"] == "utf-8"
assert request.headers["content-type"] == "application/json"
assert request.headers["foo"] == "bar"
assert request.data == {"baz": "qux"}
0