NIFI-13745 StateManager available via the Python API #9419
Conversation
There was a problem hiding this comment.
Thanks for putting together support for Component State management @pgyori. The package naming and general exception handling approach looks good. The documentation and tests are also very helpful.
I raised a couple questions regarding implementation details.
| if self._java_statemap.getStateVersion().isEmpty(): | ||
| return None | ||
| else: | ||
| return self._java_statemap.getStateVersion().get() |
There was a problem hiding this comment.
It looks like this could be set in the constructor.
| """ | ||
| return self.to_dictionary() | ||
|
|
||
| def to_dictionary(self): |
There was a problem hiding this comment.
Is there a reason for defining this method separately from toMap?
| try: | ||
| self._java_state_manager.setState(convert_pydict_to_jmap(state), convert_pyscope_to_jscope(scope)) | ||
| except Py4JJavaError as exception: | ||
| raise StateException(str(exception)) from None |
There was a problem hiding this comment.
It seems like it would be better to chain the original exception, as opposed to stringifying it as shown. Is there a particular reason for not chaining the exception?
| raise StateException(str(exception)) from None | |
| raise StateException("Set state failed") from exception |
| The StateManager Python class propagates the method calls to the underlying Java StateManager object. | ||
| When an operation fails on the Java side, a Py4JJavaError is produced on the Python side by the Py4J bridge. | ||
| This Py4JJavaError is caught in the Python StateManager and raised as a StateException instead, | ||
| indicating that the exception carries information regarding an error when accessing the state. |
There was a problem hiding this comment.
This comment seems more appropriate on the State Manager class, as opposed to the exception itself.
Summary
NIFI-13745
Tracking
Please complete the following tracking steps prior to pull request creation.
Issue Tracking
Pull Request Tracking
NIFI-00000NIFI-00000Pull Request Formatting
mainbranchVerification
Please indicate the verification steps performed prior to pull request creation.
Build
mvn clean install -P contrib-checkLicensing
LICENSEandNOTICEfilesDocumentation