Index

A

add_aliases() (in module dol.trans) add_append_functionality_to_store_cls() (in module dol.appendable) add_as_attribute_of() (in module dol.util) add_attrs() (in module dol.util) add_decoder() (in module dol.trans) add_extension() (in module dol.caching) add_invertible_key_decoder() (in module dol.kv_codecs) add_ipython_key_completions() (in module dol.trans) add_missing_key_handling() (in module dol.trans) add_optional_keywords() (dol.signatures.Sig method) add_params() (dol.signatures.Sig method) add_path_access() (in module dol.trans) add_path_get() (in module dol.trans) add_prefix_filtering() (in module dol.paths) add_store_method() (in module dol.trans) add_wrapper_method() (in module dol.trans) affix_key_codec() (in module dol.trans)

all_pk_signature() (in module dol.signatures) AlreadyExists annotations (dol.signatures.Sig property) appendable() (in module dol.appendable) ApplyToInstance (class in dol.caching) ApplyToMethodName (class in dol.caching) are_call_compatible() (dol.signatures.SigPair method) args_and_kwargs_from_kwargs() (dol.signatures.Sig method) ask_user_for_value_when_missing() (in module dol.tools) assert_min_num_of_args() (in module dol.trans) assure_params() (in module dol.signatures) attr() (dol.appendable.mk_item2kv_for static method) AttrContainer (class in dol.sources) AttrDict (class in dol.sources) AttributeMapping (class in dol.util) AttributeMutableMapping (class in dol.util) Attrs (class in dol.sources)

B

b64 (dol.kv_codecs.ValueCodecs attribute)

BigDocTest (class in dol.naming)

C

cache_iter() (in module dol.trans) cache_property_method() (in module dol.caching) cache_this() (in module dol.caching) cache_vals() (in module dol.caching) cached_keys() (in module dol.trans) cached_method() (in module dol.caching) CachedInvertibleTrans (class in dol.trans) CachedKeysSequenceKvReader (class in dol.sources) CachedMethod (class in dol.caching) CachedProperty (class in dol.caching) CachedSequenceKvReader (class in dol.sources) call_forgivingly() (in module dol.signatures) call_somewhat_forgivingly() (in module dol.signatures) CascadedStores (class in dol.sources) catch_and_cache_error_keys() (in module dol.trans) ch_func_to_all_pk() (in module dol.signatures) ch_param_attrs() (dol.signatures.Sig method) ch_signature_to_all_pk() (in module dol.signatures) ch_variadics_to_non_variadic_kind() (in module dol.signatures)

chain_get() (in module dol.util) chain_of_getters() (in module dol.paths) check_by_iteration() (in module dol.scrap.store_factories) check_by_trying_to_get() (in module dol.scrap.store_factories) clear() (dol.base.KvPersister method) Codec (class in dol.trans) CodecCollection (class in dol.kv_codecs) Collection (class in dol.base) common_and_diff_argnames() (in module dol.signatures) common_prefix_keys_wrap() (in module dol.kv_codecs) CompositeKey (class in dol.caching) confirm_overwrite() (in module dol.tools) constant_output() (in module dol.trans) convert_to_numerical_if_possible() (in module dol.tools) copy_attrs() (in module dol.util) copy_func() (in module dol.signatures) count_by_iteration() (in module dol.scrap.store_factories) create_directories() (in module dol.filesys) csv_dict_decode() (in module dol.kv_codecs) csv_dict_encode() (in module dol.kv_codecs)

D

