flinventory 2.2.3__tar.gz → 2.2.4__tar.gz

{flinventory-2.2.3 → flinventory-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flinventory
-Version: 2.2.3
+Version: 2.2.4
 Summary: An inventory system for self-help repair shops
 Author-Email: flukx <flinventory-flukx@612211124.xyz>
 License: GPL3

{flinventory-2.2.3 → flinventory-2.2.4}/flinventory/datacleanup.py

@@ -10,6 +10,7 @@ import logging
 import string
 
 import yaml
+from typing import Optional
 
 from . import constant, labelprinter_typst
 from . import inventory_io
@@ -114,7 +115,7 @@ def add_arg_parsers(subparsers):
         ),
     )
     parser_levelname.add_argument("levelname", help="The new levelname.")
-    parser_levelname.set_defaults(func=set_levelname)
+    parser_levelname.set_defaults(func=set_levelname_from_args)
 
     parser_schemaname = subparsers.add_parser(
         "setSchemaname", description="Set the name for a location schema."
@@ -131,10 +132,35 @@ def add_arg_parsers(subparsers):
         ),
     )
     parser_schemaname.add_argument("name", help="The new name.")
-    parser_schemaname.set_defaults(func=set_schema_name)
+    parser_schemaname.set_defaults(func=set_schema_name_from_args)
 
 
-def get_schema(args) -> tuple[location.Schema, inventory_io.Inventory]:
+def get_schema_from_args(
+    args,
+) -> tuple[location.Schema, inventory_io.Inventory]:
+    """Wrapper for get_schema based on command-line arguments.
+
+    Args:
+        args.level: see level_spec in get_schema
+        args.directory: directory of the inventory data
+    Returns:
+        a schema and its surrounding inventory.
+    Raises:
+        ValueError: if get_schema raises. Error is printed.
+    """
+    level_spec = args.level
+    if not level_spec:
+        print("No level specified.")
+        return
+    inventory = inventory_io.Inventory.from_json_files(directory=args.dataDirectory)
+    try:
+        return get_schema(inventory, args), inventory
+    except ValueError as wrong_spec:
+        print(wrong_spec.args[0])
+        return
+
+
+def get_schema(inventory: inventory_io.Inventory, level_spec: str) -> location.Schema:
     """Get a schema in the inventory.
 
     Args:
@@ -146,58 +172,102 @@ def get_schema(args) -> tuple[location.Schema, inventory_io.Inventory]:
         args.directory: directory of the inventory data
     Returns:
         a schema and its surrounding inventory
+    Raises:
+        ValueError: if the level_spec was invalid. Exception.args[0] contains error message
     """
-    level_spec = args.level
-    if not level_spec:
-        print("No level specified.")
-        return
-    inventory = inventory_io.Inventory.from_json_files(directory=args.dataDirectory)
     separator = level_spec[0]
     if separator in string.digits + string.ascii_letters + " ":
-        print(
+        raise ValueError(
             "Probably separator missing as first character. Use non-digit, non-letter, non-space"
         )
-        return
     schema = inventory.schema
     for schema_name in level_spec.split(separator)[1:]:
         print(
             f"debug: Currently at schema {schema.name if not schema.is_default() else '<default>'}"
         )
         if schema_name:
-            print(f"choose subschema {schema_name}")
+            print(f"debug: choose subschema {schema_name}")
             schema = schema.get_subschema(schema_name)
         else:
-            print("choose sub schema default")
+            print("debug: choose sub schema default")
             schema = schema.sub_schema_default
-            print(schema)
-    return schema, inventory
+            print("debug", schema)
+    return schema
 
 
-def set_levelname(args):
+def set_levelname_from_args(args):
     """Set the levelname of one location schema."""
     new_levelname = args.levelname
-    schema, inventory = get_schema(args)
+    schema, inventory = get_schema_from_args(args)
+    set_levelname(inventory, schema, new_levelname)
+
+
+def set_levelname(
+    inventory: inventory_io.Inventory, schema: location.Schema, new_levelname: str
+):
+    """Set the levelname of one location schema.
+
+    Strip off whitespace.
+
+    Empty levelname raises ValueError if sub schemas exist.
+    Otherwise, it removes the possibility of this schema having subschemas.
+
+    Save the changes to disk.
+
+    Args:
+        inventory: inventory with schema and things (both needed)
+        schema: schema (level) to be changed
+        new_levelname: the new levelname
+    Raises:
+        ValueError: if the new levelname is empty or whitespace-only and sub schemas exist
+    """
+    schema_name = "a default schema" if schema.is_default() else schema.name
+    new_levelname = new_levelname.strip()
     try:
         print(
-            f"Change level name of {args.level} from {schema.levelname} to {new_levelname}."
+            f"Change level name of {schema_name} from {schema.levelname} to {new_levelname}."
         )
     except location.InvalidLocation:
-        print(f"Set level name of {args.level} from nothing to {new_levelname}.")
+        print(f"Set level name of {schema_name} from nothing to {new_levelname}.")
     schema.levelname = new_levelname
     inventory.save()
 
 
-def set_schema_name(args):
-    """Set the same of a schema.
+def set_schema_name_from_args(args):
+    """Set the name of a schema based on comand-line arguments.
 
     Fails on default schemas.
+
+    Raises:
+        ValueError: if level_spec is invalid
+        ValueError: if new name is empty except for whitespace
+    """
+    schema, inventory = get_schema_from_args(args)
+    set_schema_name(inventory, schema, args.name)
+
+
+def set_schema_name(
+    inventory: inventory_io.Inventory, schema: location.Schema, new_name: str
+):
+    """Set the name of a schema.
+
+    Fails on default schemas.
+
+    Args:
+        inventory: inventory with schema and things (both needed)
+        schema: schema (level) to be changed
+        new_name: new name of the schema. Is stripped of surrounding whitespace.
+    Raises:
+        ValueError: if new name is empty except for whitespace
     """
-    new_name = args.name
-    schema, inventory = get_schema(args)
     if schema.is_default():
-        print(f"Cannot change name of default schema {args.level}")
-        return
-    print(f"Change name of {args.level} from {schema.name} to {new_name}")
+        raise ValueError(f"Cannot change name of default schema.")
+    if not new_name.strip():
+        raise ValueError(
+            f"The new name '{new_name}' is empty (or only whitespace). This is invalid."
+        )
+    new_name = new_name.strip()
+    print(f"debug: Change schema name from {schema.name} to {new_name}")
     schema.name = new_name
     inventory.save()
 

{flinventory-2.2.3 → flinventory-2.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flinventory"
-version = "2.2.3"
+version = "2.2.4"
 description = "An inventory system for self-help repair shops"
 authors = [
     { name = "flukx", email = "flinventory-flukx@612211124.xyz" },