exdrf 0.0.1.dev0__py3-none-any.whl

exdrf/var_bag.py

@@ -0,0 +1,328 @@
+import re
+from datetime import date, datetime
+from typing import Any, Dict, Iterator, List, Tuple, Union
+
+from attrs import define, field
+
+from exdrf.field import ExField
+from exdrf.field_types.api import (
+    FIELD_TYPE_STRING,
+    DateTimeField,
+    StrField,
+    field_type_to_class,
+)
+
+
+@define
+class VarBag:
+    """A bag of variables for a template.
+
+    Attributes:
+        values: Dictionary of values to be used in the template. This is the
+            source of truth for what variables exist.
+        _fields: Dictionary mapping field names to ExField objects.
+    """
+
+    values: Dict[str, Any] = field(factory=dict)
+    _fields: Dict[str, "ExField"] = field(factory=dict, init=False, repr=False)
+
+    @property
+    def fields(self) -> List["ExField"]:
+        """List of fields, ordered by keys in values."""
+        return list(self._fields.values())
+
+    @property
+    def var_names(self) -> List[str]:
+        """List of variable names."""
+        return list(self.values.keys())
+
+    @property
+    def var_values(self) -> List[str]:
+        """List of variable values."""
+        return [self.values[name] for name in self.values.keys()]
+
+    @property
+    def field_names(self) -> List[str]:
+        """List of field names."""
+        return list(self.values.keys())
+
+    @property
+    def field_values(self) -> List[Any]:
+        """List of field values."""
+        return [self.values[name] for name in self.values.keys()]
+
+    @property
+    def field_count(self) -> int:
+        """Count of fields."""
+        return len(self.values)
+
+    @property
+    def as_field_dict(self) -> Dict[str, Any]:
+        """Return a dictionary mapping field names to values."""
+        return dict((name, self.values[name]) for name in self._fields.keys())
+
+    def add_field(self, field: "ExField", value: Any = None):
+        """Add a field to the bag.
+
+        Args:
+            field: The field to add.
+            value: The value to add to the field.
+        """
+        self._fields[field.name] = field
+        self.values[field.name] = value
+
+    def add_fields(self, fields: List[Tuple["ExField", Any]]):
+        """Add a list of fields to the bag.
+
+        Args:
+            fields: List of fields to add.
+        """
+        for fld, value in fields:
+            self._fields[fld.name] = fld
+            self.values[fld.name] = value
+
+    def contains_field(self, name: str) -> bool:
+        """Check if a field exists.
+
+        Args:
+            name: The name of the field to check.
+
+        Returns:
+            True if the field exists, False otherwise.
+        """
+        return name in self.values
+
+    def is_field(self, name: str) -> bool:
+        """Check if a value has an associated ExField object.
+
+        Args:
+            name: The name of the value to check.
+
+        Returns:
+            True if the value has an associated ExField object, False if it
+            is a raw value without a field definition.
+        """
+        return name in self._fields
+
+    def get_field_value(self, name: str) -> Any:
+        """Get the value of a field.
+
+        Args:
+            name: The name of the field.
+
+        Returns:
+            The value of the field.
+
+        Raises:
+            KeyError: If the field does not exist.
+        """
+        if name not in self.values:
+            raise KeyError(f"Key {name} not found")
+        if name not in self._fields:
+            raise KeyError(f"Key {name} is not a field")
+        return self.values[name]
+
+    def set_field_value(self, name: str, value: Any) -> None:
+        """Set the value of a field.
+
+        Args:
+            name: The name of the field.
+            value: The value to set.
+
+        Raises:
+            KeyError: If the field does not exist.
+        """
+        if name not in self._fields:
+            raise KeyError(f"Key {name} is not a field")
+        self.values[name] = value
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.values
+
+    def __getitem__(self, key: str) -> Any:
+        if key not in self.values:
+            raise KeyError(f"Key {key} not found")
+        return self.values[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        if key not in self.values:
+            raise KeyError(f"Key {key} not found")
+        self.values[key] = value
+
+    def __iter__(self) -> Iterator[str]:
+        """Return an iterator of keys for dictionary unpacking."""
+        yield from self.values.keys()
+
+    def __len__(self) -> int:
+        """Return the number of fields that have values."""
+        return len(self.values)
+
+    def filtered(self, by_name: bool, text: str, exact: bool):
+        """Filter the variable bag based on name or value.
+
+        Args:
+            by_name: If True, filter by field name; if False, filter by value.
+            text: The text pattern to search for (supports % and * wildcards).
+            exact: If True, match exactly; if False, match anywhere.
+
+        Returns:
+            A new VarBag containing only the filtered fields.
+        """
+        if len(text) == 0:
+            return self
+
+        # Convert wildcard pattern to regex pattern
+        pattern = text.replace("%", ".*").replace("*", ".*")
+        if exact:
+            pattern = f"^{pattern}$"
+        regex = re.compile(pattern, re.IGNORECASE)
+
+        result = VarBag()
+        for name in self.values.keys():
+            search_text = name.lower() if by_name else str(self.values[name]).lower()
+            if regex.search(search_text):
+                if name in self._fields:
+                    result._fields[name] = self._fields[name]
+                result.values[name] = self.values[name]
+        return result
+
+    def filtered_fields(self, by_name: bool, text: str, exact: bool):
+        """Filter fields based on name or value.
+
+        Args:
+            by_name: If True, filter by field name; if False, filter by value.
+            text: The text pattern to search for (supports % and * wildcards).
+            exact: If True, match exactly; if False, match anywhere.
+
+        Returns:
+            A new VarBag containing only the filtered fields.
+        """
+        if len(text) == 0:
+            return self
+
+        # Convert wildcard pattern to regex pattern
+        pattern = text.replace("%", ".*").replace("*", ".*")
+        if exact:
+            pattern = f"^{pattern}$"
+        regex = re.compile(pattern, re.IGNORECASE)
+
+        result = VarBag()
+        for name in self._fields.keys():
+            search_text = name.lower() if by_name else str(self.values[name]).lower()
+            if regex.search(search_text):
+                result._fields[name] = self._fields[name]
+                result.values[name] = self.values[name]
+        return result
+
+    def add_now(self):
+        """Add the current date and time to the variable bag."""
+        self.add_field(DateTimeField(name="now"), datetime.now())
+
+    @property
+    def as_dict(self) -> Dict[str, Any]:
+        """Return a dictionary of the variables in the bag and their values."""
+        return dict(self.values)
+
+    def simplify_value(self, value: Any) -> Any:
+        """Convert a value to a simple value.
+
+        The simple values are:
+        - int
+        - float
+        - bool
+        - str
+        - list of simple values
+        - dict of simple values
+
+        Classes that are not one of those will be converted to a string
+        with the class name.
+        """
+        if isinstance(value, (list, tuple)):
+            return [self.simplify_value(v) for v in value]
+        elif isinstance(value, dict):
+            return {k: self.simplify_value(v) for k, v in value.items()}
+        elif isinstance(value, (str, int, float, bool)):
+            return value
+        elif isinstance(value, datetime):
+            return value.strftime("%Y-%m-%dT%H:%M:%S")
+        elif isinstance(value, date):
+            return value.strftime("%Y-%m-%d")
+        else:
+            return f"<{value.__class__.__name__}>"
+
+    def to_simple_data(self) -> List[Dict[str, Any]]:
+        """Convert the variable bag to a simple data structure.
+
+        The result is a list of dictionaries, each containing the name,
+        type, and value of a variable.
+
+        The simple values are:
+        - int
+        - float
+        - bool
+        - str
+        - list
+        - dict
+
+        Classes that are not one of those will be converted to a string
+        with the class name.
+        """
+        result = []
+        for name in self.values.keys():
+            result.append(self.one_to_simple(name))
+        return result
+
+    def one_to_simple(self, name: str) -> Dict[str, Any]:
+        fld = self._fields.get(name)
+        type_name = fld.type_name if fld else FIELD_TYPE_STRING
+        return {
+            "name": name,
+            "type": type_name,
+            "value": self.simplify_value(self.values[name]),
+        }
+
+    def from_simple_data(self, data: Any):
+        """Populate the variable bag from a simple data structure.
+
+        The simple data structure is a list of dictionaries, each
+        containing the name, type, and value of a variable.
+        """
+        for item in data:
+            self.simple_to_one(item)
+
+    def simple_to_one(self, item: Dict[str, Any]) -> Tuple[Union["ExField", None], Any]:
+        """Load a single item from a simple data structure into the variable
+        bag.
+
+        Returns:
+            A tuple containing the field and the value.
+            None, None if the item has no name.
+        """
+        type_name = item.get("type", FIELD_TYPE_STRING)
+        cls_for_type = field_type_to_class.get(type_name, StrField)
+        name = item.get("name", "")
+        if not name:
+            return None, None
+
+        if name not in self.values:
+            inst = cls_for_type(name=name)
+            self._fields[name] = inst
+        else:
+            inst = self._fields.get(name)
+            if inst is None:
+                inst = cls_for_type(name=name)
+                self._fields[name] = inst
+
+        value = item.get("value", "")
+        self.values[name] = inst.value_from_str(value)
+        return inst, value
+
+    def update(self, other: "VarBag") -> None:
+        """Update this variable bag with the values from another variable bag.
+
+        Args:
+            other: The other variable bag to update from.
+        """
+        for name in other._fields.keys():
+            self._fields[name] = other._fields[name]
+            self.values[name] = other.values[name]

exdrf/visitor.py

@@ -0,0 +1,58 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from exdrf.dataset import ExDataset
+    from exdrf.field import ExField
+    from exdrf.resource import ExResource
+
+
+class ExVisitor:
+    """Visitor class that can explore datasets, resources and fields."""
+
+    def visit_dataset(self, dataset: "ExDataset"):
+        """Visit a dataset.
+
+        Args:
+            dataset: The dataset to visit.
+
+        Returns:
+            bool: True if the visit should continue, False otherwise.
+        """
+        return True
+
+    def visit_category(self, name: str, level: int, content: dict):
+        """Visit a category.
+
+        Args:
+            name: The key of the category.
+            level: The depth level of the category.
+            content: The content of the category. This is a dictionary
+                where values can be other categories or resources. The key
+                is the name of the resource or category.
+
+        Returns:
+            bool: True if the visit should continue, False otherwise.
+        """
+        return True
+
+    def visit_resource(self, resource: "ExResource"):
+        """Visit a resource.
+
+        Args:
+            resource: The resource to visit.
+
+        Returns:
+            bool: True if the visit should continue, False otherwise.
+        """
+        return True
+
+    def visit_field(self, field: "ExField"):
+        """Visit a field.
+
+        Args:
+            field: The field to visit.
+
+        Returns:
+            bool: True if the visit should continue, False otherwise.
+        """
+        return True

exdrf-0.0.1.dev0.dist-info/METADATA

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: exdrf
+Version: 0.0.1.dev0
+Summary: Describe datasets, resources and their fields.
+Author-email: Nicu Tofan <nicu.tofan@gmail.com>
+License: MIT
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Typing :: Typed
+Requires-Python: >=3.12.2
+Description-Content-Type: text/markdown
+Requires-Dist: attrs>=25.1.0
+Requires-Dist: inflect>=7.5.0
+Requires-Dist: SQLAlchemy>=2.0.38
+Requires-Dist: Unidecode>=1.4.0
+Provides-Extra: dev
+Requires-Dist: autoflake; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyproject-flake8; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: click<8.2.0,>=8.1.8; extra == "dev"
+
+# Datasets-Resources-Fields
+
+The library allows the user to define fields that make up a resource that is
+part of a dataset. The purpose is to construct an unified interface for
+describing these concepts, with supporting libraries for deriving the
+tree from various sources (e.g. SqlAlchemy, Pydantic, etc.) and for
+generating content from the tree.

exdrf-0.0.1.dev0.dist-info/RECORD

@@ -0,0 +1,57 @@
+exdrf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exdrf/__version__.py,sha256=wd6FEk1AvxCOeRfZY-CEa3fIKmm0i6E5YP_YSuNubV8,532
+exdrf/api.py,sha256=grjmGw_xnmxLlRZ1IzN6sWa2Emw8XvjjwyReb2ncPX4,1082
+exdrf/constants.py,sha256=wu5RxQz6gZWm_WTvOc1lkL3bE2zD6IXAZpfZc6SBPWY,1580
+exdrf/dataset.py,sha256=HjBkGynj0CZUJI4Sbl0_B2tXbwvl6PfBHE5sQbkSyqA,6889
+exdrf/field.py,sha256=FnLskFULz1LEAOw4cY_Nnau4-BGt247AWaOCUAlTBGI,22086
+exdrf/filter.py,sha256=rCaOZhSggHbHv6E8RaeOV0QiqlaFg7KV-FyUcpvDUnA,22505
+exdrf/filter_dsl.py,sha256=_k1_RCqTTm9XuCyBg9Kaprdex14EZsMM_AL9mj8nB5M,29553
+exdrf/filter_op_catalog.py,sha256=_XrjcJGPAKm1nrFIrZnNszWcOA6IpcYFSw3L3AuKr6w,7349
+exdrf/label_dsl.py,sha256=VJ_dBozDeNml5pAf2jlNVhAOdmg6CGw9Md7bm3p3NsM,20822
+exdrf/moment.py,sha256=3SMlfbd-xBouAWYprVRSA9sCO2Dxy7FJNnN67x25LMg,17881
+exdrf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exdrf/py_support.py,sha256=DNQMXG_wTZg3nKSWeIzbAB4liIB4vsCcEBB2hSJ5rrY,530
+exdrf/resource.py,sha256=uM-t3VR-3BOvaggVTA0l4UsBxS3TPa6Z02RvmrZJz8A,33706
+exdrf/sa_fi_item.py,sha256=f5M4Z_h4DYz5xGqOOIpAod_wjAj8Lj-zhzxHriGmr2c,1906
+exdrf/sa_filter_op.py,sha256=zzH3jddknbOtQIo161kc-fu1JHupzoU0__NwKUTUm0I,8810
+exdrf/utils.py,sha256=nwqAdzPveabwBnNpxh2qX4Dp7O02tpb7HoDg_kiDDFk,401
+exdrf/validator.py,sha256=IatkMvcDgj9XLUotj-yL8buvsPcA2XkNCwi72eXjW4c,1253
+exdrf/var_bag.py,sha256=wVAGZv4nL__GRuFs3sUKptai8oFY1MkMpgVFhEVw_dQ,10808
+exdrf/visitor.py,sha256=8Y3v5UjBMxvlenDF1HyUI_XnmogkG77ZrfONf09ot8A,1619
+exdrf/field_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exdrf/field_types/api.py,sha256=9SjcwsbdRPLlP7WXeR0yrlb9AxMgs1Jm-H1AGsH45mA,3040
+exdrf/field_types/blob_field.py,sha256=NvqITYTiuxZSZ6IiiR_er-pd-YkMLYHunDICyzUIcs0,1222
+exdrf/field_types/bool_field.py,sha256=puDhEJ28M7bLhYaV5xpViiqQOiHrKF86v7-dizU4rt4,1441
+exdrf/field_types/date_field.py,sha256=IGfth56e8zunSruhJG2A1W6B4QMkM0w-HO51wh3CyRg,1435
+exdrf/field_types/date_time.py,sha256=AaDj-lHE47-EN195D3UJ1FQyopFm0RDYFhrMm8Ws6AU,1613
+exdrf/field_types/dur_field.py,sha256=v9dpZ2XOcClKKftWuYd0zpv-hFrapK-b7HR-1bR5stI,1277
+exdrf/field_types/enum_field.py,sha256=mWwC8fQSKT9P_2wOrmdWxXyZgBNc_capjAAlu_zvk-4,1170
+exdrf/field_types/filter_field.py,sha256=YD0iA0t6kpA-4t6vvriEb-uU77AptllpUsOLI0YbHpU,254
+exdrf/field_types/float_field.py,sha256=OexfRPZCd2MUF8BcX1gcLUL0MfPwQRF0reJCJe80688,3231
+exdrf/field_types/float_list.py,sha256=uT6mc0ZT7Hq_iuc4W1qmxkBWH4Ko2b9wCYYcxTIpFVg,515
+exdrf/field_types/formatted.py,sha256=JYjU321orU_sF2yeWe_c-5NCHcGpZ3aSTpyCcCfaBQY,1149
+exdrf/field_types/int_field.py,sha256=gHldpshmqzo5NdXRQLVaGmCGzZZQsbWx0ablLzEm10c,2410
+exdrf/field_types/int_list.py,sha256=XCxXBoMmya0JPN_K2w523TK8SXAfVQnDtz-dSVnDpAs,489
+exdrf/field_types/ref_base.py,sha256=kICJeaejzfEaaDRTM8XqCwBW5MVarVEx4JyWBNmMeps,4543
+exdrf/field_types/ref_m2m.py,sha256=TG0Su3rvLXQUi9gUxM0nkiOfXY0U-T51cRiykNQFoa4,1388
+exdrf/field_types/ref_m2o.py,sha256=ayZN5TnLze43UnNaj5kDZLvYqI2onfeh9UjvyWTzanI,735
+exdrf/field_types/ref_o2m.py,sha256=mPdD1EGvfXeqc2yr_M7ZAiIKrHOtWPF4XCSI0qrk24I,1199
+exdrf/field_types/ref_o2o.py,sha256=9GleYEQ6OM_6JflxjPLK6CJCSmkAxER3UbJU3Bt31i0,1081
+exdrf/field_types/sort_field.py,sha256=L_Od3beme8bY7iWoXQJpXrs-9edNMRao-urJGE2jw2M,459
+exdrf/field_types/str_field.py,sha256=rNbFRNf29BZGqxOSv_bQq9YDiBp8C4KMmKX50a7W0Ao,2916
+exdrf/field_types/str_list.py,sha256=oGBpaDdBrsCoYdU1S0F5S0eMLZ9BO1Lj_nrvB1L6LyI,488
+exdrf/field_types/time_field.py,sha256=sHt4C2OerQygbcFJ4pFIQVvdGZsXVDvaLPszPM74xVo,1471
+exdrf_tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exdrf_tests/test_dataset.py,sha256=JRU3B0-Owxqq8aS9eanwjmTcbrjUeGNLhCTLuH9smK0,15152
+exdrf_tests/test_field.py,sha256=4P1CS8_0wJ4jq3pgKNdYMOZ2-FTeQlpxZ09GL5AAyOY,2905
+exdrf_tests/test_filter.py,sha256=ZUs-o7GwkEgie3nIUuJTojK-MVoX4-6GhnNMHsLuugw,13705
+exdrf_tests/test_filter_dsl.py,sha256=k1zyTILMO3yTNqd5jI2GQOouWUWNXEe_sLFb5yuxYvA,22087
+exdrf_tests/test_label_dsl.py,sha256=glHYmjzx4JSF4RlB92oX2fxqaNpzFY50Ctd19ewmkig,6573
+exdrf_tests/test_resource.py,sha256=DEOd0gT67NBpMTL_z3eJxxGrurGCZjzGd1WF51-qsKM,3056
+exdrf_tests/test_utils.py,sha256=xB-Z_zziJBdh0itztFELanxoefmFWSxiVb16dv3Vg5o,1345
+exdrf_tests/test_visitor.py,sha256=D2ygbKj7w-QO45L_WWzmoh3TMFJ5wEZevQcZHt4y0XA,933
+exdrf_tests/var_bag_test.py,sha256=EAnlhHj_K5n-UIXKU-IouVOmu9WbuFVSzV8ZbTZAR1o,18872
+exdrf-0.0.1.dev0.dist-info/METADATA,sha256=EcGaHKk3c2ZAvBrneZ1aVqUcjmdEl2x2VPhC8PGZ7iw,1601
+exdrf-0.0.1.dev0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+exdrf-0.0.1.dev0.dist-info/top_level.txt,sha256=WsOz8ThH9m7N2wwPVYmnMt6XqVD6pQ5iU23LOntZzb8,23
+exdrf-0.0.1.dev0.dist-info/RECORD,,

exdrf-0.0.1.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

exdrf-0.0.1.dev0.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+dist
+exdrf
+exdrf_tests