API documentation

API documentation#

Using Sphinx’s sphinx.ext.autodoc plugin, it is possible to auto-generate documentation of a Python module.

Tip

Avoid having in-function-signature type annotations with autodoc, by setting the following options:

# -- Options for autodoc ----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration

# Automatically extract typehints when specified and place them in
# descriptions of the relevant function/method.
autodoc_typehints = "description"

# Don't show class signature with the class' name.
autodoc_class_signature = "separated"

Fast implementation of the datetime type.

class datetime.date[source]#

date(year, month, day) –> date object

ctime()#: Return ctime() style string.

fromisocalendar()#

int, int, int -> Construct a date from the ISO year, week number and weekday.

This is the inverse of the date.isocalendar() function

fromisoformat()#: str -> Construct a date from the output of date.isoformat()

fromordinal()#: int -> date corresponding to a proleptic Gregorian ordinal.

fromtimestamp(timestamp, /)#

Create a date from a POSIX timestamp.

The timestamp is a number, e.g. created via time.time(), that is interpreted as local time.

isocalendar()#: Return a named tuple containing ISO year, week number, and weekday.

isoformat()#: Return string in ISO 8601 format, YYYY-MM-DD.

isoweekday()#: Return the day of the week represented by the date. Monday == 1 … Sunday == 7

replace()#: Return date with new specified fields.

strftime()#: format -> strftime() style string.

timetuple()#: Return time tuple, compatible with time.localtime().

today()#: Current date or datetime: same as self.__class__.fromtimestamp(time.time()).

toordinal()#: Return proleptic Gregorian ordinal. January 1 of year 1 is day 1.

weekday()#: Return the day of the week represented by the date. Monday == 0 … Sunday == 6

class datetime.datetime(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])[source]#

The year, month and day arguments are required. tzinfo may be None, or an instance of a tzinfo subclass. The remaining arguments may be ints.

astimezone()#: tz -> convert to local time in new timezone tz

combine()#: date, time -> datetime with same date and time fields

ctime()#: Return ctime() style string.

date()#: Return date object with same year, month and day.

dst()#: Return self.tzinfo.dst(self).

fromisoformat()#: string -> datetime from datetime.isoformat() output

fromtimestamp()#: timestamp[, tz] -> tz’s local time from POSIX timestamp.

isoformat()#: [sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM]. sep is used to separate the year from the time, and defaults to ‘T’. The optional argument timespec specifies the number of additional terms of the time to include. Valid options are ‘auto’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’ and ‘microseconds’.

now(/, tz=None)#

Returns new datetime object representing current time local to tz.

tz
Timezone object.

If no tz is specified, uses local timezone.

replace()#: Return datetime with new specified fields.

strptime()#: string, format -> new datetime parsed from a string (like time.strptime()).

time()#: Return time object with same time but with tzinfo=None.

timestamp()#: Return POSIX timestamp as float.

timetuple()#: Return time tuple, compatible with time.localtime().

timetz()#: Return time object with same time and tzinfo.

tzname()#: Return self.tzinfo.tzname(self).

utcfromtimestamp()#: Construct a naive UTC datetime from a POSIX timestamp.

utcnow()#: Return a new datetime representing UTC day and time.

utcoffset()#: Return self.tzinfo.utcoffset(self).

utctimetuple()#: Return UTC time tuple, compatible with time.localtime().

class datetime.time[source]#

time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) –> a time object

All arguments are optional. tzinfo may be None, or an instance of a tzinfo subclass. The remaining arguments may be ints.

dst()#: Return self.tzinfo.dst(self).

fromisoformat()#: string -> time from time.isoformat() output

isoformat()#

Return string in ISO 8601 format, [HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM].

The optional argument timespec specifies the number of additional terms of the time to include. Valid options are ‘auto’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’ and ‘microseconds’.

replace()#: Return time with new specified fields.

strftime()#: format -> strftime() style string.

tzname()#: Return self.tzinfo.tzname(self).

utcoffset()#: Return self.tzinfo.utcoffset(self).

class datetime.timedelta[source]#

Difference between two datetime values.

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

All arguments are optional and default to 0. Arguments may be integers or floats, and may be positive or negative.

days#: Number of days.

microseconds#: Number of microseconds (>= 0 and less than 1 second).

seconds#: Number of seconds (>= 0 and less than 1 day).

total_seconds()#: Total seconds in the duration.

class datetime.timezone[source]#

Fixed offset from UTC implementation of tzinfo.

dst()#: Return None.

fromutc()#: datetime in UTC -> datetime in local time.

tzname()#: If name is specified when timezone is created, returns the name. Otherwise returns offset as ‘UTC(+|-)HH:MM’.

utcoffset()#: Return fixed offset.

class datetime.tzinfo[source]#

Abstract base class for time zone info objects.

dst()#: datetime -> DST offset as timedelta positive east of UTC.

fromutc()#: datetime in UTC -> datetime in local time.

tzname()#: datetime -> string name of time zone.

utcoffset()#: datetime -> timedelta showing offset from UTC, negative values indicating West of UTC

API documentation

Contents

API documentation#