thds.core 1.38.20250616192452__py3-none-any.whl → 1.38.20250617225213__py3-none-any.whl

thds/core/inspect.py

@@ -1,8 +1,9 @@
 import inspect
-from dataclasses import dataclass
 
+import attrs
 
-@dataclass(frozen=True)
+
+@attrs.frozen
 class CallerInfo:
     module: str = ""
     klass: str = ""

thds/core/meta.py

@@ -1,26 +1,22 @@
-"""Some parts of this module having to do with actual metadata files have been removed,
-being no longer in use.
-
-The actual removal was done mainly to enable us to remove attrs and cattrs as dependencies,
-not because we don't like them, but because reducing our depedency footprint in
-our most central library is a good idea.
-"""
-
 import importlib
+import json
 import os
 import re
 import typing as ty
-from dataclasses import dataclass, field
 from datetime import datetime, timezone
 from functools import lru_cache
 from getpass import getuser
 from importlib.metadata import PackageNotFoundError, version
-from importlib.resources import Package
+from importlib.resources import Package, open_text
 from pathlib import Path
 from types import MappingProxyType
 
+import attrs
+from cattrs import Converter
+
 from . import calgitver, git
 from .log import getLogger
+from .types import StrOrPath
 
 LayoutType = ty.Literal["flat", "src"]
 NameFormatType = ty.Literal["git", "docker", "hive"]
@@ -41,6 +37,8 @@ GIT_IS_DIRTY = "GIT_IS_DIRTY"
 GIT_BRANCH = "GIT_BRANCH"
 THDS_USER = "THDS_USER"
 
+META_FILE = "meta.json"
+
 LOGGER = getLogger(__name__)
 
 
@@ -172,6 +170,12 @@ def get_version(pkg: Package, orig: str = "") -> str:
             # 'recurse' upward, assuming that the package name is overly-specified
             pkg_ = pkg.split(".")
             if len(pkg_) <= 1:
+                # Check to see if there's a
+                # meta.json file hanging around, and if so, see if it contains a pyproject_version.
+                metadata = read_metadata(orig or pkg)
+                if metadata and metadata.pyproject_version:
+                    return metadata.pyproject_version
+
                 for env_var in ("CALGITVER", "GIT_COMMIT"):
                     env_var_version = os.getenv(env_var)
                     lvl = LOGGER.debug if env_var == "CALGITVER" else LOGGER.info
@@ -236,6 +240,16 @@ def get_commit(pkg: Package = "") -> str:  # should really be named get_commit_h
     except git.NO_GIT:
         pass
 
+    try:
+        if pkg:
+            LOGGER.debug("`get_commit` reading from metadata.")
+            metadata = read_metadata(pkg)
+            if metadata.is_empty:
+                raise EmptyMetadataException
+            return metadata.git_commit
+    except EmptyMetadataException:
+        pass
+
     LOGGER.warning("`get_commit` found no commit.")
     return ""
 
@@ -255,6 +269,16 @@ def is_clean(pkg: Package = "") -> bool:
     except git.NO_GIT:
         pass
 
+    try:
+        if pkg:
+            LOGGER.debug("`is_clean` reading from metadata.")
+            metadata = read_metadata(pkg)
+            if metadata.is_empty:
+                raise EmptyMetadataException
+            return metadata.git_is_clean
+    except EmptyMetadataException:
+        pass
+
     LOGGER.warning("`is_clean` found no cleanliness - assume dirty.")
     return False
 
@@ -270,6 +294,16 @@ def get_branch(pkg: Package = "", format: NameFormatType = "git") -> str:
         except git.NO_GIT:
             pass
 
+        try:
+            if pkg:
+                LOGGER.debug("`get_branch` reading from metadata.")
+                metadata = read_metadata(pkg)
+                if not metadata.git_branch:
+                    raise EmptyMetadataException
+                return metadata.git_branch
+        except EmptyMetadataException:
+            pass
+
         LOGGER.warning("`get_branch` found no branch.")
         return ""
 
@@ -282,12 +316,27 @@ def get_user(pkg: Package = "", format: NameFormatType = "git") -> str:
             LOGGER.debug("`get_user` reading from env var.")
             return os.environ[THDS_USER]
 
