Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/airflow/sdk/yaml.py: 44%

1# Licensed to the Apache Software Foundation (ASF) under one 

2# or more contributor license agreements. See the NOTICE file 

3# distributed with this work for additional information 

4# regarding copyright ownership. The ASF licenses this file 

5# to you under the Apache License, Version 2.0 (the 

6# "License"); you may not use this file except in compliance 

7# with the License. You may obtain a copy of the License at 

8# 

9# http://www.apache.org/licenses/LICENSE-2.0 

10# 

11# Unless required by applicable law or agreed to in writing, 

12# software distributed under the License is distributed on an 

13# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 

14# KIND, either express or implied. See the License for the 

15# specific language governing permissions and limitations 

16# under the License. 

17""" 

18Use libyaml for YAML dump/load operations where possible. 

19 

20If libyaml is available we will use it -- it is significantly faster. 

21 

22This module delegates all other properties to the yaml module, so it can be used as: 

23 

24.. code-block:: python 

25 

26 import airflow.sdk.yaml as yaml 

27 

28And then be used directly in place of the normal python module. 

29""" 

30 

31from __future__ import annotations 

32 

33from typing import TYPE_CHECKING, Any, BinaryIO, TextIO, cast 

34 

35if TYPE_CHECKING: 

36 from yaml.error import MarkedYAMLError, YAMLError # noqa: F401 

37 

38 

39def safe_load(stream: bytes | str | BinaryIO | TextIO) -> Any: 

40 """Like yaml.safe_load, but use the C libyaml for speed where we can.""" 

41 # delay import until use. 

42 from yaml import load as orig 

43 

44 try: 

45 from yaml import CSafeLoader as SafeLoader 

46 except ImportError: 

47 from yaml import SafeLoader # type: ignore[assignment] 

48 

49 return orig(stream, SafeLoader) 

50 

51 

52def dump(data: Any, **kwargs) -> str: 

53 """Like yaml.safe_dump, but use the C libyaml for speed where we can.""" 

54 # delay import until use. 

55 from yaml import dump as orig 

56 

57 try: 

58 from yaml import CSafeDumper as SafeDumper 

59 except ImportError: 

60 from yaml import SafeDumper # type: ignore[assignment] 

61 

62 return cast("str", orig(data, Dumper=SafeDumper, **kwargs)) 

63 

64 

65def __getattr__(name): 

66 # Delegate anything else to the yaml module 

67 import yaml 

68 

69 if name == "FullLoader": 

70 # Try to use CFullLoader by default 

71 getattr(yaml, "CFullLoader", yaml.FullLoader) 

72 

73 return getattr(yaml, name)