Skip to content

Remove deprecated http_auth parameter #2839

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 1 commit into from
Mar 12, 2025
Merged

Remove deprecated http_auth parameter #2839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 0 additions & 21 deletions elasticsearch/_async/client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@
_rewrite_parameters,
_stability_warning,
client_node_configs,
is_requests_http_auth,
is_requests_node_class,
)
from .watcher import WatcherClient
from .xpack import XPackClient
Expand Down Expand Up @@ -191,7 +189,6 @@ def __init__(
] = None,
sniffer_timeout: t.Union[DefaultType, None, float] = DEFAULT,
sniff_on_connection_fail: t.Union[DefaultType, bool] = DEFAULT,
http_auth: t.Union[DefaultType, t.Any] = DEFAULT,
maxsize: t.Union[DefaultType, int] = DEFAULT,
# Internal use only
_transport: t.Optional[AsyncTransport] = None,
Expand Down Expand Up @@ -320,26 +317,9 @@ def __init__(
sniff_callback = default_sniff_callback

if _transport is None:
requests_session_auth = None
if http_auth is not None and http_auth is not DEFAULT:
if is_requests_http_auth(http_auth):
# If we're using custom requests authentication
# then we need to alert the user that they also
# need to use 'node_class=requests'.
if not is_requests_node_class(node_class):
raise ValueError(
"Using a custom 'requests.auth.AuthBase' class for "
"'http_auth' must be used with node_class='requests'"
)

# Reset 'http_auth' to DEFAULT so it's not consumed below.
requests_session_auth = http_auth
http_auth = DEFAULT

node_configs = client_node_configs(
hosts,
cloud_id=cloud_id,
requests_session_auth=requests_session_auth,
connections_per_node=connections_per_node,
http_compress=http_compress,
verify_certs=verify_certs,
Expand Down Expand Up @@ -426,7 +406,6 @@ def __init__(
self._headers["x-opaque-id"] = opaque_id
self._headers = resolve_auth_headers(
self._headers,
http_auth=http_auth,
api_key=api_key,
basic_auth=basic_auth,
bearer_auth=bearer_auth,
Expand Down
26 changes: 0 additions & 26 deletions elasticsearch/_async/client/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@

def resolve_auth_headers(
headers: Optional[Mapping[str, str]],
http_auth: Union[DefaultType, None, Tuple[str, str], str] = DEFAULT,
api_key: Union[DefaultType, None, Tuple[str, str], str] = DEFAULT,
basic_auth: Union[DefaultType, None, Tuple[str, str], str] = DEFAULT,
bearer_auth: Union[DefaultType, None, str] = DEFAULT,
Expand All @@ -78,32 +77,7 @@ def resolve_auth_headers(
elif not isinstance(headers, HttpHeaders):
headers = HttpHeaders(headers)

resolved_http_auth = http_auth if http_auth is not DEFAULT else None
resolved_basic_auth = basic_auth if basic_auth is not DEFAULT else None
if resolved_http_auth is not None:
if resolved_basic_auth is not None:
raise ValueError(
"Can't specify both 'http_auth' and 'basic_auth', "
"instead only specify 'basic_auth'"
)
if isinstance(http_auth, str) or (
isinstance(resolved_http_auth, (list, tuple))
and all(isinstance(x, str) for x in resolved_http_auth)
):
resolved_basic_auth = resolved_http_auth
else:
raise TypeError(
"The deprecated 'http_auth' parameter must be either 'Tuple[str, str]' or 'str'. "
"Use either the 'basic_auth' parameter instead"
)

warnings.warn(
"The 'http_auth' parameter is deprecated. "
"Use 'basic_auth' or 'bearer_auth' parameters instead",
category=DeprecationWarning,
stacklevel=warn_stacklevel(),
)

resolved_api_key = api_key if api_key is not DEFAULT else None
resolved_bearer_auth = bearer_auth if bearer_auth is not DEFAULT else None
if resolved_api_key or resolved_basic_auth or resolved_bearer_auth:
Expand Down
4 changes: 0 additions & 4 deletions elasticsearch/_async/client/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@
_rewrite_parameters,
_stability_warning,
client_node_configs,
is_requests_http_auth,
is_requests_node_class,
)

__all__ = [
Expand All @@ -43,6 +41,4 @@
"client_node_configs",
"_rewrite_parameters",
"_stability_warning",
"is_requests_http_auth",
"is_requests_node_class",
]
7 changes: 2 additions & 5 deletions elasticsearch/_async/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,12 +419,9 @@ def pop_transport_kwargs(kw: MutableMapping[str, Any]) -> MutableMapping[str, An
# Grab options that should be propagated to every
# API call within this helper instead of just 'search()'
transport_kwargs = {}
for key in ("headers", "api_key", "http_auth", "basic_auth", "bearer_auth"):
for key in ("headers", "api_key", "basic_auth", "bearer_auth"):
try:
value = kw.pop(key)
if key == "http_auth":
key = "basic_auth"
transport_kwargs[key] = value
transport_kwargs[key] = kw.pop(key)
except KeyError:
pass
return transport_kwargs
Expand Down
21 changes: 0 additions & 21 deletions elasticsearch/_sync/client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@
_rewrite_parameters,
_stability_warning,
client_node_configs,
is_requests_http_auth,
is_requests_node_class,
)
from .watcher import WatcherClient
from .xpack import XPackClient
Expand Down Expand Up @@ -191,7 +189,6 @@ def __init__(
] = None,
sniffer_timeout: t.Union[DefaultType, None, float] = DEFAULT,
sniff_on_connection_fail: t.Union[DefaultType, bool] = DEFAULT,
http_auth: t.Union[DefaultType, t.Any] = DEFAULT,
maxsize: t.Union[DefaultType, int] = DEFAULT,
# Internal use only
_transport: t.Optional[Transport] = None,
Expand Down Expand Up @@ -320,26 +317,9 @@ def __init__(
sniff_callback = default_sniff_callback

if _transport is None:
requests_session_auth = None
if http_auth is not None and http_auth is not DEFAULT:
if is_requests_http_auth(http_auth):
# If we're using custom requests authentication
# then we need to alert the user that they also
# need to use 'node_class=requests'.
if not is_requests_node_class(node_class):
raise ValueError(
"Using a custom 'requests.auth.AuthBase' class for "
"'http_auth' must be used with node_class='requests'"
)

# Reset 'http_auth' to DEFAULT so it's not consumed below.
requests_session_auth = http_auth
http_auth = DEFAULT

node_configs = client_node_configs(
hosts,
cloud_id=cloud_id,
requests_session_auth=requests_session_auth,
connections_per_node=connections_per_node,
http_compress=http_compress,
verify_certs=verify_certs,
Expand Down Expand Up @@ -426,7 +406,6 @@ def __init__(
self._headers["x-opaque-id"] = opaque_id
self._headers = resolve_auth_headers(
self._headers,
http_auth=http_auth,
api_key=api_key,
basic_auth=basic_auth,
bearer_auth=bearer_auth,
Expand Down
26 changes: 0 additions & 26 deletions elasticsearch/_sync/client/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@

def resolve_auth_headers(
headers: Optional[Mapping[str, str]],
http_auth: Union[DefaultType, None, Tuple[str, str], str] = DEFAULT,
api_key: Union[DefaultType, None, Tuple[str, str], str] = DEFAULT,
basic_auth: Union[DefaultType, None, Tuple[str, str], str] = DEFAULT,
bearer_auth: Union[DefaultType, None, str] = DEFAULT,
Expand All @@ -78,32 +77,7 @@ def resolve_auth_headers(
elif not isinstance(headers, HttpHeaders):
headers = HttpHeaders(headers)

resolved_http_auth = http_auth if http_auth is not DEFAULT else None
resolved_basic_auth = basic_auth if basic_auth is not DEFAULT else None
if resolved_http_auth is not None:
if resolved_basic_auth is not None:
raise ValueError(
"Can't specify both 'http_auth' and 'basic_auth', "
"instead only specify 'basic_auth'"
)
if isinstance(http_auth, str) or (
isinstance(resolved_http_auth, (list, tuple))
and all(isinstance(x, str) for x in resolved_http_auth)
):
resolved_basic_auth = resolved_http_auth
else:
raise TypeError(
"The deprecated 'http_auth' parameter must be either 'Tuple[str, str]' or 'str'. "
"Use either the 'basic_auth' parameter instead"
)

warnings.warn(
"The 'http_auth' parameter is deprecated. "
"Use 'basic_auth' or 'bearer_auth' parameters instead",
category=DeprecationWarning,
stacklevel=warn_stacklevel(),
)

resolved_api_key = api_key if api_key is not DEFAULT else None
resolved_bearer_auth = bearer_auth if bearer_auth is not DEFAULT else None
if resolved_api_key or resolved_basic_auth or resolved_bearer_auth:
Expand Down
35 changes: 0 additions & 35 deletions elasticsearch/_sync/client/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
# under the License.

import base64
import inspect
import urllib.parse
import warnings
from datetime import date, datetime
Expand Down Expand Up @@ -44,7 +43,6 @@
AsyncTransport,
HttpHeaders,
NodeConfig,
RequestsHttpNode,
SniffOptions,
Transport,
)
Expand Down Expand Up @@ -92,7 +90,6 @@ class Stability(Enum):

_TRANSPORT_OPTIONS = {
"api_key",
"http_auth",
"request_timeout",
"opaque_id",
"headers",
Expand All @@ -105,7 +102,6 @@ class Stability(Enum):
def client_node_configs(
hosts: Optional[_TYPE_HOSTS],
cloud_id: Optional[str],
requests_session_auth: Optional[Any] = None,
**kwargs: Any,
) -> List[NodeConfig]:
if cloud_id is not None:
Expand All @@ -126,12 +122,6 @@ def client_node_configs(
headers.setdefault("user-agent", USER_AGENT)
node_options["headers"] = headers

# If a custom Requests AuthBase is passed we set that via '_extras'.
if requests_session_auth is not None:
node_options.setdefault("_extras", {})[
"requests.session.auth"
] = requests_session_auth

def apply_node_options(node_config: NodeConfig) -> NodeConfig:
"""Needs special handling of headers since .replace() wipes out existing headers"""
nonlocal node_options
Expand Down Expand Up @@ -451,28 +441,3 @@ def wrapped(*args: Any, **kwargs: Any) -> Any:
return wrapped # type: ignore[return-value]

return wrapper


def is_requests_http_auth(http_auth: Any) -> bool:
"""Detect if an http_auth value is a custom Requests auth object"""
try:
from requests.auth import AuthBase

return isinstance(http_auth, AuthBase)
except ImportError:
pass
return False


def is_requests_node_class(node_class: Any) -> bool:
"""Detect if 'RequestsHttpNode' would be used given the setting of 'node_class'"""
return (
node_class is not None
and node_class is not DEFAULT
and (
node_class == "requests"
or (
inspect.isclass(node_class) and issubclass(node_class, RequestsHttpNode)
)
)
)
6 changes: 1 addition & 5 deletions elasticsearch/helpers/actions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,16 +698,12 @@ def pop_transport_kwargs(kw: MutableMapping[str, Any]) -> Dict[str, Any]:
for key in (
"headers",
"api_key",
"http_auth",
"basic_auth",
"bearer_auth",
"opaque_id",
):
try:
value = kw.pop(key)
if key == "http_auth":
key = "basic_auth"
transport_kwargs[key] = value
transport_kwargs[key] = kw.pop(key)
except KeyError:
pass
return transport_kwargs
Expand Down
6 changes: 2 additions & 4 deletions test_elasticsearch/test_async/test_server/test_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,8 @@ async def test_clear_scroll(self, async_client, scan_teardown):
"kwargs",
[
{"api_key": ("name", "value")},
{"http_auth": ("username", "password")},
{"basic_auth": ("username", "password")},
{"bearer_auth": "token"},
{"headers": {"custom", "header"}},
],
)
Expand Down Expand Up @@ -790,9 +791,6 @@ async def test_scan_auth_kwargs_forwarded(

assert data == [{"search_data": 1}]

if "http_auth" in kwargs:
kwargs = {"basic_auth": kwargs.pop("http_auth")}

assert options.call_args_list == [
call(request_timeout=None, **kwargs),
call(ignore_status=404),
Expand Down
26 changes: 0 additions & 26 deletions test_elasticsearch/test_client/test_deprecated_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,32 +100,6 @@ def test_randomize_hosts():
)


def test_http_auth():
with warnings.catch_warnings(record=True) as w:
client = Elasticsearch(
"http://localhost:9200", http_auth=("username", "password")
)

assert len(w) == 1
assert w[0].category == DeprecationWarning
assert (
str(w[0].message)
== "The 'http_auth' parameter is deprecated. Use 'basic_auth' or 'bearer_auth' parameters instead"
)
assert client._headers["Authorization"] == "Basic dXNlcm5hbWU6cGFzc3dvcmQ="

with pytest.raises(ValueError) as e:
Elasticsearch(
"http://localhost:9200",
http_auth=("username", "password"),
basic_auth=("username", "password"),
)
assert (
str(e.value)
== "Can't specify both 'http_auth' and 'basic_auth', instead only specify 'basic_auth'"
)


def test_serializer_and_serializers():
with pytest.raises(ValueError) as e:
Elasticsearch(
Expand Down
Loading
Loading