DateTime¶

Usage

use DateTime;

Support for representing dates, times, combined dates and times and timedeltas. This module is modeled heavily off of the python module 'datetime'.

For more detailed descriptions of this functionality, please see the python docs:

https://docs.python.org/2.7/library/datetime.html

Operators are supported for adding, subtracting, and comparing dates, times, datetimes and timedeltas.

Operators are also supported for multiplying and dividing timedeltas.

param MINYEAR = 1¶

The minimum year allowed in date objects

param MAXYEAR = 9999¶

The maximum year allowed in date objects

const unixEpoch = new datetime(1970, 1, 1)¶

The Unix Epoch date and time

enum DayOfWeek { Monday = 0, Tuesday = 1, Wednesday = 2, Thursday = 3, Friday = 4, Saturday = 5, Sunday = 6 }¶

Days in the week, starting with Monday = 0

enum ISODayOfWeek { Monday = 1, Tuesday = 2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6, Sunday = 7 }¶

Days in the week, starting with Monday = 1

proc isLeapYear(year: int)¶

Return true if year is a leap year

proc daysInMonth(year: int, month: int)¶

Return the number of days in month month during the year year. The number for a month can change from year to year due to leap years.

record date¶

A record representing a date

proc year¶

The year represented by this date value

proc month¶

The month represented by this date value

proc day¶

The day represented by this date value

proc type min¶

The minimum representable date

proc type max¶

The maximum representable date

proc type resolution¶

The minimum non-zero difference between two dates

proc date.date(year, month, day)¶

Construct a new date value from a year, month, and day. All three arguments are required and must be in valid ranges. The valid ranges are:

1 <= year <= 9999

1 <= month <= 12

1 <= day <= the number of days in the given month and year

proc type date.today()¶

A date object representing the current day

proc type date.fromtimestamp(timestamp)¶

The date that is timestamp seconds from the epoch

proc type date.fromordinal(ord)¶

The date that is ord days from 1-1-0001

proc date.replace(year = 0, month = 0, day = 0)¶

Replace the year, month and/or day in a date to create a new date

proc date.timetuple()¶

Return a filled record matching the C struct tm type for the given date

proc date.toordinal()¶

Return the number of days since 1-1-0001 this date represents

proc date.weekday()¶

Return the day of the week as a DayOfWeek. Monday == 0, Sunday == 6

proc date.isoweekday()¶

Return the day of the week as an ISODayOfWeek. Monday == 1, Sunday == 7

proc date.isocalendar()¶

Return the ISO date as a tuple containing the ISO year, ISO week number, and ISO day of the week

proc date.isoformat()¶

Return the date as a string in ISO 8601 format: "YYYY-MM-DD"

proc date.ctime()¶

Return a string representing the date

proc date.strftime(fmt: string)¶

Return a formatted string matching the format argument and the date

record time¶

A record representing a time

proc hour¶

The hour represented by this date value

proc minute¶

The minute represented by this date value

proc second¶

The second represented by this date value

proc microsecond¶

The microsecond represented by this date value

proc tzinfo¶

The timezone represented by this date value

proc type min¶

The minimum representable time

proc type max¶

The maximum representable time

proc type resolution¶

The minimum non-zero difference between two times

proc time.time(hour = 0, minute = 0, second = 0, microsecond = 0, tzinfo: TZInfo =)¶

Construct a new time value from the given hour, minute, second, microsecond, and timezone. All arguments are optional

proc time.replace(hour = -1, minute = -1, second = -1, microsecond = -1, tzinfo = this.tzinfo)¶

Replace the hour, minute, second, microsecond and tzinfo in a time to create a new time. All arguments are optional.

proc time.isoformat()¶

Return a string representing the time in ISO format

proc time.utcoffset()¶

Return the offset from UTC

proc time.dst()¶

Return the daylight saving time offset

proc time.tzname()¶

Return the name of the timezone for this time value

proc time.strftime(fmt: string)¶

Return a string matching the format argument for this time

record datetime¶

A record representing a combined date and time

proc type min¶

The minimum representable date and time

proc type max¶

The maximum representable date and time

proc type resolution¶

The minimum non-zero difference between two datetimes

proc year¶

The year represented by this datetime value

proc month¶

The month represented by this datetime value

proc day¶

The day represented by this datetime value

proc hour¶

The hour represented by this datetime value

proc minute¶

The minute represented by this datetime value

proc second¶

The second represented by this datetime value

proc microsecond¶

The microsecond represented by this datetime value

