Skip to content

py client: drop delphi_utils requirement, log to stderr instead #1486

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 2 commits into from
Jul 9, 2024
Merged

py client: drop delphi_utils requirement, log to stderr instead #1486

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c08f52
py client: drop bloated delphi_utils requirement, log to stderr instead
melange396 Jun 25, 2024
aada573
Replace assertlogs with stderr capture
rzats Jun 27, 2024
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
17 changes: 11 additions & 6 deletions src/client/delphi_epidata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
- Compatible with Python 2 and 3.
"""

import sys

# External modules
import requests
import time
Expand All @@ -16,8 +18,6 @@

from aiohttp import ClientSession, TCPConnector, BasicAuth

from delphi_utils.logger import get_structured_logger

__version__ = "4.1.23"

_HEADERS = {"user-agent": "delphi_epidata/" + __version__ + " (Python)"}
Expand Down Expand Up @@ -45,10 +45,15 @@ class Epidata:

client_version = __version__

logger = get_structured_logger('delphi_epidata_client')
debug = False # if True, prints extra logging statements
sandbox = False # if True, will not execute any queries

@staticmethod
def log(evt, **kwargs):
kwargs['event'] = evt
kwargs['timestamp'] = time.strftime("%Y-%m-%d %H:%M:%S %z")
return sys.stderr.write(str(kwargs) + "\n")
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this might need a flush() call to keep it synced

Suggested change
return sys.stderr.write(str(kwargs) + "\n")
sys.stderr.write(str(kwargs) + "\n")
sys.stderr.flush()

Copy link
Contributor

Choose a reason for hiding this comment

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

TL;DR: we don't need the flush().

>>> sys.stderr
<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>
>>> sys.stderr.line_buffering
True

io.TextIOWrapper says this about line_buffering=True

If line_buffering is True, flush() is implied when a call to write contains a newline character or a carriage return.


# Helper function to cast values and/or ranges to strings
@staticmethod
def _listitem(value):
Expand All @@ -72,7 +77,7 @@ def _request_with_retry(endpoint, params={}):
"""Make request with a retry if an exception is thrown."""
request_url = f"{Epidata.BASE_URL}/{endpoint}/"
if Epidata.debug:
Epidata.logger.info("Sending GET request", url=request_url, params=params, headers=_HEADERS, auth=Epidata.auth)
Epidata.log("Sending GET request", url=request_url, params=params, headers=_HEADERS, auth=Epidata.auth)
if Epidata.sandbox:
resp = requests.Response()
resp._content = b'true'
Expand All @@ -81,10 +86,10 @@ def _request_with_retry(endpoint, params={}):
req = requests.get(request_url, params, auth=Epidata.auth, headers=_HEADERS)
if req.status_code == 414:
if Epidata.debug:
Epidata.logger.info("Received 414 response, retrying as POST request", url=request_url, params=params, headers=_HEADERS)
Epidata.log("Received 414 response, retrying as POST request", url=request_url, params=params, headers=_HEADERS)
req = requests.post(request_url, params, auth=Epidata.auth, headers=_HEADERS)
if Epidata.debug:
Epidata.logger.info(
Epidata.log(
"Received response",
status_code=req.status_code,
len=len(req.content),
Expand Down
2 changes: 1 addition & 1 deletion src/client/packaging/pypi/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ classifiers = [
"Natural Language :: English",
"Topic :: Scientific/Engineering :: Bio-Informatics",
]
dependencies = ["aiohttp", "delphi-utils", "requests>=2.7.0", "tenacity"]
dependencies = ["aiohttp", "requests>=2.7.0", "tenacity"]

[project.urls]
"Homepage" = "https://github.com/cmu-delphi/delphi-epidata"
Expand Down
Loading