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

1from __future__ import annotations 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

2 

3import importlib.metadata as importlib_metadata 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

4import os 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

5import warnings 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

6from collections.abc import Iterable 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

7from typing import TYPE_CHECKING, Final 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

8 

9if TYPE_CHECKING: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

10 from . import PydanticPluginProtocol 

11 

12 

13PYDANTIC_ENTRY_POINT_GROUP: Final[str] = 'pydantic' 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

14 

15# cache of plugins 

16_plugins: dict[str, PydanticPluginProtocol] | None = None 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

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 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

20 

21 

22def get_plugins() -> Iterable[PydanticPluginProtocol]: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

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') 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

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 true36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

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

31 return () 

32 elif disabled_plugins in ('__all__', '1', 'true'): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

33 return () 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

34 elif _plugins is None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

35 _plugins = {} 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

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

37 _loading_plugins = True 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

38 try: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

39 for dist in importlib_metadata.distributions(): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

40 for entry_point in dist.entry_points: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

41 if entry_point.group != PYDANTIC_ENTRY_POINT_GROUP: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

42 continue 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

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

44 continue 

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

46 continue 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

47 try: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

48 _plugins[entry_point.value] = entry_point.load() 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

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 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

56 

57 return _plugins.values() 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI