PathList

(class from pyomo.common.config)

class pyomo.common.config.PathList(basePath=None, expandPath=None)[source]

Bases: Path

Domain validator for a list of path-like objects.

This admits a path-like object or iterable of such. If a path-like object is passed, then a singleton list containing the object normalized through Path is returned. An iterable of path-like objects is cast to a list, each entry of which is normalized through Path.

Parameters:

basePath (Union[None, str, ConfigValue]) – The base path that will be prepended to any non-absolute path values provided. If None, defaults to Path.BasePath.
expandPath (bool) – If True, then the value will be expanded and normalized. If False, the string representation of the value will be returned unchanged. If None, expandPath will defer to the (negated) value of Path.SuppressPathExpansion

__init__(basePath=None, expandPath=None)

Methods

`__init__`([basePath, expandPath])
`domain_name`()

Attributes

`BasePath`
`SuppressPathExpansion`

Member Documentation