Ddir (in module dol.sources) decorate_callables() (in module dol.util) default_delete_func() (in module dol.trash) default_path (dol.util.FolderSpec attribute) defaults (dol.signatures.Sig property) defaults_are_the_same_when_not_empty() (in module dol.signatures) define_extend_as_seq_of_appends() (in module dol.appendable) delegator_wrap() (in module dol.base) deleter() (dol.scrap.store_factories.StoreShell method) DeletionsNotAllowed dflt1_is_empty_or_dflt2_is_not() (in module dol.signatures) dflt1_is_empty_or_dflt2_is_not_param_comparator() (in module dol.signatures) dict_of_attribute_signatures() (in module dol.signatures) dict_to_namedtuple() (dol.paths.KeyTemplate method) (in module dol.naming) dict_to_str() (dol.paths.KeyTemplate method) dict_to_tuple() (dol.paths.KeyTemplate method) diff() (dol.signatures.SigPair method) diff_str() (dol.signatures.SigPair method) DirCollection (class in dol.filesys) DirReader (class in dol.filesys) dol module dol.appendable module dol.base module dol.caching module dol.dig module dol.errors module dol.explicit module dol.filesys module dol.kv_codecs module dol.misc module

dol.mixins module dol.naming module dol.paths module dol.recipes module dol.scrap module dol.scrap.new_store_wrap module dol.scrap.store_factories module dol.signatures module dol.sources module dol.tests.scrap module dol.tests.test_appendable module dol.tests.test_kv_codecs module dol.tests.test_trans module dol.tests.utils_for_tests module dol.tools module dol.trans module dol.trash module dol.util module dol.zipfiledol module double_up_as_factory() (in module dol.trans)

E

EmptyZipError ensure_clear_method() (in module dol.trans) ensure_clear_to_kv_store() (in module dol.caching) ensure_dir() (in module dol.filesys) ensure_params() (in module dol.signatures) ensure_path_extender_func() (in module dol.paths) ensure_slash_suffix() (in module dol.filesys) env_var (dol.util.FolderSpec attribute) ExplicitKey (class in dol.caching) ExplicitKeymapReader (class in dol.explicit) ExplicitKeys (class in dol.explicit)

ExplicitKeysSource (class in dol.explicit) ExplicitKeysStore (class in dol.explicit) ExplicitKeysWithPrefixRelativization (class in dol.paths) extend() (dol.appendable.Extender method) Extender (class in dol.appendable) extension_based() (dol.kv_codecs.KeyValueCodecs method) extract_args_and_kwargs() (dol.signatures.Sig method) extract_arguments() (in module dol.signatures) extract_arguments_asserting_no_remainder() (in module dol.signatures) extract_arguments_ignoring_remainder() (in module dol.signatures) extract_kwargs() (dol.signatures.Sig method)

F

FanoutPersister (class in dol.sources) FanoutReader (class in dol.sources) field() (dol.appendable.mk_item2kv_for static method) fields() (dol.appendable.mk_item2kv_for static method) file_or_folder_to_zip_file() (in module dol.zipfiledol) FileBytesPersister (class in dol.filesys) FileBytesReader (class in dol.filesys) FileCollection (class in dol.filesys) FileInfoReader (class in dol.filesys) Files (class in dol.filesys) FilesOfZip (class in dol.zipfiledol) FilesReader (class in dol.filesys) FileStreamsOfZip (class in dol.zipfiledol) FileStringPersister (class in dol.filesys) FileStringReader (class in dol.filesys) FileSysCollection (class in dol.filesys) fill_with_dflts() (in module dol.util) filt_iter() (dol.paths.KeyTemplate method) (in module dol.trans) filter_prefixes() (in module dol.trans)

filter_regex() (in module dol.trans) filter_suffixes() (in module dol.trans) FilteredKeysMixin (class in dol.mixins) FirstAppendOnly (class in dol.appendable) FirstArgIsMapping (class in dol.trans) FlatReader (class in dol.sources) flatten() (in module dol.trans) flatten_dict() (in module dol.paths) flatten_pipe() (in module dol.util) flattened_dict_items() (in module dol.paths) FlatZipFilesReader (class in dol.zipfiledol) FolderSpec (class in dol.util) Forest (class in dol.tools) format_invocation() (in module dol.util) from_mapping() (dol.util.AttributeMapping class method) from_variadics() (dol.sources.CascadedStores method) (dol.sources.FanoutReader class method) FromMethodArgs (class in dol.caching) FuncCallNotMatchingSignature FuncDag (class in dol.sources) FuncReader (class in dol.sources)