+        try:
+            if pkg:
+                LOGGER.debug("`get_user` reading from metadata.")
+                metadata = read_metadata(pkg)
+                if not metadata.thds_user:
+                    raise EmptyMetadataException
+                return metadata.thds_user
+        except EmptyMetadataException:
+            pass
+
         LOGGER.debug("`get_user` found no user data - getting system user.")
         return getuser()
 
     return format_name(_get_user(pkg), format)
 
 
+def is_deployed(pkg: Package) -> bool:
+    meta = read_metadata(pkg)
+    return not meta.is_empty
+
+
 def _hacky_get_pyproject_toml_version(pkg: Package, wdir: Path) -> str:
     # it will be a good day when Python packages a toml reader by default.
     ppt = wdir / "pyproject.toml"
@@ -330,14 +379,14 @@ def find_pyproject_toml_version(starting_path: Path, pkg: Package) -> str:
 MiscType = ty.Mapping[str, ty.Union[str, int, float, bool]]
 
 
-@dataclass(frozen=True)
+@attrs.frozen
 class Metadata:
     git_commit: str = ""
     git_branch: str = ""
     git_is_clean: bool = False
     pyproject_version: str = ""  # only present if the project defines `version` inside pyproject.toml
     thds_user: str = ""
-    misc: MiscType = field(default_factory=lambda: MappingProxyType(dict()))
+    misc: MiscType = attrs.field(factory=lambda: MappingProxyType(dict()))
 
     @property
     def docker_branch(self) -> str:
@@ -357,13 +406,103 @@ class Metadata:
 
     @property
     def is_empty(self) -> bool:
-        return all(not getattr(self, f.name) for f in self.__dataclass_fields__.values())
+        return all(not getattr(self, field.name) for field in attrs.fields(Metadata))
 
     @property
     def git_is_dirty(self) -> bool:
         return not self.git_is_clean
 
 
+meta_converter = Converter(forbid_extra_keys=True)
+meta_converter.register_structure_hook(
+    Metadata, lambda v, _: Metadata(misc=MappingProxyType(v.pop("misc", {})), **v)
+)
+
+
+class EmptyMetadataException(Exception):
+    pass
+
+
+def init_metadata(misc: ty.Optional[MiscType] = None, pyproject_toml_version: str = "") -> Metadata:
+    return Metadata(
+        git_commit=get_commit(),
+        git_branch=get_branch(),
+        git_is_clean=is_clean(),
+        pyproject_version=pyproject_toml_version,
+        thds_user=os.getenv(THDS_USER, getuser()),
+        misc=MappingProxyType(misc) if misc else MappingProxyType(dict()),
+    )
+
+
+def _sanitize_metadata_for_docker_tools(d: dict):
+    """We want our Docker builds to be able to take advantage of
+    caching based on the contents of the sources copied over into
+    them.  If we embed a meta.json into each library where the commit
+    hash changes every time a commit happens, then we've blown away
+    our entire cache.
+
+    The Docker builds already inject this metadata as environment
+    variables after the source copies happen, so there's no need for
+    us to embed it this way.
+    """
+    d["git_commit"] = ""
+    d["git_branch"] = ""
+    d["git_is_clean"] = ""
+    d["thds_user"] = THDS_USER
+
+
+def write_metadata(
+    pkg: str,
+    *,
+    misc: ty.Optional[MiscType] = None,
+    namespace: str = "thds",
+    layout: LayoutType = "src",
+    wdir: ty.Optional[StrOrPath] = None,
+    deploying: bool = False,
+    for_docker_tools_build: bool = False,
+) -> None:
+    wdir_ = Path(wdir) if wdir else Path(".")
+    assert wdir_
+    if os.getenv(DEPLOYING) or deploying:
+        LOGGER.debug("Writing metadata.")
+        metadata = init_metadata(
+            misc=misc, pyproject_toml_version=_hacky_get_pyproject_toml_version(pkg, wdir_)
+        )
+        metadata_path = os.path.join(
+            "src" if layout == "src" else "",
+            namespace.replace("-", "/").replace(".", "/"),
+            pkg.replace("-", "_").replace(".", "/"),
+            META_FILE,
+        )
+
+        LOGGER.info(f"Writing metadata for {pkg} to {wdir_ / metadata_path}")
+        with open(wdir_ / metadata_path, "w") as f:
+            metadata_dict = meta_converter.unstructure(metadata)
+            if for_docker_tools_build:
+                _sanitize_metadata_for_docker_tools(metadata_dict)
+            json.dump(metadata_dict, f, indent=2)
+            f.write("\n")  # Add newline because Py JSON does not
+
+
 @lru_cache(None)
 def read_metadata(pkg: Package) -> Metadata:
