jan/masque
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improve DeviceLibrary docstring

Browse Source
This commit is contained in:
jan 2022-02-27 21:15:05 -08:00
parent f178e94d82
commit 86315fc32b
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
masque/library/device_library.py
View File

@ -7,7 +7,7 @@ from typing import Any, Tuple, Union, Iterator
import logging import logging
from pprint import pformat from pprint import pformat
from ..error import LibraryError from ..error import DeviceLibraryError
if TYPE_CHECKING: if TYPE_CHECKING:
from ..builder import Device from ..builder import Device
@ -21,10 +21,16 @@ L = TypeVar('L', bound='DeviceLibrary')
class DeviceLibrary: class DeviceLibrary:
""" """
This class is usually used to create a device library by mapping names to This class maps names to functions which generate or load the
functions which generate or load the relevant `Device` object as-needed. relevant `Device` object.
The cache can be disabled by setting the `enable_cache` attribute to `False`. This class largely functions the same way as `Library`, but
operates on `Device`s rather than `Patterns` and thus has no
need for distinctions between primary/secondary devices (as
there is no inter-`Device` hierarchy).
Each device is cached the first time it is used. The cache can
be disabled by setting the `enable_cache` attribute to `False`.
""" """
generators: Dict[str, Callable[[], 'Device']] generators: Dict[str, Callable[[], 'Device']]
cache: Dict[Union[str, Tuple[str, str]], 'Device'] cache: Dict[Union[str, Tuple[str, str]], 'Device']