feat(blocks): add text encoder block #11313

aryancodes1 · 2025-11-04T12:18:16Z

🧾 Issue Number: #11111

🚧 Changes

Added TextEncoderBlock — A new block that encodes text by adding escape sequences for special characters such as newlines and quotes.

✨ Key Features

Input: Accepts a text string that may contain special characters (\n, ", etc.)
Output: Returns the same text with proper escape sequences applied
Encoding Method: Uses Python’s codecs.encode() with "unicode_escape" to handle encoding
Use Case: Ideal for preparing text data for systems that require escaped characters

⚙️ Technical Details

Attribute	Description
Block ID	`1b2c3d4-e5f6-4789-a012-3456789abcde`
Category	`BlockCategory.TEXT`
Functionality	Converts special characters to escaped equivalents

Character Conversions:

Character	Encoded As
Newline (`\n`)	`\\n`
Double Quote (`"`)	`\"`
Other Special Characters	Escaped using `unicode_escape`

🧪 Example

Input:

Hello
World!
This is a "quoted" string.

Output:

Hello\\nWorld!\\nThis is a \\"quoted\\" string.

🧩 Code to Test

cd AutoGPT/autogpt_platform/backend

poetry run python -c "
import asyncio
from backend.blocks.encoder_block import TextEncoderBlock

async def test_encoder():
    block = TextEncoderBlock()
    print(f'Block ID: {block.id}')
    print(f'Block Name: {block.name}')
    
    input_data = block.Input(text='Hello\nWorld!\nThis is a \"quoted\" string.')
    async for output_name, output_value in block.run(input_data):
        print(f'Output: {output_name} = {repr(output_value)}')
        
    print('✅ TextEncoderBlock test passed!')

asyncio.run(test_encoder())
"

✅ Expected Output:

Block ID: 3681f9ef-9558-54fe-95d8-81e768034342
Block Name: TextEncoderBlock
Output: text = 'Hello\\nWorld!\\nThis is a \\"quoted\\" string.'
✅ TextEncoderBlock test passed!

🧠 Test Plan

Manual Test
- Ran the provided test script to verify correct escaping of special characters.
- Verified both the input and output printed correctly in the terminal.
- Confirmed no runtime or async errors occurred.
Edge Case Checks
- Tested empty string input ("") — output remained unchanged.
- Tested strings with multiple special characters (\t, \r, \", \\) — all escaped correctly.
- Verified that unicode characters (e.g., emojis, accented letters) were preserved.

✅ PR Checklist

Code builds and runs locally without errors
All existing tests pass successfully
Added new test coverage for TextEncoderBlock
Verified functionality manually via test script
Added detailed PR description following template
Ensured no breaking changes introduced
Confirmed correct block ID and category registration
Verified code style and linting compliance

CLAassistant · 2025-11-04T12:18:24Z

All committers have signed the CLA.

github-actions · 2025-11-04T12:18:29Z

This PR targets the master branch but does not come from dev or a hotfix/* branch.

Automatically setting the base branch to dev.

netlify · 2025-11-04T12:18:29Z

✅ Deploy Preview for auto-gpt-docs canceled.

Name	Link
🔨 Latest commit	`68ef264`
🔍 Latest deploy log	https://app.netlify.com/projects/auto-gpt-docs/deploys/69444a321f117700086cf4a3

qodo-code-review · 2025-11-04T12:18:48Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Encoding Behavior Using codecs.encode(..., "unicode_escape") will escape all non-ASCII and special characters, which may be broader than intended (e.g., emojis, non-Latin characters). Verify this matches product requirements versus only escaping newlines and quotes. async def run(self, input_data: Input, kwargs) -> BlockOutput: encoded_text = codecs.encode(input_data.text, "unicode_escape").decode("ascii") yield "encoded_text", encoded_text Unused Import The uuid module is imported but not used. Consider removing it to keep the module clean. import codecs import uuid Output Name Consistency** Ensure downstream consumers expect the output key named `encoded_text` (not `text`). Validate consistency with block interface and any existing pipelines/tests. class Output(BlockSchemaOutput): encoded_text: str = SchemaField( description="The encoded text with escape sequences added" )

coderabbitai · 2025-11-04T12:18:53Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

deepsource-io · 2025-11-04T12:19:00Z

Here's the code health analysis summary for commits 4c47441..68ef264. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
JavaScript	✅ Success		View Check ↗
Python	✅ Success		View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

AutoGPT-Agent · 2025-11-04T12:19:20Z

Thank you for your contribution adding the TextEncoderBlock! The implementation looks well-structured and includes good documentation in your PR description.

However, there are two issues that need to be addressed before this can be merged:

Missing Checklist: Your PR is missing the required checklist that helps ensure all necessary testing and verification has been completed. Please update your PR description to include the checklist section from the PR template and complete it appropriately.
PR Title Format: Your title needs to follow our conventional commit format. Instead of "added-encoder", please update it to something like:
feat(blocks): add text encoder block

Once these issues are addressed, we can proceed with reviewing the technical implementation, which looks promising.

AutoGPT-Agent · 2025-11-04T12:19:37Z

Thank you for contributing the TextEncoderBlock! The implementation looks solid and well-documented. However, there are a couple of process items that need to be addressed before this can be merged:

The PR title needs to follow conventional commit format. Please update it to something like: feat(platform/blocks): add text encoder block
The PR description is missing the required checklist from our PR template. Please update the description to include the checklist and check off the appropriate items. Since this is a code change, you'll need to include:
- Confirmation that you've clearly listed changes
- Confirmation that you've made a test plan
- Details about your test plan and confirmation that you've tested according to it

Your description has good technical details about the block's functionality, which is great! Just need these process items addressed to comply with our PR requirements.

autogpt_platform/backend/backend/blocks/encoder_block.py

+        )
+
+    async def run(self, input_data: Input, **kwargs) -> BlockOutput:
+        encoded_text = codecs.encode(input_data.text, "unicode_escape").decode("ascii")


netlify · 2025-11-04T12:22:15Z

✅ Deploy Preview for auto-gpt-docs-dev canceled.

Name	Link
🔨 Latest commit	`68ef264`
🔍 Latest deploy log	https://app.netlify.com/projects/auto-gpt-docs-dev/deploys/69444a3216047f000828d8a4

AutoGPT-Agent · 2025-11-04T12:23:31Z

Thank you for contributing this TextEncoderBlock! The code and implementation look solid, and your PR description does a good job explaining the functionality and providing test examples.

However, there are two issues that need to be addressed before this can be merged:

PR Title Format: Your title needs to follow our conventional commit format. Please update it to something like:
feat(blocks): add text encoder block
Missing Checklist: Your PR description is missing the required checklist section. Since this is adding new code, please include the standard checklist from our PR template and check off the relevant items, particularly around testing.

Once these issues are fixed, this PR should be ready for review again. The actual implementation looks good and the block functionality is clearly defined.

AutoGPT-Agent · 2025-11-04T12:44:09Z

Thank you for contributing this TextEncoderBlock! The implementation looks good and your PR description is detailed with clear examples.

Before this can be merged, there's one main issue that needs to be addressed:

The PR title needs to follow our conventional commit format. Please update it to something like: feat(platform/blocks): add text encoder block

Other notes:

Since this is a straightforward addition, the checklist omission is fine, but for future PRs please include the standard checklist from our template.
The implementation is clean and focused on a single functionality which is good.
The test example in your description is helpful for reviewers.

Once you update the PR title to follow our conventional commit format, this should be ready for merging.

AutoGPT-Agent · 2025-11-04T12:57:55Z

Thank you for adding the TextEncoderBlock! The implementation looks good and your PR description is quite detailed.

However, I noticed the PR is missing the required checklist from our template. Since this is a material code change (adding a new block), please update your PR description to include the complete checklist with all items checked off appropriately.

Specifically, we need to see:

Confirmation that you've tested your changes
Your test plan

Once you add the completed checklist, this PR should be good to go!

AutoGPT-Agent · 2025-11-04T13:13:31Z

Thank you for your detailed PR adding the TextEncoderBlock! The description is thorough and includes good examples and test cases.

I have two issues that need to be addressed before this can be merged:

Missing Checklist: Your PR is missing the required checklist. Please add the checklist from the PR template and complete it accordingly.
Block ID Inconsistency: In your PR description, you mention the Block ID as 3681f9ef-9558-54fe-95d8-81e768034342, but in your implementation, you're using a1b2c3d4-e5f6-4789-a012-3456789abcde. Please make sure these are consistent - preferably use a properly generated UUID rather than a placeholder.

Otherwise, the code looks good and follows the expected patterns for block implementation. The function's purpose is clearly defined, and you've provided good test cases.

AutoGPT-Agent · 2025-11-04T13:15:47Z

Thank you for submitting this PR to add a TextEncoderBlock. Your implementation looks good, with clear documentation and test examples.

However, there's one issue that needs to be addressed before this can be approved:

The PR description is missing the required checklist. Please update your PR description to include the standard checklist (for code changes) with all items checked off as appropriate.

The rest of your PR looks solid:

Your code is well-implemented with clear structure
The test plan is thorough
The documentation is excellent, with examples and use cases
The PR title follows our conventional commit format correctly

Once you add the required checklist to the PR description, this should be ready for approval.

ntindle · 2025-12-18T17:35:02Z

autogpt_platform/backend/backend/blocks/encoder_block.py

+
+    def __init__(self):
+        super().__init__(
+            id="a1b2c3d4-e5f6-4789-a012-3456789abcde",


@cursor regenrate this block id using python's uuid function for a v4 uuid

@ntindle I updated the block ID with a v4 uuid

autogpt_platform/backend/backend/blocks/encoder_block.py

+
+    def __init__(self):
+        super().__init__(
+            id=str(uuid.uuid4()),


autogpt_platform/backend/backend/blocks/encoder_block.py

+    def __init__(self):
+        super().__init__(
+            id=str(uuid.uuid4()),
+            description="Encodes a string by adding escape sequences for special characters",


added-encoder

41e8756

aryancodes1 requested a review from a team as a code owner November 4, 2025 12:18

aryancodes1 requested review from Bentlybro and Pwuts and removed request for a team November 4, 2025 12:18

github-project-automation bot added this to AutoGPT development kanban Nov 4, 2025

github-project-automation bot moved this to 🆕 Needs initial review in AutoGPT development kanban Nov 4, 2025

github-actions bot added the platform/blocks label Nov 4, 2025

github-actions bot changed the base branch from master to dev November 4, 2025 12:18

github-actions bot added the size/m label Nov 4, 2025

qodo-code-review bot added the Review effort 2/5 label Nov 4, 2025

sentry bot reviewed Nov 4, 2025

View reviewed changes

autogpt_platform/backend/backend/blocks/encoder_block.py Outdated

)

async def run(self, input_data: Input, **kwargs) -> BlockOutput:

encoded_text = codecs.encode(input_data.text, "unicode_escape").decode("ascii")

This comment was marked as outdated.

Sign in to view

Merge branch 'dev' into fix/issue-#11111

e038b71

aryancodes1 added 2 commits November 4, 2025 18:12

fixed-encoder

5436295

added

8e743ee

aryancodes1 changed the title ~~added-encoder~~ feat(blocks): add text encoder block Nov 4, 2025

add-feature

75fd130

fix encoder

c2d7af3

new-fix

af25f92

ntindle reviewed Dec 18, 2025

View reviewed changes

made-changes

d4e99b9

sentry bot reviewed Dec 18, 2025

View reviewed changes

autogpt_platform/backend/backend/blocks/encoder_block.py Outdated

def __init__(self):

super().__init__(

id=str(uuid.uuid4()),

This comment was marked as outdated.

Sign in to view

Merge branch 'dev' into fix/issue-#11111

2f73700

sentry bot reviewed Dec 18, 2025

View reviewed changes

autogpt_platform/backend/backend/blocks/encoder_block.py

def __init__(self):

super().__init__(

id=str(uuid.uuid4()),

description="Encodes a string by adding escape sequences for special characters",

This comment was marked as outdated.

Sign in to view

aryancodes1 added 3 commits December 18, 2025 23:57

changed-uuid

f16eedc

changed uuid

6373945

changed uuid

68ef264

feat(blocks): add text encoder block #11313

Are you sure you want to change the base?

feat(blocks): add text encoder block #11313

Uh oh!

Conversation

aryancodes1 commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧾 Issue Number: #11111

🚧 Changes

✨ Key Features

⚙️ Technical Details

Character Conversions:

🧪 Example

🧩 Code to Test

🧠 Test Plan

✅ PR Checklist

Uh oh!

CLAassistant commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 4, 2025

Uh oh!

netlify bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for auto-gpt-docs canceled.

Uh oh!

qodo-code-review bot commented Nov 4, 2025

PR Reviewer Guide 🔍

Uh oh!

coderabbitai bot commented Nov 4, 2025

Review skipped

Uh oh!

deepsource-io bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

netlify bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for auto-gpt-docs-dev canceled.

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

AutoGPT-Agent commented Nov 4, 2025

Uh oh!

ntindle Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

aryancodes1 Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aryancodes1 commented Nov 4, 2025 •

edited

Loading

CLAassistant commented Nov 4, 2025 •

edited

Loading

netlify bot commented Nov 4, 2025 •

edited

Loading

deepsource-io bot commented Nov 4, 2025 •

edited

Loading

netlify bot commented Nov 4, 2025 •

edited

Loading

aryancodes1 Dec 18, 2025 •

edited

Loading