-    return Metadata()  # this is now deprecated because we don't use it.
+    LOGGER.debug("Reading metadata.")
+
+    if pkg == "__main__":
+        raise ValueError("`read_meta` expects a package or module name, not '__main__'.")
+
+    if not pkg:
+        raise ValueError(
+            "`read_meta` is missing a package or module name. "
+            "If using `__package__` make sure an __init__.py is present."
+        )
+
+    try:
+        with open_text(pkg, META_FILE) as f:
+            return meta_converter.structure(json.load(f), Metadata)
+    # pkg=__name__ will raise a TypeError unless it is called in an __init__.py
+    except (ModuleNotFoundError, FileNotFoundError, TypeError):
+        pkg_ = pkg.split(".")
+        if len(pkg_) <= 1:
+            return Metadata()
+        return read_metadata(".".join(pkg_[:-1]))

thds/core/sqlite/insert_utils.py

@@ -1,4 +1,4 @@
-# this works only if you have something to map the tuples to a class/object.
+# this works only if you have something to map the tuples to an attrs class.
 # it also does not currently offer any parallelism.
 import typing as ty
 

{thds_core-1.38.20250616192452.dist-info → thds_core-1.38.20250617225213.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: thds.core
-Version: 1.38.20250616192452
+Version: 1.38.20250617225213
 Summary: Core utilities.
 Author-email: Trilliant Health <info@trillianthealth.com>
 License: MIT

{thds_core-1.38.20250616192452.dist-info → thds_core-1.38.20250617225213.dist-info}/RECORD

@@ -19,13 +19,13 @@ thds/core/hashing.py,sha256=OqaV65vGKpT3l78jm-Uh7xG4DtAczGjk9-Q60OGmhY0,3521
 thds/core/home.py,sha256=tTClL_AarIKeri1aNCpuIC6evD7qr83ESGD173B81hU,470
 thds/core/hostname.py,sha256=canFGr-JaaG7nUfsQlyL0JT-2tnZoT1BvXzyaOMK1vA,208
 thds/core/imports.py,sha256=0LVegY8I8_XKZPcqiIp2OVVzEDtyqYA3JETf9OAKNKs,568
-thds/core/inspect.py,sha256=5Gckjux-nc8cz7OS6Go9Bmx2n_wWmGr42gVRuysAWFw,1985
+thds/core/inspect.py,sha256=vCxKqw8XG2W1cuj0MwjdXhe9TLQrGdjRraS6UEYsbf8,1955
 thds/core/iterators.py,sha256=d3iTQDR0gCW1nMRmknQeodR_4THzR9Ajmp8F8KCCFgg,208
 thds/core/lazy.py,sha256=e1WvG4LsbEydV0igEr_Vl1cq05zlQNIE8MFYT90yglE,3289
 thds/core/link.py,sha256=kmFJIFvEZc16-7S7IGvtTpzwl3VuvFl3yPlE6WJJ03w,5404
 thds/core/logical_root.py,sha256=gWkIYRv9kNQfzbpxJaYiwNXVz1neZ2NvnvProtOn9d8,1399
 thds/core/merge_args.py,sha256=7oj7dtO1-XVkfTM3aBlq3QlZbo8tb6X7E3EVIR-60t8,5781
-thds/core/meta.py,sha256=BQls5UQpdVEd6mDlkYk8_c-k_OYkpvde9Doa_ATSrfA,12067
+thds/core/meta.py,sha256=5um8Gvl00JFrYdpYfK2qD3pyQEoq-_3T2LXAhFOcTNo,16617
 thds/core/parallel.py,sha256=HXAn9aIYqNE5rnRN5ypxR6CUucdfzE5T5rJ_MUv-pFk,7590
 thds/core/pickle_visit.py,sha256=QNMWIi5buvk2zsvx1-D-FKL7tkrFUFDs387vxgGebgU,833
 thds/core/prof.py,sha256=5ViolfPsAPwUTHuhAe-bon7IArPGXydpGoB5uZmObDk,8264
@@ -59,7 +59,7 @@ thds/core/sqlite/copy.py,sha256=y3IRQTBrWDfKuVIfW7fYuEgwRCRKHjN0rxVFkIb9VrQ,1155
 thds/core/sqlite/ddl.py,sha256=k9BvmDzb0rrlhmEpXkB6ESaZAUWtbL58x-70sPyoFk4,201
 thds/core/sqlite/functions.py,sha256=AOIRzb7lNxmFm1J5JS6R8Nl-dSv3Dy47UNZVVjl1rvk,2158
 thds/core/sqlite/index.py,sha256=Vc7qxPqQ69A6GO5gmVQf5e3y8f8IqOTHgyEDoVZxTFM,903
-thds/core/sqlite/insert_utils.py,sha256=BNI3VUdqwBdaqa0xqiJrhE6XyzPsTF8N4KKKdb4Vfes,884
+thds/core/sqlite/insert_utils.py,sha256=LUVcznl-xCVoh_L_6tabVYUAYnEnaVDmBX2PeopLMKU,884
 thds/core/sqlite/merge.py,sha256=NxettDMJ_mcrWfteQn_ERY7MUB5ETR-yJLKg7uvF6zA,3779
 thds/core/sqlite/meta.py,sha256=4P65PAmCjagHYO1Z6nWM-wkjEWv3hxw5qVa4cIpcH_8,5859
 thds/core/sqlite/read.py,sha256=5pWvrbed3XNWgSy-79-8ONWkkt4jWbTzFNW6SnOrdYQ,2576
@@ -68,8 +68,8 @@ thds/core/sqlite/structured.py,sha256=SvZ67KcVcVdmpR52JSd52vMTW2ALUXmlHEeD-VrzWV
 thds/core/sqlite/types.py,sha256=oUkfoKRYNGDPZRk29s09rc9ha3SCk2SKr_K6WKebBFs,1308
 thds/core/sqlite/upsert.py,sha256=BmKK6fsGVedt43iY-Lp7dnAu8aJ1e9CYlPVEQR2pMj4,5827
 thds/core/sqlite/write.py,sha256=z0219vDkQDCnsV0WLvsj94keItr7H4j7Y_evbcoBrWU,3458
-thds_core-1.38.20250616192452.dist-info/METADATA,sha256=DjOrq3NuNmOga0ZnKtat12hlCAfekBSKpdeBhpVxD44,2216
-thds_core-1.38.20250616192452.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-thds_core-1.38.20250616192452.dist-info/entry_points.txt,sha256=bOCOVhKZv7azF3FvaWX6uxE6yrjK6FcjqhtxXvLiFY8,161
-thds_core-1.38.20250616192452.dist-info/top_level.txt,sha256=LTZaE5SkWJwv9bwOlMbIhiS-JWQEEIcjVYnJrt-CriY,5
-thds_core-1.38.20250616192452.dist-info/RECORD,,
+thds_core-1.38.20250617225213.dist-info/METADATA,sha256=eD4VIWf_BXHdJ6N8MOR5f4smatXcSKdZ6MHzRDDOLjs,2216
+thds_core-1.38.20250617225213.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+thds_core-1.38.20250617225213.dist-info/entry_points.txt,sha256=bOCOVhKZv7azF3FvaWX6uxE6yrjK6FcjqhtxXvLiFY8,161
+thds_core-1.38.20250617225213.dist-info/top_level.txt,sha256=LTZaE5SkWJwv9bwOlMbIhiS-JWQEEIcjVYnJrt-CriY,5
+thds_core-1.38.20250617225213.dist-info/RECORD,,