Add is_anycast to Traits

Author: marselester

HISTORY.rst

@@ -9,6 +9,11 @@ History
 
 * IMPORTANT: Python 3.8 or greater is required. If you are using an older
   version, please use an earlier release.
+* The ``is_anycast`` attribute was added to ``geoip2.record.Traits``.
+  This returns ``True`` if the IP address belongs to an
+  `anycast network <https://en.wikipedia.org/wiki/Anycast>`_.
+  This is available for the GeoIP2 Country, City Plus, and Insights web services
+  and the GeoIP2 Country, City, and Enterprise databases.
 
 4.7.0 (2023-05-09)
 ++++++++++++++++++

geoip2/records.py

@@ -634,6 +634,14 @@ class Traits(Record):
 
       :type: str
 
+    .. attribute:: is_anycast
+
+      This is true if the IP address is anycast.
+      This attribute is available from the Country, City Plus, Insights
+      web services and the Country, City, Enterprise databases.
+
+      :type: bool
+
     .. attribute:: is_anonymous
 
       This is true if the IP address belongs to any sort of anonymous network.
@@ -815,6 +823,7 @@ class Traits(Record):
     autonomous_system_organization: Optional[str]
     connection_type: Optional[str]
     domain: Optional[str]
+    is_anycast: bool
     is_anonymous: bool
     is_anonymous_proxy: bool
     is_anonymous_vpn: bool
@@ -841,6 +850,7 @@ def __init__(
         autonomous_system_organization: Optional[str] = None,
         connection_type: Optional[str] = None,
         domain: Optional[str] = None,
+        is_anycast: bool = False,
         is_anonymous: bool = False,
         is_anonymous_proxy: bool = False,
         is_anonymous_vpn: bool = False,
@@ -866,6 +876,7 @@ def __init__(
         self.autonomous_system_organization = autonomous_system_organization
         self.connection_type = connection_type
         self.domain = domain
+        self.is_anycast = is_anycast
         self.is_anonymous = is_anonymous
         self.is_anonymous_proxy = is_anonymous_proxy
         self.is_anonymous_vpn = is_anonymous_vpn

tests/database_test.py

@@ -135,6 +135,10 @@ def test_city(self) -> None:
             record.location.accuracy_radius, 100, "The accuracy_radius is populated"
         )
         self.assertEqual(record.registered_country.is_in_european_union, False)
+        self.assertFalse(record.traits.is_anycast)
+
+        record = reader.city("214.1.1.0")
+        self.assertTrue(record.traits.is_anycast)
 
         reader.close()
 
@@ -171,6 +175,11 @@ def test_country(self) -> None:
         self.assertEqual(record.traits.network, ipaddress.ip_network("81.2.69.160/27"))
         self.assertEqual(record.country.is_in_european_union, False)
         self.assertEqual(record.registered_country.is_in_european_union, False)
+        self.assertFalse(record.traits.is_anycast)
+
+        record = reader.country("214.1.1.0")
+        self.assertTrue(record.traits.is_anycast)
+
         reader.close()
 
     def test_domain(self) -> None:
@@ -211,12 +220,15 @@ def test_enterprise(self) -> None:
             self.assertEqual(
                 record.traits.network, ipaddress.ip_network("74.209.16.0/20")
             )
+            self.assertFalse(record.traits.is_anycast)
 
             record = reader.enterprise("149.101.100.0")
-
             self.assertEqual(record.traits.mobile_country_code, "310")
             self.assertEqual(record.traits.mobile_network_code, "004")
 
+            record = reader.enterprise("214.1.1.0")
+            self.assertTrue(record.traits.is_anycast)
+
     def test_isp(self) -> None:
         with geoip2.database.Reader(
             "tests/data/test-data/GeoIP2-ISP-Test.mmdb"

tests/models_test.py

@@ -75,6 +75,7 @@ def test_insights_full(self) -> None:
                 "connection_type": "Cable/DSL",
                 "domain": "example.com",
                 "ip_address": "1.2.3.4",
+                "is_anycast": True,
                 "is_anonymous": True,
                 "is_anonymous_proxy": True,
                 "is_anonymous_vpn": True,
@@ -191,6 +192,7 @@ def test_insights_full(self) -> None:
         self.assertIs(model.registered_country.is_in_european_union, False)
         self.assertIs(model.represented_country.is_in_european_union, True)
 
+        self.assertIs(model.traits.is_anycast, True)
         self.assertIs(model.traits.is_anonymous, True)
         self.assertIs(model.traits.is_anonymous_proxy, True)
         self.assertIs(model.traits.is_anonymous_vpn, True)
@@ -322,6 +324,11 @@ def test_city_full(self) -> None:
             "Canada",
             "registered_country name is correct",
         )
+        self.assertEqual(
+            model.traits.is_anycast,
+            False,
+            "traits is_anycast returns False by default",
+        )
         self.assertEqual(
             model.traits.is_anonymous_proxy,
             False,

tests/webservice_test.py

@@ -44,7 +44,11 @@ class TestBaseClient(unittest.TestCase):
             "iso_code": "DE",
             "names": {"en": "Germany"},
         },
-        "traits": {"ip_address": "1.2.3.4", "network": "1.2.3.0/24"},
+        "traits": {
+            "ip_address": "1.2.3.4",
+            "is_anycast": True,
+            "network": "1.2.3.0/24"
+        },
     }
 
     # this is not a comprehensive representation of the
@@ -104,6 +108,7 @@ def test_country_ok(self):
         self.assertEqual(
             country.traits.network, ipaddress.ip_network("1.2.3.0/24"), "network"
         )
+        self.assertTrue(country.traits.is_anycast)
         self.assertEqual(country.raw, self.country, "raw response is correct")
 
     @httprettified
@@ -328,6 +333,7 @@ def test_city_ok(self):
         self.assertEqual(
             city.traits.network, ipaddress.ip_network("1.2.3.0/24"), "network"
         )
+        self.assertTrue(city.traits.is_anycast)
 
     @httprettified
     def test_insights_ok(self):
@@ -345,6 +351,7 @@ def test_insights_ok(self):
         self.assertEqual(
             insights.traits.network, ipaddress.ip_network("1.2.3.0/24"), "network"
         )
+        self.assertTrue(insights.traits.is_anycast)
         self.assertEqual(insights.traits.static_ip_score, 1.3, "static_ip_score is 1.3")
         self.assertEqual(insights.traits.user_count, 2, "user_count is 2")