Skip to content

base.py

Common mixin classes for Spyglass topic-specific mixins.

BaseMixin

Source code in src/spyglass/utils/mixins/base.py 
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
class BaseMixin:

    def restrict(self, restriction, *args, **kwargs):
        """Intercept no-op restrict calls to throw warning.

        DataJoint returns the same object (ret is self) only when make_condition
        evaluates the restriction to True — i.e. no shared attributes were found
        and the restriction had no effect.
        """
        ret = super().restrict(restriction, *args, **kwargs)
        if ret is self and restriction is not True and restriction is not False:
            self._warn_msg(
                "Restriction had no effect — no shared attributes found. "
                "Please check your restrict() call."
            )
        return ret

    @cached_property
    def _logger(self):
        """Lazy import of logger to avoid circular imports.

        Used by ...
        - CautiousDeleteMixin
        - PopulateMixin
        - RestrictByMixin
        - ExportMixin
        - AnalysisMixin
        - Merge
        """

        from spyglass.utils import logger

        return logger

    @cached_property
    def _graph_deps(self) -> list:
        """Dependencies for graph search and restriction.

        Used by ...
        - RestrictByMixin
        - CautiousDeleteMixin
        - PopulateMixin (upstream hash)
        """
        from spyglass.utils.dj_graph import RestrGraph  # noqa #F401
        from spyglass.utils.dj_graph import TableChain

        return [TableChain, RestrGraph]

    def _info_msg(self, msg: str) -> None:
        """Log info message, but debug if in test mode.

        Quiets logs during testing, but preserves user experience during use.

        Used by ...
        - AnalysisMixin.copy and .create
        - IngestionMixin._insert_logline
        - Merge._merge_repr
        """
        log = self._logger.debug if self._test_mode else self._logger.info
        log(msg)

    def _warn_msg(self, msg: str) -> None:
        """Log warning message, but debug if in test mode.

        Quiets logs during testing, but preserves user experience during use.
        """
        log = self._logger.debug if self._test_mode else self._logger.warning
        log(msg)

    def _err_msg(self, msg: str) -> None:
        """Log error message, but debug if in test mode.

        Quiets logs during testing, but preserves user experience during use.
        """
        log = self._logger.debug if self._test_mode else self._logger.error
        log(msg)

    @cached_property
    def _test_mode(self) -> bool:
        """Return True if in test mode.

        Avoids circular import. Prevents prompt on delete.

        Note: Using cached property b/c we don't expect test_mode to change
        during runtime, and it avoids repeated lookups. Changing to @property
        wouldn't reload the config. It would just re-fetch from the settings
        module.

        Used by ...
        - BaseMixin._spyglass_version
        - HelpersMixin
        """
        from spyglass.settings import config as sg_config

        return sg_config.get("test_mode", False)

    @cached_property
    def _spyglass_version(self):
        """Get Spyglass version.

        Used by ...
        - ExportMixin
        - AnalysisMixin
        """
        from spyglass import __version__ as sg_version

        ret = ".".join(sg_version.split(".")[:3])  # Ditch commit info

        if self._test_mode:
            return ret[:16] if len(ret) > 16 else ret

        if not bool(re_match(r"^\d+\.\d+\.\d+", ret)):  # Major.Minor.Patch
            raise ValueError(
                f"Spyglass version issues. Expected #.#.#, Got {ret}."
                + "Please try running `hatch build` from your spyglass dir."
            )

        return ret

restrict(restriction, *args, **kwargs)

Intercept no-op restrict calls to throw warning.

DataJoint returns the same object (ret is self) only when make_condition evaluates the restriction to True — i.e. no shared attributes were found and the restriction had no effect.

Source code in src/spyglass/utils/mixins/base.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
def restrict(self, restriction, *args, **kwargs):
    """Intercept no-op restrict calls to throw warning.

    DataJoint returns the same object (ret is self) only when make_condition
    evaluates the restriction to True — i.e. no shared attributes were found
    and the restriction had no effect.
    """
    ret = super().restrict(restriction, *args, **kwargs)
    if ret is self and restriction is not True and restriction is not False:
        self._warn_msg(
            "Restriction had no effect — no shared attributes found. "
            "Please check your restrict() call."
        )
    return ret