Skip to main content
`Ctrl`+`K`

# ng911ok.tools._tool module

class DocumentableTool

  Bases: `_Documentable`

  Tool …

  Jinja variables:

  - `create_date` - `YYYYMMDD` date string

  - `create_time` - `HHMMSS00` time string, where `00` is literal

  - `mod_date` - `YYYYMMDD` date string

  - `mod_time` - `HHMMSS00` time string, where `00` is literal

  - `min_scale` - ???; default `150000000`

  - `max_scale` - ???; default `5000`

  - `tool` - `DocumentableTool` class/subclass

  _parse_docstring() → ...
  execute(parameters: list[Parameter], messages: GPMessenger)

    The source code of the tool.

  getParameterInfo() → list[Parameter]

    Define the tool parameters. By default, this uses all the :class:`~._paramfactory.ParameterFactory` instances registered in this class’s :attr:`_parameter_factories` attribute.

  isLicensed() → bool

    Set whether the tool is licensed to execute.

  postExecute(parameters: list[Parameter])

    This method takes place after outputs are processed and added to the display.

  updateMessages(parameters: list[Parameter])

    Modify the messages created by internal validation for each tool parameter. This method is called after internal validation.

  updateParameters(parameters: list[Parameter])

    Modify the values and properties of parameters before internal validation is performed. This method is called whenever a parameter has been changed.

  _abc_impl = <_abc._abc_data object>
  _category: ClassVar[str | None] = None
  _description: ClassVar[str] = ''
  _is_protocol = False
  _label: ClassVar[str] = ''
  _parameter_factories: ClassVar[list[ParameterFactory]] = []

class DocumentableToolbox

  Bases: `_Documentable`

  Toolbox …

  Jinja variables:

  - `create_date` - `YYYYMMDD` date string

  - `create_time` - ???

  - `mod_date` - `YYYYMMDD` date string

  - `mod_time` - ???

  - `min_scale` - ???; default `150000000`

  - `max_scale` - ???; default `5000`

  - `toolbox_name` - Stem of the toolbox file name

  - `toolbox` - `DocumentableToolbox` instance

  _abc_impl = <_abc._abc_data object>
  _alias: ClassVar[str] = ''
  _is_protocol = False
  _label: ClassVar[str] = ''
  _tools: ClassVar[list[type[DocumentableTool]]] = []

class _Documentable(*args, **kwargs)

  Bases: `Protocol`

  _parse_docstring() → ...
  _abc_impl = <_abc._abc_data object>
  _is_protocol = True

document_toolbox(pyt_path: Path)