G

get() (dol.base.Store method) get_app_config_folder() (in module dol.util) get_app_data_folder() (in module dol.util) get_app_folder() (in module dol.util) get_attr_or_item() (in module dol.paths) get_cache() (in module dol.caching)

get_fields_from_template() (in module dol.naming) get_names() (dol.signatures.Sig method) get_obj() (in module dol.misc) get_platform_trash_func() (in module dol.trash) get_val() (dol.util.LiteralVal method) getter() (dol.scrap.store_factories.KvReaderShell method) groupby() (in module dol.util)

H

handle_prefixes() (in module dol.paths) has_enabled_clear_method() (in module dol.util) has_kv_store_interface() (in module dol.base) has_signature() (in module dol.signatures) has_var_keyword (dol.signatures.Sig property)

has_var_kinds (dol.signatures.Sig property) has_var_positional (dol.signatures.Sig property) HashableDict (class in dol.caching) head() (dol.base.KvReader method) (dol.base.Store method)

I

id_of_key (dol.naming.KeyMaps attribute) identity() (in module dol.caching) IdentityKeysWrapMixin (class in dol.mixins) IdentityKvWrapMixin (class in dol.mixins) IdentityValsWrapMixin (class in dol.mixins) if_i_zipped_stats() (in module dol.zipfiledol) igroupby() (in module dol.util) ihead() (in module dol) imdict (class in dol.util) IncompatibleSignatures index_of_var_keyword (dol.signatures.Sig property) index_of_var_positional (dol.signatures.Sig property) inject_into_keyword_variadic (dol.signatures.Sig property) inject_method() (in module dol.util) insert_aliases() (in module dol.trans) insert_annotations() (in module dol.signatures) insert_hash_method() (in module dol.trans) insert_load_dump_aliases() (in module dol.trans) instance_checker() (in module dol.util) InstanceProp (class in dol.caching)

InvalidSignature invert() (dol.trans.Codec method) invertible_maps() (in module dol.util) io (dol.kv_codecs.ValueCodecs attribute) is_a_cache() (in module dol.caching) is_call_compatible_with() (dol.signatures.Sig method) (in module dol.signatures) is_classmethod() (in module dol.util) is_contained() (dol.scrap.store_factories.KvReaderShell method) is_signature_error() (in module dol.signatures) is_unbound_method() (in module dol.util) is_valid_prefix() (dol.naming.StrTupleDictWithPrefix method) iSliceStore (class in dol.tools) item_to_key() (dol.appendable.mk_item2kv_for static method) item_to_key_params_and_val() (dol.appendable.mk_item2kv_for static method) items_with_caught_exceptions() (in module dol.errors) iter_dirpaths_in_folder_recursively() (in module dol.filesys) iter_filepaths_in_folder_recursively() (in module dol.filesys) IterationNotAllowed IterBasedSizedContainerMixin (class in dol.mixins)

J

JsonFiles (class in dol.filesys)

Jsons (class in dol.filesys)

K

key_based() (dol.kv_codecs.KeyValueCodecs method) key_based_codec_factory() (in module dol.kv_codecs) key_based_value_trans() (in module dol.kv_codecs) key_codec() (dol.paths.KeyTemplate method) key_of_id (dol.naming.KeyMaps attribute) KeyCodec (class in dol.trans) KeyCodecs (class in dol.kv_codecs) keyed_comparator() (in module dol.signatures) KeyMapNames (in module dol.naming) KeyMaps (class in dol.naming) KeyPath (class in dol.paths) keys_and_indices_path() (in module dol.paths) KeysReader (class in dol.explicit) KeyStrategy (class in dol.caching) KeyTemplate (class in dol.paths)

