Fix mypy - docs groups

Author: vdusek

src/apify/_actor.py

@@ -54,7 +54,7 @@
 
 
 @docs_name('Actor')
-@docs_group('Classes')
+@docs_group('Actor')
 class _ActorType:
     """The class of `Actor`. Only make a new instance if you're absolutely sure you need to."""
 

src/apify/_charging.py

@@ -26,7 +26,7 @@
 run_validator = TypeAdapter[ActorRun | None](ActorRun | None)
 
 
-@docs_group('Interfaces')
+@docs_group('Charging')
 class ChargingManager(Protocol):
     """Provides fine-grained access to pay-per-event functionality."""
 
@@ -57,7 +57,7 @@ def get_pricing_info(self) -> ActorPricingInfo:
         """
 
 
-@docs_group('Data structures')
+@docs_group('Charging')
 @dataclass(frozen=True)
 class ChargeResult:
     """Result of the `ChargingManager.charge` method."""
@@ -72,7 +72,7 @@ class ChargeResult:
     """How many events of each known type can still be charged within the limit."""
 
 
-@docs_group('Data structures')
+@docs_group('Charging')
 @dataclass
 class ActorPricingInfo:
     """Result of the `ChargingManager.get_pricing_info` method."""

src/apify/_configuration.py

@@ -25,7 +25,7 @@ def _transform_to_list(value: Any) -> list[str] | None:
     return value if isinstance(value, list) else str(value).split(',')
 
 
-@docs_group('Classes')
+@docs_group('Configuration')
 class Configuration(CrawleeConfiguration):
     """A class for specifying the configuration of an Actor.
 

src/apify/_models.py

@@ -16,7 +16,7 @@
     from typing import TypeAlias
 
 
-@docs_group('Data structures')
+@docs_group('Other')
 class Webhook(BaseModel):
     __model_config__ = ConfigDict(populate_by_name=True)
 
@@ -35,14 +35,14 @@ class Webhook(BaseModel):
     ] = None
 
 
-@docs_group('Data structures')
+@docs_group('Actor')
 class ActorRunMeta(BaseModel):
     __model_config__ = ConfigDict(populate_by_name=True)
 
     origin: Annotated[MetaOrigin, Field()]
 
 
-@docs_group('Data structures')
+@docs_group('Actor')
 class ActorRunStats(BaseModel):
     __model_config__ = ConfigDict(populate_by_name=True)
 
@@ -63,7 +63,7 @@ class ActorRunStats(BaseModel):
     compute_units: Annotated[float, Field(alias='computeUnits')]
 
 
-@docs_group('Data structures')
+@docs_group('Actor')
 class ActorRunOptions(BaseModel):
     __model_config__ = ConfigDict(populate_by_name=True)
 
@@ -74,7 +74,7 @@ class ActorRunOptions(BaseModel):
     max_total_charge_usd: Annotated[Decimal | None, Field(alias='maxTotalChargeUsd')] = None
 
 
-@docs_group('Data structures')
+@docs_group('Actor')
 class ActorRunUsage(BaseModel):
     __model_config__ = ConfigDict(populate_by_name=True)
 
@@ -92,7 +92,7 @@ class ActorRunUsage(BaseModel):
     proxy_serps: Annotated[float | None, Field(alias='PROXY_SERPS')] = None
 
 
-@docs_group('Data structures')
+@docs_group('Actor')
 class ActorRun(BaseModel):
     __model_config__ = ConfigDict(populate_by_name=True)
 

src/apify/_platform_event_manager.py

@@ -31,13 +31,13 @@
 __all__ = ['EventManager', 'LocalEventManager', 'PlatformEventManager']
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class PersistStateEvent(BaseModel):
     name: Literal[Event.PERSIST_STATE]
     data: Annotated[EventPersistStateData, Field(default_factory=lambda: EventPersistStateData(is_migrating=False))]
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class SystemInfoEventData(BaseModel):
     mem_avg_bytes: Annotated[float, Field(alias='memAvgBytes')]
     mem_current_bytes: Annotated[float, Field(alias='memCurrentBytes')]
@@ -64,31 +64,31 @@ def to_crawlee_format(self, dedicated_cpus: float) -> EventSystemInfoData:
         )
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class SystemInfoEvent(BaseModel):
     name: Literal[Event.SYSTEM_INFO]
     data: SystemInfoEventData
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class MigratingEvent(BaseModel):
     name: Literal[Event.MIGRATING]
     data: Annotated[EventMigratingData, Field(default_factory=EventMigratingData)]
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class AbortingEvent(BaseModel):
     name: Literal[Event.ABORTING]
     data: Annotated[EventAbortingData, Field(default_factory=EventAbortingData)]
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class ExitEvent(BaseModel):
     name: Literal[Event.EXIT]
     data: Annotated[EventExitData, Field(default_factory=EventExitData)]
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class EventWithoutData(BaseModel):
     name: Literal[
         Event.SESSION_RETIRED,
@@ -101,13 +101,13 @@ class EventWithoutData(BaseModel):
     data: Any = None
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class DeprecatedEvent(BaseModel):
     name: Literal['cpuInfo']
     data: Annotated[dict[str, Any], Field(default_factory=dict)]
 
 
-@docs_group('Data structures')
+@docs_group('Event data')
 class UnknownEvent(BaseModel):
     name: str
     data: Annotated[dict[str, Any], Field(default_factory=dict)]
@@ -120,7 +120,7 @@ class UnknownEvent(BaseModel):
 )
 
 
