refactor: rename ScrapeFormatEntry -> FormatConfig

The union type was awkwardly named. FormatConfig matches the naming of
its members (MarkdownFormatConfig, HtmlFormatConfig, ...) and reads
naturally in signatures: formats: list[FormatConfig].

Also exported from the top-level package so users can type-annotate
their own code.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: FrancescoSaverioZuppichini

src/scrapegraph_py/__init__.py

@@ -10,6 +10,7 @@
     ExtractRequest,
     ExtractResponse,
     FetchConfig,
+    FormatConfig,
     HealthResponse,
     HistoryEntry,
     HistoryFilter,
@@ -66,6 +67,7 @@
     "HealthResponse",
     "TokenUsage",
     "FetchConfig",
+    "FormatConfig",
     "MarkdownFormatConfig",
     "HtmlFormatConfig",
     "ScreenshotFormatConfig",

src/scrapegraph_py/async_client.py

@@ -24,6 +24,7 @@
     ExtractRequest,
     ExtractResponse,
     FetchConfig,
+    FormatConfig,
     HealthResponse,
     HistoryEntry,
     HistoryFilter,
@@ -33,7 +34,6 @@
     MonitorCreateRequest,
     MonitorResponse,
     MonitorUpdateRequest,
-    ScrapeFormatEntry,
     ScrapeRequest,
     ScrapeResponse,
     SearchRequest,
@@ -87,7 +87,7 @@ async def start(
         self,
         url: str,
         *,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         max_depth: int | None = None,
         max_pages: int | None = None,
         max_links_per_page: int | None = None,
@@ -136,7 +136,7 @@ async def create(
         interval: str,
         *,
         name: str | None = None,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         webhook_url: str | None = None,
         fetch_config: FetchConfig | None = None,
     ) -> ApiResult[MonitorResponse]:
@@ -163,7 +163,7 @@ async def update(
         id: str,
         *,
         name: str | None = None,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         webhook_url: str | None = None,
         interval: str | None = None,
         fetch_config: FetchConfig | None = None,
@@ -330,7 +330,7 @@ async def scrape(
         self,
         url: str,
         *,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         fetch_config: FetchConfig | None = None,
         content_type: ApiFetchContentType | None = None,
     ) -> ApiResult[ScrapeResponse]:

src/scrapegraph_py/client.py

@@ -24,6 +24,7 @@
     ExtractRequest,
     ExtractResponse,
     FetchConfig,
+    FormatConfig,
     HealthResponse,
     HistoryEntry,
     HistoryFilter,
@@ -33,7 +34,6 @@
     MonitorCreateRequest,
     MonitorResponse,
     MonitorUpdateRequest,
-    ScrapeFormatEntry,
     ScrapeRequest,
     ScrapeResponse,
     SearchRequest,
@@ -87,7 +87,7 @@ def start(
         self,
         url: str,
         *,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         max_depth: int | None = None,
         max_pages: int | None = None,
         max_links_per_page: int | None = None,
@@ -136,7 +136,7 @@ def create(
         interval: str,
         *,
         name: str | None = None,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         webhook_url: str | None = None,
         fetch_config: FetchConfig | None = None,
     ) -> ApiResult[MonitorResponse]:
@@ -163,7 +163,7 @@ def update(
         id: str,
         *,
         name: str | None = None,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         webhook_url: str | None = None,
         interval: str | None = None,
         fetch_config: FetchConfig | None = None,
@@ -330,7 +330,7 @@ def scrape(
         self,
         url: str,
         *,
-        formats: list[ScrapeFormatEntry] | None = None,
+        formats: list[FormatConfig] | None = None,
         fetch_config: FetchConfig | None = None,
         content_type: ApiFetchContentType | None = None,
     ) -> ApiResult[ScrapeResponse]:

src/scrapegraph_py/schemas.py

@@ -120,7 +120,7 @@ class BrandingFormatConfig(CamelModel):
     type: Literal["branding"] = "branding"
 
 
-ScrapeFormatEntry = (
+FormatConfig = (
     MarkdownFormatConfig
     | HtmlFormatConfig
     | ScreenshotFormatConfig
@@ -136,7 +136,7 @@ class ScrapeRequest(CamelModel):
     url: HttpUrl
     content_type: ApiFetchContentType | None = None
     fetch_config: FetchConfig | None = None
-    formats: list[ScrapeFormatEntry] = Field(default_factory=lambda: [MarkdownFormatConfig()])
+    formats: list[FormatConfig] = Field(default_factory=lambda: [MarkdownFormatConfig()])
 
     @model_validator(mode="after")
     def validate_unique_formats(self):
@@ -184,7 +184,7 @@ def validate_schema_requires_prompt(self):
 class MonitorCreateRequest(CamelModel):
     url: HttpUrl
     name: Annotated[str, Field(max_length=200)] | None = None
-    formats: list[ScrapeFormatEntry] = Field(default_factory=lambda: [MarkdownFormatConfig()])
+    formats: list[FormatConfig] = Field(default_factory=lambda: [MarkdownFormatConfig()])
     webhook_url: HttpUrl | None = None
     interval: Annotated[str, Field(min_length=1, max_length=100)]
     fetch_config: FetchConfig | None = None
@@ -199,7 +199,7 @@ def validate_unique_formats(self):
 
 class MonitorUpdateRequest(CamelModel):
     name: Annotated[str, Field(max_length=200)] | None = None
-    formats: list[ScrapeFormatEntry] | None = None
+    formats: list[FormatConfig] | None = None
     webhook_url: HttpUrl | None = None
     interval: Annotated[str, Field(min_length=1, max_length=100)] | None = None
     fetch_config: FetchConfig | None = None
@@ -215,7 +215,7 @@ def validate_unique_formats(self):
 
 class CrawlRequest(CamelModel):
     url: HttpUrl
-    formats: list[ScrapeFormatEntry] = Field(default_factory=lambda: [MarkdownFormatConfig()])
+    formats: list[FormatConfig] = Field(default_factory=lambda: [MarkdownFormatConfig()])
     max_depth: int = Field(default=2, ge=0)
     max_pages: int = Field(default=50, ge=1, le=1000)
     max_links_per_page: int = Field(default=10, ge=1)