moat-db-box 0.0.1__tar.gz

moat_db_box-0.0.1/LICENSE.txt

@@ -0,0 +1,14 @@
+The code in this repository, and all MoaT submodules it refers to,
+is part of the MoaT project.
+
+Unless a submodule's LICENSE.txt states otherwise, all included files are
+licensed under the LGPL V3, as published by the FSF at
+https://www.gnu.org/licenses/lgpl-3.0.html .
+
+In addition to the LGPL's terms, the author(s) respectfully ask all users of
+this code to contribute any bug fixes or enhancements. Also, please link back to
+https://M-o-a-T.org.
+
+Thank you.
+
+Copyright © 2021 ff.: the MoaT contributor(s), as per the git changelog(s).

moat_db_box-0.0.1/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: moat-db-box
+Version: 0.0.1
+Summary: MoaT support for managing containers
+Author-email: Matthias Urlichs <matthias@urlichs.de>
+Project-URL: homepage, https://m-o-a-t.org
+Project-URL: repository, https://github.com/M-o-a-T/moat
+Keywords: MoaT
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
+Classifier: Framework :: AnyIO
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: moat-util~=0.60.9
+Requires-Dist: moat-db~=0.2.3
+Requires-Dist: moat-label~=0.2.2
+Provides-Extra: event
+Requires-Dist: attr; extra == "event"
+Requires-Dist: outcome; extra == "event"
+Provides-Extra: main
+Requires-Dist: asyncclick; extra == "main"
+Requires-Dist: getpass; extra == "main"
+Provides-Extra: msg
+Requires-Dist: msgpack; extra == "msg"
+Provides-Extra: path
+Requires-Dist: simpleeval; extra == "path"
+Provides-Extra: queue
+Requires-Dist: outcome; extra == "queue"
+Provides-Extra: systemd
+Requires-Dist: systemd.daemon; extra == "systemd"
+Provides-Extra: yaml
+Requires-Dist: ruyaml; extra == "yaml"
+Provides-Extra: time
+Requires-Dist: calendar; extra == "time"
+Provides-Extra: dev
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file

moat_db_box-0.0.1/README.md

@@ -0,0 +1,18 @@
+# MoaT-Box
+
+% start synopsis
+
+This module manages boxes, i.e. things you can put other things into.
+
+"Box" is meant to be inclusive. A room is a box. So is a cupboard, or a row
+of books. Some boxes can be nested, with locations. Some boxes can be moved
+(e.g. a bookcase or a drawer), some can't (the compartments within a drawer)
+
+Boxes are typed. You can put a cupboard into a room but not vice versa.
+
+Boxes are labelled. A box can have an arbitrary number of labels, though
+most of the time it'll have one, or at most two: one with a barcode and a
+box number, and one with a text that describes the content – or at least
+reminds the owner of it.
+
+% end synopsis

moat_db_box-0.0.1/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [ "setuptools", "wheel",]
+
+[project]
+classifiers = [
+	"Intended Audience :: Developers",
+	"Programming Language :: Python :: 3",
+	"Framework :: AsyncIO",
+	"Framework :: Trio",
+	"Framework :: AnyIO",
+	"Development Status :: 4 - Beta",
+	]
+dependencies = [
+	"moat-util ~= 0.60.9",
+	"moat-db ~= 0.2.3",
+	"moat-label ~= 0.2.2",
+	]
+version = "0.0.1"
+keywords = [ "MoaT",]
+requires-python = ">=3.11"
+name = "moat-db-box"
+description = "MoaT support for managing containers"
+readme = "README.rst"
+[[project.authors]]
+name = "Matthias Urlichs"
+email = "matthias@urlichs.de"
+
+
+[project.urls]
+homepage = "https://m-o-a-t.org"
+repository = "https://github.com/M-o-a-T/moat"
+
+[project.optional-dependencies]
+event = [ "attr", "outcome",]
+main = [ "asyncclick", "getpass",]
+msg = [ "msgpack",]
+path = [ "simpleeval",]
+queue = [ "outcome",]
+systemd = [ "systemd.daemon",]
+yaml = [ "ruyaml",]
+time = [ "calendar",]
+dev = [ "flake8", "isort",]
+
+[tool.setuptools]
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"*" = ["*.yaml"]

moat_db_box-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

moat_db_box-0.0.1/src/moat/db/box/__init__.py

