Create Python,yml #13809
Create Python,yml #13809
Conversation
|
Here is the summary of possible violations 😱 DetailsThere are 2 possible violations for not having product prefix.
The end of the violation section. All the stuff below is FYI purposes only. Here is the summary of changes. You are about to add 2 region tags.
This comment is generated by snippet-bot.
|
product-auto-label
bot
added
the
samples
Summary of ChangesHello @gniumg-source, I'm Gemini Code Assist1! 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 introduces a foundational document that standardizes the development and testing practices for Python samples. It aims to ensure consistency, readability, and maintainability across all Python contributions, providing clear guidelines for authors and reviewers alike. Highlights
Changelog
Activity
Using Gemini Code AssistThe 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
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 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new authoring guide for Python samples. The guide is comprehensive and covers many important aspects of sample development. I've found a few issues in the code examples and commands that could be corrected to improve clarity and prevent errors for users. Also, the filename Python,yml seems unusual for a Markdown file; the comma is likely a typo and the extension should probably be .md.
| audio_config = texttospeech.AudioConfig( | ||
| audio_encoding=texttospeech.AudioEncoding.MP3 | ||
| ) |
There was a problem hiding this comment.
The variable texttospeech is used here, but it's not defined. Based on the import on line 198, it should be texttospeech_v1.
audio_config = texttospeech_v1.AudioConfig(
audio_encoding=texttospeech_v1.AudioEncoding.MP3
)
|
|
||
|
|
||
| def create_folder(bucket_name: str, folder_name: str) -> None: | ||
| print(f"Created folder: {response.name}") |
There was a problem hiding this comment.
The response variable is used here without being defined, which will cause a NameError. The example function should include the logic that produces the response object.
| [gsutil](https://cloud.google.com/storage/docs/gsutil). For example: | ||
|
|
||
| ```console | ||
| gsutil cp ./samples/snippets/resources/* gs://{$CLOUD_STORAGE_BUCKET}/ |
There was a problem hiding this comment.
The shell variable syntax is incorrect. It should be ${CLOUD_STORAGE_BUCKET} instead of {$CLOUD_STORAGE_BUCKET}.
gsutil cp ./samples/snippets/resources/* gs://${CLOUD_STORAGE_BUCKET}/
|
|
||
| ```py | ||
| def adder(a: int, b: int) -> int: | ||
| return a+b |
There was a problem hiding this comment.
According to PEP 8, there should be a space around operators. The example should be return a + b.
return a + b
| from google.api_core.retry import Retry | ||
|
|
||
| @Retry() | ||
| def test_quickstart_v2() -> None: |
There was a problem hiding this comment.
The example test_quickstart_v2 uses os, uuid4, and re, but the necessary imports are not shown. To make the example more complete and easier to use, please consider adding import os, from uuid import uuid4, and import re at the beginning of the snippet.
| # We add timestamp for making the query faster. | ||
| now = datetime.datetime.now(datetime.timezone.utc) | ||
| filter_date = now - datetime.timedelta(minutes=1) | ||
| filters = ( | ||
| f"timestamp>=\"{filter_date.isoformat('T')}\" " | ||
| "resource.type=cloud_run_revision " | ||
| "AND severity=NOTICE " | ||
| ) |
There was a problem hiding this comment.
The indentation in this code block is incorrect and inconsistent. Also, the project variable used on line 728 is not defined. Please correct the indentation and clarify where project should come from.
# We add timestamp for making the query faster.
now = datetime.datetime.now(datetime.timezone.utc)
filter_date = now - datetime.timedelta(minutes=1)
filters = (
f"timestamp>=\"{filter_date.isoformat('T')}\" "
"resource.type=cloud_run_revision "
"AND severity=NOTICE "
)
| nox -s py-3.7 -- snippets_test.py | ||
| ``` | ||
|
|
||
| To run a specific test from a specific following: |
There was a problem hiding this comment.
There's a typo here. 'following' should probably be 'file'.
To run a specific test from a specific file:
|
Closing as spam, will block the user if there's any more. |
2 participants
@beccasaurus #13808
@lukesneeringer #4745
@hfwang #13807
@inklesspen #13806
@jskeet Wwg
Description
Fixes #
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
nox -s py-3.9(see Test Environment Setup)nox -s lint(see Test Environment Setup)