diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 12:04:41 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 12:04:41 +0000 |
commit | 975f66f2eebe9dadba04f275774d4ab83f74cf25 (patch) | |
tree | 89bd26a93aaae6a25749145b7e4bca4a1e75b2be /ansible_collections/community/general/plugins/cache/pickle.py | |
parent | Initial commit. (diff) | |
download | ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.tar.xz ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.zip |
Adding upstream version 7.7.0+dfsg.upstream/7.7.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/community/general/plugins/cache/pickle.py')
-rw-r--r-- | ansible_collections/community/general/plugins/cache/pickle.py | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/ansible_collections/community/general/plugins/cache/pickle.py b/ansible_collections/community/general/plugins/cache/pickle.py new file mode 100644 index 000000000..06b673921 --- /dev/null +++ b/ansible_collections/community/general/plugins/cache/pickle.py @@ -0,0 +1,69 @@ +# -*- coding: utf-8 -*- +# Copyright (c) 2017, Brian Coca +# Copyright (c) 2017 Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +DOCUMENTATION = ''' + name: pickle + short_description: Pickle formatted files. + description: + - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem. + author: Brian Coca (@bcoca) + options: + _uri: + required: true + description: + - Path in which the cache plugin will save the files + env: + - name: ANSIBLE_CACHE_PLUGIN_CONNECTION + ini: + - key: fact_caching_connection + section: defaults + _prefix: + description: User defined prefix to use when creating the files + env: + - name: ANSIBLE_CACHE_PLUGIN_PREFIX + ini: + - key: fact_caching_prefix + section: defaults + _timeout: + default: 86400 + description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire + env: + - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT + ini: + - key: fact_caching_timeout + section: defaults +''' + +try: + import cPickle as pickle +except ImportError: + import pickle + +from ansible.module_utils.six import PY3 +from ansible.plugins.cache import BaseFileCacheModule + + +class CacheModule(BaseFileCacheModule): + """ + A caching module backed by pickle files. + """ + + def _load(self, filepath): + # Pickle is a binary format + with open(filepath, 'rb') as f: + if PY3: + return pickle.load(f, encoding='bytes') + else: + return pickle.load(f) + + def _dump(self, value, filepath): + with open(filepath, 'wb') as f: + # Use pickle protocol 2 which is compatible with Python 2.3+. + pickle.dump(value, f, protocol=2) |