clarify class name requirements

This commit is contained in:
coletdjnz 2025-05-16 22:38:15 +12:00
parent 83edf67155
commit 26fbb09502
No known key found for this signature in database
GPG Key ID: 91984263BB39894A

View File

@ -41,7 +41,7 @@ import json
@register_provider @register_provider
class MyPoTokenProviderPTP(PoTokenProvider): # Provider name must end with "PTP" class MyPoTokenProviderPTP(PoTokenProvider): # Provider class name must end with "PTP"
PROVIDER_VERSION = '0.2.1' PROVIDER_VERSION = '0.2.1'
# Define a unique display name for the provider # Define a unique display name for the provider
PROVIDER_NAME = 'my-provider' PROVIDER_NAME = 'my-provider'
@ -200,7 +200,7 @@ from yt_dlp.extractor.youtube.pot.provider import PoTokenRequest
@register_provider @register_provider
class MyCacheProviderPCP(PoTokenCacheProvider): # Provider name must end with "PCP" class MyCacheProviderPCP(PoTokenCacheProvider): # Provider class name must end with "PCP"
PROVIDER_VERSION = '0.1.0' PROVIDER_VERSION = '0.1.0'
# Define a unique display name for the provider # Define a unique display name for the provider
PROVIDER_NAME = 'my-cache-provider' PROVIDER_NAME = 'my-cache-provider'
@ -255,7 +255,7 @@ def my_cache_preference(provider: PoTokenCacheProvider, request: PoTokenRequest)
`yt_dlp.extractor.youtube.pot.cache` `yt_dlp.extractor.youtube.pot.cache`
These are used to provide information on how to cache a particular PO Token Request. These are used to provide information on how to cache a particular PO Token Request.
You might have a different cache spec for different kinds of PO Tokens (e.g. WebPO vs iOSGuard) You might have a different cache spec for different kinds of PO Tokens.
```python ```python
from yt_dlp.extractor.youtube.pot.cache import ( from yt_dlp.extractor.youtube.pot.cache import (
@ -269,7 +269,7 @@ from yt_dlp.extractor.youtube.pot.provider import PoTokenRequest
@register_spec @register_spec
class MyCacheSpecProviderPCSP(PoTokenCacheSpecProvider): # Provider name must end with "PCSP" class MyCacheSpecProviderPCSP(PoTokenCacheSpecProvider): # Provider class name must end with "PCSP"
PROVIDER_VERSION = '0.1.0' PROVIDER_VERSION = '0.1.0'
# Define a unique display name for the provider # Define a unique display name for the provider
PROVIDER_NAME = 'mycachespec' PROVIDER_NAME = 'mycachespec'