-
Notifications
You must be signed in to change notification settings - Fork 524
Conversation
influxdb/client.py
Outdated
@@ -410,6 +410,18 @@ def write_points(self, | |||
retention_policy=retention_policy, | |||
tags=tags, protocol=protocol) | |||
|
|||
def ping(self): | |||
"""Check connectivity to influxdb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor thing, but summary should end in a period and influxdb
replaced with InfluxDB
, so that it will be in the same style as other docstrings. Also, there should be a blank line after the summary line (PEP 257). Otherwise, having this method would be really useful in my opinion 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I'll fix that
influxdb/client.py
Outdated
""" | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blank line should be after the summary line (i.e. the first line of the docstring), before the description. In PEP 257 no blank lines allowed after the method's docstring. Also, please note that PEP 257 requires that the first line of the docstring ends with the period.
On the other side, there are currently quite many inconsistencies in the client's docstrings and tox does not check code for PEP 257. May be all these inconsistencies should be revised in a separate PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doh! I'll fix that, and create an issue for fixing pep257 in the remaining files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Created #415
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
squash down into one commit and this looks good! thank you!
fixing up failing CI tests
fixing up failing CI tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good, thanks for contributing!
a method to invoke the
/ping
endpoint so it is easy to verify connectivity