Skip to content

Commit ac6953e

Browse files
bednarbednar
committed
chore: rename kwargs to generic name
1 parent 5f3de02 commit ac6953e

File tree

6 files changed

+53
-56
lines changed

6 files changed

+53
-56
lines changed

‎examples/write_structured_data.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ class Car:
4545
"""
4646
write_api.write(bucket="my-bucket",
4747
record=sensor,
48-
dictionary_measurement_key="name",
49-
dictionary_time_key="timestamp",
50-
dictionary_tag_keys=["location", "version"],
51-
dictionary_field_keys=["pressure", "temperature"])
48+
record_measurement_key="name",
49+
record_time_key="timestamp",
50+
record_tag_keys=["location", "version"],
51+
record_field_keys=["pressure", "temperature"])
5252

5353
"""
5454
Car "current" speed
@@ -61,6 +61,6 @@ class Car:
6161
"""
6262
write_api.write(bucket="my-bucket",
6363
record=car,
64-
dictionary_measurement_key="engine",
65-
dictionary_tag_keys=["engine", "type"],
66-
dictionary_field_keys=["speed"])
64+
record_measurement_key="engine",
65+
record_tag_keys=["engine", "type"],
66+
record_field_keys=["speed"])

‎influxdb_client/client/write/point.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -97,42 +97,42 @@ def from_dict(dictionary: dict, write_precision: WritePrecision = DEFAULT_WRITE_
9797
}
9898
point = Point.from_dict(dictionary,
9999
write_precision=WritePrecision.S,
100-
dictionary_measurement_key="name",
101-
dictionary_time_key="created",
102-
dictionary_tag_keys=["location", "version"],
103-
dictionary_field_keys=["pressure", "temperature"])
100+
record_measurement_key="name",
101+
record_time_key="created",
102+
record_tag_keys=["location", "version"],
103+
record_field_keys=["pressure", "temperature"])
104104
105105
:param dictionary: dictionary for serialize into Point structure
106106
:param write_precision: sets the precision for the supplied time values
107-
:key dictionary_measurement_key: key of dictionary with specified measurement
108-
:key dictionary_time_key: key of dictionary with specified timestamp
109-
:key dictionary_tag_keys: list of dictionary keys to use as a tag
110-
:key dictionary_field_keys: list of dictionary keys to use as a field
107+
:key record_measurement_key: key of dictionary with specified measurement
108+
:key record_time_key: key of dictionary with specified timestamp
109+
:key record_tag_keys: list of dictionary keys to use as a tag
110+
:key record_field_keys: list of dictionary keys to use as a field
111111
:return: new data point
112112
"""
113-
point = Point(dictionary[kwargs.get('dictionary_measurement_key', 'measurement')])
113+
point = Point(dictionary[kwargs.get('record_measurement_key', 'measurement')])
114114

115-
dictionary_tag_keys = kwargs.get('dictionary_tag_keys', None)
116-
if dictionary_tag_keys is not None:
117-
for tag_key in dictionary_tag_keys:
115+
record_tag_keys = kwargs.get('record_tag_keys', None)
116+
if record_tag_keys is not None:
117+
for tag_key in record_tag_keys:
118118
if tag_key in dictionary:
119119
point.tag(tag_key, dictionary[tag_key])
120120
elif 'tags' in dictionary:
121121
for tag_key, tag_value in dictionary['tags'].items():
122122
point.tag(tag_key, tag_value)
123123

124-
dictionary_field_keys = kwargs.get('dictionary_field_keys', None)
125-
if dictionary_field_keys is not None:
126-
for field_key in dictionary_field_keys:
124+
record_field_keys = kwargs.get('record_field_keys', None)
125+
if record_field_keys is not None:
126+
for field_key in record_field_keys:
127127
if field_key in dictionary:
128128
point.field(field_key, dictionary[field_key])
129129
else:
130130
for field_key, field_value in dictionary['fields'].items():
131131
point.field(field_key, field_value)
132132

133-
dictionary_time_key = kwargs.get('dictionary_time_key', 'time')
134-
if dictionary_time_key in dictionary:
135-
point.time(dictionary[dictionary_time_key], write_precision=write_precision)
133+
record_time_key = kwargs.get('record_time_key', 'time')
134+
if record_time_key in dictionary:
135+
point.time(dictionary[record_time_key], write_precision=write_precision)
136136
return point
137137

138138
def __init__(self, measurement_name):

‎influxdb_client/client/write_api.py

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -257,14 +257,11 @@ def write(self, bucket: str, org: str = None,
257257
:key data_frame_measurement_name: name of measurement for writing Pandas DataFrame - ``DataFrame``
258258
:key data_frame_tag_columns: list of DataFrame columns which are tags,
259259
rest columns will be fields - ``DataFrame``
260-
:key dictionary_measurement_key: key of record with specified measurement -
261-
``dictionary``, ``NamedTuple``, ``dataclass``
262-
:key dictionary_time_key: key of record with specified timestamp -
263-
``dictionary``, ``NamedTuple``, ``dataclass``
264-
:key dictionary_tag_keys: list of record keys to use as a tag -
265-
``dictionary``, ``NamedTuple``, ``dataclass``
266-
:key dictionary_field_keys: list of record keys to use as a field -
267-
``dictionary``, ``NamedTuple``, ``dataclass``
260+
:key record_measurement_key: key of record with specified measurement -
261+
``dictionary``, ``NamedTuple``, ``dataclass``
262+
:key record_time_key: key of record with specified timestamp - ``dictionary``, ``NamedTuple``, ``dataclass``
263+
:key record_tag_keys: list of record keys to use as a tag - ``dictionary``, ``NamedTuple``, ``dataclass``
264+
:key record_field_keys: list of record keys to use as a field - ``dictionary``, ``NamedTuple``, ``dataclass``
268265
269266
Example:
270267
.. code-block:: python

‎tests/test_WriteApi.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -551,9 +551,9 @@ def test_named_tuple(self):
551551
factory = Factory(measurement='factory', position="central europe", customers=123456)
552552

553553
self.write_client.write("my-bucket", "my-org", factory,
554-
dictionary_measurement_key="measurement",
555-
dictionary_tag_keys=["position"],
556-
dictionary_field_keys=["customers"])
554+
record_measurement_key="measurement",
555+
record_tag_keys=["position"],
556+
record_field_keys=["customers"])
557557

