PENG-7708-python-sdk-zoneexport #145

soniafrancisNS1 · 2025-12-17T16:16:04Z

Add export() method to REST API and Zone class
Add unit test for zone export
Add simple usage example

Allows customers to export zones in BIND format for backup/migration.

- Add export() method to REST API and Zone class - Add unit test for zone export - Add simple usage example Allows customers to export zones in BIND format for backup/migration.

ddevine-NS1 · 2026-01-07T12:12:56Z

You need to update the changelog with the changes; probably something like 0.28 since it's a new feature.
This version variable needs to updated to it too

ddevine-NS1 · 2026-01-07T12:15:50Z

examples/zone-export.py

+print(zone_file)
+
+# save to a file
+with open("example.com.zone", "w") as f:


Suggested change

with open("example.com.zone", "w") as f:

with open("example.com.txt", "w") as f:

Usually zone files just have a .txt extension; and zone is a tld, so calling them .zone could be a bit confusing.

Changed to example.com.txt in line 31.

ddevine-NS1 · 2026-01-07T12:30:37Z

examples/zone-export.py

@@ -0,0 +1,25 @@
+#


Can you add more to the example? This example just assumes the other endpoints have been called.

It needs to initiate the export; then poll the status until it gets a complete status; then to download the file.

ddevine-NS1 · 2026-01-07T12:35:41Z

ns1/rest/zones.py

            errback=errback,
        )

+    def export(self, zone, callback=None, errback=None):


Suggested change

def export(self, zone, callback=None, errback=None):

def get_zonefile_export(self, zone, callback=None, errback=None):

Renamed to get_zonefile_export()

ddevine-NS1 · 2026-01-07T12:35:59Z

ns1/rest/zones.py

+            errback=errback,
+        )
+
+    def initiate_export(self, zone, callback=None, errback=None):


Suggested change

def initiate_export(self, zone, callback=None, errback=None):

def initiate_zonefile_export(self, zone, callback=None, errback=None):

Renamed to initiate_zonefile_export()

ddevine-NS1 · 2026-01-07T12:36:22Z

ns1/rest/zones.py

+            errback=errback,
+        )
+
+    def export_status(self, zone, callback=None, errback=None):


Suggested change

def export_status(self, zone, callback=None, errback=None):

def status_zonefile_export(self, zone, callback=None, errback=None):

Renamed to status_zonefile_export()

ddevine-NS1 · 2026-01-07T12:36:43Z

ns1/rest/zones.py


+    def export(self, zone, callback=None, errback=None):
+        """
+        Export zone as BIND-compatible zone file.


Could probably say this downloads the zonefile.

ddevine-NS1 · 2026-01-07T13:36:58Z

ns1/zones.py

            zone=self.zone, callback=callback, errback=errback, **kwargs
        )
+
+    def export(self, callback=None, errback=None):


Can you replace these with a single function that:

Initialises the export PUT

Polls the status, until "COMPLETE" or "FAILED" or some timeout hits.

Calls/returns the download endpoint.

Enhanced the example with detailed comments explaining the complete workflow. The export() method now handles all three steps automatically: initiate, poll status, and download.

…, update docs and version to 0.28.0

ddevine-NS1 · 2026-01-07T16:33:42Z

ns1/zones.py

+        :return: zone file content as string
+        :raises ZoneException: if export fails or times out
+        """
+        import time


You shouldn't import packages inside functions, can you move this to the top with the other imports?

ddevine-NS1 · 2026-01-07T16:36:21Z

ns1/zones.py

+            self.zone, callback=callback, errback=errback
+        )
+
+        if callback:


Is this necessary here? you're already sending get_zonefile_export so any callback will get called above?

ddevine-NS1 · 2026-01-07T16:58:24Z

ns1/zones.py

+        import time
+
+        # Initiate the export
+        self._rest.initiate_zonefile_export(self.zone)


You should check the response here; make sure it's 200.

If something goes wrong here then we can't tell and it'll start polling for something that will never finish.

ddevine-NS1 · 2026-01-07T17:01:26Z

ns1/zones.py

+            status_response = self._rest.status_zonefile_export(self.zone)
+            status = status_response.get("status")
+
+            if status == "COMPLETE":


Suggested change

if status == "COMPLETE":

if status == "COMPLETED":

cmckenna-ibm · 2026-01-07T17:26:27Z

examples/zone-export.py

+    f.write(zone_file)
+print("Zone file saved to example.com.txt")
+
+# Made with Bob


