Nominatim: warn for various sample user_agents too

geopy/geocoders/osm.py

@@ -9,6 +9,14 @@
 __all__ = ("Nominatim", )
 
 _DEFAULT_NOMINATIM_DOMAIN = 'nominatim.openstreetmap.org'
+_REJECTED_USER_AGENTS = (
+    # Various sample user-agent strings mentioned in docs:
+    "my-application",
+    "my_app/1",
+    "my_user_agent/1.0",
+    "specify_your_app_name_here",
+    _DEFAULT_USER_AGENT,
+)
 
 
 class Nominatim(Geocoder):
@@ -175,9 +183,9 @@ def __init__(
         self.domain = domain.strip('/')
 
         if (self.domain == _DEFAULT_NOMINATIM_DOMAIN
-                and self.headers['User-Agent'] == _DEFAULT_USER_AGENT):
+                and self.headers['User-Agent'] in _REJECTED_USER_AGENTS):
             warnings.warn(
-                'Using Nominatim with the default "%s" `user_agent` is '
+                'Using Nominatim with default or sample `user_agent` "%s" is '
                 'strongly discouraged, as it violates Nominatim\'s ToS '
                 'https://operations.osmfoundation.org/policies/nominatim/ '
                 'and may possibly cause 403 and 429 HTTP errors. '
@@ -186,7 +194,7 @@ def __init__(
                 'overriding the default `user_agent`: '
                 '`geopy.geocoders.options.default_user_agent = "my-application"`. '
                 'In geopy 2.0 this will become an exception.'
-                % _DEFAULT_USER_AGENT,
+                % self.headers['User-Agent'],
                 DeprecationWarning,
                 stacklevel=2
             )

test/geocoders/nominatim.py

@@ -68,9 +68,9 @@ def test_user_agent_default(self):
 
     def test_user_agent_custom(self):
         geocoder = self.make_geocoder(
-            user_agent='my_user_agent/1.0'
+            user_agent='my_test_application'
         )
-        assert geocoder.headers['User-Agent'] == 'my_user_agent/1.0'
+        assert geocoder.headers['User-Agent'] == 'my_test_application'
 
     def test_reverse(self):
         location = self.reverse_run(
@@ -348,6 +348,13 @@ def test_default_user_agent_warning(self):
             Nominatim()
             assert 1 == len(w)
 
+    def test_example_user_agent_warning(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter('always')
+            Nominatim(user_agent="specify_your_app_name_here")
+            assert 1 == len(w)
+
+    def test_custom_user_agent_works(self):
         with warnings.catch_warnings(record=True) as w:
             warnings.simplefilter('always')
             Nominatim(user_agent='my_application')