flinventory 0.3.2__py3-none-any.whl → 0.4.2__py3-none-any.whl

flinventory/inventory_io.py

@@ -8,7 +8,7 @@ import random
 import argparse
 import logging
 import os
-from typing import Callable, Sequence, Iterable, Optional, Self, Any, Iterator
+from typing import Callable, Sequence, Iterable, Optional, Self, Iterator, cast
 
 from . import constant
 from .box import BoxedThing
@@ -120,7 +120,6 @@ class Inventory(list[BoxedThing]):
         Saving schema would be possible with schema.json attribute.
         todo: maybe save options
         """
-        logger = logging.getLogger("save_things")
         for thing in self:
             thing.save()
 
@@ -148,7 +147,7 @@ class Inventory(list[BoxedThing]):
                 return thing
         raise KeyError(thing_id)
 
-    def get_by_key(self, key, value) -> Iterator[BoxedThing]:
+    def get_by_key(self, key, value) -> Iterable[BoxedThing]:
         """Return all boxed things that have this value for this key.
 
         For example useful for looking up thing by name: get_by_key(('name', 0), 'Nice thing')
@@ -174,6 +173,71 @@ class Inventory(list[BoxedThing]):
         """
         return (box for box in self if box.thing.best(key, backup=None) == value)
 
+    def direct_ancestors(self, thing: BoxedThing, key: str) -> set[BoxedThing]:
+        """Convert key (assuming list of ids) into set of things.
+
+        Intended for key = subclass_of and part_of.
+        """
+        generalisations = set()
+        for thing_id in cast(tuple, thing.get(key, tuple())):
+            try:
+                generalisations.add(self.get_by_id(thing_id))
+            except KeyError:
+                logging.getLogger("inventory.direct_generalisations").warning(
+                    f"id {thing_id} in {self.get_id(thing)} ({thing.best('name', backup="?")}) "
+                    "subclass_of is not a valid id. Ignore it."
+                )
+        return generalisations
+
+    def ancestors(self, thing: BoxedThing, key: str) -> set[BoxedThing]:
+        """Get all direct and indirect key of elements as things.
+
+        Intended for key = subclass_of and part_of.
+        """
+        generalisations = set()
+        unchecked = {thing}
+        while unchecked:
+            current = unchecked.pop()
+            generalisations.add(current)
+            unchecked.update(self.direct_ancestors(current, key))
+            # to avoid checking something again, avoiding infinite loops:
+            unchecked.difference_update(generalisations)
+        return generalisations.difference({thing})
+
+    def super_things(self, thing: BoxedThing) -> set[BoxedThing]:
+        """Get all things this thing is a part of. Directly or indirectly.
+
+        That is: a part_of b & b part_of c ⇒ a part_of c
+        and a subclass_of b not⇒ a part_of b but
+        a subclass_of b & b part_of c ⇒ a part_of c
+
+        Infinite loops must be avoided, so simple recursive call might be problematic.
+
+        Not implemented but maybe necessary: caching result in the thing.
+        Cache must be invalidated whenever part_of or subclass_of of any
+        included thing changes. Difficult. Better would be cache on the
+        direct level.
+        """
+        supers = set()
+        unchecked = {thing}
+        generalisations = {thing}  # only saved to avoid recursion loop
+        unchecked_generalisations = set()
+        while unchecked or unchecked_generalisations:
+            if unchecked:
+                current = unchecked.pop()
+                supers.add(current)
+            else:
+                current = unchecked_generalisations.pop()
+                generalisations.add(current)
+            unchecked.update(self.direct_ancestors(current, "part_of"))
+            unchecked_generalisations.update(
+                self.direct_ancestors(current, "subclass_of")
+            )
+            unchecked.difference_update(supers)
+            unchecked_generalisations.difference_update(generalisations)
+
+        return supers.difference({thing})
+
 
 def check_filename_types(filetypes: Sequence[str]) -> Callable[[str], str]:
     """Create function that checks for being a simple file.
@@ -267,7 +331,7 @@ def add_file_args(parser: argparse.ArgumentParser) -> None:
         "--logfile",
         "-lf",
         default="things.log",
-        help=("Where to write the log file. Relative to the out directory."),
+        help="Where to write the log file. Relative to the out directory.",
         type=check_filename_types([".log"]),
     )
 

flinventory/thing.py

@@ -39,7 +39,7 @@ class Thing(defaulted_data.DefaultedDict):
             default=default,
             non_defaulted=tuple(),
             translated=("name", "name_alt", "description"),
-            lists=("name_alt", "part_of"),
+            lists=("name_alt", "part_of", "subclass_of"),
             default_order=("name", "name_alt", "part_of", "category", "url"),
             options=options,
         )

