refactor(dns): fix sample 'create_zone'

[eapl-gemugami]

Description

Fixes Internal: b/347349999

• As per the Style guide, move the sample to a separate file.
• Update sample to latest best practices for Python 3.13 and style guide.
• Fix invalid region tag.

Checklist

• I have followed Sample Guidelines from AUTHORING_GUIDE.MD
• README is updated to include all relevant information
• Tests pass: nox -s py-3.9 (see Test Environment Setup)
• Lint pass: nox -s lint (see Test Environment Setup)
• Please merge this PR for me once it is approved

[gemini-code-assist]

Hello @eapl-gemugami, 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!

Summary of Changes

This pull request addresses issue b/347349999 by refactoring the 'create_zone' sample in the dns/api directory. The changes include updating the sample to align with the latest best practices for Python 3.13 and the Google Cloud Samples style guide. Additionally, the pull request fixes an invalid region tag in the sample code. The changes involve modifications to the README.rst, conftest.py, create_zone.py, create_zone_test.py, main.py, main_test.py, and the removal of noxfile_config.py.

Highlights

• Python Version Update: The README.rst file has been updated to reflect compatibility with Python 3.9+ instead of Python 2.7 and 3.4+.
• Sample Restructuring: The 'create_zone' function has been extracted from main.py into its own file create_zone.py, and a corresponding test file create_zone_test.py has been added.
• Test Improvements: The test setup has been improved by introducing a conftest.py file to manage test fixtures, including client and zone creation and deletion.
• Code Modernization: The code has been updated to use type hints and follows the latest Google Cloud Samples style guide.
• Nox Configuration: The noxfile_config.py file has been removed, suggesting that the configuration is now handled elsewhere, possibly within the noxfile.py itself or through other means.

Changelog

Click here to see the changelog

• dns/api/README.rst
  • Updated compatible Python versions to 3.9+.
• dns/api/conftest.py
  • Introduced a new conftest.py file to handle test fixtures for client and zone management.
  • Includes fixtures for client, zone, project_id, zone_name, zone_dns_name, and zone_description.
• dns/api/create_zone.py
  • Created a new file containing the 'create_zone' function, extracted from main.py.
  • Includes type hints and docstrings.
• dns/api/create_zone_test.py
  • Created a new test file for the 'create_zone' function.
  • Uses pytest and includes a flaky mark.
• dns/api/main.py
  • Removed the 'create_zone' function and imported it from create_zone.py.
  • Minor formatting changes and removal of blank lines.
• dns/api/main_test.py
  • Removed client and zone fixtures, relying on the new conftest.py.
  • Updated tests to remove client and zone arguments.
  • Removed google.cloud imports.
• dns/api/noxfile_config.py
  • Removed the noxfile_config.py file.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

---

Did you know?

The .rst file extension stands for reStructuredText, a file format for textual data used primarily in the Python programming language community for technical documentation.

Footnotes

1. 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. ↩

[gemini-code-assist]

Code Review

The pull request refactors the 'create_zone' sample to align with the latest best practices for Python 3.13 and the project's style guide. It also fixes an invalid region tag. The changes include updating the README, adding a conftest.py file for test configuration, modifying the create_zone.py file, adding a create_zone_test.py file, and updating main.py and main_test.py to reflect the refactoring.

Merge Readiness

The pull request appears to be well-structured and addresses the issues outlined in the description. The code changes seem to improve the sample's adherence to best practices and fix the identified bug. Given the absence of any identified issues, the pull request seems ready for merging. However, I am unable to directly approve the pull request, and other reviewers should also review and approve this code before merging.

[snippet-bot]

Here is the summary of changes.

You are about to add 1 region tag.

• dns/api/create_zone.py:21, tag dns_create_zone

You are about to delete 1 region tag.

• dns/api/main.py:21, tag create_zone

---

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

• Refresh this comment