Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥
TypeScript aiai-agentsai-crawlerai-scrapingai-searchcrawlerdata-extractionhtml-to-markdownllmmarkdownscraperscrapingweb-crawlerweb-dataweb-data-extractionweb-scraperweb-scrapingweb-searchwebscraping
fix(python-sdk): preserve ChangeTrackingFormat options through serialization
Himadri Mbc0956eba6d2
diff --git a/apps/python-sdk/firecrawl/v2/utils/validation.py b/apps/python-sdk/firecrawl/v2/utils/validation.pyindex 11f427f2c..3b3fca58e 100644--- a/apps/python-sdk/firecrawl/v2/utils/validation.py+++ b/apps/python-sdk/firecrawl/v2/utils/validation.py@@ -634,6 +634,10 @@ def prepare_scrape_options(options: Optional[ScrapeOptions]) -> Optional[Dict[stconverted_formats.append(_validate_highlights_format(fmt.model_dump(exclude_none=True)))elif fmt.type == 'query':converted_formats.append(_validate_query_format(fmt.model_dump(exclude_none=True)))+ elif fmt.type in ('changeTracking', 'change_tracking'):+ data = fmt.model_dump(exclude_none=True)+ data['type'] = _convert_format_string(data.get('type', fmt.type))+ converted_formats.append(data)else:converted_formats.append(_convert_format_string(fmt.type))else:@@ -711,6 +715,10 @@ def prepare_scrape_options(options: Optional[ScrapeOptions]) -> Optional[Dict[stconverted_formats.append(normalized)elif fmt.type == 'query':converted_formats.append(_validate_query_format(fmt.model_dump(exclude_none=True)))+ elif fmt.type in ('changeTracking', 'change_tracking'):+ data = fmt.model_dump(exclude_none=True)+ data['type'] = _convert_format_string(data.get('type', fmt.type))+ converted_formats.append(data)else:converted_formats.append(_convert_format_string(fmt.type))else:diff --git a/apps/python-sdk/tests/test_format_type_defaults.py b/apps/python-sdk/tests/test_format_type_defaults.pynew file mode 100644index 000000000..fa99dc87f--- /dev/null+++ b/apps/python-sdk/tests/test_format_type_defaults.py@@ -0,0 +1,59 @@+"""Tests for JsonFormat and ChangeTrackingFormat default type fields and serialization."""++import pytest++from firecrawl.v2.types import JsonFormat, ChangeTrackingFormat, ScrapeOptions+from firecrawl.v2.utils.validation import prepare_scrape_options+++class TestJsonFormat:+ def test_defaults_type_to_json(self):+ fmt = JsonFormat(prompt="Extract titles.")+ assert fmt.type == "json"++ def test_explicit_type_json_still_works(self):+ fmt = JsonFormat(type="json", prompt="Extract titles.")+ assert fmt.type == "json"++ def test_rejects_wrong_type(self):+ with pytest.raises(Exception):+ JsonFormat(type="markdown", prompt="x")++ def test_serializes_through_prepare(self):+ opts = ScrapeOptions(formats=[JsonFormat(prompt="Extract titles.")])+ prepared = prepare_scrape_options(opts)+ fmts = prepared["formats"]+ assert any(+ isinstance(f, dict) and f.get("type") == "json" and f.get("prompt") == "Extract titles."+ for f in fmts+ )+++class TestChangeTrackingFormat:+ def test_defaults_type(self):+ fmt = ChangeTrackingFormat(modes=["git-diff"])+ assert fmt.type in ("change_tracking", "changeTracking")++ def test_serializes_with_modes(self):+ opts = ScrapeOptions(formats=[ChangeTrackingFormat(modes=["git-diff"])])+ prepared = prepare_scrape_options(opts)+ fmts = prepared["formats"]+ assert fmts == [{"type": "changeTracking", "modes": ["git-diff"]}]++ def test_serializes_with_all_options(self):+ opts = ScrapeOptions(formats=[+ ChangeTrackingFormat(modes=["git-diff"], tag="daily", prompt="track changes")+ ])+ prepared = prepare_scrape_options(opts)+ fmts = prepared["formats"]+ assert fmts == [+ {"type": "changeTracking", "modes": ["git-diff"], "prompt": "track changes", "tag": "daily"}+ ]++ def test_does_not_drop_schema(self):+ opts = ScrapeOptions(formats=[+ ChangeTrackingFormat(modes=["json"], schema={"type": "object"})+ ])+ prepared = prepare_scrape_options(opts)+ fmts = prepared["formats"]+ assert fmts[0]["schema"] == {"type": "object"}