fix(cli): handle agent engine deploy imports #4243

smwitkowski · 2026-01-22T21:23:18Z

Summary

This PR closes #4237

Sanitize Agent Engine temp folder names to avoid invalid Python module imports.
Adjust Agent Engine template imports to support agents located under an app/ subdirectory.
Document the fixes in the changelog.

Root Cause

Temp folders derived from agent names included hyphens, yielding invalid module paths for import.
The generated template always imported from .agent, which fails when the agent is under app/agent.py.

Testing

uv run pytest tests/unittests/cli/utils/test_cli_deploy.py
Manual E2E

gemini-code-assist · 2026-01-22T21:23:33Z

Summary of Changes

Hello @smwitkowski, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves two critical issues affecting the deployment of Agent Engines. It ensures that temporary directories created during deployment have valid Python module names by sanitizing them, and it adapts the import mechanism to correctly locate agent files whether they are at the root level or nested within an 'app/' subdirectory. These changes enhance the robustness and flexibility of the Agent Engine deployment process.

Highlights

Temporary Folder Name Sanitization: Introduced a sanitization function to replace hyphens with underscores in Agent Engine temporary folder names, resolving issues with invalid Python module imports.
Dynamic Agent Import Paths: Modified the Agent Engine deployment logic to dynamically determine the correct import module path, supporting agents located directly in the root or within an 'app/' subdirectory.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

adk-bot · 2026-01-22T21:24:20Z

Response from ADK Triaging Agent

Hello @smwitkowski, thank you for creating this PR!

This is a great bug fix. Could you please associate a GitHub issue with this PR? If there is no existing issue, could you please create one? This information will help us to track the bug and the fix more effectively. Thanks!

gemini-code-assist

Code Review

This pull request introduces two important fixes for agent engine deployment. First, it sanitizes temporary folder names by replacing hyphens to prevent invalid Python module import errors. Second, it adjusts the agent engine template to correctly handle imports for agents located within an app/ subdirectory. The changes are well-structured and address the root causes described. I've added one suggestion to make the folder name sanitization more robust against other potential invalid characters. Overall, this is a good improvement.

src/google/adk/cli/cli_deploy.py

ryanaiagent · 2026-01-23T00:29:03Z

Hi @smwitkowski , Thank you for your contribution through this pull request! This PR has merge conflicts that require changes from your end. Could you please rebase your branch with the latest main branch to address these? Once this is complete, please let us know so we can proceed with the review.

smwitkowski · 2026-01-23T14:28:04Z

Hi @ryanaiagent - I've rebased my branch with the recent changes!

cc: @wuliang229

smwitkowski · 2026-01-26T14:51:44Z

@ryanaiagent @wuliang229 - Friendly reminder, this branch is ready to be merged!

ryanaiagent · 2026-01-26T23:39:35Z

/gemini review

gemini-code-assist

Code Review

This pull request effectively addresses two critical issues related to Agent Engine deployments: invalid Python module imports due to unsanitized temporary folder names and incorrect template imports for agents located in app/ subdirectories. The introduction of the _sanitize_temp_folder_name function and the logic to dynamically determine adk_app_import_module are well-implemented solutions. The changelog has been updated to reflect these bug fixes, providing clear documentation of the improvements.

gemini-code-assist · 2026-01-26T23:41:11Z

src/google/adk/cli/cli_deploy.py

+def _sanitize_temp_folder_name(folder_name: str) -> str:
+  if not folder_name:
+    return folder_name
+  sanitized = ''.join(
+      char if char.isalnum() or char == '_' else '_' for char in folder_name
+  )
+  if sanitized and sanitized[0].isdigit():
+    return '_' + sanitized
+  return sanitized


The _sanitize_temp_folder_name function is a good addition to ensure that generated temporary folder names are valid Python module identifiers. This prevents import errors that could arise from special characters or leading digits in agent names.

gemini-code-assist · 2026-01-26T23:41:11Z

src/google/adk/cli/cli_deploy.py

  root_agent = config_agent_utils.from_config(config_path)
 else:
-  from .agent import {adk_app_object}
+  from {adk_app_import_module} import {adk_app_object}