@@ -0,0 +1,3 @@
+"""
+MoaT inventory module to store boxes.
+"""

moat_db_box-0.0.1/src/moat/db/box/_main.py

@@ -0,0 +1,228 @@
+"""
+Support for boxes for storing things.
+"""
+
+# The main code must not load any sqlalchemy code.
+# sqlalchemy might not be present.
+
+from __future__ import annotations
+
+import sys
+
+import asyncclick as click
+from sqlalchemy import select
+
+from moat.util import load_subgroup, option_ng, yprint
+from moat.db import database
+
+from .model import Box, BoxTyp
+
+
+@load_subgroup(prefix="moat.box", invoke_without_command=False)
+@click.pass_context
+def cli(ctx):
+    """Boxes for storing things."""
+    obj = ctx.obj
+
+    sess = ctx.with_resource(database(obj.cfg.db))
+    ctx.with_resource(sess.begin())
+
+    obj.session = sess
+
+
+@cli.group
+@click.option("--name", "-n", type=str, help="Text on the label")
+@click.pass_obj
+def one(obj, name):
+    """
+    Manage boxes.
+    """
+    obj.name = name
+    pass
+
+
+@one.command(name="show")
+@click.pass_obj
+def show_(obj):
+    """
+    Show box details / list all box types.
+
+    If a name is set, show details for this box.
+    Otherwise list all boxes without parents.
+    """
+    sess = obj.session
+
+    if obj.name is None:
+        seen = False
+        with sess.execute(select(Box).where(Box.container == None)) as boxes:  # noqa:E711
+            for (box,) in boxes:
+                seen = True
+                print(box.name)
+        if not seen:
+            print("No box types defined yet. Use '--help'?", file=sys.stderr)
+    else:
+        box = sess.one(Box, name=obj.name)
+        yprint(box.dump())
+
+
+def opts(c):
+    c = option_ng("--name", "-n", type=str, help="Rename this box")(c)
+    c = option_ng("--x", "-x", "pos_x", type=int, help="X position in parent")(c)
+    c = option_ng("--y", "-y", "pos_y", type=int, help="Y position in parent")(c)
+    c = option_ng("--z", "-z", "pos_z", type=int, help="Z position in parent")(c)
+    c = option_ng("--in", "-i", "container", type=str, help="Where is it?")(c)
+    c = option_ng("--typ", "-t", "boxtyp", type=str, help="Type of the box")(c)
+    return c
+
+
+@one.command()
+@opts
+@click.pass_obj
+def add(obj, **kw):
+    """
+    Add a box.
+    """
+    if obj.name is None:
+        raise click.UsageError("The box needs a name!")
+
+    try:
+        box = obj.session.one(Box, name=obj.name)
+    except KeyError:
+        pass
+    else:
+        print("This box already exists", file=sys.stderr)
+        sys.exit(1)
+    box = Box(name=obj.name)
+    obj.session.add(box)
+    box.apply(**kw)
+
+
+@one.command(epilog="Use '-in -' to drop the parent box, -x/-y/-z 0 to clear a position.")
+@opts
+@click.pass_obj
+def set(obj, **kw):  # noqa:A001
+    """
+    Modify a box.
+    """
+    if obj.name is None:
+        raise click.UsageError("Which box? Use a name")
+
+    try:
+        box = obj.session.one(Box, name=obj.name)
+    except KeyError:
+        print("This box doesn't exist", file=sys.stderr)
+        sys.exit(1)
+    box.apply(**kw)
+
+
+@one.command()
+@click.pass_obj
+def delete(obj):
+    """
+    Remove a box.
+    """
+    if obj.name is None:
+        raise click.UsageError("Which box? Use a name")
+    try:
+        box = obj.session.one(Box, name=obj.name)
+    except KeyError:
+        print("This box doesn't exist", file=sys.stderr)
+        sys.exit(1)
+    obj.session.delete(box)
+
+
+@cli.group(name="typ")
+@click.option("--name", "-n", type=str, help="Name of the box type")
+@click.pass_context
+def typ_(ctx, name):
+    """\
+    Manage box types.
+    """
+    obj = ctx.obj
+    obj.name = name
+
+
+@typ_.command(name="show")
+@click.pass_obj
+def typ_show(obj):
+    """
+    Show box details / list all box types.
+
+    If a name is set, show details for this type.
+    Otherwise list all known box types.
+    """
+    sess = obj.session
+
+    if obj.name is None:
+        seen = False
+        with sess.execute(select(BoxTyp)) as boxes:
+            for (box,) in boxes:
+                seen = True
+                print(box.name)
+        if not seen:
+            print("No box types defined yet. Use '--help'?", file=sys.stderr)
+    else:
+        box = sess.one(BoxTyp, name=obj.name)
+        yprint(box.dump())
+
+
+def typopts(c):
+    c = option_ng("--name", "-n", type=str, help="Rename this type")(c)
+    c = option_ng("--x", "-x", "pos_x", type=int, help="Number of X positions for content")(c)
+    c = option_ng("--y", "-y", "pos_y", type=int, help="Number of Y positions for content")(c)
+    c = option_ng("--z", "-z", "pos_z", type=int, help="Number of Z positions for content")(c)
+    c = option_ng("--comment", "-c", "comment", type=str, help="Description of this type")(c)
+    c = click.option(
+        "--in",
+        "-i",
+        "parent",
+        type=str,
+        multiple=True,
+        help="Where can you put this thing into?",
+    )(c)
+    c = click.option("--usable", "-u", is_flag=True, help="Things can be put into this box")(c)
+    c = click.option("--unusable", "-U", is_flag=True, help="The box holds fixed subdividers")(c)
+    return c
+
+
+@typ_.command(name="add")
+@typopts
+@click.pass_obj
+def typ_add(obj, parent, **kw):
+    """
+    Add a box type.
+    """
+    parent  # noqa:B018
+
+    if obj.name is None:
+        raise click.UsageError("The box type needs a name!")
+
+    bt = BoxTyp(name=obj.name)
+    obj.session.add(bt)
+    bt.apply(**kw)
+
+
+@typ_.command(name="set", epilog="Use '-i -NAME' to remove a containing box type.")
+@typopts
+@click.pass_obj
+def typ_set(obj, **kw):
+    """
+    Modify a box type.
+    """
+    if obj.name is None:
+        raise click.UsageError("Which box type? Use a name")
+
+    bt = obj.session.one(BoxTyp, name=obj.name)
+    bt.apply(**kw)
+
+
+@typ_.command(name="delete")
+@click.pass_obj
+def typ_delete(obj):
+    """
+    Remove a box type.
+    """
+    if obj.name is None:
+        raise click.UsageError("Which box type? Use a name")
+    bt = obj.session.one(BoxTyp, name=obj.name)
+    obj.session.delete(bt)

