storm/limnoria-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some minor code cleanup.

Browse Source
This commit is contained in:
Storm Dragon
2025-03-30 13:24:36 -04:00
parent d97e7fa7b5
commit b6b08503f4
4 changed files with 107 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
Weather/plugin.py
View File

@@ -32,7 +32,7 @@ except ImportError:
class WeatherDB:
"""Class to handle user location storage and retrieval"""
pluginVersion = "0.1"
def __init__(self, filename):
self.filename = filename
@@ -40,7 +40,7 @@ class WeatherDB:
# Cache for geocoded locations
self.location_cache = {}
self.load()
def load(self):
"""Load the database from file"""
try:
@@ -64,33 +64,33 @@ class WeatherDB:
except IOError:
# File doesn't exist or can't be read
pass
def save(self):
"""Save the database to file"""
with open(self.filename, 'w') as f:
# Save user locations
for user, data in self.db.items():
f.write(f"{user}::{data['location']}::{data['lat']}::{data['lon']}\n")
# Save cached locations
for key, data in self.location_cache.items():
f.write(f"CACHE::{key}::{data['location']}||{data['lat']}||{data['lon']}\n")
def set(self, user, location, lat, lon):
"""Set a user's location"""
self.db[user] = {'location': location, 'lat': lat, 'lon': lon}
self.save()
def get(self, user):
"""Get a user's location"""
return self.db.get(user, None)
def remove(self, user):
"""Remove a user's location"""
if user in self.db:
del self.db[user]
self.save()
def add_to_cache(self, query, location, lat, lon):
"""Add a location to the cache"""
query_key = query.lower()
@@ -100,7 +100,7 @@ class WeatherDB:
'lon': lon
}
self.save()
def get_from_cache(self, query):
"""Get a location from the cache"""
query_key = query.lower()
@@ -114,7 +114,7 @@ class Configure(registry.Group):
def configure(self, advanced):
from supybot.questions import expect, anything, something, yn
conf.registerPlugin('Weather', True)
if advanced:
# User agent for Nominatim
user_agent = something("used for Nominatim?",
@@ -139,11 +139,11 @@ conf.registerChannelValue(Config, 'forecastDays',
class Weather(callbacks.Plugin):
"""Get weather forecasts using the Open-Meteo API"""
def __init__(self, irc):
self.__parent = super(Weather, self)
self.__parent.__init__(irc)
# Initialize weather codes (mapping from Open-Meteo codes to conditions)
self.weather_codes = {
0: "Clear sky",
@@ -175,41 +175,41 @@ class Weather(callbacks.Plugin):
96: "Thunderstorm with slight hail",
99: "Thunderstorm with heavy hail"
}
# Initialize database
self.db = WeatherDB(conf.supybot.directories.data.dirize('Weather.db'))
# Initialize geocoder
user_agent = self.registryValue('userAgent')
self.geocoder = Nominatim(user_agent=user_agent)
# Set up logging
self.log = log.getPluginLogger('Weather')
def _celsius_to_fahrenheit(self, celsius):
"""Convert Celsius to Fahrenheit"""
if celsius is None:
return None
return (celsius * 9/5) + 32
def _format_temp(self, temp, unit='F'):
"""Format temperature with unit"""
if temp is None:
return "N/A"
return f"{temp:.1f}°{unit}"
def _kmh_to_mph(self, kmh):
"""Convert km/h to mph"""
if kmh is None:
return None
return kmh * 0.621371
def _format_wind(self, wind_speed, unit='mph'):
"""Format wind speed with unit"""
if wind_speed is None:
return "N/A"
return f"{wind_speed:.1f} {unit}"
def _geocode(self, location):
"""Geocode a location string to get latitude and longitude"""
cached_location = self.db.get_from_cache(location)
@@ -220,7 +220,7 @@ class Weather(callbacks.Plugin):
'lon': cached_location['lon'],
'address': cached_location['location']
}
# If not in cache, query the geocoding service
try:
self.log.info(f"Geocoding new location: {location}")
@@ -233,7 +233,7 @@ class Weather(callbacks.Plugin):
location_data.latitude,
location_data.longitude
)
return {
'lat': location_data.latitude,
'lon': location_data.longitude,
@@ -243,7 +243,7 @@ class Weather(callbacks.Plugin):
except (GeocoderTimedOut, GeocoderServiceError) as e:
self.log.error(f"Geocoding error: {e}")
return None
def _get_weather(self, lat, lon, unit='F', forecast_days=3):
"""Get weather data from Open-Meteo API"""
url = f"https://api.open-meteo.com/v1/forecast"
@@ -255,28 +255,28 @@ class Weather(callbacks.Plugin):
'timezone': 'auto',
'forecast_days': forecast_days
}
try:
response = requests.get(url, params=params, timeout=10)
response.raise_for_status()
data = response.json()
# Process current weather
current = data.get('current', {})
temp_c = current.get('temperature_2m')
temp_f = self._celsius_to_fahrenheit(temp_c) if temp_c is not None else None
temp = temp_f if unit == 'F' else temp_c
humidity = current.get('relative_humidity_2m')
wind_kmh = current.get('wind_speed_10m')
wind_mph = self._kmh_to_mph(wind_kmh) if wind_kmh is not None else None
wind = wind_mph if unit == 'F' else wind_kmh
wind_unit = 'mph' if unit == 'F' else 'km/h'
weather_code = current.get('weather_code', 0)
conditions = self.weather_codes.get(weather_code, "Unknown")
# Process forecast
forecast = []
daily = data.get('daily', {})
@@ -284,26 +284,26 @@ class Weather(callbacks.Plugin):
min_temps_c = daily.get('temperature_2m_min', [])
max_temps_c = daily.get('temperature_2m_max', [])
codes = daily.get('weather_code', [])
for i in range(min(len(dates), forecast_days)):
date_str = dates[i]
min_temp_c = min_temps_c[i] if i < len(min_temps_c) else None
max_temp_c = max_temps_c[i] if i < len(max_temps_c) else None
code = codes[i] if i < len(codes) else 0
min_temp_f = self._celsius_to_fahrenheit(min_temp_c) if min_temp_c is not None else None
max_temp_f = self._celsius_to_fahrenheit(max_temp_c) if max_temp_c is not None else None
min_temp = min_temp_f if unit == 'F' else min_temp_c
max_temp = max_temp_f if unit == 'F' else max_temp_c
# Format date to day of week
try:
date_obj = datetime.datetime.strptime(date_str, '%Y-%m-%d')
day = date_obj.strftime('%A')
except ValueError:
day = date_str
forecast.append({
'day': day,
'date': date_str,
@@ -311,7 +311,7 @@ class Weather(callbacks.Plugin):
'max_temp': max_temp,
'conditions': self.weather_codes.get(code, "Unknown")
})
return {
'current': {
'temp': temp,
@@ -323,14 +323,14 @@ class Weather(callbacks.Plugin):
'forecast': forecast,
'unit': unit
}
except requests.RequestException as e:
self.log.error(f"Weather API error: {e}")
return None
def setweather(self, irc, msg, args, location):
"""<location>
Set your location for weather lookups. Location can be a city name, ZIP code, or any location string.
"""
# Improved identification check
@@ -339,25 +339,25 @@ class Weather(callbacks.Plugin):
# User is identified if we got this far
except KeyError:
irc.error("You must be identified to use this command. Register with NickServ and identify yourself.", Raise=True)
# Get the user's name
username = msg.prefix.split('!')[0]
# Geocode the location
location_data = self._geocode(location)
if not location_data:
irc.error("Could not find that location. Please try a different search term.", Raise=True)
# Store the user's location
self.db.set(username, location_data['address'], location_data['lat'], location_data['lon'])
irc.reply(f"Your location has been set to: {location_data['address']}")
setweather = wrap(setweather, ['text'])
def delweather(self, irc, msg, args):
"""takes no arguments
Delete your saved location.
"""
# Improved identification check
@@ -366,20 +366,20 @@ class Weather(callbacks.Plugin):
# User is identified if we got this far
except KeyError:
irc.error("You must be identified to use this command. Register with NickServ and identify yourself.", Raise=True)
# Get the user's name
username = msg.prefix.split('!')[0]
# Remove the user's location
self.db.remove(username)
irc.reply("Your location has been deleted.")
delweather = wrap(delweather)
def weather(self, irc, msg, args, location):
"""[<location>]
Show weather for your saved location, or for the specified location.
"""
channel = msg.args[0] if irc.isChannel(msg.args[0]) else None
@@ -388,17 +388,17 @@ class Weather(callbacks.Plugin):
show_wind = self.registryValue('showWind', channel)
show_forecast = self.registryValue('showForecast', channel)
forecast_days = self.registryValue('forecastDays', channel)
# Get the user's name
user = msg.prefix.split('!')[0]
# Determine if showing weather for a location or the user's saved location
if location:
# Looking up weather for the specified location
location_data = self._geocode(location)
if not location_data:
irc.error("Could not find that location. Please try a different search term.", Raise=True)
lat = location_data['lat']
lon = location_data['lon']
location_name = location_data['address']
@@ -408,33 +408,33 @@ class Weather(callbacks.Plugin):
user_data = self.db.get(user)
if not user_data:
irc.error("You have not set a location. Use '.weather <location>' to check the weather for a specific location, or '.setweather <location>' to save your location if you're registered.", Raise=True)
lat = user_data['lat']
lon = user_data['lon']
location_name = user_data['location']
weather_for = f"your location ({location_name})"
# Get the weather data
weather_data = self._get_weather(lat, lon, unit, forecast_days)
if not weather_data:
irc.error("Could not retrieve weather data. Please try again later.", Raise=True)
# Format the current weather
current = weather_data['current']
temp = self._format_temp(current['temp'], unit)
conditions = current['conditions']
reply = f"Weather for {weather_for}: {temp}, {conditions}"
if show_humidity and current['humidity'] is not None:
reply += f", Humidity: {current['humidity']}%"
if show_wind and current['wind'] is not None:
reply += f", Wind: {self._format_wind(current['wind'], current['wind_unit'])}"
# Send the current weather
irc.reply(reply)
# Format and send the forecast if requested
if show_forecast and weather_data['forecast']:
forecast_parts = []
@@ -442,10 +442,10 @@ class Weather(callbacks.Plugin):
min_temp = self._format_temp(day['min_temp'], unit)
max_temp = self._format_temp(day['max_temp'], unit)
forecast_parts.append(f"{day['day']}: {min_temp} to {max_temp}, {day['conditions']}")
forecast_msg = f"Forecast: {' | '.join(forecast_parts)}"
irc.reply(forecast_msg)
weather = wrap(weather, [optional('text')])

10
Weather/test.py
View File

@@ -8,21 +8,21 @@ from supybot.test import *
class WeatherTestCase(PluginTestCase):
plugins = ('Weather',)
def testWeatherCommands(self):
# Since we can't actually test the API calls in a unit test,
# we'll just test that the commands exist and respond
# Test setweather command
self.assertNotError('setweather Bluefield, WV')
# Test weather command with no arguments
# This should use the previously set location
self.assertNotError('weather')
# Test weather command with a location
self.assertNotError('weather Salt Lake City, Utah')
# Test delweather command
self.assertNotError('delweather')