dcicutils 8.8.3.1b12__tar.gz → 8.8.3.1b13__tar.gz

{dcicutils-8.8.3.1b12 → dcicutils-8.8.3.1b13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.3.1b12
+Version: 8.8.3.1b13
 Summary: Utility package for interacting with the 4DN Data Portal and other 4DN resources
 Home-page: https://github.com/4dn-dcic/utils
 License: MIT

{dcicutils-8.8.3.1b12 → dcicutils-8.8.3.1b13}/dcicutils/data_readers.py

@@ -66,6 +66,13 @@ class RowReader(abc.ABC):
         else:
             return value
 
+    @property
+    def nrows(self) -> int:
+        nrows = 0
+        for row in self:
+            nrows += 1
+        return nrows
+
     def open(self) -> None:
         pass
 
@@ -192,6 +199,10 @@ class Excel:
                 return True
         return False
 
+    @property
+    def nsheets(self) -> int:
+        return len(self.sheet_names)
+
     def __del__(self) -> None:
         if (workbook := self._workbook) is not None:
             self._workbook = None

{dcicutils-8.8.3.1b12 → dcicutils-8.8.3.1b13}/dcicutils/datetime_utils.py

@@ -1,6 +1,7 @@
 from dcicutils.misc_utils import normalize_spaces
 from datetime import datetime, timedelta, timezone
-from typing import Optional, Tuple
+from dateutil import parser as datetime_parser
+from typing import Optional, Tuple, Union
 
 
 def parse_datetime_string(value: str) -> Optional[datetime]:
@@ -82,6 +83,32 @@ def normalize_date_string(value: str) -> Optional[str]:
     return d.strftime("%Y-%m-%d") if d else None
 
 
+def get_timezone(hours: int, minutes: Optional[int] = None) -> timezone:
+    try:
+        return timezone(timedelta(hours=hours, minutes=minutes or 0))
+    except Exception:
+        return timezone.utc
+
+
+def get_timezone_hours_minutes(tz: timezone) -> Tuple[int, int]:
+    """
+    Returns a tuple with the integer hours and minutes offset for the given timezone.
+    """
+    tz_minutes = datetime.now(tz).utcoffset().total_seconds() / 60
+    return int(tz_minutes // 60), int(abs(tz_minutes % 60))
+
+
+def get_utc_timezone() -> timezone:
+    return timezone.utc
+
+
+def get_local_timezone() -> timezone:
+    """
+    Returns current/local timezone as a datetime.timezone object.
+    """
+    return datetime.now().astimezone().tzinfo
+
+
 def get_local_timezone_string() -> str:
     """
     Returns current/local timezone in format like: "-05:00".
@@ -96,3 +123,85 @@ def get_local_timezone_hours_minutes() -> Tuple[int, int]:
     """
     tz_minutes = datetime.now(timezone.utc).astimezone().utcoffset().total_seconds() / 60
     return int(tz_minutes // 60), int(abs(tz_minutes % 60))
+
+
+def parse_datetime(value: str, utc: bool = False, tz: Optional[timezone] = None) -> Optional[datetime]:
+    """
+    Parses the given string into a datetime, if possible, and returns that value,
+    or None if not able to parse. The timezone of the returned datetime will be the
+    local timezone; or if the given utc argument is True then it will be UTC; or if the
+    given tz argument is a datetime.timezone then return datetime will be in that timezone.
+    """
+    if isinstance(value, datetime):
+        return value
+    elif not isinstance(value, str):
+        return None
+    try:
+        # This dateutil.parser handles quite a wide variety of formats and suits our needs.
+        value = datetime_parser.parse(value)
+        if utc is True:
+            # If the given utc argument is True then it trumps any tz argument if given.
+            tz = timezone.utc
+        if value.tzinfo is not None:
+            # The given value had an explicit timezone specified.
+            if isinstance(tz, timezone):
+                return value.astimezone(tz)
+            return value
+        return value.replace(tzinfo=tz if isinstance(tz, timezone) else get_local_timezone())
+    except Exception:
+        return None
+
+
+def format_datetime(value: datetime,
+                    utc: bool = False,
+                    iso: bool = False,
+                    ms: bool = False,
+                    tz: Optional[Union[timezone, bool]] = None,
+                    notz: bool = False,
+                    noseconds: bool = False,
+                    verbose: bool = False,
+                    noseparator: bool = False,
+                    noday: bool = False) -> Optional[str]:
+    """
+    Returns the given datetime as a string in "YYYY:MM:DD hh:mm:ss tz" format, for
+    example "2024-04-17 15:42:26 EDT". If the given notz argument is True then omits
+    the timezone; if the noseconds argument is given the omits the seconds. If the given
+    verbose argument is True then returns a really verbose version of the datetime, for
+    example "Wednesday, April 17, 2024 | 15:42:26 EDT"; if the noseparator argument is
+    True then omits the "|" separator; if the noday argument is True then omits the day
+    of week part. The timezone of the returned datetime string will default to the local
+    one; if the given utc argument is True then it will be UTC; or if the given tz
+    argument is a datetime.timezone it will be in that timezone.
+    """
+    if not isinstance(value, datetime):
+        if not isinstance(value, str) or not (value := parse_datetime(value)):
+            return None
+    try:
+        if utc is True:
+            tz = timezone.utc
+        elif not isinstance(tz, timezone):
+            tz = get_local_timezone()
+            if tz is True:
+                notz = False
+            elif tz is False:
+                notz = True
+        value = value.astimezone(tz)
+        if iso:
+            if notz is True:
+                value = value.replace(tzinfo=None)
+            if not (ms is True):
+                value = value.replace(microsecond=0)
+            return value.isoformat()
+        if noseconds is True:
+            ms = False
+        if verbose:
+            return value.strftime(
+                f"{'' if noday is True else '%A, '}%B %-d, %Y{'' if noseparator is True else ' |'}"
+                f" %-I:%M{'' if noseconds is True else ':%S'}"
+                f"{f'.%f' if ms is True else ''} %p{'' if notz is True else ' %Z'}")
+        else:
+            return value.strftime(
+                f"%Y-%m-%d %H:%M{'' if noseconds is True else ':%S'}"
+                f"{f'.%f' if ms is True else ''}{'' if notz is True else ' %Z'}")
+    except Exception:
+        return None

{dcicutils-8.8.3.1b12 → dcicutils-8.8.3.1b13}/dcicutils/progress_bar.py

@@ -50,6 +50,7 @@ class ProgressBar:
     def __init__(self, total: Optional[int] = None,
                  description: Optional[str] = None,
                  use_byte_size_for_rate: bool = False,
+                 use_ascii: bool = False,
                  catch_interrupt: bool = True,
                  interrupt: Optional[Callable] = None,
                  interrupt_continue: Optional[Callable] = None,
@@ -66,6 +67,7 @@ class ProgressBar:
         self._tidy_output_hack = (tidy_output_hack is True)
         self._stop_requested = False
         self._use_byte_size_for_rate = (use_byte_size_for_rate is True and self._tidy_output_hack)
+        self._use_ascii = (use_ascii is True)
         # Interrupt handling. We do not do the actual (signal) interrupt setup
         # in self._initialize as that could be called from a (sub) thread; and in
         # Python we can only set a signal (SIGINT in our case) on the main thread.
@@ -103,7 +105,7 @@ class ProgressBar:
             else:
                 bar_format = "{l_bar}{bar}| {n_fmt}/{total_fmt} | {rate_fmt} | {elapsed}{postfix} | ETA: {remaining} "
             self._bar = TQDM(total=self._total, desc=self._description,
-                             dynamic_ncols=True, bar_format=bar_format, unit="", file=sys.stdout)
+                             dynamic_ncols=True, bar_format=bar_format, unit="", file=sys.stdout, ascii=self._use_ascii)
             self._started = time.time()
             if self._disabled:
                 self._bar.disable = True

{dcicutils-8.8.3.1b12 → dcicutils-8.8.3.1b13}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicutils"
-version = "8.8.3.1b12"  # TODO: To become 8.8.4
+version = "8.8.3.1b13"  # TODO: To become 8.8.4
 description = "Utility package for interacting with the 4DN Data Portal and other 4DN resources"
 authors = ["4DN-DCIC Team <support@4dnucleome.org>"]
 license = "MIT"