moat_db_box-0.0.1/src/moat/db/box/model.py

@@ -0,0 +1,152 @@
+"""
+Database schema for collecting things
+"""
+
+from __future__ import annotations
+
+from sqlalchemy import Column, ForeignKey, Integer, String, Table, event
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from moat.db.schema import Base
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Any
+
+boxtyp_tree = Table(
+    "boxtyp_tree",
+    Base.metadata,
+    Column(
+        "parent_id",
+        Integer,
+        ForeignKey("boxtyp.id", name="fk_boxtyp_parent"),
+        primary_key=True,
+    ),
+    Column("child_id", Integer, ForeignKey("boxtyp.id", name="fk_boxtyp_child"), primary_key=True),
+)
+
+
+class BoxTyp(Base):
+    "One kind of box."
+
+    name: Mapped[str] = mapped_column(unique=True, type_=String(40))
+    comment: Mapped[str] = mapped_column(type_=String(200), nullable=True)
+
+    parents: Mapped[set[BoxTyp]] = relationship(
+        "BoxTyp",
+        secondary=boxtyp_tree,
+        primaryjoin="BoxTyp.id == boxtyp_tree.c.child_id",
+        secondaryjoin="BoxTyp.id == boxtyp_tree.c.parent_id",
+        back_populates="children",
+    )
+    children: Mapped[set[BoxTyp]] = relationship(
+        "BoxTyp",
+        secondary=boxtyp_tree,
+        primaryjoin="BoxTyp.id == boxtyp_tree.c.parent_id",
+        secondaryjoin="BoxTyp.id == boxtyp_tree.c.child_id",
+        back_populates="parents",
+    )
+    usable: Mapped[bool] = mapped_column(
+        nullable=False,
+        default=True,
+        server_default="1",
+        comment="Can you put things directly into this?",
+    )
+
+    # Possible locations in there
+    pos_x: Mapped[int] = mapped_column(nullable=True, comment="Max # of X positions")
+    pos_y: Mapped[int] = mapped_column(nullable=True, comment="Max # of Y positions")
+    pos_z: Mapped[int] = mapped_column(nullable=True, comment="Max # of Z positions")
+
+    labeltyp_id: Mapped[int] = mapped_column(
+        ForeignKey("labeltyp.id", name="fk_boxtyp_labeltyp"),
+        nullable=True,
+        comment="Default label",
+    )
+
+    boxes: Mapped[set[Box]] = relationship(back_populates="boxtyp")
+
+    def dump(self) -> dict[str, Any]:
+        "Standard info dump"
+        res = super().dump()
+        res.pop("pos_x", None)
+        res.pop("pos_y", None)
+        res.pop("pos_z", None)
+        if self.pos_x or self.pos_y or self.pos_z:
+            res["size"] = [self.pos_x, self.pos_y, self.pos_z]
+        if self.parents:
+            res["parent"] = [p.name for p in self.parents]
+        if self.children:
+            res["child"] = [p.name for p in self.children]
+        return res
+
+
+class Box(Base):
+    "One particular box, possibly with other boxes inside."
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+
+    typ_id: Mapped[int] = mapped_column(ForeignKey("boxtyp.id", name="fk_box_typ"))
+    name: Mapped[str] = mapped_column(unique=True, type_=String(40))
+    container_id: Mapped[int] = mapped_column(
+        ForeignKey("box.id", name="fk_box_container"),
+        nullable=True,
+    )
+
+    boxtyp: Mapped[BoxTyp] = relationship(back_populates="boxes")
+    container: Mapped[Box | None] = relationship(back_populates="boxes", remote_side=[id])
+    boxes: Mapped[set[Box]] = relationship(back_populates="container")
+
+    # location within its parent
+    pos_x: Mapped[int] = mapped_column(nullable=True, comment="X position in parent")
+    pos_y: Mapped[int] = mapped_column(nullable=True, comment="Y position in parent")
+    pos_z: Mapped[int] = mapped_column(nullable=True, comment="Z position in parent")
+
+    def dump(self) -> dict[str, Any]:
+        "Standard info dump"
+        res = super().dump()
+        res.pop("pos_x", None)
+        res.pop("pos_y", None)
+        res.pop("pos_z", None)
+        if self.pos_x or self.pos_y or self.pos_z:
+            res["pos"] = [self.pos_x, self.pos_y, self.pos_z]
+        if self.container is not None:
+            res["in"] = self.container.name
+        if self.labels:
+            res["labels"] = [f"{lab.id}:{lab.text}" for lab in self.labels]
+        if self.boxes:
+            res["content"] = sorted([box.name for box in self.boxes])
+        if self.boxtyp:
+            res["typ"] = self.boxtyp.name
+        return res
+
+
+@event.listens_for(Box, "before_insert")
+@event.listens_for(Box, "before_update")
+def validate_box_coords(mapper, connection, model):
+    "Validator for box position"
+    mapper, connection  # noqa:B018
+    par = model.container
+    if par is not None:
+        par = par.boxtyp
+
+    def chk(p):
+        pp = f"pos_{p}"
+        ppos = getattr(par, pp, None)
+
+        if (pos := getattr(model, pp)) is None:
+            if ppos is not None and ppos > 1:
+                raise ValueError(f"Box {model.name} needs a value for {p}")
+        elif pos <= 0:
+            raise ValueError(f"Box {model.name} can't set {p} <= 0")
+        elif par is None:
+            raise ValueError(f"Box {model.name} is not in a sized container")
+        elif ppos is None:
+            raise ValueError(f"Box {model.name} can't have a value for {p}")
+        elif ppos < pos:
+            raise ValueError(f"Box {model.name}: {p} is {pos}, max is {ppos}")
+
+    chk("x")
+    chk("y")
+    chk("z")

