# -*- coding: utf-8 -*-

## \package globals.dateinfo

# MIT licensing
# See: docs/LICENSE.txt


from time       import strftime
from datetime   import datetime


## Formatting methods for dates & times
#  
#  Formats:
#    DEFAULT (none), CL (changelog), LOG (logger)
class DTFMT:
    DEFAULT = 0
    CL = 1
    LOG = 2


## Prepends a zero to single-digit numbers
#  
#  \return
#    \b \e String representation of digit
def _digit_to_string(number):
    if number < 10:
        return unicode(u'0{}'.format(number))
    
    return unicode(number)


## Retrieves the current year
#  
#  \return
#    \b \e String representation of the current year
def GetYear(fmt=DTFMT.DEFAULT):
    return unicode(strftime(u'%Y'))


## Retrieves today's date
#  
#  \param changelog
#    If \b \e True, formats output to Debian changelog standard
#  \return
#    \b \e String representation of date
def GetDate(fmt=DTFMT.DEFAULT):
    yr = GetYear()
    
    if fmt == DTFMT.CL:
        # Format: Wkdy, DD Mon YYYY
        # NOTE: May be a simpler method
        return u'{} {}'.format(strftime(u'%a, %d %b'), yr)
    
    # Format: YYYY-MM-DD
    return u'{}-{}'.format(yr, strftime(u'%m-%d'))


## Retrieves current time
def GetTime(fmt=DTFMT.DEFAULT):
    ms = None
    
    if fmt in (DTFMT.LOG,):
        ms = unicode(datetime.now().strftime(u'%f'))[:3]
    
    current_time = unicode(strftime(u'%T'))
    
    if ms != None:
        current_time = u'{}.{}'.format(current_time, ms)
    
    return current_time


## Retrieves current time zone
def GetTimeZone(fmt=DTFMT.DEFAULT):
    return unicode(strftime(u'%z'))