1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
import logging
import pkgutil
from datetime import datetime
from pathlib import Path
from typing import List, Optional, Set, Type
from bot.constants import Month
__all__ = ("SeasonBase", "get_seasons", "get_extensions", "get_current_season", "get_season")
log = logging.getLogger(__name__)
def get_seasons() -> List[str]:
"""Returns all the Season objects located in /bot/seasons/."""
seasons = []
for module in pkgutil.iter_modules([Path("bot/seasons")]):
if module.ispkg:
seasons.append(module.name)
return seasons
def get_extensions() -> List[str]:
"""
Give a list of dot-separated paths to all extensions.
The strings are formatted in a way such that the bot's `load_extension`
method can take them. Use this to load all available extensions.
"""
base_path = Path("bot", "seasons")
extensions = []
for package in pkgutil.iter_modules([base_path]):
if package.ispkg:
package_path = base_path.joinpath(package.name)
for module in pkgutil.iter_modules([package_path]):
extensions.append(f"bot.seasons.{package.name}.{module.name}")
else:
extensions.append(f"bot.seasons.{package.name}")
return extensions
class SeasonBase:
"""
Base for Seasonal classes.
This serves as the off-season fallback for when no specific
seasons are active.
Seasons are 'registered' by simply by inheriting from `SeasonBase`,
as they are then found by looking at `__subclasses__`.
"""
season_name: str = "Evergreen"
bot_name: str = "SeasonalBot"
description: str = "The default season!"
branding_path: str = "seasonal/evergreen"
months: Set[Month] = set(Month)
def get_current_season() -> Type[SeasonBase]:
"""Give active season, based on current UTC month."""
current_month = Month(datetime.utcnow().month)
active_seasons = tuple(
season
for season in SeasonBase.__subclasses__()
if current_month in season.months
)
if not active_seasons:
return SeasonBase
if len(active_seasons) > 1:
log.warning(f"Multiple active season in month {current_month.name}")
return active_seasons[0]
def get_season(name: str) -> Optional[Type[SeasonBase]]:
"""
Give season such that its class name or its `season_name` attr match `name` (caseless).
If no such season exists, return None.
"""
name = name.casefold()
for season in [SeasonBase] + SeasonBase.__subclasses__():
matches = (season.__name__.casefold(), season.season_name.casefold())
if name in matches:
return season
|