{flinventory-0.3.2.dist-info → flinventory-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flinventory
-Version: 0.3.2
+Version: 0.4.2
 Summary: An inventory system for self-help repair shops
 Author-Email: flukx <flinventory-flukx@612211124.xyz>
 License: GPL3
@@ -43,7 +43,7 @@ There this inventory should help.
 3. Each thing can be found by one of its names alphabetically, by several categories, by English or German name, by looking at pictures in the storage. Not a single categorization to be limited to.
 
 ## Data
-For example data see the directory `sample-data` or [the data repository](https://flugit.hilsky.de/flukx/things-data). (Currently outdated.)
+For example data see the directory `sample-data` or [branch Rad i.O. in the data repository](https://codeberg.org/flukx/flings/src/branch/rad-i-o) or the [private data repository](https://flugit.hilsky.de/flukx/things-data) if you have access.
 The data format is a specific directory structure with specific file names:
 - `schema.yaml`: describes how locations in this workshop are defined. See `sample_data` for details.
 - `preferences.yaml`: general options for this data. See `sample_data` for details.

{flinventory-0.3.2.dist-info → flinventory-0.4.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
-flinventory-0.3.2.dist-info/METADATA,sha256=j-huk4wILTl7PYAmUVaKGQzT5c7Nj5bIBS_BlGzaxGM,4439
-flinventory-0.3.2.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-flinventory-0.3.2.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-flinventory-0.3.2.dist-info/licenses/LICENSE,sha256=9c-AWlAEeFMmn1aODEfabsw2he-SpQeykurYw-KqSdw,34478
+flinventory-0.4.2.dist-info/METADATA,sha256=ZQjK-O4pZu_8nTuBLmDKJ0iSepizKaVkxaGIRP-cTnc,4542
+flinventory-0.4.2.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+flinventory-0.4.2.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+flinventory-0.4.2.dist-info/licenses/LICENSE,sha256=9c-AWlAEeFMmn1aODEfabsw2he-SpQeykurYw-KqSdw,34478
 flinventory/__init__.py,sha256=0HTGxw9J-2KnbxQbzX6HH-Pztkp0BEjiHANhndfbtYM,270
 flinventory/__main__.py,sha256=YI3dGiBr1i56JpGommQTWYjgfCmhr2JT1pQUdf0lf1w,1228
 flinventory/box.py,sha256=rk7yrAjVdxcrpvmTMt3jkMVOAoQNJfqoSig9U2S3yJ0,10480
@@ -9,15 +9,15 @@ flinventory/constant.py,sha256=pPNCwScLon_MOKL9_jjD_sxqB7Q2WW6rZqtrBl7SyWk,10283
 flinventory/datacleanup.py,sha256=_CImmWJhq5uKz21jJQUqKYoQfbHEYA0000RyPRt5BI0,11363
 flinventory/defaulted_data.py,sha256=KAy6V2KLcifLg7zHBFnx_eFLp31sCWih1Btp6cE0bQc,21585
 flinventory/generate_labels.py,sha256=wB9ibokHOcab599qZhi5uTzfy3DTo3wT4DJP9qLMzXs,6642
-flinventory/inventory_io.py,sha256=bC5NjJ2XAVZDPlr4pcJaAyh7TmRV6ELQs1LJOHW2j3U,9841
+flinventory/inventory_io.py,sha256=OWThcf9nzeZNqvNpzQiBhESQAnVXC7hUA8DEVzq-w-Y,12561
 flinventory/location.py,sha256=eaZ8tF8HdzH17IBDl3_p_MsnSw5-H1GfbvkTe3dPFGk,16593
 flinventory/sign.py,sha256=8G7fsne3Nsf8zZKKTUl40uWMNsWIv7FYV2KcqBR2MQI,5515
 flinventory/signprinter_latex.py,sha256=Ytf1T_ADedj_Wkqe8bWyN23-TwFaKE7zFpeoYxn5NzM,19105
-flinventory/thing.py,sha256=e1PZoS29EmDNVhFoPW1_XGaovai9WthitNalailyfTM,5064
+flinventory/thing.py,sha256=86fXj3RwTbkCdVVWrbyO-VEW_e5lKJlV8PPt1Xf8ejY,5079
 flinventory/thingtemplate_latex/.gitignore,sha256=DTF250Ttj8O2lxrQBwMNrQ73rWPvdwCytipfZSLFtlU,51
 flinventory/thingtemplate_latex/dummyImage.jpg,sha256=bIBH5Lrxlr5qJ42nP1cpJXPRNGLOwyEuzwXFSvNwTSk,147857
 flinventory/thingtemplate_latex/sign.tex,sha256=cVlOjImuS97Gf19MGW27HiP6Uw8JNnobXym6NlY-qSI,787
 flinventory/thingtemplate_latex/signlist-footer.tex,sha256=LcZw5__h8SqgMmYxs5oLbXLaFTQlx_X5rtYnpxwUh9Y,14
 flinventory/thingtemplate_latex/signlist-header.tex,sha256=F1J4aSPq6QO_Ved4Zn7-rytP1vDkdWTqjjtGJpe_FDg,297
 flinventory/thingtemplate_latex/signs-example.tex,sha256=J6eCcPhP0Xklgn8xnSenDOvjzmc_NGmakWU4RGbeUtM,3090
-flinventory-0.3.2.dist-info/RECORD,,
+flinventory-0.4.2.dist-info/RECORD,,

{flinventory-0.3.2.dist-info → flinventory-0.4.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.3)
+Generator: pdm-backend (2.4.4)
 Root-Is-Purelib: true
 Tag: py3-none-any