Added support for AS domain, AS usage type and AS CIDR

Author: ip2location

IP2Location/database.py

@@ -33,8 +33,11 @@
 _ADDRESSTYPE_POSITION         = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 21, 21)
 _CATEGORY_POSITION            = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 22, 22)
 _DISTRICT_POSITION            = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 23)
-_ASN_POSITION            = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 24)
-_AS_POSITION            = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25)
+_ASN_POSITION                 = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 24)
+_AS_POSITION                  = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25)
+_ASDOMAIN_POSITION            = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 26)
+_ASUSAGETYPE_POSITION         = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 27)
+_ASCIDR_POSITION              = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 28)
 
 if sys.version < '3':
     import urllib, httplib
@@ -156,6 +159,9 @@ class IP2LocationRecord:
     district = "This parameter is unavailable in selected .BIN data file. Please upgrade data file."
     asn = "This parameter is unavailable in selected .BIN data file. Please upgrade data file."
     as_name = "This parameter is unavailable in selected .BIN data file. Please upgrade data file."
+    as_domain = "This parameter is unavailable in selected .BIN data file. Please upgrade data file."
+    as_usagetype = "This parameter is unavailable in selected .BIN data file. Please upgrade data file."
+    as_cidr = "This parameter is unavailable in selected .BIN data file. Please upgrade data file."
 
     def __str__(self):
         return str(self.__dict__)
@@ -335,6 +341,18 @@ def get_as(self, ip):
         ''' Get as_name '''
         rec = self.get_all(ip)
         return rec and rec.as_name
