Coverage for src/loman/serialization/default.py: 100%

1"""Default transformer configuration for serialization. 

2 

3.. deprecated:: 

4 :func:`default_transformer` predates 

5 :func:`~loman.serialization.computation.default_computation_transformer` and 

6 is not used on the :class:`~loman.computeengine.Computation` path. It 

7 registers only ndarray support, so a Transformer built with it cannot encode 

8 a DataFrame, a Series, a callable or a NodeKey. Use 

9 :func:`~loman.serialization.computation.default_computation_transformer`, or 

10 construct a bare :class:`~loman.serialization.transformer.Transformer` and 

11 register what you need. 

12""" 

13 

14import warnings 

15from typing import Any 

16 

17from .transformer import NdArrayTransformer, Transformer 

18 

19 

20def default_transformer(*args: Any, **kwargs: Any) -> Transformer: 

21 """Create a default transformer with NdArray support. 

22 

23 .. deprecated:: 

24 Use 

25 :func:`~loman.serialization.computation.default_computation_transformer` 

26 instead. This function will be removed in a future release. 

27 """ 

28 warnings.warn( 

29 "default_transformer is deprecated and will be removed in a future release. " 

30 "Use loman.serialization.computation.default_computation_transformer instead, " 

31 "or build a Transformer and register the transformers you need.", 

32 DeprecationWarning, 

33 stacklevel=2, 

34 ) 

35 t = Transformer(*args, **kwargs) 

36 t.register(NdArrayTransformer()) 

37 return t