Welcome to dol’s documentation!
Contents:
- dol
- dol.appendable
- dol.base
- dol.caching
ApplyToInstanceApplyToMethodNameCachedMethodCachedPropertyCompositeKeyExplicitKeyFromMethodArgsHashableDictInstancePropKeyStrategyWriteBackChainMapadd_extension()cache_property_method()cache_this()cache_vals()cached_method()ensure_clear_to_kv_store()get_cache()identity()is_a_cache()lru_cache_method()mk_cached_store()mk_memoizer()mk_sourced_store()mk_write_cached_store()register_key_strategy()store_cached()store_cached_with_single_key()
- dol.dig
- dol.errors
- dol.explicit
- dol.filesys
DirCollectionDirReaderFileBytesPersisterFileBytesReaderFileCollectionFileInfoReaderFileStringPersisterFileStringReaderFileSysCollectionFilesFilesReaderJsonFilesJsonsKeyValidationErrorMakeMissingDirsStoreMixinPickleFilesPickleStorePickleStoresRelPathFileBytesPersisterRelPathFileBytesReaderRelPathFileStringPersisterRelPathFileStringReaderTextFilesTextFilesReadercreate_directories()ensure_dir()ensure_slash_suffix()iter_dirpaths_in_folder_recursively()iter_filepaths_in_folder_recursively()mk_dirs_if_missing()mk_dirs_if_missing_preset()mk_tmp_dol_dir()process_path()resolve_dir()resolve_path()subfolder_stores()temp_dir()
- dol.kv_codecs
- dol.misc
- dol.mixins
- dol.naming
BigDocTestKeyMapNamesKeyMapsLinearNamingParametricKeyStorePartialFormatterStoreWithDictKeysStoreWithNamedTupleKeysStoreWithTupleKeysStrTupleDictWithPrefixdict_to_namedtuple()get_fields_from_template()mk_kwargs_trans()mk_pattern_from_template_and_format_dict()mk_store_from_path_format_store_cls()mk_tupled_store_from_path_format_store_cls()namedtuple_to_dict()update_fields_of_namedtuple()validate_kwargs()
- dol.paths
ExplicitKeysWithPrefixRelativizationKeyPathKeyTemplatePathKeyTypesPathMappedDataPrefixRelativizationPrefixRelativizationMixinadd_prefix_filtering()chain_of_getters()ensure_path_extender_func()flatten_dict()flattened_dict_items()get_attr_or_item()handle_prefixes()keys_and_indices_path()leaf_paths()mk_relative_path_store()path_edit()path_filter()path_get()path_set()paths_getter()rel_path_wrap()search_paths()separator_based_path_extender()str_template_key_trans()string_unparse()
- dol.recipes
- dol.scrap
- dol.scrap.new_store_wrap
- dol.scrap.store_factories
- dol.signatures
FuncCallNotMatchingSignatureIncompatibleSignaturesInvalidSignatureMissingArgValForPParamSigSigPairall_pk_signature()assure_params()call_forgivingly()call_somewhat_forgivingly()ch_func_to_all_pk()ch_signature_to_all_pk()ch_variadics_to_non_variadic_kind()common_and_diff_argnames()copy_func()defaults_are_the_same_when_not_empty()dflt1_is_empty_or_dflt2_is_not()dflt1_is_empty_or_dflt2_is_not_param_comparator()dict_of_attribute_signatures()ensure_params()extract_arguments()extract_arguments_asserting_no_remainder()extract_arguments_ignoring_remainder()has_signature()insert_annotations()is_call_compatible_with()is_signature_error()keyed_comparator()kind_forgiving_func()mk_sig_from_args()name_of_obj()param_binary_func()param_comparator()param_comparison_dict()param_differences_dict()param_for_kind()permissive_param_comparator()postprocess()replace_kwargs_using()resolve_function()set_signature_of_func()sig_to_dataclass()sort_params()tuple_the_args()use_interface()validate_signature()
- dol.sources
- dol.tests.base_test
- dol.tests.pickability_test
- dol.tests.scrap
- dol.tests.test_appendable
- dol.tests.test_caching
- dol.tests.test_dol_tools
- dol.tests.test_edge_cases
- dol.tests.test_fanout_stores
- dol.tests.test_filesys
- dol.tests.test_kv_codecs
- dol.tests.test_paths
- dol.tests.test_trans
- dol.tests.utils_for_tests
- dol.tools
- dol.trans
CachedInvertibleTransCodecFirstArgIsMappingKeyCodecKeyValueCodecMapInvertabilityErrorOverWritesNotAllowedMixinValueCodecadd_aliases()add_decoder()add_ipython_key_completions()add_missing_key_handling()add_path_access()add_path_get()add_store_method()add_wrapper_method()affix_key_codec()assert_min_num_of_args()cache_iter()cached_keys()catch_and_cache_error_keys()constant_output()double_up_as_factory()ensure_clear_method()filt_iter()filter_prefixes()filter_regex()filter_suffixes()flatten()insert_aliases()insert_hash_method()insert_load_dump_aliases()kv_wrap()kv_wrap_persister_cls()mk_kv_reader_from_kv_collection()mk_level_walk_filt()mk_trans_obj()mk_wrapper()redirect_getattr_to_getitem()store_decorator()wrap_kvs()
- dol.util
AttributeMappingAttributeMutableMappingFolderSpecLiteralValPipeadd_as_attribute_of()add_attrs()chain_get()copy_attrs()decorate_callables()fill_with_dflts()flatten_pipe()format_invocation()get_app_config_folder()get_app_data_folder()get_app_folder()groupby()has_enabled_clear_method()igroupby()imdictinject_method()instance_checker()invertible_maps()is_classmethod()is_unbound_method()lazyproplazyprop_w_sentinelmax_common_prefix()named_partial()non_colliding_key()norm_kv_filt()not_a_mac_junk_path()num_of_args()num_of_required_args()partialclass()read_from_bytes()regroupby()safe_compile()staticpropertystr_to_var_str()truncate_string_with_marker()written_bytes()written_key()
- dol.zipfiledol
EmptyZipErrorFileStreamsOfZipFilesOfZipFlatZipFilesReaderOverwriteNotAllowedZipFileStreamsReaderZipFilesZipFilesReaderZipFilesReaderAndBytesWriterZipInfoReaderZipReaderZipStorefile_or_folder_to_zip_file()if_i_zipped_stats()mk_flatzips_store()remove_mac_junk_from_zip()remove_some_entries_from_zip()to_zip_file()zip_compress()zip_decompress()
Indices and tables
Release: 0.3.30
Last change: Oct 29, 2025