fmtr.tools 1.3.63__py3-none-any.whl → 1.3.65__py3-none-any.whl

fmtr/tools/data_modelling_tools.py

@@ -1,4 +1,110 @@
-from pydantic import BaseModel, RootModel, ConfigDict
+from functools import cached_property
+from typing import ClassVar, List, Any, Dict
+
+from pydantic import BaseModel
+from pydantic import RootModel, ConfigDict
+from pydantic.fields import FieldInfo
+from pydantic_core import PydanticUndefined, PydanticUndefinedType
+
+from fmtr.tools.datatype_tools import is_optional
+from fmtr.tools.iterator_tools import get_class_lookup
+from fmtr.tools.string_tools import camel_to_snake
+from fmtr.tools.tools import Auto, Required
+
+
+class Field(FieldInfo):
+    """
+
+    Allow DRYer field definitions, set annotation and defaults at the same time, easier field inheritance, etc.
+
+    """
+    NAME = Auto
+    ANNOTATION = None
+    DEFAULT = Auto
+    FILLS = None
+    DESCRIPTION = None
+    TITLE = Auto
+    CONFIG = None
+
+    def __init__(self):
+        """
+
+        Infer default from type annotation, if enabled, use class/argument fills to create titles/descriptions, etc.
+
+        """
+        title = self.get_title_auto()
+        description = self.get_desc()
+        default = self.get_default_auto()
+        kwargs = self.CONFIG or {}
+
+        if default is Required:
+            default = PydanticUndefined
+
+        super().__init__(default=default, title=title, description=description, **kwargs)
+
+    @classmethod
+    def get_name_auto(cls) -> str:
+        """
+
+        Infer field name, if set to auto.
+
+        """
+        if cls.NAME is Auto:
+            return camel_to_snake(cls.__name__)
+        elif cls.NAME is None:
+            return cls.__name__
+
+        return cls.NAME
+
+    @cached_property
+    def fills(self) -> Dict[str, str]:
+        """
+
+        Get fills with filled title merged in
+
+        """
+        return (self.FILLS or {}) | dict(title=self.get_title_auto())
+
+    def get_default_auto(self) -> type[Any] | None | PydanticUndefinedType:
+        """
+
+        Infer default, if not specified.
+
+        """
+        if self.DEFAULT is not Auto:
+            return self.DEFAULT
+
+        if is_optional(self.ANNOTATION):
+            return None
+        else:
+            return Required
+
+    def get_title_auto(self) -> str | None:
+        """
+
+        Get title from classname/mask
+
+        """
+
+        mask = self.__class__.__name__ if self.TITLE is Auto else self.TITLE
+        fills = (self.FILLS or {})
+
+        if mask:
+            return mask.format(**fills)
+
+        return None
+
+    def get_desc(self) -> str | None:
+        """
+
+        Get description from classname/mask
+
+        """
+
+        if self.DESCRIPTION:
+            return self.DESCRIPTION.format(**self.fills)
+
+        return None
 
 
 def to_df(*objs, name_value='value'):
@@ -51,12 +157,47 @@ class MixinFromJson:
         return self
 
 
+
 class Base(BaseModel, MixinFromJson):
     """
 
-    Base model
+    Base model allowing model definition via a list of custom Field objects.
 
     """
