updated docs

Author: rm-Umar

README.md

@@ -230,6 +230,14 @@ Request behavior can be modified by setting the `request_options` keyword argume
 >>> handler = ipinfo.getHandler(request_options={'timeout': 4})
 ```
 
+### Custom Headers
+
+You can add custom headers or modify default headers by setting the `headers` keyword argument when initializing the handler. `headers` is a dictionary of `{'header': 'value'}` format.
+
+```python
+>>> handler = ipinfo.getHandler(headers={'user-agent': 'My Custom User-agent', 'custom_header': 'yes'})
+```
+
 ### Internationalization
 
 When looking up an IP address, the response object includes a `details.country_name`, `details.isEU`, `details.country_flag` and `details.country_currency` attributes which includes the country based on American English. It is possible to return the country name in other languages by setting the `countries_file`, remove or add EU countries by setting the keyword argument `eu_countries_file`, change the country flag emoji or unicode by setting the keyword argument `countries_flags_file` or change country's currency code or currency symbol by setting the `countries_currencies` when creating the `IPinfo` object. Moreover the response object includes a `details.continent` which includes continent code and name of IP. The default file can be changed by setting the `continent_file` while creating the `IPinfo` object.

ipinfo/handler_async.py

@@ -99,7 +99,7 @@ def __init__(self, access_token=None, **kwargs):
                 cache_options["ttl"] = CACHE_TTL
             self.cache = DefaultCache(**cache_options)
 
-                # setup custom headers
+        # setup custom headers
         self.headers = kwargs.get("headers", None)
 
     async def init(self):

ipinfo/handler_utils.py

@@ -45,22 +45,21 @@
 
 
 def get_headers(access_token, custom_headers):
-    headers = {}
-
-    if custom_headers:
-        headers = custom_headers
-    else:
-        """Build headers for request to IPinfo API."""
-        headers = {
-        "user-agent": "IPinfoClient/Python{version}/{sdk_version}".format(
-            version=sys.version_info[0], sdk_version=SDK_VERSION
+    """Build headers for request to IPinfo API."""
+    headers = {
+       "user-agent": "IPinfoClient/Python{version}/{sdk_version}".format(
+        version=sys.version_info[0], sdk_version=SDK_VERSION
         ),
         "accept": "application/json",
-        }
+    }
+
+    if custom_headers:
+        headers = {** headers, ** custom_headers}
 
     if access_token:
         headers["authorization"] = "Bearer {}".format(access_token)
 
+    print(headers)
     return headers
 
 

tests/handler_async_test.py

@@ -21,7 +21,7 @@ async def test_init():
 @pytest.mark.asyncio
 async def test_headers():
     token = "mytesttoken"
-    handler = AsyncHandler(token, headers={"user-agent": "test-agent", "accept": "application/json", "custom_field": "yes"})
+    handler = AsyncHandler(token, headers={"custom_field": "yes"})
     headers = handler_utils.get_headers(token, handler.headers)
     await handler.deinit()
 

tests/handler_test.py

@@ -20,7 +20,7 @@ def test_init():
 
 def test_headers():
     token = "mytesttoken"
-    handler = Handler(token, headers={"user-agent": "test-agent", "accept": "application/json", "custom_field": "yes"})
+    handler = Handler(token, headers={"custom_field": "yes"})
     headers = handler_utils.get_headers(token, handler.headers)
 
     assert "user-agent" in headers