Skip to content

Commit 06df6d8

Browse files
committed
Deprecate parse_headers function
Fixes open-telemetry#2376
1 parent d710f61 commit 06df6d8

File tree

1 file changed

+12
-3
lines changed
  • opentelemetry-api/src/opentelemetry/util

1 file changed

+12
-3
lines changed

opentelemetry-api/src/opentelemetry/util/re.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
import logging
15+
from logging import getLogger
1616
from re import compile, split
1717
from typing import Dict, List, Mapping
1818
from urllib.parse import unquote
1919

20-
_logger = logging.getLogger(__name__)
20+
from deprecated import deprecated
21+
22+
_logger = getLogger(__name__)
2123

2224
# The following regexes reference this spec: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specifying-headers-via-environment-variables
2325

@@ -40,6 +42,13 @@
4042

4143

4244
# pylint: disable=invalid-name
45+
46+
47+
@deprecated(version="1.15.0", reason="You should use parse_env_headers")
48+
def parse_headers(s: str) -> Mapping[str, str]:
49+
return parse_env_headers(s)
50+
51+
4352
def parse_env_headers(s: str) -> Mapping[str, str]:
4453
"""
4554
Parse ``s``, which is a ``str`` instance containing HTTP headers encoded
@@ -57,7 +66,7 @@ def parse_env_headers(s: str) -> Mapping[str, str]:
5766
_logger.warning(
5867
"Header format invalid! Header values in environment variables must be "
5968
"URL encoded per the OpenTelemetry Protocol Exporter specification: %s",
60-
header
69+
header,
6170
)
6271
continue
6372
# value may contain any number of `=`

0 commit comments

Comments
 (0)