44 lines
1 KiB
Python
44 lines
1 KiB
Python
"""
|
|
Provides location/timezone data from IP addresses, using [[https://github.com/purarue/ipgeocache][ipgeocache]]
|
|
"""
|
|
|
|
from my.core import __NOT_HPI_MODULE__ # isort: skip
|
|
|
|
import ipaddress
|
|
from collections.abc import Iterator
|
|
from datetime import datetime
|
|
from typing import NamedTuple
|
|
|
|
import ipgeocache
|
|
|
|
from my.core import Json
|
|
|
|
|
|
class IP(NamedTuple):
|
|
dt: datetime
|
|
addr: str # an IP address
|
|
|
|
# TODO: could cache? not sure if it's worth it
|
|
def ipgeocache(self) -> Json:
|
|
return ipgeocache.get(self.addr)
|
|
|
|
@property
|
|
def latlon(self) -> tuple[float, float]:
|
|
loc: str = self.ipgeocache()["loc"]
|
|
lat, _, lon = loc.partition(",")
|
|
return float(lat), float(lon)
|
|
|
|
@property
|
|
def tzname(self) -> str:
|
|
tz: str = self.ipgeocache()["timezone"]
|
|
return tz
|
|
|
|
|
|
def drop_private(ips: Iterator[IP]) -> Iterator[IP]:
|
|
"""
|
|
Helper function that can be used to filter out private IPs
|
|
"""
|
|
for ip in ips:
|
|
if ipaddress.ip_address(ip.addr).is_private:
|
|
continue
|
|
yield ip
|