diff --git a/CHANGELOG.md b/CHANGELOG.md index 15fb6c5a..cd56518e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,9 @@ ### Bug Fixes 1. [#193](https://github.com/influxdata/influxdb-client-python/pull/193): Fixed `tasks_api` to use proper function to get `Run` +### Documentation +1. [#200](https://github.com/influxdata/influxdb-client-python/pull/200): Updated docs, examples, tests: use `close` instead of `__del__`. + ## 1.14.0 [2021-01-29] ### Features diff --git a/README.rst b/README.rst index 7ffbd119..b050ed08 100644 --- a/README.rst +++ b/README.rst @@ -345,8 +345,8 @@ The batching is configurable by ``write_options``\ : """ Close client """ - _write_client.__del__() - _client.__del__() + _write_client.close() + _client.close() .. marker-batching-end @@ -436,7 +436,7 @@ Data are writes in an asynchronous HTTP request. async_result = write_api.write(bucket="my-bucket", record=[_point1, _point2]) async_result.get() - client.__del__() + client.close() Synchronous client """""""""""""""""" @@ -456,7 +456,7 @@ Data are writes in a synchronous HTTP request. write_api.write(bucket="my-bucket", record=[_point1, _point2]) - client.__del__() + client.close() Queries ^^^^^^^ @@ -537,7 +537,7 @@ The API also support streaming ``FluxRecord`` via `query_stream `_ supports deletes `po """ Close client """ - client.__del__() + client.close() .. marker-delete-end @@ -1031,7 +1031,7 @@ that is replacement for python ``datetime.datetime`` object and also you should """ Close client """ - client.__del__() + client.close() Local tests diff --git a/examples/import_data_set.py b/examples/import_data_set.py index b3758143..d67810b6 100644 --- a/examples/import_data_set.py +++ b/examples/import_data_set.py @@ -71,7 +71,7 @@ def parse_row(row: OrderedDict): Write data into InfluxDB """ write_api.write(bucket="my-bucket", record=data) -write_api.__del__() +write_api.close() """ Querying max value of CBOE Volatility Index @@ -95,4 +95,4 @@ def parse_row(row: OrderedDict): """ Close client """ -client.__del__() +client.close() diff --git a/examples/import_data_set_multiprocessing.py b/examples/import_data_set_multiprocessing.py index e234f057..e5414e94 100644 --- a/examples/import_data_set_multiprocessing.py +++ b/examples/import_data_set_multiprocessing.py @@ -60,8 +60,8 @@ def terminate(self) -> None: proc_name = self.name print() print('Writer: flushing data...') - self.write_api.__del__() - self.client.__del__() + self.write_api.close() + self.client.close() print('Writer: closed'.format(proc_name)) @@ -216,4 +216,4 @@ def init_counter(counter, progress, queue): """ Close client """ -client.__del__() +client.close() diff --git a/examples/influxdb_18_example.py b/examples/influxdb_18_example.py index 82a23691..24bd1561 100644 --- a/examples/influxdb_18_example.py +++ b/examples/influxdb_18_example.py @@ -18,7 +18,7 @@ print(point.to_line_protocol()) write_api.write(bucket=bucket, record=point) -write_api.__del__() +write_api.close() print('*** Query Points ***') diff --git a/examples/ingest_dataframe_default_tags.py b/examples/ingest_dataframe_default_tags.py index 4e9afd3d..a8d9485a 100644 --- a/examples/ingest_dataframe_default_tags.py +++ b/examples/ingest_dataframe_default_tags.py @@ -49,4 +49,4 @@ """ Close client """ -client.__del__() +client.close() diff --git a/examples/iot_sensor.py b/examples/iot_sensor.py index 02c1c79c..6b33306f 100644 --- a/examples/iot_sensor.py +++ b/examples/iot_sensor.py @@ -20,8 +20,8 @@ def on_exit(db_client: InfluxDBClient, write_api: WriteApi): :param write_api: WriteApi :return: nothing """ - write_api.__del__() - db_client.__del__() + write_api.close() + db_client.close() def sensor_temperature(): diff --git a/examples/nanosecond_precision.py b/examples/nanosecond_precision.py index 223aa68d..cedba872 100644 --- a/examples/nanosecond_precision.py +++ b/examples/nanosecond_precision.py @@ -47,4 +47,4 @@ """ Close client """ -client.__del__() +client.close() diff --git a/examples/query.py b/examples/query.py index 91581d06..6b2a84fe 100644 --- a/examples/query.py +++ b/examples/query.py @@ -75,4 +75,4 @@ """ Close client """ -client.__del__() +client.close() diff --git a/examples/query_from_file.py b/examples/query_from_file.py index f98c887c..0411d82a 100644 --- a/examples/query_from_file.py +++ b/examples/query_from_file.py @@ -46,7 +46,7 @@ """ Close client """ -client.__del__() +client.close() diff --git a/examples/rx_playground.py b/examples/rx_playground.py index 194f36b8..7cc298a9 100644 --- a/examples/rx_playground.py +++ b/examples/rx_playground.py @@ -54,6 +54,9 @@ def __init__(self) -> None: .subscribe(self._result, self._error, self._on_complete) pass + def close(self): + self.__del__() + def __del__(self): if self._subject: self._subject.on_completed() @@ -179,8 +182,8 @@ def _group_to_batch(group: GroupedObservable): print("\n== finish writing ==\n") time.sleep(5) -print("\n== __del__ ==\n") -rxWriter.__del__() +print("\n== close ==\n") +rxWriter.close() print("\n== finished ==\n") diff --git a/notebooks/stock_predictions_import_data.py b/notebooks/stock_predictions_import_data.py index 93996dc4..4c479911 100644 --- a/notebooks/stock_predictions_import_data.py +++ b/notebooks/stock_predictions_import_data.py @@ -61,7 +61,7 @@ def main(): write_api = client.write_api(write_options=WriteOptions(batch_size=50_000, flush_interval=10_000)) write_api.write(bucket="my-bucket", record=data) - write_api.__del__() + write_api.close() query = ''' from(bucket:"my-bucket") @@ -78,7 +78,7 @@ def main(): """ Close client """ - client.__del__() + client.close() # %% diff --git a/tests/test_QueryApiDataFrame.py b/tests/test_QueryApiDataFrame.py index 90a0dcb3..5d9c8205 100644 --- a/tests/test_QueryApiDataFrame.py +++ b/tests/test_QueryApiDataFrame.py @@ -20,7 +20,7 @@ def setUp(self) -> None: httpretty.reset() def tearDown(self) -> None: - self.client.__del__() + self.client.close() httpretty.disable() def test_one_table(self): @@ -276,7 +276,7 @@ def _create_point(index) -> Point: write_api = self.client.write_api(write_options=WriteOptions(batch_size=500)) write_api.write(org="my-org", bucket="my-bucket", record=data, write_precision=WritePrecision.S) - write_api.__del__() + write_api.close() query = 'from(bucket: "my-bucket")' \ '|> range(start: 2020-02-19T23:30:00Z, stop: now())' \ diff --git a/tests/test_QueryApiStream.py b/tests/test_QueryApiStream.py index d56c5dc6..45464715 100644 --- a/tests/test_QueryApiStream.py +++ b/tests/test_QueryApiStream.py @@ -15,7 +15,7 @@ def setUp(self) -> None: self.bucket = self.create_test_bucket() def tearDown(self) -> None: - self.write_client.__del__() + self.write_client.close() super().tearDown() def test_block(self): diff --git a/tests/test_WriteApi.py b/tests/test_WriteApi.py index 335cafcc..96c6d500 100644 --- a/tests/test_WriteApi.py +++ b/tests/test_WriteApi.py @@ -35,7 +35,7 @@ def setUp(self) -> None: '${env.data_center}'})) def tearDown(self) -> None: - self.write_client.__del__() + self.write_client.close() super().tearDown() def test_write_line_protocol(self): @@ -425,7 +425,7 @@ def test_check_write_permission_by_empty_data(self): self.assertEqual(401, exception.status) self.assertEqual("Unauthorized", exception.reason) - client.__del__() + client.close() def test_write_query_data_nanoseconds(self): @@ -477,7 +477,7 @@ def setUp(self) -> None: self.influxdb_client = InfluxDBClient(url=conf.host, token="my-token") def tearDown(self) -> None: - self.influxdb_client.__del__() + self.influxdb_client.close() httpretty.disable() def test_writes_synchronous_without_retry(self): @@ -521,7 +521,7 @@ def setUp(self) -> None: '${env.data_center}'})) def tearDown(self) -> None: - self.write_client.__del__() + self.write_client.close() super().tearDown() def test_write_result(self): @@ -723,7 +723,7 @@ def setUp(self) -> None: self.customer_tag = "California Miner" def tearDown(self) -> None: - self.write_client.__del__() + self.write_client.close() super().tearDown() def test_point_settings(self): @@ -773,7 +773,7 @@ def setUp(self) -> None: os.environ['INFLUXDB_V2_TAG_DATA_CENTER'] = "${env.data_center}" def tearDown(self) -> None: - self.write_client.__del__() + self.write_client.close() super().tearDown() def test_connection_option_from_conf_file(self): diff --git a/tests/test_WriteApiBatching.py b/tests/test_WriteApiBatching.py index 8ee60c25..2c64c4ec 100644 --- a/tests/test_WriteApiBatching.py +++ b/tests/test_WriteApiBatching.py @@ -31,7 +31,7 @@ def setUp(self) -> None: self._write_client = WriteApi(influxdb_client=self.influxdb_client, write_options=self.write_options) def tearDown(self) -> None: - self._write_client.__del__() + self._write_client.close() httpretty.disable() def test_batch_size(self): @@ -150,7 +150,7 @@ def test_flush_interval(self): httpretty.httpretty.latest_requests[1].parsed_body) def test_jitter_interval(self): - self._write_client.__del__() + self._write_client.close() self._write_client = WriteApi(influxdb_client=self.influxdb_client, write_options=WriteOptions(batch_size=2, flush_interval=5_000, jitter_interval=3_000)) @@ -179,7 +179,7 @@ def test_jitter_interval(self): def test_retry_interval(self): - self._write_client.__del__() + self._write_client.close() # Set retry interval to 1_500 self.write_options = WriteOptions(batch_size=2, flush_interval=5_000, retry_interval=1_500) @@ -226,7 +226,7 @@ def test_retry_interval_max_retries(self): httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=429, adding_headers={'Retry-After': '1'}) - self._write_client.__del__() + self._write_client.close() self._write_client = WriteApi(influxdb_client=self.influxdb_client, write_options=WriteOptions(batch_size=2, flush_interval=5_000, max_retries=5)) @@ -380,7 +380,7 @@ def test_del(self): _record = "h2o_feet,location=coyote_creek level\\ water_level=1 1" _result = self._write_client.write("my-bucket", "my-org", _record) - self._write_client.__del__() + self._write_client.close() _requests = httpretty.httpretty.latest_requests @@ -388,7 +388,7 @@ def test_del(self): self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1 1", _requests[0].parsed_body) def test_default_tags(self): - self._write_client.__del__() + self._write_client.close() self.id_tag = "132-987-655" self.customer_tag = "California Miner" @@ -431,7 +431,7 @@ def test_user_agent_header(self): def test_to_low_flush_interval(self): - self._write_client.__del__() + self._write_client.close() self._write_client = WriteApi(influxdb_client=self.influxdb_client, write_options=WriteOptions(batch_size=8, flush_interval=1, @@ -448,7 +448,7 @@ def test_to_low_flush_interval(self): self._write_client.write("my-bucket", "my-org", [point_one, point_two]) time.sleep(0.1) - self._write_client.__del__() + self._write_client.close() _requests = httpretty.httpretty.latest_requests diff --git a/tests/test_WriteApiDataFrame.py b/tests/test_WriteApiDataFrame.py index 4f01202e..7c9b15a7 100644 --- a/tests/test_WriteApiDataFrame.py +++ b/tests/test_WriteApiDataFrame.py @@ -21,7 +21,7 @@ def setUp(self) -> None: def tearDown(self) -> None: super().tearDown() - self._write_client.__del__() + self._write_client.close() def test_write_num_py(self): from influxdb_client.extras import pd, np @@ -38,7 +38,7 @@ def test_write_num_py(self): write_api.write(bucket.name, record=data_frame, data_frame_measurement_name='h2o_feet', data_frame_tag_columns=['location']) - write_api.__del__() + write_api.close() result = self.query_api.query( "from(bucket:\"" + bucket.name + "\") |> range(start: 1970-01-01T00:00:00.000000001Z)", diff --git a/tests/test_WriteApiPickle.py b/tests/test_WriteApiPickle.py index 309e19d1..7f105b01 100644 --- a/tests/test_WriteApiPickle.py +++ b/tests/test_WriteApiPickle.py @@ -19,8 +19,8 @@ def write(self, record): self.write_api.write(bucket="my-bucket", record=record) def terminate(self) -> None: - self.write_api.__del__() - self.client.__del__() + self.write_api.close() + self.client.close() class WriteApiPickle(BaseTest): diff --git a/tests/test_gzip.py b/tests/test_gzip.py index 0dd49e3e..c37d7733 100644 --- a/tests/test_gzip.py +++ b/tests/test_gzip.py @@ -16,7 +16,7 @@ def setUp(self) -> None: httpretty.reset() def tearDown(self) -> None: - self.client.__del__() + self.client.close() httpretty.disable() def test_gzip_disabled(self): diff --git a/tests/test_health.py b/tests/test_health.py index d3422064..0c03f9e3 100644 --- a/tests/test_health.py +++ b/tests/test_health.py @@ -44,7 +44,7 @@ def setUp(self) -> None: self.influxdb_client = InfluxDBClient(url="http://localhost", token="my-token") def tearDown(self) -> None: - self.influxdb_client.__del__() + self.influxdb_client.close() httpretty.disable() def test_without_retry(self): @@ -61,7 +61,7 @@ def test_without_retry(self): def test_with_retry(self): - self.influxdb_client.__del__() + self.influxdb_client.close() self.influxdb_client = InfluxDBClient(url="http://localhost", token="my-token", retries=Retry()) httpretty.register_uri(httpretty.GET, uri="http://localhost/health", status=200,