Source code for miranda.convert.utils

"""Conversion Utilities submodule."""
from __future__ import annotations

import hashlib
import logging.config
import os
import re
from pathlib import Path

import cftime
import pandas as pd
from pandas._libs import NaTType  # noqa

from miranda.scripting import LOGGING_CONFIG


__all__ = ["find_version_hash", "date_parser"]

[docs] def find_version_hash(file: os.PathLike | str) -> dict: """Check for an existing version hash file and, if one cannot be found, generate one from file. Parameters ---------- file : str or os.PathLike Returns ------- dict """ def _get_hash(f): hash_sha256_writer = hashlib.sha256() with open(f, "rb") as f_opened: hash_sha256_writer.update( sha256sum = hash_sha256_writer.hexdigest()"Calculated sha256sum (starting: {sha256sum[:6]})") del hash_sha256_writer return sha256sum version_info = dict() possible_version = Path(file) if re.match(r"^v\d+", possible_version, re.IGNORECASE): version_info["version"] = Path(file) version_info["sha256sum"] = _get_hash(file) else: file_identity = str(Path(file).name).split(".")[0] possible_version_signature = Path(file).parent.glob(f"{file_identity}.*") for sig in possible_version_signature: found_version ="\.(v\d+.+)$",, re.IGNORECASE) if found_version: try: version_info["version"] = version_info["sha256sum"] = int( except ValueError: continue break else: version_info["version"] = "vNotFound" version_info["sha256sum"] = _get_hash(file) return version_info
[docs] def date_parser( date: str, *, end_of_period: bool = False, output_type: str = "str", strftime_format: str = "%Y-%m-%d", ) -> str | pd.Timestamp | NaTType: """Parses datetime objects from a string representation of a date or both a start and end date. Parameters ---------- date : str Date to be converted. end_of_period : bool If True, the date will be the end of month or year depending on what's most appropriate. output_type : {"datetime", "str"} Desired returned object type. strftime_format : str If output_type=='str', this sets the strftime format. Returns ------- pd.Timestamp or str or pd.NaT Parsed date. Notes ----- Adapted from code written by Gabriel Rondeau-Genesse (@RondeauG) """ # Formats, ordered depending on string length formats = { 4: ["%Y"], 6: ["%Y%m"], 7: ["%Y-%m"], 8: ["%Y%m%d"], 10: ["%Y%m%d%H", "%Y-%m-%d"], 12: ["%Y%m%d%H%M"], 13: ["%Y%m-%Y%m"], 17: ["%Y%m%d-%Y%m%d"], 19: ["%Y-%m-%dT%H:%M:%S"], 21: ["%Y%m%d%H-%Y%m%d%H"], 25: ["%Y%m%d%H%M-%Y%m%d%H%M"], } end_date_found = False def _parse_date(d, fmts): for fmt in fmts: try: s = pd.to_datetime(d, format=fmt) match = fmt break except ValueError: pass else: raise ValueError( f"Can't parse date {d} with supported formats: [{', '.join(fmts)}]." ) return s, match date_format = None if isinstance(date, str): if len(date) in [13, 17, 21, 25]: dates = date.split("-") if not end_of_period: date = dates[0] else: date = dates[1] end_date_found = True try: possible_formats = formats[len(date)] date, date_format = _parse_date(date, possible_formats) except KeyError: # Return NaT for fixed/missing/ill-formatted date strings return pd.NaT elif isinstance(date, cftime.datetime): # noqa for n in range(3): try: date = pd.Timestamp.fromisoformat((date - pd.Timedelta(n)).isoformat()) except ValueError: # We are NOT catching OutOfBoundsDatetime. pass else: break else: raise ValueError( f"Unable to parse cftime date {date}, even when moving back 2 days." ) elif not isinstance(date, pd.Timestamp): date = pd.Timestamp(date) # noqa if end_of_period and date_format and not end_date_found: if "m" not in date_format: date = date + pd.tseries.offsets.YearEnd(1) # noqa elif "d" not in date_format: date = date + pd.tseries.offsets.MonthEnd(1) # noqa if output_type == "str": return date.strftime(strftime_format) return date