Build Status

Platform	Python Version	Status
ubuntu	3.5
	3.6
	3.7
	3.8
macos	3.5
	3.6
	3.7
	3.8
windows	3.5
	3.6
	3.7
	3.8

Demo

Environment Variables

Environment variable name	Default value	Explanation
PYFILEDIR_CANDIDATE_SEP	\n	how pyfiledir join candidates
PYFILEDIR_WILDCARD	,	wildcard character when doing match
PYFILEDIR_ADD_TRAILING_SLASH	True	add trailing slash for directory candidate
PYFILEDIR_KEEP_LEADING_DOT_SLASH	True	keep leading ./ in path
PYFILEDIR_COMPLETE_COMMON_PREFIX	True	complete common prefix of candidates first
PYFILEDIR_EXPAND_TIDLE	False	expand ~ to /home/<user>
PYFILEDIR_IGNORE_CASE	True	completion ignore case
PYFILEDIR_USE_UNIHAN_DICT	True	use rich Unihan dict
PYFILEDIR_USE_NATURAL_SORT	False	use natural sort, sorting filenames

pyfiledir default following some behaviors from .inputrc, see equivalents below:

INPUTRC setting name	PYFILEDIR environment variable name
mark-directories	PYFILEDIR_ADD_TRAILING_SLASH
completion-ignore-case	PYFILEDIR_IGNORE_CASE
expand-tilde	PYFILEDIR_EXPAND_TIDLE

Development Guide

Create Demo

python helper/create_demo.py &

Profiling

requirements: python 3.7

python -m cProfile -m pyfiledir [option] <arg>

testing

enable pyfiledir tests verbose debug.

pytest --pyfiledir-debug -s

PYTEST_ADDOPTS='--pyfiledir-debug -s' pytest

Installation

readline

if you don't like default key binding ALT+/,
   you could define your own key binding.

add following lines to your .bashrc.

source shell/readline_completion.bash

source shell/readline_key_binding.bash