KeyValidationABC (class in dol.base) KeyValidationError, [1] KeyValueCodec (class in dol.trans) KeyValueCodecs (class in dol.kv_codecs) kind_forgiving_func() (in module dol.signatures) kv_pairs() (dol.appendable.mk_item2kv_for static method) kv_walk() (in module dol.base) kv_wrap() (in module dol.trans) kv_wrap_persister_cls() (in module dol.trans) kvhead() (in module dol) KvPersister (class in dol.base) KvReader (class in dol.base) KvReaderShell (class in dol.scrap.store_factories) KvStore (in module dol.base) kwargs_from_args_and_kwargs() (dol.signatures.Sig method)

L

lazyprop (class in dol.util) lazyprop_w_sentinel (class in dol.util) leaf_paths() (in module dol.paths) LinearNaming (in module dol.naming)

lister() (dol.scrap.store_factories.KvReaderShell method) LiteralVal (class in dol.util) LocalFileDeleteMixin (class in dol.filesys) lru_cache_method() (in module dol.caching)

M

make_safe_delete_func() (in module dol.trash) MakeMissingDirsStoreMixin (class in dol.filesys) map_arguments() (dol.signatures.Sig method) map_arguments_from_variadics() (dol.signatures.Sig method) MapInvertabilityError mapped_keys() (dol.kv_codecs.KeyCodecs method) match_str() (dol.paths.KeyTemplate method) max_common_prefix() (in module dol.util) merge_with_sig() (dol.signatures.Sig method) MethodFuncNotValid MethodNameAlreadyExists MiscGetter (class in dol.misc) MiscGetterAndSetter (class in dol.misc) MiscReaderMixin (class in dol.misc) MiscStoreMixin (class in dol.misc) MissingArgValFor (class in dol.signatures) mk_args_and_kwargs() (dol.signatures.Sig method) mk_cached_store() (in module dol.caching) mk_dirs_if_missing() (in module dol.filesys) mk_dirs_if_missing_preset() (in module dol.filesys) mk_flatzips_store() (in module dol.zipfiledol) mk_item2kv_for (class in dol.appendable) mk_kv_reader_from_kv_collection() (in module dol.trans) mk_kwargs_trans() (in module dol.naming) mk_level_walk_filt() (in module dol.trans) mk_memoizer() (in module dol.caching) mk_pattern_from_template_and_format_dict() (in module dol.naming) mk_relative_path_store() (in module dol.paths) mk_sig_from_args() (in module dol.signatures) mk_sourced_store() (in module dol.caching) mk_store_from_path_format_store_cls() (in module dol.naming) mk_test_store_from_keys() (in module dol.tests.utils_for_tests) mk_tmp_dol_dir() (in module dol.filesys) mk_trans_obj() (in module dol.trans)

mk_tupled_store_from_path_format_store_cls() (in module dol.naming) mk_wrapper() (in module dol.trans) mk_write_cached_store() (in module dol.caching) modified() (dol.signatures.Sig method) module dol dol.appendable dol.base dol.caching dol.dig dol.errors dol.explicit dol.filesys dol.kv_codecs dol.misc dol.mixins dol.naming dol.paths dol.recipes dol.scrap dol.scrap.new_store_wrap dol.scrap.store_factories dol.signatures dol.sources dol.tests.scrap dol.tests.test_appendable dol.tests.test_kv_codecs dol.tests.test_trans dol.tests.utils_for_tests dol.tools dol.trans dol.trash dol.util dol.zipfiledol MultiSource (class in dol.sources)

N

n_required (dol.signatures.Sig property) name_of_obj() (in module dol.signatures) named_partial() (in module dol.util) namedtuple_to_dict() (dol.paths.KeyTemplate method) (in module dol.naming) names_for_kind() (dol.signatures.Sig method) names_missing_in_sig1 (dol.signatures.SigPair property) names_missing_in_sig2 (dol.signatures.SigPair property) non_colliding_key() (in module dol.util)

norm_kv_filt() (in module dol.util) NoSuchKeyError not_a_mac_junk_path() (in module dol.util) NotAllowed NotGiven (class in dol.kv_codecs) NotUnique NotValid num_of_args() (in module dol.util) num_of_required_args() (in module dol.util)