moat_db_box-0.0.1/src/moat/db/box/model_.py

@@ -0,0 +1,67 @@
+"""
+Database schema for collecting things
+"""
+
+from __future__ import annotations
+
+from sqlalchemy.orm import relationship
+
+from moat.util import NotGiven
+from moat.db.schema import Base
+from moat.db.util import session
+from moat.label.model import Label, LabelTyp
+from moat.thing.model import Thing
+
+from .model import Box, BoxTyp
+
+BoxTyp.labeltyp = relationship(LabelTyp, back_populates="boxtypes")
+Box.labels = relationship(Label, back_populates="box", collection_class=set)
+Box.things = relationship(Thing, back_populates="container", collection_class=set)
+
+
+def box_apply(self, container=NotGiven, boxtyp=NotGiven, **kw):
+    "?"
+    sess = session.get()
+    with sess.no_autoflush:
+        Base.apply(self, **kw)
+
+        if container is NotGiven:
+            pass
+        elif container is None:
+            self.container = None
+        else:
+            self.container = sess.one(Box, name=container)
+
+        if boxtyp is NotGiven:
+            if self.boxtyp is None:
+                raise ValueError("New boxes need a type")
+        elif boxtyp is None:
+            raise ValueError("Boxes need a type")
+        else:
+            if self.boxtyp is None:
+                self.boxtyp = sess.one(BoxTyp, name=boxtyp)
+            elif self.boxtyp.name != boxtyp:
+                raise ValueError("Box types cannot be changed")
+
+
+Box.apply = box_apply
+
+
+def boxtyp_apply(self, usable, unusable, parent=(), **kw):
+    "?"
+    Base.apply(self, **kw)
+    if usable:
+        if unusable:
+            raise ValueError("Can't both use and not use this type")
+        self.usable = True
+    elif unusable:
+        self.usable = False
+
+    for p in parent:
+        if p[0] != "-":
+            self.parents.add(session.get().one(BoxTyp, name=p))
+        else:
+            self.parents.remove(session.get().one(BoxTyp, name=p[1:]))
+
+
+BoxTyp.apply = boxtyp_apply

