recent_items_list

Provides finite length Last Recently Used (LRU) caches.

RecentItemsList

A class which stores any type of object.

Appending or "bump"-ing items adds them to the beginning of the list. If the "maxlen" number of items already exist, the last item is dropped from the list.

By default, only the last 10 items are kept in the list. You can change this by setting the "maxlen" property. Setting the "maxlen" property to < 1 makes for an infinite length list, constrained only by system resourecs.

bump

Bump the given item to the beginning of the list. If the given item is not in the list, inserts it at the beginning.

recent_items.bump(thing)

append

Alias of "bump"

remove

Removes the given item if it is in the list. Does nothing if the item is not in the list.

recent_items.remove(thing)

on_change

Registers a callback which is run every time the list changes. The callback must have the signature:

def item_list_changed(self, items: list):

...where "item_list_changed" is an example function name.

clear

Removes all items from the list

RecentFilesList

This class extends RecentItemsList, providing a "prune" function to clear the list only of files which don't exist.

prune

Removes files which no longer exist.

Example:

This is a simple implementation of a "Recent Files" menu in PyQt.

Instantiation:

def __init__(self):
	self.recent_files = RecentFilesList(
		self.settings.value("RecentFiles", defaultValue = []))
	self.menuOpen_Recent.aboutToShow.connect(self.fill_recent_file_menu)

Filling the Qt menu:

@pyqtSlot()
def fill_recent_file_menu(self):
	self.menuOpen_Recent.clear()
	actions = []
	for filename in self.recent_files:
		action = QAction(filename, self)
		action.triggered.connect(partial(self.load_file, filename))
		actions.append(action)
	self.menuOpen_Recent.addActions(actions)

Opening a file:

def open(self, filename):
	self.recent_files.bump(filename)
	[...]

Saving to a QSettings instance:

self.settings.setValue("RecentFiles", self.recent_files.items)

"RecentFiles" above is the setting key. It's just a string value. It could be anything.

on_change callback

An alternate method of saving the most recent file list without having to explicitly save the changes, is to provide a callback which will be called whenever the list changes, which saves the list to QSettings:

self.recent_files = RecentFilesList(
	self.settings.value("RecentFiles", defaultValue = []))
self.recent_files.on_change(self.save_recent_files)

def save_recent_files(self, items):
	self.settings.setValue("RecentFiles", items)

Another complete example:

from functools import partial
from qt_extras.settings import init_settings, get_setting, set_setting
from recent_items_list import RecentFilesList

class Window(QMainWindow):

	def __init__(self):
		super().__init__()
		init_settings("ZenSoSo", __package__)
		self.recent_files = RecentFilesList(get_setting("RecentFiles", []))
		recent_files.list.on_change(self.sync_recent_files)
		self.menuOpen_Recent.aboutToShow.connect(self.fill_recent_file_menu)

	def sync_recent_files(self, items):
		set_setting("RecentFiles", items)

	@pyqtSlot()
	def fill_recent_file_menu(self):
		self.menuOpen_Recent.clear()
		actions = []
		for filename in recent_files().prune():
			action = QAction(filename, self)
			action.triggered.connect(partial(self.load_file, filename))
			actions.append(action)
		self.menuOpen_Recent.addActions(actions)

	def load_file(self, filename):
		self.recent_files.bump(filename)