mru

Small Python module to manage Most Recently Used (MRU) file paths.


License
MIT
Install
pip install mru==0.1.0

Documentation

Travis Coveralls Conda PyPI

MRU

Small Python module to manage Most Recently Used (MRU) file paths.

Say you want to remember the most recently used files so the user can quickly select one of these next time the application is launched. This module will manage that for you:

>>> from mru import MRU
>>> history = MRU(app='Economy App', org='Balliol College')
>>> history.add('~/Documents/Intro.pdf')
>>> pass  # ...later...
>>> history.add('~/Documents/The Wealth of Nations.pdf')
>>> history[0]
'~/Documents/The Wealth of Nations.pdf'

Entries are automatically saved to disk, so opening the application again works as aspected:

>>> from mru import MRU
>>> history = MRU(app='Economy App', org='Balliol College')
>>> list(history)
['~/Documents/The Wealth of Nations.pdf', '~/Documents/Intro.pdf']

MRU instances are iterables (collections.deque, more precisely). So you can iterate over the object directly, convert to lists etc. The most recent item comes first:

>>> for path in history:
...     print(path)
...
~/Documents/The Wealth of Nations.pdf
~/Documents/Intro.pdf

By default, the MRU module remembers up to 20 paths. Change this like this:

>>> history = MRU(app='Economy App', org='Balliol College', maxlen=10)

To remove all entries:

>>> history.clear()
>>> list(history)
[]

Where are the MRU entries saved? Depending on the platform, somewhere in the user's profile:

>>> history.file_path
'C:\\Users\\Adam Smith\\AppData\\Local\\Balliol College\\Economy App\\mru'

Assuming you're Adam Smith and you use Windows, that is!

MRU uses the AppDirs module to find a suitable location using user_config_dir(app, org). The organisation name is optional, but omitting it risks that the MRU will be saved in another application's configuration folder.

Licence

Distributed under the MIT licence.