+    def get_asdomain(self, ip):
+        ''' Get as_domain '''
+        rec = self.get_all(ip)
+        return rec and rec.as_domain
+    def get_asusagetype(self, ip):
+        ''' Get as_usagetype '''
+        rec = self.get_all(ip)
+        return rec and rec.as_usagetype
+    def get_ascidr(self, ip):
+        ''' Get as_cidr '''
+        rec = self.get_all(ip)
+        return rec and rec.as_cidr
 
     def get_all(self, addr):
         ''' Get the whole record with all fields read from the file
@@ -492,6 +510,15 @@ def calc_off(what, mid):
         if _AS_POSITION[self._dbtype] != 0:
             rec.as_name = self._reads(struct.unpack('<I', raw_positions_row[((_AS_POSITION[self._dbtype]-1) * 4 - 4) : ((_AS_POSITION[self._dbtype]-1) * 4)])[0] + 1)
 
+        if _ASDOMAIN_POSITION[self._dbtype] != 0:
+            rec.as_domain = self._reads(struct.unpack('<I', raw_positions_row[((_ASDOMAIN_POSITION[self._dbtype]-1) * 4 - 4) : ((_ASDOMAIN_POSITION[self._dbtype]-1) * 4)])[0] + 1)
+
+        if _ASUSAGETYPE_POSITION[self._dbtype] != 0:
+            rec.as_usagetype = self._reads(struct.unpack('<I', raw_positions_row[((_ASUSAGETYPE_POSITION[self._dbtype]-1) * 4 - 4) : ((_ASUSAGETYPE_POSITION[self._dbtype]-1) * 4)])[0] + 1)
+
+        if _ASCIDR_POSITION[self._dbtype] != 0:
+            rec.as_cidr = self._reads(struct.unpack('<I', raw_positions_row[((_ASCIDR_POSITION[self._dbtype]-1) * 4 - 4) : ((_ASCIDR_POSITION[self._dbtype]-1) * 4)])[0] + 1)
+
         return rec
 
     def __iter__(self):

docs/source/code.md

@@ -45,6 +45,9 @@ Retrieve geolocation information for an IP address.
 | district         |     District or county name. |
 | asn              |     Autonomous system number (ASN). BIN databases. |
 | as_name          |     Autonomous system (AS) name. |
+| as_domain        |     Domain name of the AS registrant. |
+| as_usagetype     |     Usage type of the AS registrant. |
+| as_cidr          |     CIDR range for the whole AS. |
 ```
 
 ## IP2LocationIPTools Class

docs/source/conf.py

@@ -6,11 +6,11 @@
 # -- Project information
 
 project = 'IP2Location'
-copyright = '2023, IP2Location'
+copyright = '2025, IP2Location'
 author = 'IP2Location'
 
-release = '8.10.0'
-version = '8.10.0'
+release = '8.11.0'
+version = '8.11.0'
 
 # -- General configuration
 

docs/source/quickstart.md

@@ -35,7 +35,7 @@ pip install IP2Location
 
 For Arch Linux user, you can install the module using the following command:
 ```Bash
-git clone https://aur.archlinux.org/ip2location-python.git && cd ip2location-io-python
+git clone https://aur.archlinux.org/ip2location-python.git && cd ip2location-python
 makepkg -si
 ```
 
@@ -86,12 +86,15 @@ print("Category              : " + rec.category)
 print("District              : " + rec.district)
 print("ASN                   : " + rec.asn)
 print("AS                    : " + rec.as_name)
+print("AS Domain             : " + rec.as_domain)
+print("AS Usage Type         : " + rec.as_usagetype)
+print("AS CIDR               : " + rec.as_cidr)
 print("\nYou may download the DB26 sample BIN at http://www.ip2location.com/downloads/sample6.bin.db26.zip for full data display.")
 ```
 
 ### Processing IP address using IP Tools class
 
-You can manupulate IP address, IP number and CIDR as below:
+You can manipulate IP address, IP number and CIDR as below:
 
 ``` python
 import IP2Location

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
 	name="IP2Location",
-	version="8.10.5", 
+	version="8.11.0", 
 	author="IP2Location",
 	author_email="[email protected]",
 	description="This is an IP geolocation library that enables the user to find the country, region, city, latitude and longitude, ZIP code, time zone, ISP, domain name, area code, weather info, mobile info, elevation, usage type, address type and IAB category from an IP address. It supports both IPv4 and IPv6 lookup.",

tests/test_database.py

@@ -16,9 +16,9 @@ def testinvaliddatabase():
 
 def testfunctionexist():
     database = IP2Location.IP2Location(ipv4database)
-    functions_list = ['open', 'close', 'get_all', 'get_country_short', 'get_country_long', 'get_region', 'get_city', 'get_latitude', 'get_longitude', 'get_isp', 'get_domain', 'get_zipcode', 'get_timezone', 'get_netspeed', 'get_idd_code', 'get_area_code', 'get_weather_code', 'get_weather_name', 'get_mcc', 'get_mnc', 'get_mobile_brand', 'get_elevation', 'get_usage_type', 'get_district', 'get_asn', 'get_as']
+    functions_list = ['open', 'close', 'get_all', 'get_country_short', 'get_country_long', 'get_region', 'get_city', 'get_latitude', 'get_longitude', 'get_isp', 'get_domain', 'get_zipcode', 'get_timezone', 'get_netspeed', 'get_idd_code', 'get_area_code', 'get_weather_code', 'get_weather_name', 'get_mcc', 'get_mnc', 'get_mobile_brand', 'get_elevation', 'get_usage_type', 'get_district', 'get_asn', 'get_as', 'get_asdomain', 'get_asusagetype', 'get_ascidr']
     for x in range(len(functions_list)): 
-        assert hasattr(database, functions_list[x]) == True, "Function did not exist."
+        assert hasattr(database, functions_list[x]) == True, f"Function {functions_list[x]} did not exist."
 
 def testipv4countrycode():
     database = IP2Location.IP2Location(ipv4database)
@@ -43,107 +43,122 @@ def testgetcountrylong():
 def testgetregion():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_region("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetcity():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_city("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetlatitude():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_latitude("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetlongitude():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_longitude("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetisp():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_isp("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetdomain():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_domain("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetzipcode():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_zipcode("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgettimezone():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_timezone("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetnetspeed():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_netspeed("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetiddcode():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_idd_code("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetareacode():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_area_code("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetweathercode():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_weather_code("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetweathername():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_weather_name("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetmcc():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_mcc("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetmnc():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_mnc("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetmobilebrand():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_mobile_brand("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetelevation():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_elevation("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetusagetype():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_usage_type("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetdistrict():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_district("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetasn():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_asn("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testgetas():
     database = IP2Location.IP2Location(ipv4database)
     rec = database.get_as("8.8.8.8")
-    assert rec == None
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
+
+def testgetasdomain():
+    database = IP2Location.IP2Location(ipv4database)
+    rec = database.get_asdomain("8.8.8.8")
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
+
+def testgetasusagetype():
+    database = IP2Location.IP2Location(ipv4database)
+    rec = database.get_asusagetype("8.8.8.8")
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
+
+def testgetascidr():
+    database = IP2Location.IP2Location(ipv4database)
+    rec = database.get_ascidr("8.8.8.8")
+    assert rec == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.'
 
 def testipv6countrycode():
     database = IP2Location.IP2Location(ipv6database)
@@ -158,4 +173,4 @@ def testipv6countryname():
 def testipv6unsupportedfield():
     database = IP2Location.IP2Location(ipv6database)
     rec = database.get_all("2001:4860:4860::8888")
-    assert rec.city == None, "Test failed because city name not same."
+    assert rec.city == 'This parameter is unavailable in selected .BIN data file. Please upgrade data file.', "Test failed because city name not same."