mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-28 11:10:21 -07:00
937d92ee25
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.15) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.15+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.15+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.15+py3.5) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* pickle cache plugin, avoid extra steps in DT * clog * Update changelogs/fragments/10136-cache-pickle-json.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
72 lines
2 KiB
Python
72 lines
2 KiB
Python
# -*- 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 annotations
|
|
|
|
DOCUMENTATION = r"""
|
|
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
|
|
type: path
|
|
_prefix:
|
|
description: User defined prefix to use when creating the files.
|
|
env:
|
|
- name: ANSIBLE_CACHE_PLUGIN_PREFIX
|
|
ini:
|
|
- key: fact_caching_prefix
|
|
section: defaults
|
|
type: string
|
|
_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
|
|
type: float
|
|
"""
|
|
|
|
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.
|
|
"""
|
|
_persistent = False # prevent unnecessary JSON serialization and key munging
|
|
|
|
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)
|