Skip to content

← utilities package

CreateDatestamp

Create a new datestamp from the current time, or a given timestamp, or constituent parts.

To retrieve the current time in a desired time zone, leave all fields unspecified except for the time zone. To convert a POSIX (UNIX) time stamp (integer or float) into a datestamp, pass the timestamp and the desired time zone in which you want your datestamp to be expressed. To create a datestamp from constituent parts, populate some or all input fields with the desired values (at least year, month, and day must then be provided, the others assume default values). The resulting object can also be interrogated and updated via the GetField and GetNested or SetNested nodes, where the same fields, i.e., :year, :hour, etc are available. The timezone can be retrieved via :timezone_name and written via :tz. This can also be applied to data structure(s) of timestamps or e.g., arrays of hours, minutes, etc. Version 0.5.0

Ports/Properties

datestamp

Datestamp(s).

  • verbose name: Datestamp
  • default value: None
  • port type: DataPort
  • value type: AnyNumeric (can be None)
  • data direction: OUT

timestamp

POSIX timestamp(s).

  • verbose name: Timestamp
  • default value: None
  • port type: DataPort
  • value type: AnyNumeric (can be None)
  • data direction: IN

timezone

Desired timezone. If a POSIX timestamp is given (which is always in UTC), then the stamp is translated into the desired time zone. If the current time is requested, this is the current time in that time zone. Time zones are formatted as in US/Pacific, Europe/London, and so forth.

  • verbose name: Timezone
  • default value: UTC
  • port type: ComboPort
  • value type: str

year

Year.

  • verbose name: Year
  • default value: None
  • port type: Port
  • value type: int (can be None)

month

Month.

  • verbose name: Month
  • default value: None
  • port type: Port
  • value type: int (can be None)

day

Day.

  • verbose name: Day
  • default value: None
  • port type: Port
  • value type: int (can be None)

hour

Hour.

  • verbose name: Hour
  • default value: None
  • port type: Port
  • value type: int (can be None)

minute

Minute.

  • verbose name: Minute
  • default value: None
  • port type: Port
  • value type: int (can be None)

second

Second.

  • verbose name: Second
  • default value: None
  • port type: Port
  • value type: int (can be None)

microsecond

Microsecond.

  • verbose name: Microsecond
  • default value: None
  • port type: Port
  • value type: int (can be None)

fold

DST Fold (0 or 1). For times that occur twice in a given year (when the clock is reversed for daylight savings time), this identifies whether this is the first or second occurrence of that time. When a datestamp is constructed from scratch, and this is not specified, it is assumed to be the second occurrence (i.e., 1).

  • verbose name: Fold (Dst)
  • default value: None
  • port type: Port
  • value type: int (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)