Python >= 3.7 anno, src layout

.mypy.ini

@@ -1,12 +1,8 @@
 [mypy]
-files = sciencedates/
+files = src/
 
 ignore_missing_imports = True
-strict_optional = False
 allow_redefinition = True
 show_error_context = False
 show_column_numbers = True
 warn_unreachable = False
-
-[mypy-xarray]
-follow_imports = skip

date2doy.py

@@ -1,20 +1,15 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """
 command-line utility to convert date to day of year
 """
 from argparse import ArgumentParser
 from sciencedates import date2doy
 
 
-def main():
-    p = ArgumentParser(description="convert date to day of year")
-    p.add_argument("date", help="yyyy-mm-dd")
-    P = p.parse_args()
+p = ArgumentParser(description="convert date to day of year")
+p.add_argument("date", help="yyyy-mm-dd")
+P = p.parse_args()
 
-    doy, year = date2doy(P.date)
+doy, year = date2doy(P.date)
 
-    print(doy.item())
-
-
-if __name__ == "__main__":
-    main()
+print(doy.item())

findnearest.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 import numpy as np
 from bisect import bisect
 import sciencedates as sd
@@ -13,11 +13,6 @@ def INCORRECTRESULT_using_bisect(x, X0):  # pragma: no cover
     return np.asanyarray(ind), x[ind]
 
 
-def main():
-    print(sd.find_nearest([10, 15, 12, 20, 14, 33], [32, 12.01]))
+print(sd.find_nearest([10, 15, 12, 20, 14, 33], [32, 12.01]))
 
-    print(INCORRECTRESULT_using_bisect([10, 15, 12, 20, 14, 33], [32, 12.01]))
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()
+print(INCORRECTRESULT_using_bisect([10, 15, 12, 20, 14, 33], [32, 12.01]))

pyproject.toml

@@ -2,4 +2,4 @@
 requires = ["setuptools", "wheel"]
 
 [tool.black]
-line-length = 132
+line-length = 100

randomdate.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 """
 generate a random date (month and day) in a year.
 Michael Hirsch, Ph.D.
@@ -8,13 +8,8 @@
 from sciencedates import randomdate
 
 
-def main():
-    p = ArgumentParser(description="generate random date in year")
-    p.add_argument("year", type=int, nargs="?", default=date.today().year)
-    P = p.parse_args()
+p = ArgumentParser(description="generate random date in year")
+p.add_argument("year", type=int, nargs="?", default=date.today().year)
+P = p.parse_args()
 
-    print(randomdate(P.year))
-
-
-if __name__ == "__main__":
-    main()
+print(randomdate(P.year))

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = sciencedates
-version = 1.5.0
+version = 1.5.1
 author = Michael Hirsch, Ph.D.
 author_email = [email protected]
 url = https://github.com/geospace-code/sciencedates
@@ -21,22 +21,25 @@ long_description = file: README.md
 long_description_content_type = text/markdown
 
 [options]
-python_requires = >= 3.5
+python_requires = >= 3.7
 packages = find:
-scripts =
-  date2doy.py
-  findnearest.py
-  randomdate.py
 install_requires =
   numpy
   python-dateutil
+package_dir=
+    =src
+
+[options.packages.find]
+where=src
 
 [options.extras_require]
 tests =
   pytest
 lint =
   flake8
   mypy
+  types-pytz
+  types-python-dateutil
 plot =
   xarray
   matplotlib

sciencedates/dec.py → src/sciencedates/dec.py

@@ -1,12 +1,14 @@
+from __future__ import annotations
 import typing as T
-import numpy as np
 import datetime
 import dateutil.parser
+import numpy as np
+
 
 __all__ = ["datetime2utsec", "datetime2yeardec", "yeardec2datetime"]
 
 
-def datetime2utsec(t: T.Union[str, datetime.date, datetime.datetime, np.datetime64]) -> float:
+def datetime2utsec(t: T.Any) -> float | np.ndarray:
     """
     input: datetime
     output: float utc seconds since THIS DAY'S MIDNIGHT
