Metadata-Version: 2.1
Name: py-itime
Version: 0.0.4
Summary: Time package supporting chain call
Home-page: https://github.com/AvinsWang/py-itime
Author: Avins Wang
Author-email: avinswang@gmail.com
License: LGPL-3.0
Download-URL: http://pypi.python.org/pypi/py-itime/
Keywords: py-itime,python time
Platform: UNKNOWN
Classifier: Topic :: Utilities
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3.6
License-File: LICENSE

`py-itime` --- Time package supporting chain call
==================================================

py-itime is a time package supporting chain call.

install and use:

::

    pip install py-itime


Example
-------

::

    from itime import iTime

    # get datetime str of previous day with specified hours
    >>> iTime(f'{iTime.now().delta(days=-1).date_str()} 10:00:00').datetime_str()
    '2021-04-04 10:00:00'

    # get unix timestamp of previous day
    >>> iTime.now().delta(days=-1).uts(is_ms=True)
    1627211818635

    # get corresponding unix timestamp with specified datetime str
    >>> iTime('2021-04-04 18:23:12').uts()
    1617531792

    # get datetime str of UTC time which is converted and down sampled by local time
    >>> iTime.now().delta(hours=8).ds(minutes=5).datetime_str()
    '2021-04-04 08:05:00'

Initialize
----------
There are 5 ways to initialize an iTime object.
::

    # 1. init with time str, format '%Y{}%m{}%d', '%Y{}%m{}%d %H{}%M{}%S' date_sep could be '','-','/', time_sep could be '',':'.
    >>> iTime('20210404')
    >>> iTime('2021-04-04 18:23:12')
    >>> iTime('2021/04/04 18:23:12')

    # 2. init with unix timestamp, support second and milliseconds, default as second
    >>> iTime(1617531792)
    >>> iTime(1617531792000, is_ms=True)    # if is milliseconds, is_ms=True
    >>> iTime(1617531792.123)               # float is also supported

    # 3. init with custom datetime str, use iTime.strp(time: str, fmt: str)
    >>> iTime.strp('2021-04-04 18:23', fmt='%Y-%m-%d %H:%M')

    # 4. init datetime.datetime object
    >>> dt = datetime.datetime.now()
    >>> iTime(dt)

    # 5. init with timetuple
    >>> iTime((2021, 4, 4, 18, 23, 12))
    >>> iTime(['2021', '04', '04', '18', '23', '12'])


class iTime
---------------


* iTime.now() -> iTime
    get current local time.
* iTime.today() -> iTime
    get current date, hour minute second is 00:00:00.
* iTime.strp(time: str, fmt: str) -> iTime
    init iTime from custom time str format.
* iTime.uts(is_ms=False) -> int
    get unix timestamp, if is_ms=True, get milliseconds.
* iTime.date_str(date_sep='-') -> str
    get date str, sep include '', '-', '/'.
* time_str(time_sep=':') -> str
    get time str, 'time_sep' is sep include '', ':'.
* datetime_str(date_sep='-', time_sep=':') -> str
    get datetime str, date_sep and time_sep same to above.
* join(datetime_str: str, fmt: str) -> iTime
    join iTime self with given time str.
    Notice: There is no date or time range checking, be careful

::
    >>> iTime('2021-04-04 18:23:12').join('23:59:59').__str__()
    '2021-04-04 23:59:59'
    >>> iTime('2021-04-04 23:59:59').join('10 235959', fmt='%d %H%M%S').__str__()
    '2021-04-10 23:59:59'
    >>> iTime('2021-04-04 18:23:12').join('10', fmt='%d').__str__()
    '2021-04-10 18:23:12'


* strf(fmt) -> str
    get custom time str with given fmt.
* pop() -> datetime.datetime
    get datetime.datetime object from iTime instance
* delta(days=0, seconds=0, minutes=0, hours=0) -> iTime
    get offset time.
* ds(hours=None, minutes=None, seconds=None) -> iTime
    down sample time, example as follows.

::
    >>> iTime('2021-04-04 18:23:12').ds(hours=5).__str__()
    '2021-04-04 15:23:12'
    >>> iTime('2021-04-04 18:23:12').ds(minutes=5).__str__()
    '2021-04-04 18:20:12'
    >>> iTime('2021-04-04 18:23:12').ds(seconds=5).__str__()
    '2021-04-04 18:23:10'
    >>> iTime('2021-04-04 18:23:12').ds(minutes=5, seconds=0).__str__()
    '2021-04-04 18:20:00'
    >>> iTime('2021-04-04 18:23:12').ds(hours=0, minutes=0, seconds=0).__str__()
    '2021-04-04 00:00:00'
    >>> iTime('2021-04-04 18:23:12').ds(hours=17, minutes=5, seconds=5).__str__()
    '2021-04-04 17:20:10'


