sphinx.util.FilenameUniqDict

class documentation

class FilenameUniqDict(dict): (source)

A dictionary that automatically generates unique names for its keys, interpreted as filenames, and keeps track of a set of docnames they appear in. Used for images and downloadable files in the environment.

Method	`__getstate__`	Undocumented
Method	`__init__`	Undocumented
Method	`__setstate__`	Undocumented
Method	`add_file`	Undocumented
Method	`merge_other`	Undocumented
Method	`purge_doc`	Undocumented
Instance Variable	`_existing`	Undocumented

def __getstate__(self): (source) ¶

Undocumented

Returns
`set[str]`	Undocumented

def __init__(self): (source) ¶

Undocumented

def __setstate__(self, state): (source) ¶

Undocumented

Parameters
state:`set[str]`	Undocumented

def add_file(self, docname, newfile): (source) ¶

Undocumented

Parameters
docname:`str`	Undocumented
newfile:`str`	Undocumented
Returns
`str`	Undocumented

def merge_other(self, docnames, other): (source) ¶

Undocumented

Parameters
docnames:`set[str]`	Undocumented
other:`dict[str, tuple[set[str], Any]]`	Undocumented

def purge_doc(self, docname): (source) ¶

Undocumented

Parameters
docname:`str`	Undocumented

_existing = (source) ¶

Undocumented