From c649a9c9993f371c0b885b0a7a0a4e76ab2c2ca6 Mon Sep 17 00:00:00 2001 From: Ross McFarland Date: Sat, 29 Jul 2023 17:57:35 -0700 Subject: [PATCH] Formally deprecate Zone._remove_record in favor of Zone.remove_record --- octodns/zone.py | 8 ++++++-- tests/test_octodns_zone.py | 10 +++++++++- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/octodns/zone.py b/octodns/zone.py index 9cbc712..8855986 100644 --- a/octodns/zone.py +++ b/octodns/zone.py @@ -161,8 +161,12 @@ class Zone(object): self._records[record.name].discard(record) - # TODO: delete this - _remove_record = remove_record + # TODO: delete this at v2.0.0rc0 + def _remove_record(self, record): + self.log.warning( + '_remove_record: method has been deprecated, used remove_record instead' + ) + return self.remove_record(record) def changes(self, desired, target): self.log.debug('changes: zone=%s, target=%s', self, target) diff --git a/tests/test_octodns_zone.py b/tests/test_octodns_zone.py index 93d8a87..6563105 100644 --- a/tests/test_octodns_zone.py +++ b/tests/test_octodns_zone.py @@ -125,7 +125,7 @@ class TestZone(TestCase): # add a record, delete a record -> [Delete, Create] c = ARecord(before, 'c', {'ttl': 42, 'value': '1.1.1.1'}) after.add_record(c) - after._remove_record(b) + after.remove_record(b) self.assertEqual(after.records, set([a, c])) changes = before.changes(after, target) self.assertEqual(2, len(changes)) @@ -154,6 +154,14 @@ class TestZone(TestCase): self.assertFalse(changed.changes(update.new, target)) update.__repr__() + def test_deprecated__remove_record(self): + zone = Zone('unit.tests.', []) + a = ARecord(zone, 'a', {'ttl': 42, 'value': '1.1.1.1'}) + zone.add_record(a) + self.assertEqual({a}, zone.records) + zone._remove_record(a) + self.assertEqual(set(), zone.records) + def test_unsupporting(self): class NoAaaaProvider(object): id = 'no-aaaa'