Skip to content

Commit 56cab64

Browse files
committed
Update docstring of unimplemented API
1 parent 5ead1d8 commit 56cab64

File tree

2 files changed

+30
-27
lines changed

2 files changed

+30
-27
lines changed

influxdb/client.py

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -104,25 +104,25 @@ def write_points_with_precision(self, data, time_precision='s'):
104104

105105
# One Time Deletes
106106

107-
# todo
108107
def delete_points(self, name,
109108
regex=None, start_epoch=None, end_epoch=None):
110109
"""
111-
Delete a range of data
110+
TODO: Delete a range of data
112111
113-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
112+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
113+
but it is documented in http://influxdb.org/docs/api/http.html.
114114
See also: src/api/http/api.go:l57
115115
"""
116116
raise NotImplementedError()
117117

118118
# Regularly Scheduled Deletes
119119

120-
# todo
121120
def create_scheduled_delete(self, json_body):
122121
"""
123-
Create scheduled delete
122+
TODO: Create scheduled delete
124123
125-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
124+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
125+
but it is documented in http://influxdb.org/docs/api/http.html.
126126
See also: src/api/http/api.go:l57
127127
"""
128128
raise NotImplementedError()
@@ -133,22 +133,22 @@ def create_scheduled_delete(self, json_body):
133133
# remove a regularly scheduled delete
134134
# curl -X DELETE http://localhost:8086/db/site_dev/scheduled_deletes/:id
135135

136-
# todo
137136
def get_list_scheduled_delete(self):
138137
"""
139-
Get list of scheduled deletes
138+
TODO: Get list of scheduled deletes
140139
141-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
140+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
141+
but it is documented in http://influxdb.org/docs/api/http.html.
142142
See also: src/api/http/api.go:l57
143143
"""
144144
raise NotImplementedError()
145145

146-
# todo
147146
def remove_scheduled_delete(self, delete_id):
148147
"""
149-
Remove scheduled delete
148+
TODO: Remove scheduled delete
150149
151-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
150+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
151+
but it is documented in http://influxdb.org/docs/api/http.html.
152152
See also: src/api/http/api.go:l57
153153
"""
154154
raise NotImplementedError()
@@ -378,42 +378,42 @@ def unset_database_admin(self, username):
378378
raise Exception(
379379
"{0}: {1}".format(response.status_code, response.content))
380380

381-
# todo
382381
def get_list_database_admins(self):
383382
"""
384-
Get list of database admins
383+
TODO: Get list of database admins
385384
386-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
385+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
386+
but it is documented in http://influxdb.org/docs/api/http.html.
387387
See also: src/api/http/api.go:l57
388388
"""
389389
raise NotImplementedError()
390390

391-
# todo
392391
def add_database_admin(self, new_username, new_password):
393392
"""
394-
Add cluster admin
393+
TODO: Add cluster admin
395394
396-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
395+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
396+
but it is documented in http://influxdb.org/docs/api/http.html.
397397
See also: src/api/http/api.go:l57
398398
"""
399399
raise NotImplementedError()
400400

401-
# todo
402401
def update_database_admin_password(self, username, new_password):
403402
"""
404-
Update database admin password
403+
TODO: Update database admin password
405404
406-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
405+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
406+
but it is documented in http://influxdb.org/docs/api/http.html.
407407
See also: src/api/http/api.go:l57
408408
"""
409409
raise NotImplementedError()
410410

411-
# todo
412411
def delete_database_admin(self, username):
413412
"""
414-
Delete database admin
413+
TODO: Delete database admin
415414
416-
This endpoint has been not implemented yet in InfluxDB ver0.0.8
415+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
416+
but it is documented in http://influxdb.org/docs/api/http.html.
417417
See also: src/api/http/api.go:l57
418418
"""
419419
raise NotImplementedError()
@@ -517,9 +517,12 @@ def delete_database_user(self, username):
517517

518518
# update the user by POSTing to db/site_dev/users/paul
519519

520-
# todo
521520
def update_permission(self, username, json_body):
522521
"""
523-
Update read/write permission
522+
TODO: Update read/write permission
523+
524+
2013-11-08: This endpoint has not been implemented yet in ver0.0.8,
525+
but it is documented in http://influxdb.org/docs/api/http.html.
526+
See also: src/api/http/api.go:l57
524527
"""
525528
raise NotImplementedError()

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tox]
2-
envlist = py32, py27, flake8
2+
envlist = py33, py27, flake8
33

44
[testenv]
55
commands =

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy