refactor: update chart creation to return chart object for method chaining

Author: palewire

docs/user-guide/chart-operations.md

@@ -1,6 +1,6 @@
 # Working with chart objects
 
-This guide tours the key operations available on all of our object-oriented chart types.
+This guide tours the key operations available on all charts based on our object-oriented classes.
 
 ## Creating a new chart
 
@@ -16,19 +16,20 @@ data = pd.DataFrame(
     }
 )
 
-# Create a chart
+# Configure the chart object
 chart = dw.BarChart(
     title="Most Popular Programming Languages 2024",
     data=data,
     value_label_format=dw.NumberFormat.ONE_DECIMAL,
 )
 
+# Create it by sending to Datawrapper
 chart.create()
 ```
 
 ## Getting an existing chart
 
-You can retrieve an existing chart by using `get_chart` with the chart ID:
+You can retrieve an existing chart with the ID, which is found in its URL.
 
 ```python
 # Retrieve an existing chart
@@ -41,8 +42,6 @@ print(existing_chart.chart_id)
 
 ## Updating an existing chart
 
-After creating or retrieving a chart, you can modify its properties and update it:
-
 ```python
 # Modify the chart properties
 chart.title = "Programming Language Popularity - Updated"
@@ -57,7 +56,7 @@ new_data = pd.DataFrame(
 )
 chart.data = new_data
 
-# Push the changes to Datawrapper (returns self for method chaining)
+# This will send the updates to Datawrapper
 chart.update()
 ```
 
@@ -66,7 +65,6 @@ chart.update()
 Once your chart is ready, publish it to make it publicly accessible:
 
 ```python
-# Publish the chart (returns self for method chaining)
 chart.publish()
 
 # Chain with other operations
@@ -75,8 +73,6 @@ chart.create().publish()
 
 ## Exporting a chart
 
-Export your chart as an SVG, PNG, or PDF file:
-
 ```python
 # Export as PNG (default)
 chart.export(filepath="chart.png")
@@ -90,14 +86,9 @@ chart.export(
 )
 ```
 
-The export method supports various other options for customizing the output format and dimensions.
-
 ## Duplicating a chart
 
-Create an editable copy of your chart:
-
 ```python
-# Create a duplicate
 duplicate_chart = chart.duplicate()
 
 # The duplicate is a new chart with a different ID
@@ -111,10 +102,7 @@ duplicate_chart.update()
 
 ## Deleting a chart
 
-Remove a chart from Datawrapper:
-
 ```python
-# Delete the chart
 success = chart.delete()
 
 if success:
@@ -136,22 +124,17 @@ Get the HTML iframe embed code for your chart:
 ```python
 # Get standard iframe code
 iframe_code = chart.get_iframe_code()
-print(iframe_code)
 
 # Get responsive iframe code
 responsive_iframe = chart.get_iframe_code(responsive=True)
-print(responsive_iframe)
 ```
 
 ## Getting png URL
 
 Get the fallback image URL for use in noscript tags:
 
 ```python
-# Get the PNG URL
 png_url = chart.get_png_url()
-print(f"PNG fallback: {png_url}")
 
-# Use in HTML noscript tags
 html = f'<noscript><img src="{png_url}" alt="Chart" /></noscript>'
 ```

tests/functional/test_chart_factory.py

@@ -32,6 +32,7 @@ def test_get_chart_line_chart():
     mock_client.get_chart.return_value = mock_metadata
 
     with (
+        patch.dict("os.environ", {}, clear=True),  # Clear environment variables
         patch("datawrapper.Datawrapper", return_value=mock_client),
         patch.object(LineChart, "get") as mock_line_get,
     ):

tests/integration/test_area_chart.py

@@ -350,7 +350,8 @@ def test_round_trip_create_and_get(self):
 
         # Create the chart
         with patch.object(original_chart, "_get_client", return_value=mock_client):
-            chart_id = original_chart.create(access_token="test-token")
+            original_chart.create(access_token="test-token")
+            chart_id = original_chart.chart_id
 
         # Now fetch it back
         serialized = original_chart.serialize_model()

tests/integration/test_arrow_chart.py

@@ -419,7 +419,8 @@ def test_round_trip_create_and_get(self):
 
         # Create the chart
         with patch.object(original_chart, "_get_client", return_value=mock_client):
-            chart_id = original_chart.create(access_token="test-token")
+            original_chart.create(access_token="test-token")
+            chart_id = original_chart.chart_id
 
         # Now fetch it back
         serialized = original_chart.serialize_model()

tests/integration/test_base_api_integration.py

@@ -77,9 +77,8 @@ def test_create_chart_success(self):
         mock_client._CHARTS_URL = "https://api.datawrapper.de/v3/charts"
 
         with patch.object(chart, "_get_client", return_value=mock_client):
-            chart_id = chart.create(access_token="test-token")
+            chart = chart.create(access_token="test-token")
 
-            assert chart_id == "test-chart-id"
             assert chart.chart_id == "test-chart-id"
 
             # Verify create_chart was called with correct parameters
@@ -128,9 +127,9 @@ def test_update_chart_success(self):
         mock_client._CHARTS_URL = "https://api.datawrapper.de/v3/charts"
 
         with patch.object(chart, "_get_client", return_value=mock_client):
-            chart_id = chart.update(access_token="test-token")
+            chart = chart.update(access_token="test-token")
 
-            assert chart_id == "existing-chart-id"
+            assert chart.chart_id == "existing-chart-id"
 
             # Verify update_chart was called with correct parameters
             mock_client.update_chart.assert_called_once()
@@ -182,9 +181,9 @@ def test_create_with_list_data(self):
         mock_client._CHARTS_URL = "https://api.datawrapper.de/v3/charts"
 
         with patch.object(chart, "_get_client", return_value=mock_client):
-            chart_id = chart.create(access_token="test-token")
+            chart = chart.create(access_token="test-token")
 
-            assert chart_id == "test-chart-id"
+            assert chart.chart_id == "test-chart-id"
 
             # Verify create_chart was called for chart creation
             mock_client.create_chart.assert_called_once()
@@ -219,16 +218,15 @@ def test_full_workflow_create_then_update(self):
 
         with patch.object(chart, "_get_client", return_value=mock_client):
             # Create the chart
-            chart_id = chart.create(access_token="test-token")
-            assert chart_id == "workflow-chart-id"
+            chart = chart.create(access_token="test-token")
             assert chart.chart_id == "workflow-chart-id"
 
             # Update the chart
             chart.title = "Updated Title"
             chart.data = pd.DataFrame({"x": [5, 6], "y": [7, 8]})
 
-            updated_id = chart.update(access_token="test-token")
-            assert updated_id == "workflow-chart-id"
+            updated = chart.update(access_token="test-token")
+            assert updated.chart_id == "workflow-chart-id"
 
             # Verify both create and update were called
             assert mock_client.create_chart.call_count == 1  # Chart creation

tests/integration/test_chart_get_method.py

@@ -587,7 +587,8 @@ def test_round_trip_create_and_get(self):
 
         # Create the chart
         with patch.object(original_chart, "_get_client", return_value=mock_client):
-            chart_id = original_chart.create(access_token="test-token")
+            original_chart.create(access_token="test-token")
+            chart_id = original_chart.chart_id
 
         # Now fetch it back
         serialized = original_chart.serialize_model()

tests/integration/test_column_chart.py

@@ -485,7 +485,8 @@ def test_round_trip_create_and_get(self):
 
         # Create the chart
         with patch.object(original_chart, "_get_client", return_value=mock_client):
-            chart_id = original_chart.create(access_token="test-token")
+            original_chart.create(access_token="test-token")
+            chart_id = original_chart.chart_id
 
         # Now fetch it back
         serialized = original_chart.serialize_model()

tests/integration/test_line_chart.py

@@ -432,7 +432,8 @@ def test_round_trip_create_and_get(self):
 
         # Create the chart
         with patch.object(original_chart, "_get_client", return_value=mock_client):
-            chart_id = original_chart.create(access_token="test-token")
+            original_chart.create(access_token="test-token")
+            chart_id = original_chart.chart_id
 
         # Now fetch it back
         serialized = original_chart.serialize_model()