Skip to content

docs: add deprecation warning for WriteType.asynchronous #499

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
Sep 14, 2022
Merged

docs: add deprecation warning for WriteType.asynchronous #499

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
218242e
docs: add deprecation warning for `WriteType.asynchronous`
bednar Sep 12, 2022
80b20a0
docs: add deprecation warning for `WriteType.asynchronous`
bednar Sep 12, 2022
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
9 changes: 9 additions & 0 deletions influxdb_client/client/write_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# coding: utf-8
import logging
import os
import warnings
from collections import defaultdict
from datetime import timedelta
from enum import Enum
Expand Down Expand Up @@ -273,6 +274,14 @@ def __init__(self,
self._subject = None
self._disposable = None

if self._write_options.write_type is WriteType.asynchronous:
message = """The 'WriteType.asynchronous' is deprecated and will be removed in future major version.

You can use native asynchronous version of the client:
- https://influxdb-client.readthedocs.io/en/stable/usage.html#how-to-use-asyncio
"""
warnings.warn(message, DeprecationWarning)

def write(self, bucket: str, org: str = None,
record: Union[
str, Iterable['str'], Point, Iterable['Point'], dict, Iterable['dict'], bytes, Iterable['bytes'],
Expand Down