moat_db_box-0.0.1/src/moat_db_box.egg-info/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: moat-db-box
+Version: 0.0.1
+Summary: MoaT support for managing containers
+Author-email: Matthias Urlichs <matthias@urlichs.de>
+Project-URL: homepage, https://m-o-a-t.org
+Project-URL: repository, https://github.com/M-o-a-T/moat
+Keywords: MoaT
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
+Classifier: Framework :: AnyIO
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: moat-util~=0.60.9
+Requires-Dist: moat-db~=0.2.3
+Requires-Dist: moat-label~=0.2.2
+Provides-Extra: event
+Requires-Dist: attr; extra == "event"
+Requires-Dist: outcome; extra == "event"
+Provides-Extra: main
+Requires-Dist: asyncclick; extra == "main"
+Requires-Dist: getpass; extra == "main"
+Provides-Extra: msg
+Requires-Dist: msgpack; extra == "msg"
+Provides-Extra: path
+Requires-Dist: simpleeval; extra == "path"
+Provides-Extra: queue
+Requires-Dist: outcome; extra == "queue"
+Provides-Extra: systemd
+Requires-Dist: systemd.daemon; extra == "systemd"
+Provides-Extra: yaml
+Requires-Dist: ruyaml; extra == "yaml"
+Provides-Extra: time
+Requires-Dist: calendar; extra == "time"
+Provides-Extra: dev
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file

moat_db_box-0.0.1/src/moat_db_box.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/moat/db/box/__init__.py
+src/moat/db/box/_main.py
+src/moat/db/box/model.py
+src/moat/db/box/model_.py
+src/moat_db_box.egg-info/PKG-INFO
+src/moat_db_box.egg-info/SOURCES.txt
+src/moat_db_box.egg-info/dependency_links.txt
+src/moat_db_box.egg-info/requires.txt
+src/moat_db_box.egg-info/top_level.txt

moat_db_box-0.0.1/src/moat_db_box.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

moat_db_box-0.0.1/src/moat_db_box.egg-info/requires.txt

@@ -0,0 +1,33 @@
+moat-db~=0.2.3
+moat-label~=0.2.2
+moat-util~=0.60.9
+
+[dev]
+flake8
+isort
+
+[event]
+attr
+outcome
+
+[main]
+asyncclick
+getpass
+
+[msg]
+msgpack
+
+[path]
+simpleeval
+
+[queue]
+outcome
+
+[systemd]
+systemd.daemon
+
+[time]
+calendar
+
+[yaml]
+ruyaml

moat_db_box-0.0.1/src/moat_db_box.egg-info/top_level.txt

@@ -0,0 +1 @@
+moat