@@ -20,7 +22,9 @@ def datetime2utsec(t: T.Union[str, datetime.date, datetime.datetime, np.datetime
     elif isinstance(t, str):
         t = dateutil.parser.parse(t)
 
-    return datetime.timedelta.total_seconds(t - datetime.datetime.combine(t.date(), datetime.datetime.min.time()))
+    return datetime.timedelta.total_seconds(
+        t - datetime.datetime.combine(t.date(), datetime.datetime.min.time())
+    )
 
 
 def yeardec2datetime(atime: float) -> datetime.datetime:
@@ -54,7 +58,7 @@ def yeardec2datetime(atime: float) -> datetime.datetime:
     return time
 
 
-def datetime2yeardec(time: T.Union[str, datetime.datetime, datetime.date]) -> float:
+def datetime2yeardec(time: str | datetime.datetime | datetime.date) -> float:
     """
     Convert a datetime into a float. The integer part of the float should
     represent the year.

sciencedates/doy.py → src/sciencedates/doy.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import typing as T
 import datetime
 import numpy as np
@@ -8,7 +9,7 @@
 __all__ = ["datetime2yeardoy", "yeardoy2datetime", "date2doy", "datetime2gtd"]
 
 
-def datetime2yeardoy(time: T.Union[str, datetime.datetime]) -> T.Tuple[int, float]:
+def datetime2yeardoy(time: T.Any) -> tuple[int, float]:
     """
     Inputs:
     T: Numpy 1-D array of datetime.datetime OR string for dateutil.parser.parse
@@ -33,7 +34,7 @@ def datetime2yeardoy(time: T.Union[str, datetime.datetime]) -> T.Tuple[int, floa
     return yd.squeeze()[()], utsec.squeeze()[()]
 
 
-def yeardoy2datetime(yeardate: int, utsec: T.Union[float, int] = None) -> datetime.datetime:
+def yeardoy2datetime(yeardate: int, utsec: float | int = 0) -> datetime.datetime:
     """
 
     Parameters
@@ -51,10 +52,10 @@ def yeardoy2datetime(yeardate: int, utsec: T.Union[float, int] = None) -> dateti
     http://stackoverflow.com/questions/2427555/python-question-year-and-day-of-year-to-date
     """
     if isinstance(yeardate, (tuple, list, np.ndarray)):
-        if utsec is None:
-            return np.asarray([yeardoy2datetime(y) for y in yeardate])
-        elif isinstance(utsec, (tuple, list, np.ndarray)):
+        if isinstance(utsec, (tuple, list, np.ndarray)):
             return np.asarray([yeardoy2datetime(y, s) for y, s in zip(yeardate, utsec)])
+        else:
+            return np.asarray([yeardoy2datetime(y, utsec) for y in yeardate])
 
     yeardate = int(yeardate)
 
@@ -65,15 +66,16 @@ def yeardoy2datetime(yeardate: int, utsec: T.Union[float, int] = None) -> dateti
     year = int(yd[:4])
     assert 0 < year < 3000, "year not in expected format"
 
-    dt = datetime.datetime(year, 1, 1) + datetime.timedelta(days=int(yd[4:]) - 1)
-
-    if utsec is not None:
-        dt += datetime.timedelta(seconds=utsec)
+    dt = (
+        datetime.datetime(year, 1, 1)
+        + datetime.timedelta(days=int(yd[4:]) - 1)
+        + datetime.timedelta(seconds=utsec)
+    )
 
     return dt
 
 
-def date2doy(time: T.Union[str, datetime.datetime]) -> T.Tuple[int, int]:
+def date2doy(time: T.Any) -> tuple[np.ndarray, np.ndarray]:
     """
     < 366 for leap year too. normal year 0..364.  Leap 0..365.
     """
@@ -94,7 +96,9 @@ def date2doy(time: T.Union[str, datetime.datetime]) -> T.Tuple[int, int]:
     return doy, year
 
 
-def datetime2gtd(time: T.Union[str, datetime.datetime, np.datetime64], glon: np.ndarray = np.nan) -> T.Tuple[int, float, float]:
+def datetime2gtd(
+    time: T.Any, glon: float | np.ndarray = np.nan
+) -> tuple[np.ndarray, np.ndarray, np.ndarray]:
     """
 
     Parameters

sciencedates/findnearest.py → src/sciencedates/findnearest.py

@@ -1,9 +1,10 @@
-from typing import Tuple, Any
+from __future__ import annotations
+import typing as T
 import numpy as np
 import datetime
 
 
-def find_nearest(x, x0) -> Tuple[int, Any]:
+def find_nearest(x, x0) -> tuple[int, T.Any]:
     """
     This find_nearest function does NOT assume sorted input
 
@@ -34,9 +35,14 @@ def find_nearest(x, x0) -> Tuple[int, Any]:
 
     # NOTE: not trapping IndexError (all-nan) becaues returning None can surprise with slice indexing
     for i, xi in enumerate(x0):
-        if xi is not None and (isinstance(xi, (datetime.datetime, datetime.date, np.datetime64)) or np.isfinite(xi)):
+        if xi is not None and (
+            isinstance(xi, (datetime.datetime, datetime.date, np.datetime64)) or np.isfinite(xi)
+        ):
             ind[i] = np.nanargmin(abs(x - xi))
         else:
             raise ValueError("x0 must NOT be None or NaN to avoid surprising None return value")
 
-    return ind.squeeze()[()], x[ind].squeeze()[()]  # [()] to pop scalar from 0d array while being OK with ndim>0
+    return (
+        ind.squeeze()[()],
+        x[ind].squeeze()[()],
+    )  # [()] to pop scalar from 0d array while being OK with ndim>0

sciencedates/random.py → src/sciencedates/random.py

@@ -4,7 +4,7 @@
 
 
 def randomdate(year: int) -> datetime.date:
-    """ gives random date in year"""
+    """gives random date in year"""
     if calendar.isleap(year):
         doy = random.randrange(366)
     else: