diff --git a/CHANGES.md b/CHANGES.md index 210c864..8a57f5f 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,10 @@ # fmetools changes +## 0.7.4 + +* Update doc for `fmetools.paramparsing` to note FME 2024 requirement + when running under FME Flow. + ## 0.7.3 * Add links to HTML docs. diff --git a/src/fmetools/__init__.py b/src/fmetools/__init__.py index 610093a..993ff18 100644 --- a/src/fmetools/__init__.py +++ b/src/fmetools/__init__.py @@ -1,6 +1,6 @@ # coding: utf-8 -__version__ = "0.7.3" +__version__ = "0.7.4" import gettext import os diff --git a/src/fmetools/paramparsing.py b/src/fmetools/paramparsing.py index ef26a3a..f105c51 100644 --- a/src/fmetools/paramparsing.py +++ b/src/fmetools/paramparsing.py @@ -1,9 +1,15 @@ """ This module provides :class:`TransformerParameterParser`, -the recommended way to access transformer parameter values in FME 2023+. +the recommended way to access transformer parameter values. -.. note:: - This module can only be imported in FME 2023 or newer. +.. warning:: + This module requires: + + - FME Form 2023 b23224 or newer + - FME Flow 2024 b24145 or newer + + Packages using this module and targeting both FME Form and FME Flow + should set ``minimum_fme_build`` in its package.yml accordingly. """ from __future__ import annotations @@ -21,6 +27,10 @@ class TransformerParameterParser: """ Helper for getting parsed transformer parameter values. + .. warning:: + Instantiating this class on FME Flow requires FME Flow b24145 or newer. + Instantiating the class on older versions of FME Flow will raise an exception. + All parameters of Python transformers are set as attributes on input features. By convention, these attributes are given a prefix to give it a namespace and signify that they are internal attributes.