proc tzinfo¶

The timezone represented by this datetime value

proc datetime.datetime(year, month, day, hour = 0, minute = 0, second = 0, microsecond = 0, tzinfo: TZInfo =)¶

Construct a new datetime value from the given year, month, day, hour, minute, second, microsecond and timezone. The year, month, and day arguments are required, the rest are optional.

proc type datetime.today()¶

Return a datetime value representing the current time and date

proc type datetime.now(tz: TZInfo =)¶

Return a datetime value representing the current time and date

proc type datetime.utcnow()¶

Return a datetime value representing the current time and date in UTC

proc type datetime.fromtimestamp(timestamp: real, tz: TZInfo =)¶

The datetime that is timestamp seconds from the epoch

proc type datetime.utcfromtimestamp(timestamp)¶

The datetime that is timestamp seconds from the epoch in UTC

proc type datetime.fromordinal(ordinal)¶

The datetime that is ordinal days from 1-1-0001

proc type datetime.combine(d: date, t: time)¶

Form a datetime value from a given date and time

proc datetime.getdate()¶

Get the date portion of the datetime value

proc datetime.gettime()¶

Get the time portion of the datetime value, with tzinfo = nil

proc datetime.timetz()¶

Get the time portion of the datetime value including the tzinfo field

proc datetime.replace(year = -1, month = -1, day = -1, hour = -1, minute = -1, second = -1, microsecond = -1, tzinfo = this.tzinfo)¶

Replace the year, month, day, hour, minute, second, microsecond, or tzinfo to form a new datetime object. All arguments are optional.

proc datetime.astimezone(tz: TZInfo)¶

Return the date and time converted into the timezone in the argument

proc datetime.utcoffset()¶

Return the offset from UTC

proc datetime.dst()¶

Return the daylight saving time offset

proc datetime.tzname()¶

Return the name of the timezone for this datetime value

proc datetime.timetuple()¶

Return a filled record matching the C struct tm type for the given datetime

proc datetime.utctimetuple()¶

Return a filled record matching the C struct tm type for the given datetime in UTC

proc datetime.toordinal()¶

Return the number of days since 1-1-0001 this datetime represents

proc datetime.weekday()¶

Return the day of the week as a DayOfWeek. Monday == 0, Sunday == 6

proc datetime.isoweekday()¶

Return the day of the week as an ISODayOfWeek. Monday == 1, Sunday == 7

proc datetime.isocalendar()¶

Return the ISO date as a tuple containing the ISO year, ISO week number, and ISO day of the week

proc datetime.isoformat(sep = "T")¶

Return the datetime as a string in ISO format

proc type datetime.strptime(date_string: string, format: string)¶

Create a datetime as described by the date_string and format string

proc datetime.strftime(fmt: string)¶

Create a string from a datetime matching the format string

record timedelta¶

A record representing an amount of time. A timedelta has fields representing days, seconds, and microseconds. These fields are always kept within the following ranges:

0 <= microseconds < 1000000

0 <= seconds < 60*60*24

-999999999 <= days <= 999999999

It is an overflow error if days is outside the given range.

proc days¶

The number of days this timedelta represents

proc seconds¶

The number of seconds this timedelta represents

proc microseconds¶

The number of microseconds this timedelta represents

proc type min¶

Return the minimum representable timedelta object.

proc type max¶

Return the maximum representable timedelta object.

proc type resolution¶

Return the smallest positive value representable by a timedelta object.

proc timedelta.timedelta(days = 0, seconds = 0, microseconds = 0, milliseconds = 0, minutes = 0, hours = 0, weeks = 0)¶

Construct a timedelta object. All arguments are optional and default to 0. Since only days, seconds and microseconds are stored, the other arguments are converted to days, seconds and microseconds.

proc timedelta.timedelta(timestamp: real)

Create a timedelta from a given number of seconds

proc timedelta.total_seconds(): real¶

Return the total number of seconds represented by this object

proc abs(t: timedelta)¶

Return the absolute value of t. If t is negative, then returns -t, else returns t.

class TZInfo¶

Abstract base class for time zones. This class should not be used directly, but concrete implementations of time zones should be derived from it.

proc utcoffset(dt: datetime): timedelta¶

The offset from UTC this class represents

proc dst(dt: datetime): timedelta¶

The timedelta for daylight saving time

proc tzname(dt: datetime): string¶

The name of this time zone

proc fromutc(in dt: datetime): datetime¶

Convert a time in UTC to this time zone