arconverter.ardate

 1"""Absalom Reckoning Date Class
 2
 3Example:
 4    >>> ar_date = ArDate()  # typically created via convert()
 5    >>> ar_date.month = "Erastus"
 6    >>> ar_date.day = 10
 7    >>> ar_date.year = 4723
 8    >>> print(ar_date.long_date())
 9    "Erastus 10, 4723"
10"""
11
12
13class ArDate:
14    """Represents an Absalom Reckoning Date
15
16    Examples:
17        >>> ar_date = ArDate()
18        >>> ar_date.month = "Erastus"
19        >>> ar_date.monthShort = "Era"
20        >>> ar_date.commonMonth = "Fletch"
21        >>> ar_date.day = 10
22        >>> ar_date.year = 4723
23        >>> ar_date.weekday = "Moonday"
24        >>> ar_date.weekdayShort = "Moon"
25        >>> ar_date.weekdayNum = 1
26        >>> ar_date.monthNum = 7
27        >>> ar_date.season = "Summer"
28    """
29
30    month: str
31    day: int
32    year: int
33    weekday: str
34    weekdayShort: str
35    weekdayNum: int
36    monthNum: int
37    monthShort: str
38    commonMonth: str
39    season: str
40
41    def short_date(self) -> str:
42        """Returns a short date string
43
44        Example:
45            >>> ar_date.short_date()
46            'Era 10, 4723'
47        """
48        return f'{self.monthShort} {self.day}, {self.year}'
49
50    def long_date(self) -> str:
51        """Returns a long date string
52
53        Example:
54            >>> ar_date.long_date()
55            'Erastus 10, 4723'
56        """
57        return f'{self.month} {self.day}, {self.year}'
58
59    def weekday_date(self) -> str:
60        """Returns a weekday date string
61
62        Example:
63            >>> ar_date.weekday_date()
64            'Moonday Erastus 10, 4723'
65        """
66        return f'{self.weekday} {self.month} {self.day}, {self.year}'
67
68    def common_long_month(self) -> str:
69        """Returns a long date string with common month name
70
71        Example:
72            >>> ar_date.common_long_month()
73            'Fletch 10, 4723'
74        """
75        return f'{self.commonMonth} {self.day}, {self.year}'
76
77    def month_season(self) -> str:
78        """Returns the season for the current month
79
80        Example:
81            >>> ar_date.month_season()
82            'Summer'
83        """
84        return self.season
85
86    def __str__(self) -> str:
87        """Returns a short date string"""
88        return self.short_date()