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

1from __future__ import annotations 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

2 

3import importlib.metadata as importlib_metadata 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

4import os 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

5import warnings 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

6from collections.abc import Iterable 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

7from typing import TYPE_CHECKING, Final 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

8 

9if TYPE_CHECKING: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

10 from . import PydanticPluginProtocol 

11 

12 

13PYDANTIC_ENTRY_POINT_GROUP: Final[str] = 'pydantic' 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

14 

15# cache of plugins 

16_plugins: dict[str, PydanticPluginProtocol] | None = None 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

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

18# this means that if plugins use pydantic 

19_loading_plugins: bool = False 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

20 

21 

22def get_plugins() -> Iterable[PydanticPluginProtocol]: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

23 """Load plugins for Pydantic. 

24 

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

26 """ 

27 disabled_plugins = os.getenv('PYDANTIC_DISABLE_PLUGINS') 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

28 global _plugins, _loading_plugins 

29 if _loading_plugins: 29 ↛ 31line 29 didn't jump to line 31 because the condition on line 29 was never true39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

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

31 return () 

32 elif disabled_plugins in ('__all__', '1', 'true'): 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

33 return () 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

34 elif _plugins is None: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

35 _plugins = {} 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

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

37 _loading_plugins = True 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

38 try: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

39 for dist in importlib_metadata.distributions(): 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

40 for entry_point in dist.entry_points: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

41 if entry_point.group != PYDANTIC_ENTRY_POINT_GROUP: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

42 continue 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

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

44 continue 

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

46 continue 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

47 try: 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

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

49 except (ImportError, AttributeError) as e: 

50 warnings.warn( 

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

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

53 ) 

54 finally: 

55 _loading_plugins = False 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

56 

57 return _plugins.values() 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF