owid-datautils 0.6.1__py3-none-any.whl

owid/datautils/__init__.py

@@ -0,0 +1,3 @@
+"""Library to support the work of the Data Team at Our World in Data."""
+
+__version__ = "0.5.3"

owid/datautils/checks.py

@@ -0,0 +1 @@
+"""Utils related to sanity checks of datasets."""

owid/datautils/common.py

@@ -0,0 +1,44 @@
+"""Common objects shared by other modules."""
+
+import warnings
+from typing import Any, List, Set, Union, cast
+
+
+class ExceptionFromDocstring(Exception):
+    """Exception that returns its own docstring, if no message is explicitly given."""
+
+    def __init__(self, exception_message: Union[str, None] = None, *args: Any):
+        super().__init__(exception_message or self.__doc__, *args)
+
+
+class ExceptionFromDocstringWithKwargs(Exception):
+    """Exception that returns its own docstring, if no message is explicitly given."""
+
+    def __init__(self, exception_message: Union[str, None] = None, *args: Any, **kwargs: Any):
+        text = cast(str, exception_message or self.__doc__)
+        if kwargs:
+            additional_text = ", ".join([f"{key}: {value}" for key, value in kwargs.items()])
+            if additional_text is not None:
+                text += " " + additional_text
+        super().__init__(text, *args)
+
+
+def warn_on_list_of_entities(
+    list_of_entities: Union[List[Any], Set[Any]], warning_message: str, show_list: bool
+) -> None:
+    """Raise a warning with a custom message, and optionally print a list of affected elements.
+
+    Parameters
+    ----------
+    list_of_entities : list or set
+        Elements to optionally print one by one (only relevant if show_list is True).
+    warning_message : str
+        Warning message.
+    show_list : bool
+        True to print a list of affected entities.
+
+    """
+    warnings.warn(warning_message)
+    if show_list:
+        print(warning_message)
+        print("\n".join(["* " + str(entity) for entity in list_of_entities]))