[ie/youtube] Rename get_setting to _configuration_arg

test/test_pot/test_pot_framework.py

@@ -199,14 +199,14 @@ class TestPoTokenProvider:
         assert sent_request.proxies == {'http': 'http://example-proxy-override.com'}
         assert sent_request.extensions['cookiejar'] is not cookiejar_request
 
-    def test_get_setting(self, ie, logger):
+    def test_get_config_arg(self, ie, logger):
         provider = ExamplePTP(ie=ie, logger=logger, settings={'abc': ['123D'], 'xyz': ['456a', '789B']})
 
-        assert provider.get_setting('abc') == ['123d']
+        assert provider._configuration_arg('abc') == ['123d']
-        assert provider.get_setting('abc', default=['default']) == ['123d']
+        assert provider._configuration_arg('abc', default=['default']) == ['123d']
-        assert provider.get_setting('ABC', default=['default']) == ['default']
+        assert provider._configuration_arg('ABC', default=['default']) == ['default']
-        assert provider.get_setting('abc', casesense=True) == ['123D']
+        assert provider._configuration_arg('abc', casesense=True) == ['123D']
-        assert provider.get_setting('xyz', casesense=False) == ['456a', '789b']
+        assert provider._configuration_arg('xyz', casesense=False) == ['456a', '789b']
 
     def test_require_class_end_with_suffix(self, ie, logger):
         class InvalidSuffix(PoTokenProvider):
@@ -314,13 +314,13 @@ class TestPoTokenCacheProvider:
         assert provider.BUG_REPORT_MESSAGE == 'please report this issue to the provider developer at  https://example.com/issues  .'
         assert provider.is_available()
 
-    def test_get_setting(self, ie, logger):
+    def test_get_config_arg(self, ie, logger):
         provider = ExampleCacheProviderPCP(ie=ie, logger=logger, settings={'abc': ['123D'], 'xyz': ['456a', '789B']})
-        assert provider.get_setting('abc') == ['123d']
+        assert provider._configuration_arg('abc') == ['123d']
-        assert provider.get_setting('abc', default=['default']) == ['123d']
+        assert provider._configuration_arg('abc', default=['default']) == ['123d']
-        assert provider.get_setting('ABC', default=['default']) == ['default']
+        assert provider._configuration_arg('ABC', default=['default']) == ['default']
-        assert provider.get_setting('abc', casesense=True) == ['123D']
+        assert provider._configuration_arg('abc', casesense=True) == ['123D']
-        assert provider.get_setting('xyz', casesense=False) == ['456a', '789b']
+        assert provider._configuration_arg('xyz', casesense=False) == ['456a', '789b']
 
     def test_require_class_end_with_suffix(self, ie, logger):
         class InvalidSuffix(PoTokenCacheProvider):
@@ -384,14 +384,14 @@ class TestPoTokenCacheSpecProvider:
         assert provider.generate_cache_spec(pot_request).default_ttl == 60
         assert provider.generate_cache_spec(pot_request).write_policy == CacheProviderWritePolicy.WRITE_FIRST
 
-    def test_get_setting(self, ie, logger):
+    def test_get_config_arg(self, ie, logger):
         provider = ExampleCacheSpecProviderPCSP(ie=ie, logger=logger, settings={'abc': ['123D'], 'xyz': ['456a', '789B']})
 
-        assert provider.get_setting('abc') == ['123d']
+        assert provider._configuration_arg('abc') == ['123d']
-        assert provider.get_setting('abc', default=['default']) == ['123d']
+        assert provider._configuration_arg('abc', default=['default']) == ['123d']
-        assert provider.get_setting('ABC', default=['default']) == ['default']
+        assert provider._configuration_arg('ABC', default=['default']) == ['default']
-        assert provider.get_setting('abc', casesense=True) == ['123D']
+        assert provider._configuration_arg('abc', casesense=True) == ['123D']
-        assert provider.get_setting('xyz', casesense=False) == ['456a', '789b']
+        assert provider._configuration_arg('xyz', casesense=False) == ['456a', '789b']
 
     def test_require_class_end_with_suffix(self, ie, logger):
         class InvalidSuffix(PoTokenCacheSpecProvider):

yt_dlp/extractor/youtube/pot/README.md

@@ -88,7 +88,7 @@ class MyPoTokenProviderPTP(PoTokenProvider):  # Provider name must end with "PTP
 
         # ℹ️ Settings are pulled from extractor args passed to yt-dlp with the key `youtubepot-<PROVIDER_KEY>`.
         # For this example, the extractor arg would be `--extractor-args "youtubepot-mypotokenprovider:url=https://custom.example.com/get_pot"`
-        external_provider_url = self.get_setting('url', default=['https://provider.example.com/get_pot'])[0]
+        external_provider_url = self._configuration_arg('url', default=['https://provider.example.com/get_pot'])[0]
 
         # You should use the internal HTTP client to make requests where possible,
         # as it will handle cookies and other networking settings passed to yt-dlp.
@@ -201,7 +201,7 @@ class MyCacheProviderPCP(PoTokenCacheProvider):  # Provider name must end with "
 
     def get(self, key: str):
         # ℹ️ Similar to PO Token Providers, Cache Providers and Cache Spec Providers are passed down extractor args matching key youtubepot-<PROVIDER_KEY>.
-        some_setting = self.get_setting('some_setting', default=['default_value'])[0]
+        some_setting = self._configuration_arg('some_setting', default=['default_value'])[0]
         return self.my_cache.get(key)
 
     def store(self, key: str, value: str, expires_at: str):

yt_dlp/extractor/youtube/pot/_provider.py

@@ -82,7 +82,7 @@ class IEContentProvider(abc.ABC):
     def close(self):  # noqa: B027
         pass
 
-    def get_setting(self, key, default=NO_DEFAULT, *, casesense=False):
+    def _configuration_arg(self, key, default=NO_DEFAULT, *, casesense=False):
         '''
         @returns            A list of values for the setting given by "key"
                             or "default" if no such key is present

yt_dlp/extractor/youtube/pot/builtin/cachespec/webpo.py

@@ -19,7 +19,7 @@ class WebPoPCSP(PoTokenCacheSpecProvider, BuiltInIEContentProvider):
     PROVIDER_NAME = 'webpo'
 
     def generate_cache_spec(self, request: PoTokenRequest) -> PoTokenCacheSpec | None:
-        bind_to_visitor_id = self.get_setting('bind_to_visitor_id', default=['true'])[0] == 'true'
+        bind_to_visitor_id = self._configuration_arg('bind_to_visitor_id', default=['true'])[0] == 'true'
         content_binding, content_binding_type = get_webpo_content_binding(
             request, bind_to_visitor_id=bind_to_visitor_id)