Skip to content

new: Annotate set/unordered fields as unordered #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgarber-akamai merged 1 commit into from
Apr 9, 2024
Merged

new: Annotate set/unordered fields as unordered #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions linode_api4/objects/account.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class Account(Base):
"zip": Property(mutable=True),
"address_2": Property(mutable=True),
"tax_id": Property(mutable=True),
"capabilities": Property(),
"capabilities": Property(unordered=True),
"credit_card": Property(),
"active_promotions": Property(),
"active_since": Property(),
Expand Down Expand Up @@ -670,5 +670,5 @@ class AccountAvailability(Base):

properties = {
"region": Property(identifier=True),
"unavailable": Property(),
"unavailable": Property(unordered=True),
}
6 changes: 6 additions & 0 deletions linode_api4/objects/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def __init__(
id_relationship=False,
slug_relationship=False,
nullable=False,
unordered=False,
json_object=None,
):
"""
Expand All @@ -50,6 +51,10 @@ def __init__(
(This should be used on fields ending with '_id' only)
slug_relationship - This property is a slug related for a given type.
nullable - This property can be explicitly null on PUT requests.
unordered - The order of this property is not significant.
NOTE: This field is currently only for annotations purposes
and does not influence any update or decoding/encoding logic.
json_object - The JSONObject class this property should be decoded into.
"""
self.mutable = mutable
self.identifier = identifier
Expand All @@ -60,6 +65,7 @@ def __init__(
self.id_relationship = id_relationship
self.slug_relationship = slug_relationship
self.nullable = nullable
self.unordered = unordered
self.json_class = json_object


Expand Down
6 changes: 3 additions & 3 deletions linode_api4/objects/database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ class MySQLDatabase(Base):
properties = {
"id": Property(identifier=True),
"label": Property(mutable=True),
"allow_list": Property(mutable=True),
"allow_list": Property(mutable=True, unordered=True),
"backups": Property(derived_class=MySQLDatabaseBackup),
"cluster_size": Property(),
"created": Property(is_datetime=True),
Expand Down Expand Up @@ -262,7 +262,7 @@ class PostgreSQLDatabase(Base):
properties = {
"id": Property(identifier=True),
"label": Property(mutable=True),
"allow_list": Property(mutable=True),
"allow_list": Property(mutable=True, unordered=True),
"backups": Property(derived_class=PostgreSQLDatabaseBackup),
"cluster_size": Property(),
"created": Property(is_datetime=True),
Expand Down Expand Up @@ -404,7 +404,7 @@ class Database(Base):
properties = {
"id": Property(),
"label": Property(),
"allow_list": Property(),
"allow_list": Property(unordered=True),
"cluster_size": Property(),
"created": Property(),
"encrypted": Property(),
Expand Down
6 changes: 3 additions & 3 deletions linode_api4/objects/domain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ class Domain(Base):
"status": Property(mutable=True),
"soa_email": Property(mutable=True),
"retry_sec": Property(mutable=True),
"master_ips": Property(mutable=True),
"axfr_ips": Property(mutable=True),
"master_ips": Property(mutable=True, unordered=True),
"axfr_ips": Property(mutable=True, unordered=True),
"expire_sec": Property(mutable=True),
"refresh_sec": Property(mutable=True),
"ttl_sec": Property(mutable=True),
"records": Property(derived_class=DomainRecord),
"type": Property(mutable=True),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
}

def record_create(self, record_type, **kwargs):
Expand Down
4 changes: 3 additions & 1 deletion linode_api4/objects/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,7 @@ class Image(Base):
"vendor": Property(),
"size": Property(),
"deprecated": Property(),
"capabilities": Property(),
"capabilities": Property(
unordered=True,
),
}
8 changes: 5 additions & 3 deletions linode_api4/objects/linode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,11 +642,11 @@ class Instance(Base):
"configs": Property(derived_class=Config),
"type": Property(slug_relationship=Type),
"backups": Property(mutable=True),
"ipv4": Property(),
"ipv4": Property(unordered=True),
"ipv6": Property(),
"hypervisor": Property(),
"specs": Property(),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
"host_uuid": Property(),
"watchdog_enabled": Property(mutable=True),
"has_user_data": Property(),
Expand Down Expand Up @@ -1745,7 +1745,9 @@ class StackScript(Base):
"created": Property(is_datetime=True),
"deployments_active": Property(),
"script": Property(mutable=True),
"images": Property(mutable=True), # TODO make slug_relationship
"images": Property(
mutable=True, unordered=True
), # TODO make slug_relationship
"deployments_total": Property(),
"description": Property(mutable=True),
"updated": Property(is_datetime=True),
Expand Down
4 changes: 2 additions & 2 deletions linode_api4/objects/lke.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class LKENodePool(DerivedBase):
volatile=True
), # this is formatted in _populate below
"autoscaler": Property(mutable=True),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
}

