View GitHub Repository core

Schedule Inspection
Subscribe
Passed
Pull Request — master (#1079)
by Konstantin
02:32
created

ocrd_utils.deprecate.rename_kwargs()   A

↳ Parent: ocrd_utils.deprecate

Complexity

Conditions 4

Size

Total Lines 13
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 9
dl 0
loc 13
rs 9.95
c 0
b 0
f 0
cc 4
nop 3
1 
import functools
2 
import warnings
3 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                
def deprecation_warning(msg, stacklevel=2):

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
    warnings.warn(msg, DeprecationWarning, stacklevel)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
def deprecated_alias(**aliases):

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
    """

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
    Deprecate a kwarg in favor of another kwarg

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
    """

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    def deco(f):

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
        @functools.wraps(f)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        def wrapper(*args, **kwargs):

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
            rename_kwargs(f.__name__, kwargs, aliases)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
            return f(*args, **kwargs)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        return wrapper

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
    return deco

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
def rename_kwargs(func_name, kwargs, aliases):

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
    """

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
    https://stackoverflow.com/questions/49802412/how-to-implement-deprecation-in-python-with-argument-alias

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
    by user2357112 supports Monica

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
    """

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
    for alias, new in aliases.items():

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
        if alias in kwargs:

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
            if new in kwargs:

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
                raise TypeError('{} received both {} and {}'.format(

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
                    func_name, alias, new))

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
            warnings.warn('{} is deprecated; use {}'.format(alias, new),

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
                          DeprecationWarning)

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
            kwargs[new] = kwargs.pop(alias)

            


            
                                                        
            
                                    
            
            

                
                    32