Changing the import statement in the _AGENT_ENGINE_APP_TEMPLATE to use adk_app_import_module is crucial for supporting agents located in subdirectories. This makes the deployment process more flexible and robust.

gemini-code-assist · 2026-01-26T23:41:11Z

src/google/adk/cli/cli_deploy.py

+  raw_temp_folder = temp_folder or tmp_app_name
+  temp_folder = _sanitize_temp_folder_name(raw_temp_folder)


Applying the _sanitize_temp_folder_name function to the temp_folder variable ensures that the directory created for staging files will always be a valid Python module name, preventing potential import issues during deployment.

gemini-code-assist · 2026-01-26T23:41:11Z

src/google/adk/cli/cli_deploy.py

+    app_subdir_agent = os.path.join(agent_src_path, 'app', 'agent.py')
+    app_subdir_init = os.path.join(agent_src_path, 'app', '__init__.py')
+    root_agent_file = os.path.join(agent_src_path, 'agent.py')
+    if (
+        os.path.exists(app_subdir_agent)
+        and os.path.exists(app_subdir_init)
+        and not os.path.exists(root_agent_file)
+    ):
+      adk_app_import_module = '.app.agent'
+    else:
+      adk_app_import_module = '.agent'


The logic to determine adk_app_import_module based on the presence of app/agent.py and app/__init__.py is well-thought-out. This correctly handles the scenario where an agent is nested within an app/ subdirectory, ensuring the generated import path is accurate.

gemini-code-assist · 2026-01-26T23:41:11Z

src/google/adk/cli/cli_deploy.py

              agent_folder=f'./{temp_folder}',
              adk_app_object=adk_app_object,
              adk_app_type=adk_app_type,
+              adk_app_import_module=adk_app_import_module,


Passing the newly determined adk_app_import_module to the _AGENT_ENGINE_APP_TEMPLATE is the final step to ensure the generated adk_app.py file uses the correct import path for the agent.

ryanaiagent · 2026-01-27T08:39:36Z

Hi @smwitkowski , Your PR has been received by the team and is currently under review. We will provide feedback as soon as we have an update to share.

adk-bot added the tools [Component] This issue is related to tools label Jan 22, 2026

gemini-code-assist bot reviewed Jan 22, 2026

View reviewed changes

src/google/adk/cli/cli_deploy.py Outdated Show resolved Hide resolved

smwitkowski mentioned this pull request Jan 22, 2026

ADK fails to deploy with 1.18.0 and above #4237

Open

wuliang229 self-assigned this Jan 22, 2026

ryanaiagent added the request clarification [Status] The maintainer need clarification or more information from the author label Jan 23, 2026

smwitkowski force-pushed the fix/agent-engine-deploy-imports branch from 3215a43 to dbd8014 Compare January 23, 2026 14:27

smwitkowski added 2 commits January 26, 2026 09:49

fix(cli): fix agent engine deploy imports

c42f151

fix(cli): harden temp folder sanitization

be9a166

smwitkowski force-pushed the fix/agent-engine-deploy-imports branch from dbd8014 to be9a166 Compare January 26, 2026 14:49

gemini-code-assist bot reviewed Jan 26, 2026

View reviewed changes

ryanaiagent added needs review [Status] The PR/issue is awaiting review from the maintainer and removed request clarification [Status] The maintainer need clarification or more information from the author labels Jan 26, 2026

Merge branch 'main' into fix/agent-engine-deploy-imports

803200d

		raw_temp_folder = temp_folder or tmp_app_name
		temp_folder = _sanitize_temp_folder_name(raw_temp_folder)

fix(cli): handle agent engine deploy imports #4243

Are you sure you want to change the base?

fix(cli): handle agent engine deploy imports #4243

Conversation

smwitkowski commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Root Cause

Testing

Uh oh!

gemini-code-assist bot commented Jan 22, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

adk-bot commented Jan 22, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

ryanaiagent commented Jan 23, 2026

Uh oh!

smwitkowski commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smwitkowski commented Jan 26, 2026

Uh oh!

ryanaiagent commented Jan 26, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

ryanaiagent commented Jan 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

smwitkowski commented Jan 22, 2026 •

edited

Loading

smwitkowski commented Jan 23, 2026 •

edited

Loading