PathData

(class from pyomo.common.fileutils)

class pyomo.common.fileutils.PathData(manager, name)

Bases: object

An object for storing and managing a PathManager path

__init__(manager, name)

Methods

__init__(manager, name)
available()	Returns True if the registered path is available.
disable()	Disable this path entry
get_path()	DEPRECATED.
path()	Return the full, normalized path to the registered path entry.
rehash()	Requery the location of this path entry
set_path(value)

Member Documentation

available()

Returns True if the registered path is available.

Entries are available if the object was found found in the search locations and has not been explicitly disabled.

disable()

Disable this path entry

This method “disables” this path entry by marking it as “not found”. Disabled entries return False for available() and None for path(). The disabled status will persist until the next call to rehash().

get_path()

DEPRECATED.

Deprecated since version 5.6.2: get_path() is deprecated; use pyomo.common.Executable(name).path()

path()

Return the full, normalized path to the registered path entry.

If the object is not found (or was marked “disabled”), path() returns None.

rehash()

Requery the location of this path entry

This method derives its name from the csh command of the same name, which rebuilds the hash table of executables reachable through the PATH.