Core Types¶

JalaliTimestamp¶

JalaliTimestamp is the scalar type for Jalali dates.

from jalali_pandas import JalaliTimestamp

ts = JalaliTimestamp(1402, 6, 15, 10, 30)
print(ts.year, ts.month, ts.day)
print(ts.to_gregorian())

Key methods and properties:

JalaliTimestamp.from_gregorian(pd.Timestamp)
JalaliTimestamp.strptime(string, format)
to_gregorian()
normalize(), replace(...)
tz_localize(...), tz_convert(...)

JalaliDatetimeDtype¶

The pandas extension dtype representing Jalali timestamps.

from jalali_pandas.core.dtypes import JalaliDatetimeDtype

dtype = JalaliDatetimeDtype()

JalaliDatetimeArray¶

The extension array storing Jalali values.

from jalali_pandas.core.arrays import JalaliDatetimeArray
from jalali_pandas import JalaliTimestamp

arr = JalaliDatetimeArray._from_sequence(
    [JalaliTimestamp(1402, 1, 1), JalaliTimestamp(1402, 1, 2)]
)

Calendar utilities¶

from jalali_pandas.core.calendar import is_leap_year, days_in_month, days_in_year

is_leap_year(1403)
days_in_month(1402, 12)
days_in_year(1402)