def _populate(self, json):
Expand Down Expand Up @@ -121,7 +121,7 @@ class LKECluster(Base):
"id": Property(identifier=True),
"created": Property(is_datetime=True),
"label": Property(mutable=True),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
"updated": Property(is_datetime=True),
"region": Property(slug_relationship=Region),
"k8s_version": Property(slug_relationship=KubeVersion, mutable=True),
Expand Down
8 changes: 5 additions & 3 deletions linode_api4/objects/networking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ class IPv6Range(Base):
"region": Property(slug_relationship=Region),
"prefix": Property(),
"route_target": Property(),
"linodes": Property(),
"linodes": Property(
unordered=True,
),
"is_bgp": Property(),
}

Expand Down Expand Up @@ -151,7 +153,7 @@ class VLAN(Base):
properties = {
"label": Property(identifier=True),
"created": Property(is_datetime=True),
"linodes": Property(),
"linodes": Property(unordered=True),
"region": Property(slug_relationship=Region),
}

Expand Down Expand Up @@ -189,7 +191,7 @@ class Firewall(Base):
properties = {
"id": Property(identifier=True),
"label": Property(mutable=True),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
"status": Property(mutable=True),
"created": Property(is_datetime=True),
"updated": Property(is_datetime=True),
Expand Down
4 changes: 2 additions & 2 deletions linode_api4/objects/nodebalancer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class NodeBalancerNode(DerivedBase):
"weight": Property(mutable=True),
"mode": Property(mutable=True),
"status": Property(),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
}

def __init__(self, client, id, parent_id, nodebalancer_id=None, json=None):
Expand Down Expand Up @@ -217,7 +217,7 @@ class NodeBalancer(Base):
"region": Property(slug_relationship=Region),
"configs": Property(derived_class=NodeBalancerConfig),
"transfer": Property(),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
}

# create derived objects
Expand Down
2 changes: 1 addition & 1 deletion linode_api4/objects/region.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class Region(Base):
properties = {
"id": Property(identifier=True),
"country": Property(),
"capabilities": Property(),
"capabilities": Property(unordered=True),
"status": Property(),
"resolvers": Property(),
"label": Property(),
Expand Down
2 changes: 1 addition & 1 deletion linode_api4/objects/volume.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class Volume(Base):
"size": Property(),
"status": Property(),
"region": Property(slug_relationship=Region),
"tags": Property(mutable=True),
"tags": Property(mutable=True, unordered=True),
"filesystem_path": Property(),
"hardware_type": Property(),
"linode_label": Property(),
Expand Down
2 changes: 1 addition & 1 deletion linode_api4/objects/vpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class VPCSubnet(DerivedBase):
"id": Property(identifier=True),
"label": Property(mutable=True),
"ipv4": Property(),
"linodes": Property(json_object=VPCSubnetLinode),
"linodes": Property(json_object=VPCSubnetLinode, unordered=True),
"created": Property(is_datetime=True),
"updated": Property(is_datetime=True),
}
Expand Down