:py:mod:`gnome.scripting.time_utils`
====================================

.. py:module:: gnome.scripting.time_utils

.. autoapi-nested-parse::

   Handy utilities for working with time

   Internally, py_Gnome uses ``datetime.timedelta`` objects to represent time spans.
   But it is a bit awkward to create these objects::

       datetime.timedelta(seconds=3600)

   The time_utils module provides handy utilities to make it easier to construct
   these objects.

   Examples:

   ``hours()`` -- represents one hour

   ``hours(12)`` -- represents 12 hours

   As these functions return timedelta objects, you can do math with them::

     seconds() * 60
     days(2) + hours(12)

   etc...

   These are the full set:

   | ``seconds``
   | ``minutes``
   | ``hours``
   | ``days``
   | ``weeks``



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   gnome.scripting.time_utils.seconds
   gnome.scripting.time_utils.minutes
   gnome.scripting.time_utils.hours
   gnome.scripting.time_utils.days
   gnome.scripting.time_utils.weeks



Attributes
~~~~~~~~~~

.. autoapisummary::

   gnome.scripting.time_utils.now


.. py:data:: now

   

.. py:function:: seconds(seconds=1)

   returns a datetime.timedelta object representing the specified number of seconds"

   :param seconds=1:


.. py:function:: minutes(minutes=1)

   returns a datetime.timedelta object representing the specified number of minutes

   :param minutes=1:


.. py:function:: hours(hours=1)

   returns a datetime.timedelta object representing the specified number of hours

   :param hours=1:


.. py:function:: days(days=1)

   returns a datetime.timedelta object representing the specified number of hours"

   :param hours=1:


.. py:function:: weeks(weeks=1)

   returns a datetime.timedelta object representing the specified number of weeks"

   :param weeks=1: