https://github.com/annotation/text-fabric
Tip revision: e933354a3e7dfd8a5126869b6538a40619237975 authored by Dirk Roorda on 29 April 2022, 09:43:20 UTC
safe limits on query result fetching; better precomputing, new PACK_VERSION
safe limits on query result fetching; better precomputing, new PACK_VERSION
Tip revision: e933354
lib.py
"""
# Uitility functions
Read and write TF node sets from/to file.
"""
import os
import pickle
import gzip
from .parameters import PICKLE_PROTOCOL, GZIP_LEVEL
from .core.helpers import console, expanduser
def writeSets(sets, dest):
"""Writes a dictionary of named sets to file.
The dictionary will be written as a gzipped, pickled data structure.
Intended use: if you have constructed custom node sets that you want to use
in search templates that run in the TF browser.
Parameters
----------
sets: dict of sets
The keys are names for the values, which are sets of nodes.
dest: string
A file path. You may use `~` to refer to your home directory.
The result will be written from this file.
Returns
-------
boolean
`True` if all went well, `False` otherwise.
"""
destPath = expanduser(dest)
(baseDir, fileName) = os.path.split(destPath)
if not os.path.exists(baseDir):
try:
os.makedirs(baseDir, exist_ok=True)
except Exception:
console(f'Cannot create directory "{baseDir}"', error=True)
return False
with gzip.open(destPath, "wb", compresslevel=GZIP_LEVEL) as f:
pickle.dump(sets, f, protocol=PICKLE_PROTOCOL)
return True
def readSets(source):
"""Reads a dictionary of named sets from file.
This is used by the TF browser, when the user has passed a
`--sets=fileName` argument to it.
Parameters
----------
source: string
A file path. You may use `~` to refer to your home directory.
This file must contain a gzipped, pickled data structure.
Returns
-------
data | boolean
The data structure contained in the file if all went well, False otherwise.
"""
sourcePath = expanduser(source)
if not os.path.exists(sourcePath):
console(f'Sets file "{source}" does not exist.')
return False
with gzip.open(sourcePath, "rb") as f:
sets = pickle.load(f)
return sets