Skip to content

Update http.py to mask "x-api-key" header #102

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

Open
cpandya2909 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update http.py to mask "x-api-key" header #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 16 additions & 2 deletions sec-gemini-python/sec_gemini/http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,14 @@ def post(
url = self._make_url(endpoint)
headers = self._make_headers(headers)

logging.debug("POST URL: %s, Headers:%s", url, headers)
# Headers have x-api-key, which is API key. So skip loggig it.
if "x-api-key" in headers:
masked_headers = headers.copy()
masked_headers["x-api-key"] = "***"
logging.debug("POST URL: %s, Headers:%s", url, masked_headers)
del masked_headers
else:
logging.debug("POST URL: %s, Headers:%s", url, headers)
Comment on lines +68 to +75
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The logic for masking the API key before logging is correct, but it can be made more concise and readable. The if/else block contains a duplicated logging.debug call. You can refactor this to determine which headers to log first, and then make a single logging call. This also removes the need for del masked_headers, which is redundant as the variable would be garbage collected anyway. Additionally, there's a typo in the comment (loggig).

    # Headers have x-api-key, which is an API key, so we mask it for logging.
    headers_to_log = headers
    if "x-api-key" in headers:
      headers_to_log = headers.copy()
      headers_to_log["x-api-key"] = "***"
    logging.debug("POST URL: %s, Headers:%s", url, headers_to_log)

logging.debug("Request: %s", model.model_dump_json())
start_time = time()
response = self.client.post(url, headers=headers, json=data)
Expand Down Expand Up @@ -100,7 +107,14 @@ def get(
url = self._make_url(endpoint)
headers = self._make_headers(headers)

logging.debug("GET URL: %s, Headers:%s", url, headers)
# Headers have x-api-key, which is API key. So skip loggig it.
if "x-api-key" in headers:
masked_headers = headers.copy()
masked_headers["x-api-key"] = "***"
logging.debug("GET URL: %s, Headers:%s", url, masked_headers)
del masked_headers
else:
logging.debug("GET URL: %s, Headers:%s", url, headers)
Comment on lines +110 to +117
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to the post method, this logic for masking the API key can be simplified to avoid code duplication in the if/else block and improve readability. The del masked_headers call is also unnecessary. There's also a typo in the comment (loggig).

    # Headers have x-api-key, which is an API key, so we mask it for logging.
    headers_to_log = headers
    if "x-api-key" in headers:
      headers_to_log = headers.copy()
      headers_to_log["x-api-key"] = "***"
    logging.debug("GET URL: %s, Headers:%s", url, headers_to_log)

logging.debug("Request: %s", json.dumps(query_params))

start_time = time()
Expand Down