docutils.utils.DependencyList Class Reference

Public Member Functions
	__init__ (self, output_file=None, dependencies=())
	set_output (self, output_file)
	add (self, *paths)
	close (self)
	__repr__ (self)

Public Attributes
	list
	file

Detailed Description

List of dependencies, with file recording support.

Note that the output file is not automatically closed.  You have
to explicitly call the close() method.

Constructor & Destructor Documentation

__init__()

docutils.utils.DependencyList.__init__	(		self,
			output_file = None,
			dependencies = ()
	)

Initialize the dependency list, automatically setting the
output file to `output_file` (see `set_output()`) and adding
all supplied dependencies.

If output_file is None, no file output is done when calling add().

Member Function Documentation

add()

docutils.utils.DependencyList.add	(		self,
		*	paths
	)

Append `path` to `self.list` unless it is already there.

Also append to `self.file` unless it is already there
or `self.file is `None`.

close()

docutils.utils.DependencyList.close

(

self

)

Close the output file.

set_output()

docutils.utils.DependencyList.set_output	(		self,
			output_file
	)

Set the output file and clear the list of already added
dependencies.

`output_file` must be a string.  The specified file is
immediately overwritten.

If output_file is '-', the output will be written to stdout.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/utils/__init__.py