dates module¶
The dates module implements classes for representing and manipulating several date types.
Contents¶
Notes
All instances of the classes in this module should be treated as read only. No attributes should be changed once they’re created.
-
class
pyluach.dates.BaseDate[source]¶ Bases:
objectBaseDate is a base class for all date types.
It provides the following arithmetic and comparison operators common to all child date types.
Operation
Result
d2 = date1 + int
New date
intdays after date1d2 = date1 - int
New date
intdays before date1int = date1 - date2
Integer equal to the absolute value of the difference between date1 and date2
date1 > date2
True if date1 occurs later than date2
date1 < date2
True if date1 occurs earlier than date2
date1 == date2
True if date1 occurs on the same day as date2
date1 != date2
True if
date1 == date2is Falsedate1 >=, <= date2
True if both are True
Any child of BaseDate that implements a jd attribute representing the Julian Day of that date can be compared to and diffed with any other valid date type.
-
class
pyluach.dates.CalendarDateMixin(year, month, day, jd=None)[source]¶ Bases:
objectCalendarDateMixin is a mixin for Hebrew and Gregorian dates.
- Parameters
Year (int) –
Month (int) –
day (int) –
-
year¶ - Type
int
-
month¶ - Type
int
-
day¶ - Type
int
-
jd¶ The equivelant Julian day at midnight.
- Type
float
-
dict()[source]¶ Return the date as a dictionary.
- Returns
A dictionary in the form
{'year': int, 'month': int, 'day': int}.- Return type
Dict
-
class
pyluach.dates.GregorianDate(year, month, day, jd=None)[source]¶ Bases:
pyluach.dates.BaseDate,pyluach.dates.CalendarDateMixinA GregorianDate object represents a Gregorian date (year, month, day).
This is an idealized date with the current Gregorian calendar infinitely extended in both directions.
- Parameters
year (int) –
month (int) –
day (int) –
jd (float, optional) – This parameter should not be assigned manually.
-
year¶ - Type
int
-
month¶ - Type
int
-
day¶ - Type
int
-
jd¶ The corresponding Julian Day Number at midnight (as n.5).
- Type
float(property)
Warning
Although B.C.E. dates are allowed, they should be treated as approximations as they may return inconsistent results when converting between date types and using arithmetic and comparison operators!
-
dict()¶ Return the date as a dictionary.
- Returns
A dictionary in the form
{'year': int, 'month': int, 'day': int}.- Return type
Dict
-
static
from_pydate(pydate)[source]¶ Return a GregorianDate instance from a python date object.
- Parameters
pydate (datetime.date) – A python standard library
datetime.dateinstance.- Returns
- Return type
-
is_leap()[source]¶ Return if the date is in a leap year
- Returns
True if the date is in a leap year, False otherwise.
- Return type
bool
-
property
jd Return the corresponding Julian day number.
This property retrieves the corresponding Julian Day as a float if it was passed into the init method or already calculated, and if it wasn’t, it calculates it and saves it for later retrievals and returns it.
- Returns
The Julian day number at midnight.
- Return type
float
-
shabbos()¶ Return the Shabbos on or following the date.
- Returns
Self if it’s Shabbos or else the following Shabbos as the same date type as operated on.
- Return type
Date
-
to_pydate()[source]¶ Convert to a standard library date.
- Returns
The equivalent datetime.date instance.
- Return type
datetime.date
-
static
today()[source]¶ Return a GregorianDate instance for the current day.
This static method wraps the Python standard library’s date.today() method to get the date from the timestamp.
- Returns
The current Gregorian date from the computer’s timestamp.
- Return type
-
tuple()¶ Return date as tuple.
- Returns
A tuple of ints in the form
(year, month, day).- Return type
tuple of ints
-
weekday()¶ Return day of week as an integer.
- Returns
An integer representing the day of the week with Sunday as 1 through Saturday as 7.
- Return type
int
-
class
pyluach.dates.HebrewDate(year, month, day, jd=None)[source]¶ Bases:
pyluach.dates.BaseDate,pyluach.dates.CalendarDateMixinA class for manipulating Hebrew dates.
- Parameters
year (int) – The Hebrew year. If the year is less than 1 it will raise a ValueError.
month (int) – The Hebrew month starting with Nissan as 1 (and Tishrei as 7). If there is a second Adar in the year it is represented as 13. A month below 1 or above the last month will raise a ValueError.
day (int) – The Hebrew day of the month. An invalid day will raise a ValueError.
jd (float, optional) – This parameter should not be assigned manually.
-
year¶ - Type
int
-
month¶ The Hebrew month starting with Nissan as 1 (and Tishrei as 7). If there is a second Adar it is represented as 13.
- Type
int
-
day¶ The day of the month.
- Type
int
-
dict()¶ Return the date as a dictionary.
- Returns
A dictionary in the form
{'year': int, 'month': int, 'day': int}.- Return type
Dict
-
static
from_pydate(pydate)[source]¶ Return a HebrewDate from a python date object.
- Parameters
pydate (datetime.date) – A python standard library
datetime.dateinstance- Returns
- Return type
-
property
jd¶ Return the corresponding Julian day number.
This property retrieves the corresponding Julian Day as a float if it was passed into the init method or already calculated, and if it wasn’t, it calculates it, saves it for later retrievals, and returns it.
- Returns
The Julian day number at midnight.
- Return type
float
-
shabbos()¶ Return the Shabbos on or following the date.
- Returns
Self if it’s Shabbos or else the following Shabbos as the same date type as operated on.
- Return type
Date
-
to_greg()[source]¶ Convert to a Gregorian date.
- Returns
The equivalent GregorianDate instance.
- Return type
-
to_pydate()[source]¶ Convert to a standard library date.
- Returns
The equivalent datetime.date instance.
- Return type
datetime.date
-
static
today()[source]¶ Return HebrewDate instance for the current day.
This static method wraps the Python standard library’s
date.today()method to get the date from the timestamp.- Returns
The current Hebrew date from the computer’s timestamp.
- Return type
Notes
This method coverts the Gregorian date from the time stamp to a Hebrew date, so if it is after nightfall but before midnight you will have to add one day, ie.
today = HebrewDate.today() + 1.
-
tuple()¶ Return date as tuple.
- Returns
A tuple of ints in the form
(year, month, day).- Return type
tuple of ints
-
weekday()¶ Return day of week as an integer.
- Returns
An integer representing the day of the week with Sunday as 1 through Saturday as 7.
- Return type
int
-
class
pyluach.dates.JulianDay(day)[source]¶ Bases:
pyluach.dates.BaseDateA JulianDay object represents a Julian Day at midnight.
- Parameters
day (float or int) – The julian day. Note that Julian days start at noon so day number 10 is represented as 9.5 which is day 10 at midnight.
-
day¶ The Julian Day Number at midnight (as n.5)
- Type
float
-
jd¶ Alias for day.
- Type
float
-
static
from_pydate(pydate)[source]¶ Return a JulianDay from a python date object.
- Parameters
pydate (datetime.date) – A python standard library
datetime.dateinstance- Returns
- Return type
-
shabbos()¶ Return the Shabbos on or following the date.
- Returns
Self if it’s Shabbos or else the following Shabbos as the same date type as operated on.
- Return type
Date
-
to_greg()[source]¶ Convert JulianDay to a Gregorian Date.
- Returns
The equivalent Gregorian date instance.
- Return type
Notes
This method uses the Fliegel-Van Flandern algorithm.
-
to_heb()[source]¶ Convert to a Hebrew date.
- Returns
The equivalent Hebrew date instance.
- Return type
-
to_pydate()[source]¶ Convert to a datetime.date object.
- Returns
A standard library
datetime.dateinstance.- Return type
datetime.date