First good commit with TS & TSMsec classes &setup scripts

Author: asuiu

.gitignore

@@ -127,3 +127,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.idea/
+.pypirc

README.md

@@ -1,2 +1,19 @@
 # tsx
 Time Stamp eXtensions for Python
+
+### Usage:
+
+TS(ts: Union[int, float, str], prec: Literal["s", "ms"] = "s")
+TSMsec(ts: Union[int, float, str], prec: Literal["s", "ms"] = "ms")
+
+prec - means precision of the `ts` argument.
+    If prec=="s" - the `ts` argument will be interpreted as nr of seconds since epoch,
+    If prec=="s" - the `ts` argument will be interpreted as nr of milliseconds since epoch 
+
+Example:
+ts = TS(ts="1519855200.123856", prec="s")
+
+ts==1519855200.123856
+ts.as_iso == '2018-02-28T22:00:00.123856Z'
+ts.as_iso_tz(pytz.timezone("Europe/Bucharest"))=='2018-03-01T00:00:00.123856+02:00'
+

requirements.txt

@@ -0,0 +1,3 @@
+pyxtension>=1.13.15
+typing-extensions>=3.10.0.0
+dateparser>=1.0.0

setup.py

@@ -0,0 +1,109 @@
+# Always prefer setuptools over distutils
+# To use a consistent encoding
+from codecs import open
+from os import path
+
+from setuptools import setup
+
+__author__ = 'ASU'
+
+# Bump up this version
+VERSION = '0.0.1'
+
+basedir = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(basedir, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+install_requires = ['pyxtension>=1.13.15;python_version>="3.6"', 'typing-extensions>=3.10.0.0',
+                    'dateparser>=1.0.0'
+                    ]
+
+print("List of dependencies : {0}".format(str(install_requires)))
+
+parameters = dict(
+    name='tsx',
+
+    # Versions should comply with PEP440.  For a discussion on single-sourcing
+    # the version across setup.py and the project code, see
+    # https://packaging.python.org/en/latest/single_source_version.html
+    version=VERSION,
+
+    description='TimeStam eXtensions for Python',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+
+    # The project's main homepage.
+    url='https://github.com/asuiu/tsx',
+
+    author='Andrei Suiu',
+    author_email='[email protected]',
+
+    license='GPL',
+
+    classifiers=[
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        'Development Status :: 5 - Production/Stable',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Developers',
+        'Topic :: System :: Logging',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Internet :: Log Analysis',
+
+        # Pick your license as you wish (should match "license" above)
+        'License :: OSI Approved :: Apache Software License',
+
+        # Specify the Python versions you support basedir.
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy"
+    ],
+
+    # What does your project relate to?
+    keywords='logging elasticsearch handler log instrumentation',
+
+    # You can just specify the packages manually basedir if your project is
+    # simple. Or you can use find_packages().
+    # packages=find_packages(exclude=['dist', 'docs', 'build', 'tests']),
+    packages=['tsx'],
+
+    # Alternatively, if you want to distribute just a my_module.py, uncomment
+    # this:
+    #   py_modules=["my_module"],
+
+    # List run-time dependencies basedir.  These will be installed by pip when
+    # your project is installed. For an analysis of "install_requires" vs pip's
+    # requirements files see:
+    # https://packaging.python.org/en/latest/requirements.html
+    install_requires=install_requires,
+
+    # List additional groups of dependencies basedir (e.g. development
+    # dependencies). You can install these using the following syntax,
+    # for example:
+    # $ pip install -e .[dev,test]
+    extras_require={},
+
+    # If there are data files included in your packages that need to be
+    # installed, specify them basedir.  If using Python 2.6 or less, then these
+    # have to be included in MANIFEST.in as well.
+    package_data={},
+
+    # Although 'package_data' is the preferred approach, in some case you may
+    # need to place data files outside of your packages. See:
+    # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
+    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
+    data_files=[],
+
+    # To provide executable scripts, use entry points in preference to the
+    # "scripts" keyword. Entry points provide cross-platform support and allow
+    # pip to create the appropriate form of executable for the target platform.
+    entry_points={},
+)
+
+setup(**parameters)

tests/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# coding:utf-8
+# Author: ASU --<[email protected]>
+# Purpose: 
+# Created: 8/4/2021
+
+__author__ = 'ASU'
+
+
+class __init__.py(object):
+    def __init__(self):
+
+
+if __name__ == '__main__':
+    pass

tests/test_ts.py

@@ -0,0 +1,144 @@
+#!/usr/bin/env python
+# coding:utf-8
+# Author: ASU --<[email protected]>
+# Purpose: 
+# Created: 8/4/2021
+
+__author__ = 'ASU'
+
+import unittest
+from datetime import datetime
+from unittest import TestCase
+
+import pytz
+from dateutil import tz
+
+from tsx import TS, TSMsec
+
+
+class TestTS(TestCase):
+    INT_BASE_TS = 1519855200
+    INT_BASE_ROUND_MS_TS = 1519855200000
+    INT_BASE_MS_TS = 1519855200123
+    FLOAT_MS_TS = 1519855200.123856
+    STR_SEC_TS = "2018-02-28T22:00:00Z"
+    AS_FILE_SEC_TS = "20180228-220000"
+    STR_MSEC_TS = "2018-02-28T22:00:00.123000Z"
+
+    def _get_tz_delta(self, dt: datetime) -> float:
+        return tz.tzlocal().utcoffset(dt).total_seconds()
+
+    def test_from_ms(self):
+        ts = TS(ts=self.INT_BASE_ROUND_MS_TS + 500, prec="ms")
+        self.assertEqual(ts, self.INT_BASE_TS + 0.5)
+        # round up
+        ts = TS(ts=self.INT_BASE_ROUND_MS_TS + 501, prec="ms")
+        self.assertEqual(ts, self.INT_BASE_TS + 0.501)
+
+    def test_from_ms_str(self):
+        ts = TS(ts=str(self.INT_BASE_ROUND_MS_TS + 500), prec="ms")
+        self.assertEqual(ts, self.INT_BASE_TS + 0.5)
+        # round up
+        ts = TS(ts=self.INT_BASE_ROUND_MS_TS + 501, prec="ms")
+        self.assertEqual(ts, self.INT_BASE_TS + 0.501)
+
+    def test_TSMsec_nominal(self):
+        ts = TSMsec(ts=str(self.INT_BASE_ROUND_MS_TS + 500))
+        self.assertEqual(ts, self.INT_BASE_TS + 0.5)
+        # round up
+        ts = TS(ts=self.INT_BASE_ROUND_MS_TS + 501, prec="ms")
+        self.assertEqual(ts, self.INT_BASE_TS + 0.501)
+
+    def test_from_float_str(self):
+        ts = TS(ts="1519855200.123856", prec="s")
+        self.assertEqual(ts, self.FLOAT_MS_TS)
+
+    def test_from_int_str(self):
+        ts = TS(ts="1519855200")
+        self.assertEqual(ts, 1519855200)
+
+    def test_to_int(self):
+        ts = TS(ts=self.INT_BASE_ROUND_MS_TS + 500, prec="ms")
+        self.assertEqual(int(ts), self.INT_BASE_TS)
+        # round up
+        ts = TS(ts=self.INT_BASE_ROUND_MS_TS + 501, prec="ms")
+        self.assertEqual(int(ts), self.INT_BASE_TS + 1)
+
+    def test_as_iso(self):
+        ts = TS(ts=self.INT_BASE_TS)
+        self.assertEqual(ts.as_iso, self.STR_SEC_TS)
+
+    def test_as_iso_tz_standard(self):
+        ts = TS("2018-03-01T00:00:00Z")
+        res = ts.as_iso_tz(pytz.timezone("Europe/Bucharest"))
+        self.assertEqual(res, "2018-03-01T02:00:00+02:00")
+        res = ts.as_iso_tz("Europe/Bucharest")
+        self.assertEqual(res, "2018-03-01T02:00:00+02:00")
+
+    def test_as_iso_tz_DST(self):
+        ts = TS("2020-06-01T10:00:00Z")
+        res = ts.as_iso_tz(pytz.timezone("Europe/Bucharest"))
+        self.assertEqual(res, "2020-06-01T13:00:00+03:00")
+
+    def test_as_file_ts(self):
+        ts = TS(ts=self.INT_BASE_TS)
+        self.assertEqual(ts.as_file_ts, self.AS_FILE_SEC_TS)
+
+    def test_to_str(self):
+        ts = TS(ts=self.INT_BASE_TS)
+        self.assertEqual(str(ts), str(self.INT_BASE_TS))
+        float_ts = TS(ts=self.FLOAT_MS_TS)
+        self.assertEqual(str(float_ts), str(self.FLOAT_MS_TS))
+
+    def test_input_float_rounds(self):
+        # round down
+        ts = TS(ts=1519855200.123456)
+        self.assertEqual(ts.as_ms, 1519855200123)
+        # round up
+        ts = TS(ts=1519855200.123856)
+        self.assertEqual(ts.as_ms, 1519855200124)
+
+    def test_as_str_ms(self):
+        ts = TS(ts=self.INT_BASE_MS_TS, prec="ms")
+        self.assertEqual(ts.as_iso, self.STR_MSEC_TS)
+
+    def test_convert_from_str(self):
+        ts = TS(ts="2018-02-28T22:00:00Z")
+        self.assertEqual(ts, self.INT_BASE_TS)
+        ts = TS(ts="2018-02-28T22:00:00+00:00")
+        self.assertEqual(ts, self.INT_BASE_TS)
+
+    def test_convert_from_str_with_TZ_2(self):
+        ts = TS(ts="2018-02-28T22:00:00+01:30")
+        self.assertEqual(ts, self.INT_BASE_TS - 1.5 * 3600)
+
+    def test_convert_from_ms_str_local_time(self):
+        tz_delta_in_sec = self._get_tz_delta(datetime(2018, 2, 28))
+        ts = TS(ts="2018-02-28T22:00:00.123") + tz_delta_in_sec
+        utc_ms_ts = TS("2018-02-28T22:00:00.123Z")
+        self.assertEqual(utc_ms_ts, ts)
+
+    def test_convert_from_ms_str_with_TZ_0(self):
+        ts = TS(ts="2018-02-28T22:00:00.123+00:00")
+        self.assertEqual(ts, self.INT_BASE_MS_TS / 1000)
+
+        ts = TS(ts="2018-02-28T22:00:00.123Z")
+        self.assertEqual(ts, self.INT_BASE_MS_TS / 1000)
+
+    def test_math_ops(self):
+        ts = TS(ts=1519855200)
+        self.assertEqual((ts + 20).as_ms, 1519855220000)
+        self.assertEqual(TS(20 + ts).as_ms, 1519855220000)
+        self.assertEqual((ts - 0.5).as_ms, 1519855199500)
+
+    def test_as_iso_date(self):
+        ts = TS(ts=self.INT_BASE_TS)
+        self.assertEqual(ts.as_iso_date, "2018-02-28")
+
+    def test_repr(self):
+        ts = TS(ts=self.INT_BASE_TS)
+        self.assertEqual(repr(ts), "TS('2018-02-28T22:00:00Z')")
+
+
+if __name__ == '__main__':
+    unittest.main()

tsx/__init__.py

@@ -0,0 +1,3 @@
+from .ts import TS, TSMsec
+
+__all__ = ['TS', 'TSMsec']