+    FIELDS: ClassVar[List[Field] | Dict[str, Field]] = []
+
+    def __init_subclass__(cls, **kwargs):
+        """
+
+        Fetch aggregated fields metadata from the hierarchy and set annotations and FieldInfo objects in the class.
+
+        """
+        super().__init_subclass__(**kwargs)
+
+        fields = {}
+        for base in reversed(cls.__mro__):
+
+            try:
+                raw = base.FIELDS
+            except AttributeError:
+                raw = {}
+
+            if isinstance(raw, dict):
+                fields |= raw
+            else:
+                fields |= get_class_lookup(*raw, name_function=lambda cls_field: cls_field.get_name_auto())
+
+        cls.FIELDS = fields
+
+        for name, FieldInfoType in fields.items():
+            if name in cls.__annotations__:
+                continue
+
+            field = FieldInfoType()
+            setattr(cls, name, field)
+
+            annotation = FieldInfoType.ANNOTATION
+            cls.__annotations__[name] = annotation
 
     def to_df(self, name_value='value'):
         """

fmtr/tools/datatype_tools.py

@@ -1,4 +1,5 @@
-from typing import Any
+from types import UnionType, NoneType
+from typing import Any, get_origin, get_args
 
 from fmtr.tools.tools import Raise
 
@@ -84,3 +85,15 @@ def none_else(value: Any, default: Any) -> Any:
     if is_none(value):
         return default
     return value
+
+
+def is_optional(annotation) -> bool:
+    """
+
+    Is type/annotation optional? todo should be in typing_tools?
+
+    """
+    origin = get_origin(annotation)
+    args = get_args(annotation)
+    is_opt = origin is UnionType and NoneType in args
+    return is_opt

fmtr/tools/iterator_tools.py

@@ -1,5 +1,4 @@
 from itertools import chain, batched
-
 from typing import List, Dict, Any
 
 from fmtr.tools.datatype_tools import is_none
@@ -73,3 +72,12 @@ def dedupe(items):
 
     """
     return list(dict.fromkeys(items))
+
+
+def get_class_lookup(*classes, name_function=lambda cls: cls.__name__):
+    """
+
+    Dictionary of class names to classes
+
+    """
+    return {name_function(cls): cls for cls in classes}

fmtr/tools/string_tools.py

@@ -1,11 +1,10 @@
 import re
+from collections import namedtuple
 from dataclasses import dataclass
+from string import Formatter
 from textwrap import dedent
 from typing import List
 
-from collections import namedtuple
-from string import Formatter
-
 from fmtr.tools.datatype_tools import is_none
 
 ELLIPSIS = '…'
@@ -182,6 +181,7 @@ def join_natural(items, sep=', ', conj='and'):
 
     """
 
+    items = list(items)
     if not items:
         return ""
     if len(items) == 1:
@@ -241,3 +241,18 @@ def trim(text: str) -> str:
 
     """
     return dedent(text).strip()
+
+
+ACRONYM_BOUNDARY = re.compile(r'([A-Z]+)([A-Z][a-z])')
+CAMEL_BOUNDARY = re.compile(r'([a-z0-9])([A-Z])')
+
+
+def camel_to_snake(name: str) -> str:
+    """
+
+    Camel case to snake case
+
+    """
+    name = ACRONYM_BOUNDARY.sub(r'\1_\2', name)
+    name = CAMEL_BOUNDARY.sub(r'\1_\2', name)
+    return name.lower()

fmtr/tools/tools.py

@@ -27,7 +27,15 @@ def identity(x: Any) -> Any:
     return x
 
 
-class Empty:
+class Special:
+    """
+
+    Classes to differentiate special arguments from primitive arguments.
+
+    """
+
+
+class Empty(Special):
     """
 
     Class to denote an unspecified object (e.g. argument) when `None` cannot be used.
@@ -35,7 +43,7 @@ class Empty:
     """
 
 
-class Raise:
+class Raise(Special):
     """
 
     Class to denote when a function should raise instead of e.g. returning a default.
@@ -43,4 +51,21 @@ class Raise:
     """
 
 
+class Auto(Special):
+    """
+
+    Class to denote when an argument should be inferred.
+
+    """
+
+
+class Required(Special):
+    """
+
+    Class to denote when an argument is required.
+
+    """
+
+
+
 EMPTY = Empty()

fmtr/tools/version

@@ -1 +1 @@
-1.3.63
+1.3.65