-@docs_group('Classes')
+@docs_group('Event managers')
 class PlatformEventManager(EventManager):
     """A class for managing Actor events.
 

src/apify/_proxy_configuration.py

@@ -70,7 +70,7 @@ def _check(
         raise ValueError(f'{error_str} does not match pattern {pattern.pattern!r}')
 
 
-@docs_group('Classes')
+@docs_group('Configuration')
 @dataclass
 class ProxyInfo(CrawleeProxyInfo):
     """Provides information about a proxy connection that is used for requests."""
@@ -90,7 +90,7 @@ class ProxyInfo(CrawleeProxyInfo):
     """
 
 
-@docs_group('Classes')
+@docs_group('Configuration')
 class ProxyConfiguration(CrawleeProxyConfiguration):
     """Configures a connection to a proxy server with the provided options.
 

src/apify/_utils.py

@@ -30,7 +30,16 @@ def is_running_in_ipython() -> bool:
     return getattr(builtins, '__IPYTHON__', False)
 
 
-GroupName = Literal['Classes', 'Abstract classes', 'Interfaces', 'Data structures', 'Errors', 'Functions']
+# The order of the rendered API groups is defined in the docusaurus-plugin-typedoc-api.
+GroupName = Literal[
+    'Actor',
+    'Charging',
+    'Configuration',
+    'Storage clients',
+    'Storage data',
+    'Storages',
+    'Other',
+]
 
 
 def docs_group(group_name: GroupName) -> Callable:  # noqa: ARG001

src/apify/storage_clients/_apify/_models.py

@@ -5,13 +5,13 @@
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from crawlee._utils.docs import docs_group
 from crawlee.storage_clients.models import KeyValueStoreMetadata
 
 from apify import Request
+from apify._utils import docs_group
 
 
-@docs_group('Data structures')
+@docs_group('Storage data')
 class ApifyKeyValueStoreMetadata(KeyValueStoreMetadata):
     """Extended key-value store metadata model for Apify platform.
 
@@ -22,7 +22,7 @@ class ApifyKeyValueStoreMetadata(KeyValueStoreMetadata):
     """The secret key used for signing URLs for secure access to key-value store records."""
 
 
-@docs_group('Data structures')
+@docs_group('Storage data')
 class ProlongRequestLockResponse(BaseModel):
     """Response to prolong request lock calls."""
 
@@ -31,7 +31,7 @@ class ProlongRequestLockResponse(BaseModel):
     lock_expires_at: Annotated[datetime, Field(alias='lockExpiresAt')]
 
 
-@docs_group('Data structures')
+@docs_group('Storage data')
 class RequestQueueHead(BaseModel):
     """Model for request queue head.
 
@@ -61,7 +61,10 @@ class RequestQueueHead(BaseModel):
 
 
 class KeyValueStoreKeyInfo(BaseModel):
-    """Model for a key-value store key info."""
+    """Model for a key-value store key info.
+
+    Only internal structure.
+    """
 
     model_config = ConfigDict(populate_by_name=True)
 
@@ -70,7 +73,10 @@ class KeyValueStoreKeyInfo(BaseModel):
 
 
 class KeyValueStoreListKeysPage(BaseModel):
-    """Model for listing keys in the key-value store."""
+    """Model for listing keys in the key-value store.
+
+    Only internal structure.
+    """
 
     model_config = ConfigDict(populate_by_name=True)
 
@@ -83,7 +89,10 @@ class KeyValueStoreListKeysPage(BaseModel):
 
 
 class CachedRequest(BaseModel):
-    """Pydantic model for cached request information."""
+    """Pydantic model for cached request information.
+
+    Only internal structure.
+    """
 
     id: str
     """The ID of the request."""

src/apify/storage_clients/_apify/_storage_client.py

@@ -9,11 +9,13 @@
 from ._dataset_client import ApifyDatasetClient
 from ._key_value_store_client import ApifyKeyValueStoreClient
 from ._request_queue_client import ApifyRequestQueueClient
+from apify._utils import docs_group
 
 if TYPE_CHECKING:
     from crawlee.configuration import Configuration
 
 
+@docs_group('Storage clients')
 class ApifyStorageClient(StorageClient):
     """Apify storage client."""
 

src/apify/storage_clients/_file_system/_storage_client.py

@@ -4,7 +4,6 @@
 
 from typing_extensions import override
 
-from crawlee._utils.docs import docs_group
 from crawlee.configuration import Configuration
 from crawlee.storage_clients import FileSystemStorageClient
 
@@ -14,7 +13,6 @@
     from crawlee.storage_clients._file_system import FileSystemKeyValueStoreClient
 
 
-@docs_group('Classes')
 class ApifyFileSystemStorageClient(FileSystemStorageClient):
     """Apify-specific implementation of the file system storage client.