Skip to content

cacher_bin

Base module to handle extension binary caching.

Attributes

mlogger = get_logger(__name__) module-attribute

loaded_extensions = [] module-attribute

Classes

Functions

update_cache(parsed_ext)

Source code in pyrevitlib/pyrevit/extensions/cacher_bin.py 
20
21
22
23
24
25
26
27
28
29
def update_cache(parsed_ext):
    try:
        mlogger.debug('Writing cache for: %s', parsed_ext)
        cache_file = _get_cache_file(parsed_ext)
        mlogger.debug('Cache file is: %s', cache_file)
        with open(cache_file, 'wb') as bin_cache_file:
            pickle.dump(parsed_ext, bin_cache_file, pickle.HIGHEST_PROTOCOL)
    except Exception as err:
        raise PyRevitException('Error writing cache for: {} | {}'
                               .format(parsed_ext, err))

get_cached_extension(installed_ext)

Source code in pyrevitlib/pyrevit/extensions/cacher_bin.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def get_cached_extension(installed_ext):
    for loaded_ext in loaded_extensions:
        if loaded_ext.name == installed_ext.name:
            return loaded_ext

    try:
        mlogger.debug('Reading cache for: %s', installed_ext)
        cache_file = _get_cache_file(installed_ext)
        mlogger.debug('Cache file is: %s', cache_file)
        with open(cache_file, 'rb') as bin_cache_file:
            unpickled_pkg = pickle.load(bin_cache_file)
    except Exception as err:
        raise PyRevitException('Error reading cache for: {} | {}'
                               .format(installed_ext, err))

    return unpickled_pkg

is_cache_valid(extension)

Source code in pyrevitlib/pyrevit/extensions/cacher_bin.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def is_cache_valid(extension):
    try:
        cached_ext = get_cached_extension(extension)
        mlogger.debug('Extension cache directory is: %s for: %s',
                      extension.directory, extension)
        cache_dir_valid = \
            cached_ext.directory == extension.directory

        mlogger.debug('Extension cache version is: %s for: %s',
                      extension.pyrvt_version, extension)
        cache_version_valid = \
            cached_ext.pyrvt_version == extension.pyrvt_version

        mlogger.debug('Extension hash value is: %s for: %s',
                      extension.dir_hash_value, extension)
        cache_hash_valid = \
            cached_ext.dir_hash_value == extension.dir_hash_value

        cache_valid = \
            cache_dir_valid and cache_version_valid and cache_hash_valid

        # add loaded package to list so it can be recovered later
        if cache_valid:
            loaded_extensions.append(cached_ext)

        # cache is valid if both version and hash value match
        return cache_valid

    except PyRevitException as err:
        mlogger.debug('Error reading cache file or file is not available: %s',
                      err)
        return False

    except Exception as err:
        mlogger.debug('Error determining cache validity: %s | %s',
                      extension, err)
        return False