python-sdk: Support regions/vpc-availability endpoints#646
python-sdk: Support regions/vpc-availability endpoints#646mgwoj wants to merge 7 commits intolinode:devfrom
Conversation
mgwoj
requested review from
ezilber-akamai and
yec-akamai
and removed request for
a team
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR adds support for VPC availability endpoints in the Python SDK, enabling users to query which regions support VPC functionality and what IPv6 prefix lengths are available. The PR also adds support for retrieving availability information for a specific region.
Changes:
- Added
vpc_availability()andvpc_availability_get()methods toRegionGroupfor listing and retrieving VPC availability data - Added
availability_get()method toRegionGroupfor retrieving availability data for a specific region - Added
vpc_availabilityproperty toRegionobject for convenient access to VPC availability data - Introduced
RegionVPCAvailabilitydataclass to represent VPC availability information
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
linode_api4/groups/region.py |
Added three new methods: availability_get, vpc_availability, and vpc_availability_get for retrieving region availability data |
linode_api4/objects/region.py |
Added vpc_availability property to Region class and RegionVPCAvailability dataclass |
test/unit/groups/region_test.py |
Added unit tests for new VPC availability and availability_get methods; cleaned up existing test assertions |
test/unit/objects/region_test.py |
Added unit test for Region.vpc_availability property |
test/integration/models/region/test_region.py |
Added comprehensive integration tests covering all three access patterns for VPC availability and the new availability_get method |
test/fixtures/regions_vpc-availability.json |
Added fixture data for VPC availability listing endpoint with pagination support |
test/fixtures/regions_us-east_vpc-availability.json |
Added fixture data for single region VPC availability endpoint |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| { | ||
| "region": "us-east", | ||
| "available": true, | ||
| "available_ipv6_prefix_lengths": [52, 60] |
There was a problem hiding this comment.
The available_ipv6_prefix_lengths values for us-east region are inconsistent between the two fixtures. In regions_vpc-availability.json (line 6), it's [52, 48], but in regions_us-east_vpc-availability.json (line 4), it's [52, 60]. These should be the same since they represent the same region. Please verify which values are correct and update one of the fixtures accordingly.
| "available_ipv6_prefix_lengths": [52, 60] | |
| "available_ipv6_prefix_lengths": [52, 48] |
ezilber-akamai
left a comment
ezilber-akamai
left a comment
There was a problem hiding this comment.
Looks good and tests are passing locally. Nice work!
…pc-availability-endpoints
linode_api4/groups/region.py
Outdated
| RegionAvailabilityEntry, *filters, endpoint="/regions/availability" | ||
| ) | ||
|
|
||
| def availability_get(self, region_id): |
There was a problem hiding this comment.
I wonder if it's better to move this function under region object too, since it's getting availabilities for a specific region.
There was a problem hiding this comment.
removed in favour of availability from object
linode_api4/groups/region.py
Outdated
| endpoint="/regions/vpc-availability", | ||
| ) | ||
|
|
||
| def vpc_availability_get(self, region_id): |
There was a problem hiding this comment.
I think we can remove this function here, because the endpoint is also implemented under the region object and better just live there.
There was a problem hiding this comment.
removed in favour of vpc_availability from object
|
|
||
| return [RegionAvailabilityEntry.from_json(v) for v in result] | ||
|
|
||
| def vpc_availability(self, *filters): |
There was a problem hiding this comment.
nit: vpc_availabilities. Normally we use plural forms to indicate it's an list endpoints.
There was a problem hiding this comment.
but then it will be inconsistent with the naming of availability method
| assert len(avail_entries) > 0 | ||
|
|
||
| for entry in avail_entries: | ||
| assert entry.region is not None |
There was a problem hiding this comment.
Is it intended to remove not None checks? It looks the fields are Optional
There was a problem hiding this comment.
but it is redundant with next check:
assert len(entry.region) > 0
…pc-availability-endpoints
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (2)
test/unit/groups/region_test.py:28
- The assertion for
entry.plan is not Nonewas removed, creating an inconsistency with howentry.regionis tested. Line 26 checksentry.region is not Nonebefore checking its length on line 27, butentry.plannow only has the length check without the None check. Consider adding backassert entry.plan is not Nonebefore this line for consistency, or remove theis not Nonecheck forentry.regionif the length check is sufficient.
assert len(entry.plan) > 0
linode_api4/objects/region.py:126
- The existing
availabilityproperty (lines 115-126) lacks a docstring, while the newvpc_availabilityproperty includes comprehensive documentation. For consistency, consider adding a docstring to theavailabilityproperty following the same format asvpc_availability.
@property
def availability(self) -> List["RegionAvailabilityEntry"]:
result = self._client.get(
f"{self.api_endpoint}/availability", model=self
)
if result is None:
raise UnexpectedResponseError(
"Expected availability data, got None."
)
return [RegionAvailabilityEntry.from_json(v) for v in result]
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📝 Description
Added support regions/vpc-availability endpoints:
Also added support for get availability endpoint
✔️ How to Test