O

ObjReader (class in dol.sources) OperationNotAllowed OverwriteNotAllowed

OverWritesNotAllowedError OverWritesNotAllowedMixin (class in dol.mixins) (class in dol.trans)

P

P (in module dol.signatures) pair_with() (dol.signatures.Sig method) Param (class in dol.signatures) param_binary_func() (in module dol.signatures) param_comparator() (in module dol.signatures) param_comparison() (dol.signatures.SigPair method) param_comparison_dict() (in module dol.signatures) param_differences() (dol.signatures.SigPair method) param_differences_dict() (in module dol.signatures) param_for_kind() (in module dol.signatures) ParametricKeyStore (class in dol.naming) params (dol.signatures.Sig property) partialclass() (in module dol.util) PartialFormatter (class in dol.naming) path_edit() (in module dol.paths) path_filter() (in module dol.paths)

path_get() (in module dol.paths) path_set() (in module dol.paths) PathKeyTypes (class in dol.paths) PathMappedData (class in dol.paths) paths_getter() (in module dol.paths) permanent_delete() (in module dol.trash) permissive_param_comparator() (in module dol.signatures) Persister (in module dol.base) pformat() (dol.signatures.IncompatibleSignatures method) PickleFiles (class in dol.filesys) PickleStore (in module dol.filesys) PickleStores (class in dol.filesys) Pipe (class in dol.util) postprocess() (in module dol.signatures) PrefixRelativization (class in dol.paths) PrefixRelativizationMixin (class in dol.paths) process_path() (in module dol.filesys)

R

read_add_write() (in module dol.appendable) read_from_bytes() (in module dol.util) Reader (in module dol.base) ReadOnlyMixin (class in dol.mixins) ReadsNotAllowed redirect_getattr_to_getitem() (in module dol.trans) register_key_strategy() (in module dol.caching) regroupby() (in module dol.util) rel_path_wrap() (in module dol.paths) RelPathFileBytesPersister (in module dol.filesys) RelPathFileBytesReader (in module dol.filesys) RelPathFileStringPersister (in module dol.filesys) RelPathFileStringReader (in module dol.filesys) remove_mac_junk_from_zip() (in module dol.zipfiledol) remove_some_entries_from_zip() (in module dol.zipfiledol) replace_kwargs_using() (dol.signatures.Sig method) (in module dol.signatures)

required_names (dol.signatures.Sig property) resolve_at_definition() (dol.caching.ApplyToInstance method) (dol.caching.ApplyToMethodName method) (dol.caching.CompositeKey method) (dol.caching.ExplicitKey method) (dol.caching.FromMethodArgs method) (dol.caching.InstanceProp method) (dol.caching.KeyStrategy method) resolve_at_runtime() (dol.caching.ApplyToInstance method) (dol.caching.CompositeKey method) (dol.caching.FromMethodArgs method) (dol.caching.InstanceProp method) (dol.caching.KeyStrategy method) resolve_dir() (in module dol.filesys) resolve_function() (in module dol.signatures) resolve_path() (in module dol.filesys)

S

safe_compile() (in module dol.util) search_paths() (in module dol.paths) (in module dol.recipes) separator_based_path_extender() (in module dol.paths) SequenceKvReader (class in dol.sources) set_obj() (in module dol.misc) set_signature_of_func() (in module dol.signatures) SetattrNotAllowed setter() (dol.scrap.store_factories.StoreShell method) shared_names (dol.signatures.SigPair property) Sig (class in dol.signatures) sig_or_default() (dol.signatures.Sig class method) sig_or_none() (dol.signatures.Sig class method) sig_to_dataclass() (in module dol.signatures) SigPair (class in dol.signatures) simple_str_to_str() (dol.paths.KeyTemplate method) simple_str_to_tuple() (dol.paths.KeyTemplate method) SimpleJsonMixin (class in dol.mixins) single_nested_value() (dol.kv_codecs.ValueCodecs method) single_to_str() (dol.paths.KeyTemplate method) sizer() (dol.scrap.store_factories.KvReaderShell method) sort_params() (dol.signatures.Sig method) (in module dol.signatures) source_args_and_kwargs() (dol.signatures.Sig method)

