Coverage for pydantic/plugin/_loader.py: 87.50%

1from __future__ import annotations 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

2 

3import importlib.metadata as importlib_metadata 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

4import os 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

5import warnings 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

6from typing import TYPE_CHECKING, Final, Iterable 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

7 

8if TYPE_CHECKING: 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

9 from . import PydanticPluginProtocol 

10 

11 

12PYDANTIC_ENTRY_POINT_GROUP: Final[str] = 'pydantic' 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

13 

14# cache of plugins 

15_plugins: dict[str, PydanticPluginProtocol] | None = None 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

16# return no plugins while loading plugins to avoid recursion and errors while import plugins 

17# this means that if plugins use pydantic 

18_loading_plugins: bool = False 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

19 

20 

21def get_plugins() -> Iterable[PydanticPluginProtocol]: 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

22 """Load plugins for Pydantic. 

23 

24 Inspired by: https://github.com/pytest-dev/pluggy/blob/1.3.0/src/pluggy/_manager.py#L376-L402 

25 """ 

26 disabled_plugins = os.getenv('PYDANTIC_DISABLE_PLUGINS') 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

27 global _plugins, _loading_plugins 

28 if _loading_plugins: 28 ↛ 30line 28 didn't jump to line 30, because the condition on line 28 was never true41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

29 # this happens when plugins themselves use pydantic, we return no plugins 

30 return () 

31 elif disabled_plugins in ('__all__', '1', 'true'): 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

32 return () 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

33 elif _plugins is None: 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

34 _plugins = {} 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

35 # set _loading_plugins so any plugins that use pydantic don't themselves use plugins 

36 _loading_plugins = True 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

37 try: 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

38 for dist in importlib_metadata.distributions(): 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

39 for entry_point in dist.entry_points: 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

40 if entry_point.group != PYDANTIC_ENTRY_POINT_GROUP: 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

41 continue 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

42 if entry_point.value in _plugins: 42 ↛ 43line 42 didn't jump to line 43, because the condition on line 42 was never true32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

43 continue 

44 if disabled_plugins is not None and entry_point.name in disabled_plugins.split(','): 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

45 continue 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

46 try: 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

47 _plugins[entry_point.value] = entry_point.load() 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

48 except (ImportError, AttributeError) as e: 

49 warnings.warn( 

50 f'{e.__class__.__name__} while loading the `{entry_point.name}` Pydantic plugin, ' 

51 f'this plugin will not be installed.\n\n{e!r}' 

52 ) 

53 finally: 

54 _loading_plugins = False 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF

55 

56 return _plugins.values() 41 ctx1abcdefghijklmnopqrstuvGHIJKLMNOwxyzABCDEF