Skip to content

← utilities package

FormatDatestamp

Format a datestamp into a string using either a named date form, or a custom format string using placeholders.

Formatting can additionally be localized using the locale parameter. This can also be applied to data structures(s) of datestamps. More Info... Version 0.5.0

Ports/Properties

datestamp

Input datestamp(s).

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

string

Formatted result string(s).

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

format

Format for the generated time stamps. This can either be one of the named formats, or a custom format string using placeholders. The basic placeholders are Y, Q, M, D for the numeric year, quarter, month, and day, respectively, Qo, Mo, Do for their ordinal forms (1st, 2nd etc), H, h, m, s for the hour (24- or 12-hour based), minute, and second, S for fractional seconds, d for day of the week, and A for AM/PM. Repeat characters like YYYY, ddd yield respectively more detailed forms of these components. For the time zone, use Z or ZZ for the time zone offset, and z or zz for the time zone name or abbreviation. A full listing of these placeholders can be found in the Pendulum documentation (https://pendulum.eustace.io/docs/#tokens).

  • verbose name: Format
  • default value: default
  • port type: ComboPort
  • value type: str (can be None)

locale

Locale for parsing of month and day names. Note that additional locales may be supported by the implementation.

  • verbose name: Locale For Date Format
  • default value: en
  • port type: ComboPort
  • value type: str (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)