558558
requests = httpretty.httpretty.latest_requests
559559
self.assertEqual(1, len(requests))
@@ -576,9 +576,9 @@ class Car:
576576
car = Car('12V-BT', 'sport-cars', 125.25)
577577
self.write_client.write("my-bucket", "my-org",
578578
record=car,
579-
dictionary_measurement_key="engine",
580-
dictionary_tag_keys=["engine", "type"],
581-
dictionary_field_keys=["speed"])
579+
record_measurement_key="engine",
580+
record_tag_keys=["engine", "type"],
581+
record_field_keys=["speed"])
582582

583583
requests = httpretty.httpretty.latest_requests
584584
self.assertEqual(1, len(requests))

‎tests/test_WriteApiBatching.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -532,9 +532,9 @@ def test_named_tuple(self):
532532
factory = Factory(measurement='factory', position="central europe", customers=123456)
533533

534534
self._write_client.write("my-bucket", "my-org", factory,
535-
dictionary_measurement_key="measurement",
536-
dictionary_tag_keys=["position"],
537-
dictionary_field_keys=["customers"])
535+
record_measurement_key="measurement",
536+
record_tag_keys=["position"],
537+
record_field_keys=["customers"])
538538

539539
time.sleep(1)
540540

@@ -562,9 +562,9 @@ class Car:
562562
car = Car('12V-BT', 'sport-cars', 125.25)
563563
self._write_client.write("my-bucket", "my-org",
564564
record=car,
565-
dictionary_measurement_key="engine",
566-
dictionary_tag_keys=["engine", "type"],
567-
dictionary_field_keys=["speed"])
565+
record_measurement_key="engine",
566+
record_tag_keys=["engine", "type"],
567+
record_field_keys=["speed"])
568568

569569
time.sleep(1)
570570

‎tests/test_point.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ def test_from_dictionary_custom_measurement(self):
415415
"fields": {"value": 1},
416416
"time": 1,
417417
}
418-
point = Point.from_dict(dictionary, dictionary_measurement_key="name")
418+
point = Point.from_dict(dictionary, record_measurement_key="name")
419419
self.assertEqual("test,tag=a value=1i 1", point.to_line_protocol())
420420

421421
def test_from_dictionary_custom_time(self):
@@ -426,8 +426,8 @@ def test_from_dictionary_custom_time(self):
426426
"created": 100250,
427427
}
428428
point = Point.from_dict(dictionary,
429-
dictionary_measurement_key="name",
430-
dictionary_time_key="created")
429+
record_measurement_key="name",
430+
record_time_key="created")
431431
self.assertEqual("test,tag=a value=1i 100250", point.to_line_protocol())
432432

433433
def test_from_dictionary_custom_tags(self):
@@ -439,8 +439,8 @@ def test_from_dictionary_custom_tags(self):
439439
"time": 1,
440440
}
441441
point = Point.from_dict(dictionary,
442-
dictionary_measurement_key="name",
443-
dictionary_tag_keys=["tag_a", "tag_b"])
442+
record_measurement_key="name",
443+
record_tag_keys=["tag_a", "tag_b"])
444444
self.assertEqual("test,tag_a=a,tag_b=b value=1i 1", point.to_line_protocol())
445445

446446
def test_from_dictionary_custom_fields(self):
@@ -454,9 +454,9 @@ def test_from_dictionary_custom_fields(self):
454454
}
455455
point = Point.from_dict(dictionary,
456456
write_precision=WritePrecision.S,
457-
dictionary_measurement_key="name",
458-
dictionary_tag_keys=["location", "version"],
459-
dictionary_field_keys=["pressure", "temperature"])
457+
record_measurement_key="name",
458+
record_tag_keys=["location", "version"],
459+
record_field_keys=["pressure", "temperature"])
460460
self.assertEqual("sensor_pt859,location=warehouse_125,version=2021.06.05.5874 pressure=125i,temperature=10i 1632208639", point.to_line_protocol())
461461

462462
def test_from_dictionary_tolerant_to_missing_tags_and_fields(self):
@@ -467,9 +467,9 @@ def test_from_dictionary_tolerant_to_missing_tags_and_fields(self):
467467
}
468468
point = Point.from_dict(dictionary,
469469
write_precision=WritePrecision.S,
470-
dictionary_measurement_key="name",
471-
dictionary_tag_keys=["location", "version"],
472-
dictionary_field_keys=["pressure", "temperature"])
470+
record_measurement_key="name",
471+
record_tag_keys=["location", "version"],
472+
record_field_keys=["pressure", "temperature"])
473473
self.assertEqual("sensor_pt859,location=warehouse_125 pressure=125i", point.to_line_protocol())
474474

475475

0 commit comments

Comments
 (0)