Skip to content

omnipy.util.param_key_mapper

Utilities for renaming parameter keys between paired vocabularies.

This module provides a small mapping helper that can translate matching keys in either direction, drop matched keys, or combine both operations.

CLASS DESCRIPTION
ParamKeyMapper

Translate selected mapping keys using a bidirectional key map.

ParamKeyMapper

Translate selected mapping keys using a bidirectional key map.

PARAMETER DESCRIPTION
key_map

Mapping from source keys to target keys.

TYPE: Mapping[str, str] | Iterable[tuple[str, str]]

RAISES DESCRIPTION
ValueError

If the mapping is not one-to-one and cannot be inverted without losing keys.
METHOD DESCRIPTION
__init__
delete_matching_keys
map_matching_keys
map_matching_keys_delete_inverse_matches_keep_rest
ATTRIBUTE DESCRIPTION
key_map

Source code in src/omnipy/util/param_key_mapper.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class ParamKeyMapper:
    """Translate selected mapping keys using a bidirectional key map.

    Args:
        key_map: Mapping from source keys to target keys.

    Raises:
        ValueError: If the mapping is not one-to-one and cannot be inverted
            without losing keys.
    """
    def __init__(self, key_map: Mapping[str, str] | Iterable[tuple[str, str]]):
        self.key_map = dict(key_map)
        self._inverse_key_map = {val: key for key, val in self.key_map.items()}
        self._identity_keys = {key for key, value in self.key_map.items() if key == value}

        if len(self.key_map) != len(self._inverse_key_map):
            raise ValueError('Some values were dropped when translating to the inverse key_map!')

    def _get_key_map(self, inverse: bool):
        return self._inverse_key_map if inverse else self.key_map

    def map_matching_keys(self,
                          params: Mapping[str, Any],
                          inverse: bool,
                          keep_non_matching_keys: bool):
        key_map = self._get_key_map(inverse)
        keys = params.keys() if keep_non_matching_keys else [
            key for key in params if key in key_map
        ]
        return {key_map[key] if key in key_map else key: params[key] for key in keys}

    def delete_matching_keys(self, params: Mapping[str, Any], inverse: bool):
        key_map = self._get_key_map(inverse)
        return {
            key: params[key] for key in params if key not in key_map or key in self._identity_keys
        }

    def map_matching_keys_delete_inverse_matches_keep_rest(self,
                                                           params: Mapping[str, Any],
                                                           inverse: bool):
        params = self.delete_matching_keys(params, not inverse)
        params = self.map_matching_keys(params, inverse, keep_non_matching_keys=True)

        return params

key_map instance-attribute 

key_map = dict(key_map)

__init__ 

__init__(key_map: Mapping[str, str] | Iterable[tuple[str, str]])
Source code in src/omnipy/util/param_key_mapper.py 
20
21
22
23
24
25
26
def __init__(self, key_map: Mapping[str, str] | Iterable[tuple[str, str]]):
    self.key_map = dict(key_map)
    self._inverse_key_map = {val: key for key, val in self.key_map.items()}
    self._identity_keys = {key for key, value in self.key_map.items() if key == value}

    if len(self.key_map) != len(self._inverse_key_map):
        raise ValueError('Some values were dropped when translating to the inverse key_map!')

delete_matching_keys 

delete_matching_keys(params: Mapping[str, Any], inverse: bool)
Source code in src/omnipy/util/param_key_mapper.py 
41
42
43
44
45
def delete_matching_keys(self, params: Mapping[str, Any], inverse: bool):
    key_map = self._get_key_map(inverse)
    return {
        key: params[key] for key in params if key not in key_map or key in self._identity_keys
    }

map_matching_keys 

map_matching_keys(params: Mapping[str, Any], inverse: bool, keep_non_matching_keys: bool)
Source code in src/omnipy/util/param_key_mapper.py 
31
32
33
34
35
36
37
38
39
def map_matching_keys(self,
                      params: Mapping[str, Any],
                      inverse: bool,
                      keep_non_matching_keys: bool):
    key_map = self._get_key_map(inverse)
    keys = params.keys() if keep_non_matching_keys else [
        key for key in params if key in key_map
    ]
    return {key_map[key] if key in key_map else key: params[key] for key in keys}

map_matching_keys_delete_inverse_matches_keep_rest 

map_matching_keys_delete_inverse_matches_keep_rest(params: Mapping[str, Any], inverse: bool)
Source code in src/omnipy/util/param_key_mapper.py 
47
48
49
50
51
52
53
def map_matching_keys_delete_inverse_matches_keep_rest(self,
                                                       params: Mapping[str, Any],
                                                       inverse: bool):
    params = self.delete_matching_keys(params, not inverse)
    params = self.map_matching_keys(params, inverse, keep_non_matching_keys=True)

    return params