{fmtr_tools-1.3.63.dist-info → fmtr_tools-1.3.65.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmtr.tools
-Version: 1.3.63
+Version: 1.3.65
 Summary: Collection of high-level tools to simplify everyday development tasks, with a focus on AI/ML
 Home-page: https://github.com/fmtr/fmtr.tools
 Author: Frontmatter
@@ -8,6 +8,20 @@ Author-email: innovative.fowler@mask.pro.fmtr.dev
 License: Copyright © 2025 Frontmatter. All rights reserved.
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: logfire; extra == "dev"
+Requires-Dist: semver; extra == "dev"
+Requires-Dist: pydevd-pycharm~=251.25410.159; extra == "dev"
+Requires-Dist: pydantic-settings; extra == "dev"
+Requires-Dist: pydantic; extra == "dev"
+Requires-Dist: pydantic-extra-types; extra == "dev"
+Requires-Dist: pycountry; extra == "dev"
+Requires-Dist: yamlscript; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: yamlscript; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: beanie[odm]; extra == "dev"
+Requires-Dist: motor; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest-cov; extra == "test"
 Provides-Extra: yaml
@@ -154,68 +168,68 @@ Provides-Extra: db-document
 Requires-Dist: beanie[odm]; extra == "db-document"
 Requires-Dist: motor; extra == "db-document"
 Provides-Extra: all
+Requires-Dist: pydantic; extra == "all"
+Requires-Dist: pydevd-pycharm~=251.25410.159; extra == "all"
 Requires-Dist: uvicorn[standard]; extra == "all"
+Requires-Dist: google-auth; extra == "all"
+Requires-Dist: pymupdf4llm; extra == "all"
 Requires-Dist: contexttimer; extra == "all"
-Requires-Dist: pymupdf; extra == "all"
-Requires-Dist: motor; extra == "all"
-Requires-Dist: huggingface_hub; extra == "all"
-Requires-Dist: google-auth-httplib2; extra == "all"
-Requires-Dist: sre_yield; extra == "all"
-Requires-Dist: json_repair; extra == "all"
-Requires-Dist: fastapi; extra == "all"
-Requires-Dist: tabulate; extra == "all"
-Requires-Dist: flet-webview; extra == "all"
-Requires-Dist: beanie[odm]; extra == "all"
-Requires-Dist: openai; extra == "all"
-Requires-Dist: pydantic-extra-types; extra == "all"
-Requires-Dist: torchaudio; extra == "all"
-Requires-Dist: flet-video; extra == "all"
-Requires-Dist: tinynetrc; extra == "all"
-Requires-Dist: flet[all]; extra == "all"
-Requires-Dist: pycountry; extra == "all"
-Requires-Dist: torchvision; extra == "all"
-Requires-Dist: deepdiff; extra == "all"
-Requires-Dist: pydantic; extra == "all"
+Requires-Dist: google-auth-oauthlib; extra == "all"
+Requires-Dist: python-on-whales; extra == "all"
 Requires-Dist: httpx_retries; extra == "all"
-Requires-Dist: logfire[fastapi]; extra == "all"
+Requires-Dist: distributed; extra == "all"
+Requires-Dist: beanie[odm]; extra == "all"
 Requires-Dist: diskcache; extra == "all"
-Requires-Dist: dask[bag]; extra == "all"
-Requires-Dist: yamlscript; extra == "all"
-Requires-Dist: Unidecode; extra == "all"
-Requires-Dist: openpyxl; extra == "all"
-Requires-Dist: httpx; extra == "all"
 Requires-Dist: transformers[sentencepiece]; extra == "all"
-Requires-Dist: html2text; extra == "all"
+Requires-Dist: appdirs; extra == "all"
+Requires-Dist: torchaudio; extra == "all"
+Requires-Dist: filetype; extra == "all"
+Requires-Dist: flet-webview; extra == "all"
+Requires-Dist: motor; extra == "all"
+Requires-Dist: openai; extra == "all"
+Requires-Dist: ollama; extra == "all"
 Requires-Dist: pytest-cov; extra == "all"
+Requires-Dist: pydantic-settings; extra == "all"
+Requires-Dist: Unidecode; extra == "all"
+Requires-Dist: huggingface_hub; extra == "all"
+Requires-Dist: bokeh; extra == "all"
 Requires-Dist: logfire; extra == "all"
-Requires-Dist: appdirs; extra == "all"
-Requires-Dist: python-on-whales; extra == "all"
 Requires-Dist: semver; extra == "all"
-Requires-Dist: pydevd-pycharm~=251.25410.159; extra == "all"
-Requires-Dist: pandas; extra == "all"
-Requires-Dist: distributed; extra == "all"
-Requires-Dist: filetype; extra == "all"
-Requires-Dist: faker; extra == "all"
+Requires-Dist: logfire[fastapi]; extra == "all"
+Requires-Dist: tinynetrc; extra == "all"
+Requires-Dist: torchvision; extra == "all"
+Requires-Dist: pymupdf; extra == "all"
+Requires-Dist: peft; extra == "all"
+Requires-Dist: yamlscript; extra == "all"
+Requires-Dist: logfire[httpx]; extra == "all"
+Requires-Dist: pycountry; extra == "all"
+Requires-Dist: setuptools; extra == "all"
+Requires-Dist: playwright; extra == "all"
 Requires-Dist: sentence_transformers; extra == "all"
-Requires-Dist: regex; extra == "all"
+Requires-Dist: faker; extra == "all"
 Requires-Dist: deepmerge; extra == "all"
-Requires-Dist: google-api-python-client; extra == "all"
-Requires-Dist: setuptools; extra == "all"
-Requires-Dist: google-auth; extra == "all"
+Requires-Dist: httpx; extra == "all"
+Requires-Dist: tabulate; extra == "all"
+Requires-Dist: openpyxl; extra == "all"
+Requires-Dist: deepdiff; extra == "all"
+Requires-Dist: flet[all]; extra == "all"
+Requires-Dist: sre_yield; extra == "all"
+Requires-Dist: pydantic-extra-types; extra == "all"
 Requires-Dist: pydantic-ai[logfire,openai]; extra == "all"
-Requires-Dist: pydantic-settings; extra == "all"
-Requires-Dist: dnspython[doh]; extra == "all"
-Requires-Dist: ollama; extra == "all"
-Requires-Dist: cachetools; extra == "all"
-Requires-Dist: pymupdf4llm; extra == "all"
+Requires-Dist: json_repair; extra == "all"
+Requires-Dist: tokenizers; extra == "all"
+Requires-Dist: pandas; extra == "all"
+Requires-Dist: fastapi; extra == "all"
+Requires-Dist: html2text; extra == "all"
+Requires-Dist: flet-video; extra == "all"
 Requires-Dist: pyyaml; extra == "all"
-Requires-Dist: logfire[httpx]; extra == "all"
-Requires-Dist: playwright; extra == "all"
+Requires-Dist: google-api-python-client; extra == "all"
+Requires-Dist: dask[bag]; extra == "all"
+Requires-Dist: google-auth-httplib2; extra == "all"
+Requires-Dist: cachetools; extra == "all"
+Requires-Dist: dnspython[doh]; extra == "all"
+Requires-Dist: regex; extra == "all"
 Requires-Dist: odfpy; extra == "all"
-Requires-Dist: tokenizers; extra == "all"
-Requires-Dist: bokeh; extra == "all"
-Requires-Dist: google-auth-oauthlib; extra == "all"
-Requires-Dist: peft; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{fmtr_tools-1.3.63.dist-info → fmtr_tools-1.3.65.dist-info}/RECORD

@@ -5,9 +5,9 @@ fmtr/tools/augmentation_tools.py,sha256=-6ESbO4CDlKqVOV1J1V6qBeoBMzbFIinkDHRHnCB
 fmtr/tools/caching_tools.py,sha256=74p7m2GLFfeP41LX69wxgfkilxEAoWkMIfFMjKsYpyg,4976
 fmtr/tools/constants.py,sha256=90wCirUpw4bWMAbjhip0LL6k57eS5VmxRUP9pLCChBg,1812
 fmtr/tools/context_tools.py,sha256=4UvIHYgLqAh7dXMX9EBrLEpYp81qfzhSVrkffOSAoGA,350
-fmtr/tools/data_modelling_tools.py,sha256=0BFm-F_cYzVTxftWQwORkPd0FM2BTLVh9-s0-rTTFoo,1744
+fmtr/tools/data_modelling_tools.py,sha256=vD7nbqeQh_azoNZUiVWvK8GuyNE-Qagcqg_RE7wYNBk,5303
 fmtr/tools/dataclass_tools.py,sha256=0Gt6KeLhtPgubo_2tYkIVqB8oQ91Qzag8OAGZDdjvMU,1209
-fmtr/tools/datatype_tools.py,sha256=3P4AWIFGkJ-UqvXlj0Jc9IvkIIgTOE9jRrOk3NVbpH8,1508
+fmtr/tools/datatype_tools.py,sha256=1XznVwlY4-DkYa6FwhHMstD8qz27vCcV64IvCrcJgMA,1830
 fmtr/tools/datetime_tools.py,sha256=L7wmBoQbD9h_pJIL92WQOX32r_vrXgRvE-_0PVPRAGY,232
 fmtr/tools/debugging_tools.py,sha256=_xzqS0V5BpL8d06j-jVQjGgI7T020QsqVXKAKMz7Du8,2082
 fmtr/tools/environment_tools.py,sha256=43uqfj1G1bNX0IwKz-NKbu3AbFYSdbBuGN9rlThe030,1845
@@ -20,7 +20,7 @@ fmtr/tools/http_tools.py,sha256=RVwGrBNMyjfbpgAPCSnxEkXfSzXXWARb3ayq981ONQE,464
 fmtr/tools/import_tools.py,sha256=XJmiWLukRncJAcaGReDn4jIz1_IpVBjfYCQHH1hIg7c,588
 fmtr/tools/inherit_tools.py,sha256=gTGL4mRm5RsbFW76s25AbuAJ2vlymbh1c8Q4Hl2uJGU,646
 fmtr/tools/inspection_tools.py,sha256=tLTRvzy9XVomQPi0dfnF_cgwc7KiDVZAr7gPTk4S_bQ,278
-fmtr/tools/iterator_tools.py,sha256=ymxo2U9MrPhouIhWCVvh1TrP1bXJPm_p0Lqwgi5Jr6w,1628
+fmtr/tools/iterator_tools.py,sha256=ucsDj-T4YgwRCieFvjBXLfTe4RipL1CJ1_1GOxvEIW8,1816
 fmtr/tools/json_fix_tools.py,sha256=vNSlswVQnujPmKEqDjFJcO901mjMyv59q3awsT7mlhs,477
 fmtr/tools/json_tools.py,sha256=WkFc5q7oqMtcFejhN1K5zQFULa9TdLOup83Fr0saDRY,348
 fmtr/tools/logging_tools.py,sha256=jZFKnL-7HHOaPkn7F3fT9DyffIgwY-g7SEQ0p1RhzBo,2673
@@ -40,12 +40,12 @@ fmtr/tools/random_tools.py,sha256=4VlQdk5THbR8ka4pZaLbk_ZO_4yy6PF_lHZes_rgenY,22
 fmtr/tools/semantic_tools.py,sha256=cxY9NSAHWj4nEc6Oj4qA1omR3dWbl2OuH7_PkINc6_E,1386
 fmtr/tools/settings_tools.py,sha256=o11W3T60UZSvCTkh_eEQq1Mx74GycQ6JxUr0plBDbsk,2356
 fmtr/tools/spaces_tools.py,sha256=D_he3mve6DruB3OPS6QyzqD05ChHnRTb4buViKPe7To,1099
-fmtr/tools/string_tools.py,sha256=Lz_H9l25OOoxE48QBJ_Upkk5nno7dPA6G2Gc0Wo8rOk,5275
+fmtr/tools/string_tools.py,sha256=ZKHBrl2tui9VjWt7qit4UWbvpuzY6zp5ytiQvhlJVG4,5610
 fmtr/tools/tabular_tools.py,sha256=mw6vOij1Ch-pVAyHMPtm5zj__ULZN_TKeBYOfj33wFM,1634
 fmtr/tools/tokenization_tools.py,sha256=me-IBzSLyNYejLybwjO9CNB6Mj2NYfKPaOVThXyaGNg,4268
-fmtr/tools/tools.py,sha256=CAsApa1YwVdNE6H66Vjivs_mXYvOas3rh7fPELAnTpk,795
+fmtr/tools/tools.py,sha256=sLMXk8juOL8_n_D776cJ-kzjyMHqFI_fctDEjy6PIKs,1115
 fmtr/tools/unicode_tools.py,sha256=yS_9wpu8ogNoiIL7s1G_8bETFFO_YQlo4LNPv1NLDeY,52
-fmtr/tools/version,sha256=1-w7DNphgnwgQa3EckgnbD0Qx9ULcbjMgAOknBRyoWI,6
+fmtr/tools/version,sha256=jSMjAm19YQafVxIPX-mu0uNeQjDY56c4NghzH2KMxTY,6
 fmtr/tools/webhook_tools.py,sha256=q3pVJ1NCem2SrMuFcLxiWd7DibFs7Q-uGtojfXd3Qcg,380
 fmtr/tools/yaml_tools.py,sha256=Bhhyd6GQVKO72Lp8ky7bAUjIB_65Hdh0Q45SKIEe6S8,1901
 fmtr/tools/ai_tools/__init__.py,sha256=O8VRlPnnQCncg2ZZ2l_VdWLJf4jkKH6dkZFVbv6o7IM,388
@@ -85,9 +85,9 @@ fmtr/tools/tests/test_path.py,sha256=AkZQa6_8BQ-VaCyL_J-iKmdf2ZaM-xFYR37Kun3k4_g
 fmtr/tools/tests/test_yaml.py,sha256=jc0TwwKu9eC0LvFGNMERdgBue591xwLxYXFbtsRwXVM,287
 fmtr/tools/version_tools/__init__.py,sha256=cjE6nO6AoVOUp3RwgTbqL9wiw8J1l2pHJOz6Gn6bxjA,326
 fmtr/tools/version_tools/version_tools.py,sha256=Hcc6yferZS1hHbugRTdiHhSNmXEEG0hjCiTTXKna-YY,1127
-fmtr_tools-1.3.63.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
-fmtr_tools-1.3.63.dist-info/METADATA,sha256=nSjkJECziz3f5ss_9fCnnyyVJCoAKvOl0LzYDPShNzo,17455
-fmtr_tools-1.3.63.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmtr_tools-1.3.63.dist-info/entry_points.txt,sha256=h-r__Xh5njtFqreMLg6cGuTFS4Qh-QqJPU1HB-_BS-Q,357
-fmtr_tools-1.3.63.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
-fmtr_tools-1.3.63.dist-info/RECORD,,
+fmtr_tools-1.3.65.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
+fmtr_tools-1.3.65.dist-info/METADATA,sha256=GU4COvHnYDWpDNeNy4PX0q3x6dxqRjxj0Ps0s_tCLX4,18035
+fmtr_tools-1.3.65.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmtr_tools-1.3.65.dist-info/entry_points.txt,sha256=h-r__Xh5njtFqreMLg6cGuTFS4Qh-QqJPU1HB-_BS-Q,357
+fmtr_tools-1.3.65.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
+fmtr_tools-1.3.65.dist-info/RECORD,,