Rename flowfile module to ff_kernel across codebase#325
Open
Edwardvaneechoud wants to merge 2 commits intofeauture/kernel-implementationfrom
Open
Rename flowfile module to ff_kernel across codebase#325Edwardvaneechoud wants to merge 2 commits intofeauture/kernel-implementationfrom
Edwardvaneechoud wants to merge 2 commits intofeauture/kernel-implementationfrom
Conversation
The kernel runtime previously injected a module called 'flowfile' into the user's execution namespace, which caused confusion with the top-level flowfile package. This renames the injected namespace variable to 'ff_kernel' to clearly distinguish the kernel-side data I/O and artifact API from the broader FlowFile ecosystem. Changes: - kernel_runtime/main.py: inject as 'ff_kernel' with deprecated 'flowfile' alias that emits DeprecationWarning on first use - Frontend completions, API help, and default code templates updated - All test inline code strings updated to use ff_kernel - kernel_runtime/README.md documentation updated https://claude.ai/code/session_01EuVZrAvHRhfChnx4AK63ss
Drop the _DeprecatedFlowfileAlias proxy and the 'flowfile' key from exec_globals entirely. The kernel namespace now only exposes 'ff_kernel'. https://claude.ai/code/session_01EuVZrAvHRhfChnx4AK63ss
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR renames the
flowfilemodule toff_kernelthroughout the codebase to better reflect its purpose as a kernel-level API for code execution within the FlowFile system.Key Changes
Test files: Updated all test code snippets in
test_global_artifacts_kernel_integration.pyandtest_kernel_integration.pyto useff_kernelinstead offlowfilefor all API calls (read_input, publish_output, publish_artifact, read_artifact, delete_artifact, list_artifacts, publish_global, get_global, list_global_artifacts, delete_global_artifact, etc.)Frontend documentation: Updated the API help modal (
FlowfileApiHelp.vue) to referenceff_kernelin all code examples and API documentation sections (Data I/O, Artifacts, Display, Global Artifacts, and Logging)Frontend code completions: Updated autocomplete suggestions in
flowfileCompletions.tsto useff_kernelmodule name and updated all function detail strings to reflect the new module nameFrontend templates: Updated default Python script template in
utils.tsto useff_kernel.read_input()andff_kernel.publish_output()Documentation: Updated
kernel_runtime/README.mdto referenceff_kernelmodule in all code examples and explanations throughout the documentationImplementation Details
The rename is consistent across:
This change improves clarity by using a more specific name (
ff_kernel) that better indicates this is the kernel-level API, distinguishing it from other potential FlowFile APIs.https://claude.ai/code/session_01EuVZrAvHRhfChnx4AK63ss