Before merging, let's confirm if this is something that should be included in public repositories. I suspect not, but let me check.

cmckenna-ibm · 2026-01-07T17:33:44Z

examples/zone-export.py

@@ -0,0 +1,35 @@
+#
+# Copyright (c) 2025 NSONE, Inc.


As this is new code and yet to be released, I would suggest we add 2026 to the copyright? @ddevine-NS1 - any thoughts on this?
Not sure about the other pre-existing files.

Yeah agree, we should update the copyright

cmckenna-ibm · 2026-01-08T09:53:42Z

ns1/rest/zones.py

+        """
+        return self._make_request(
+            "GET",
+            f"{self.ROOT}/{zone}/export",


Is the use of {self.ROOT} here instead of export/zonefile in the two previous function definitions intentional?

ddevine-NS1 · 2026-01-08T15:57:16Z

ns1/rest/zones.py

+        # Note: This endpoint returns raw zone file text, not JSON
+        # The transport layer will try to parse it as JSON and fail
+        # We catch that exception and extract the raw body text
+        from ns1.rest.errors import ResourceException


imports need to go on the top of the file

ddevine-NS1 · 2026-01-08T16:00:05Z

ns1/rest/zones.py

+                # The body is the third argument in ResourceException
+                if hasattr(e, 'args') and len(e.args) >= 3:
+                    body = e.args[2]
+                    if callback:


Why is the callback being checked here?

ddevine-NS1 · 2026-01-08T16:20:05Z

ns1/rest/zones.py

+            # If it's about invalid JSON, that's expected - extract the body
+            if "invalid json in response" in str(e):
+                # The body is the third argument in ResourceException
+                if hasattr(e, 'args') and len(e.args) >= 3:


ResourceException is a custom error, you can access the body like:

body = e.body

invalid json in response is too generic, since any http/txt response will probably result in this error too and this will just assume it's a zonefile.

Can you update this to check that the response code is valid otherwise raise the error.
And to check that the content type header is valid too.

ddevine-NS1 · 2026-01-08T16:24:10Z

examples/zone-export.py

+# 1. Initiate the export job
+# 2. Poll the status until complete or failed
+# 3. Download and return the zone file content
+zone = api.loadZone("example.com")


Can you set example.com to be a variable and then use that for the script, it's a bit neater for using it.

soniafrancisNS1 added 5 commits December 17, 2025 16:10

Add zone export functionality

9d7c48b

- Add export() method to REST API and Zone class - Add unit test for zone export - Add simple usage example Allows customers to export zones in BIND format for backup/migration.

zone name

12d4ad1

ruff formatting

9d1500d

Fix black formatting for zone export code

f0d21b1

Add put and get endpoints in sdk

c2b75da

ddevine-NS1 reviewed Jan 7, 2026

View reviewed changes

soniafrancisNS1 added 3 commits January 7, 2026 16:18

Address PR review feedback - rename methods, consolidate export logic…

2e7ecac

…, update docs and version to 0.28.0

Fix black formatting for zones.py

ccb6000

Update unit tests to use renamed zone export methods

ca1896b

ddevine-NS1 reviewed Jan 7, 2026

View reviewed changes

cmckenna-ibm requested changes Jan 8, 2026

View reviewed changes

soniafrancisNS1 added 3 commits January 8, 2026 14:39

add error handling, update status check to COMPLETED, update copyright

c04cadf

fixed the api endpoint

8cb5012

lint format

421d382

soniafrancisNS1 marked this pull request as draft January 8, 2026 15:36

black format

f371731

ddevine-NS1 reviewed Jan 8, 2026

View reviewed changes

	with open("example.com.zone", "w") as f:
	with open("example.com.txt", "w") as f:

	def export(self, zone, callback=None, errback=None):
	def get_zonefile_export(self, zone, callback=None, errback=None):

	def initiate_export(self, zone, callback=None, errback=None):
	def initiate_zonefile_export(self, zone, callback=None, errback=None):

	def export_status(self, zone, callback=None, errback=None):
	def status_zonefile_export(self, zone, callback=None, errback=None):

PENG-7708-python-sdk-zoneexport #145

Are you sure you want to change the base?

PENG-7708-python-sdk-zoneexport #145

Uh oh!

Conversation

soniafrancisNS1 commented Dec 17, 2025

Uh oh!

ddevine-NS1 commented Jan 7, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

soniafrancisNS1 Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

soniafrancisNS1 Jan 7, 2026 •

edited

Loading