source_arguments() (dol.signatures.Sig method) source_kwargs() (dol.signatures.Sig method) staticproperty (class in dol.util) Store (class in dol.base) store_aggregate() (in module dol.tools) store_cached() (in module dol.caching) store_cached_with_single_key() (in module dol.caching) store_decorator() (in module dol.trans) StoreShell (class in dol.scrap.store_factories) StoreWithDictKeys (class in dol.naming) StoreWithNamedTupleKeys (class in dol.naming) StoreWithTupleKeys (class in dol.naming) str_template_key_trans() (in module dol.paths) str_to_dict() (dol.paths.KeyTemplate method) str_to_namedtuple() (dol.paths.KeyTemplate method) str_to_simple_str() (dol.paths.KeyTemplate method) str_to_single() (dol.paths.KeyTemplate method) str_to_tuple() (dol.paths.KeyTemplate method) str_to_var_str() (in module dol.util) Stream (class in dol.base) string_unparse() (in module dol.paths) StringKvWrap (class in dol.mixins) StrTupleDictWithPrefix (class in dol.naming) subfolder_stores() (in module dol.filesys)

T

temp_dir() (in module dol.filesys) template_to_pattern() (in module dol.naming) test_filter_regex_is_os_independent() (in module dol.tests.test_trans) TextFiles (class in dol.filesys) TextFilesReader (class in dol.filesys) to_signature_kwargs() (dol.signatures.Sig method) to_simple_signature() (dol.signatures.Sig method)

to_zip_file() (in module dol.zipfiledol) trace_getitem() (in module dol.dig) trash_only() (in module dol.trash) truncate_string_with_marker() (in module dol.util) tuple_of_dict() (dol.kv_codecs.ValueCodecs method) tuple_the_args() (in module dol.signatures) tuple_to_dict() (dol.paths.KeyTemplate method) tuple_to_str() (dol.paths.KeyTemplate method)

U

update() (dol.sources.Attrs method) (dol.sources.CachedKeysSequenceKvReader method) update_fields_of_namedtuple() (in module dol.naming) update_keys_cache() (dol.sources.Attrs method) (dol.sources.CachedKeysSequenceKvReader method)

use_interface() (in module dol.signatures) utc_key() (dol.appendable.mk_item2kv_for static method) uuid_key() (dol.appendable.mk_item2kv_for static method)

V

validate_kwargs() (in module dol.naming) validate_signature() (in module dol.signatures) ValueCodec (class in dol.trans)

ValueCodecs (class in dol.kv_codecs) ValueCodecs.default (class in dol.kv_codecs) ValueCodecs.methodcaller (class in dol.kv_codecs)

W

with_defaults (dol.signatures.Sig property) with_relative_paths() (dol.filesys.FileSysCollection method) without_defaults (dol.signatures.Sig property) wrap() (dol.base.Store class method) (dol.base.Stream class method) (dol.signatures.Sig method)

wrap_kvs() (in module dol.trans) WriteBackChainMap (class in dol.caching) WritesNotAllowed written_bytes() (in module dol.util) written_key() (in module dol.util)

Z

zip_compress() (dol.kv_codecs.ValueCodecs method) (in module dol.zipfiledol) zip_decompress() (dol.kv_codecs.ValueCodecs method) (in module dol.zipfiledol) ZipFiles (class in dol.zipfiledol)

ZipFilesReader (class in dol.zipfiledol) ZipFilesReaderAndBytesWriter (class in dol.zipfiledol) ZipFileStreamsReader (class in dol.zipfiledol) ZipInfoReader (class in dol.zipfiledol) ZipReader (class in dol.zipfiledol) ZipStore (in module dol.zipfiledol)