Skip to content

Commit 5b9f759

Browse files
committed
feat: add User-Agent request header
1 parent 716b6b3 commit 5b9f759

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## 1.5.0 [unreleased]
22

3+
### Features
4+
1. [#59](https://github.com/influxdata/influxdb-client-python/issues/59): Set User-Agent to influxdb-client-python/VERSION for all requests
5+
36
## 1.4.0 [2020-02-14]
47

58
### Features

influxdb_client/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
7575
self.default_headers[header_name] = header_value
7676
self.cookie = cookie
7777
# Set default User-Agent.
78-
self.user_agent = 'OpenAPI-Generator/1.5.0dev/python'
78+
self.user_agent = 'influxdb-client-python/1.5.0dev'
7979

8080
def __del__(self):
8181
if self._pool:

openapi-generator/src/main/resources/python/api_client.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class ApiClient(object):
7070
self.default_headers[header_name] = header_value
7171
self.cookie = cookie
7272
# Set default User-Agent.
73-
self.user_agent = '{{#httpUserAgent}}{{{.}}}{{/httpUserAgent}}{{^httpUserAgent}}OpenAPI-Generator/{{{packageVersion}}}/python{{/httpUserAgent}}'
73+
self.user_agent = 'influxdb-client-python/{{{packageVersion}}}'
7474

7575
def __del__(self):
7676
if self._pool:

tests/test_WriteApiBatching.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,19 @@ def test_default_tags(self):
365365
self.assertNotEqual(-1, request.find('customer=California\\\\ Miner'))
366366
self.assertNotEqual(-1, request.find('id=132-987-655'))
367367

368+
def test_user_agent_header(self):
369+
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
370+
371+
self._write_client.write("my-bucket", "my-org",
372+
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
373+
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"])
374+
375+
time.sleep(1)
376+
377+
requests = httpretty.httpretty.latest_requests
378+
self.assertEqual(1, len(requests))
379+
self.assertEqual(f'influxdb-client-python/{influxdb_client.__version__}', requests[0].headers['User-Agent'])
380+
368381

369382
if __name__ == '__main__':
370383
unittest.main()

0 commit comments

Comments
 (0)