Skip to content

Commit 5741faa

Browse files
m-strzelczykm-strzelczyk
authored
cleanup(compute): Cleaning up code for Compute samples (GoogleCloudPlatform#9083)
Fixing multiple small issues common to many Compute samples: 1. Unnecessary `return`s at the end of functions. 2. Unused imports. 3. Incorrect usage of `NoReturn` type hint. 4. Any minor issue I found during this cleanup. Please pay attention only to files in the `compute/client_library/ingredients/` folder, the rest is generated from the ingredients, so it just a lot of repeated changes.
1 parent 51b64b0 commit 5741faa

95 files changed

Lines changed: 241 additions & 308 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎compute/client_library/ingredients/disks/autodelete_change.py‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,12 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
from typing import NoReturn
21-
2219

2320
from google.cloud import compute_v1
2421

2522

2623
# <INGREDIENT set_disk_autodelete>
27-
def set_disk_autodelete(project_id: str, zone: str, instance_name: str, disk_name: str, autodelete: bool) -> NoReturn:
24+
def set_disk_autodelete(project_id: str, zone: str, instance_name: str, disk_name: str, autodelete: bool) -> None:
2825
"""
2926
Set the autodelete flag of a disk to given value.
3027
@@ -49,5 +46,4 @@ def set_disk_autodelete(project_id: str, zone: str, instance_name: str, disk_nam
4946
operation = instance_client.update(project=project_id, zone=zone, instance=instance_name, instance_resource=instance)
5047

5148
wait_for_extended_operation(operation, "disk update")
52-
return
5349
# </INGREDIENT>

‎compute/client_library/ingredients/disks/create_empty_disk.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
2119
from google.cloud import compute_v1
2220

2321

‎compute/client_library/ingredients/disks/create_from_image.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
2119
from google.cloud import compute_v1
2220

2321

‎compute/client_library/ingredients/disks/create_kms_encrypted_disk.py‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,16 @@
2222

2323

2424
# <INGREDIENT create_kms_encrypted_disk>
25-
def create_kms_encrypted_disk(project_id: str, zone: str, disk_name: str, disk_type: str,
26-
disk_size_gb: int, kms_key_name: str,
27-
disk_link: Optional[str] = None, image_link: Optional[str] = None) -> compute_v1.Disk:
25+
def create_kms_encrypted_disk(
26+
project_id: str,
27+
zone: str,
28+
disk_name: str,
29+
disk_type: str,
30+
disk_size_gb: int,
31+
kms_key_name: str,
32+
disk_link: Optional[str] = None,
33+
image_link: Optional[str] = None
34+
) -> compute_v1.Disk:
2835
"""
2936
Creates a zonal disk in a project. If you do not provide values for disk_link or image_link,
3037
an empty disk will be created.

‎compute/client_library/ingredients/disks/delete.py‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,11 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
from typing import NoReturn
21-
2219
from google.cloud import compute_v1
2320

2421

2522
# <INGREDIENT delete_disk>
26-
def delete_disk(project_id: str, zone: str, disk_name: str) -> NoReturn:
23+
def delete_disk(project_id: str, zone: str, disk_name: str) -> None:
2724
"""
2825
Deletes a disk from a project.
2926
@@ -35,5 +32,4 @@ def delete_disk(project_id: str, zone: str, disk_name: str) -> NoReturn:
3532
disk_client = compute_v1.DisksClient()
3633
operation = disk_client.delete(project=project_id, zone=zone, disk=disk_name)
3734
wait_for_extended_operation(operation, "disk deletion")
38-
return
3935
# </INGREDIENT>

‎compute/client_library/ingredients/disks/get.py‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
from typing import NoReturn, Iterable
21-
2219
from google.cloud import compute_v1
2320

2421

‎compute/client_library/ingredients/disks/list.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
from typing import NoReturn, Iterable
19+
from typing import Iterable
2120

2221
from google.cloud import compute_v1
2322

@@ -40,4 +39,3 @@ def list_disks(project_id: str, zone: str, filter_: str = "") -> Iterable[comput
4039
request.filter = filter_
4140
return disk_client.list(request)
4241
# </INGREDIENT>
43-

‎compute/client_library/ingredients/disks/regional_delete.py‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,11 @@
1616
# folder for complete code samples that are ready to be used.
1717
# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
1818
# flake8: noqa
19-
import sys
20-
from typing import NoReturn
21-
2219
from google.cloud import compute_v1
2320

2421

2522
# <INGREDIENT delete_regional_disk>
26-
def delete_regional_disk(project_id: str, region: str, disk_name: str) -> NoReturn:
23+
def delete_regional_disk(project_id: str, region: str, disk_name: str) -> None:
2724
"""
2825
Deletes a disk from a project.
2926
@@ -35,5 +32,4 @@ def delete_regional_disk(project_id: str, region: str, disk_name: str) -> NoRetu
3532
disk_client = compute_v1.RegionDisksClient()
3633
operation = disk_client.delete(project=project_id, region=region, disk=disk_name)
3734
wait_for_extended_operation(operation, "regional disk deletion")
38-
return
3935
# </INGREDIENT>

‎compute/client_library/ingredients/firewall/delete.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,4 @@ def delete_firewall_rule(project_id: str, firewall_rule_name: str) -> None:
3535
)
3636

3737
wait_for_extended_operation(operation, "firewall rule deletion")
38-
return
3938
# </INGREDIENT>

‎compute/client_library/ingredients/firewall/patch.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,4 @@ def patch_firewall_priority(project_id: str, firewall_rule_name: str, priority:
4141
)
4242

4343
wait_for_extended_operation(operation, "firewall rule patching")
44-
return
4544
# </INGREDIENT>
46-

0 commit comments

Comments
 (0)