pestifer.subcommands.cache module

The cache subcommand. Inspect, clear, or rebuild pestifer’s on-disk caches (the parsed CHARMM force field, the PDB repository, and the residue-name lookup index).

class pestifer.subcommands.cache.CacheSubcommand(name: str = 'cache', aliases: list = <factory>, log_file: str = 'pestifer_diagnostics.log', short_help: str = "inspect, clear, or rebuild pestifer's on-disk caches", long_help: str = "Manage pestifer's per-user caches (the parsed CHARMM force field, the PDB repository, and the residue-name lookup index): 'status' lists them, 'clear' deletes them, and 'rebuild' force-rebuilds them.", func_returns_type: type = <class 'bool'>, parser: argparse.ArgumentParser = None)

Bases: Subcommand

add_subparser(subparsers)

Adds the subcommand parser to the given subparsers. Subclasses declare arguments here, after a super().add_subparser() call.

static func(args: Namespace, **kwargs)

the function that executes the subcommand. Subclasses must implement this method.

long_help: str = "Manage pestifer's per-user caches (the parsed CHARMM force field, the PDB repository, and the residue-name lookup index): 'status' lists them, 'clear' deletes them, and 'rebuild' force-rebuilds them."

description

name: str = 'cache'

subcommand name

short_help: str = "inspect, clear, or rebuild pestifer's on-disk caches"

help string