development-framework-cli 1.8.0__py3-none-any.whl → 1.8.1__py3-none-any.whl

{development_framework_cli-1.8.0.dist-info → development_framework_cli-1.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: development-framework-cli
-Version: 1.8.0
+Version: 1.8.1
 Summary: CLI tool for working with Data Modelling Storage Service
 Project-URL: Homepage, https://github.com/equinor/dm-cli
 Project-URL: Repository, https://github.com/equinor/dm-cli

{development_framework_cli-1.8.0.dist-info → development_framework_cli-1.8.1.dist-info}/RECORD

@@ -1,15 +1,15 @@
-dm_cli/__init__.py,sha256=9YY96-1GuXPdzOeSEWKmn9tAZ72Fc9sM8JlJufdz18w,46
-dm_cli/cli.py,sha256=giAVltKTVUB3MuG8KQcoDTJYTJYcnfICJtAsRVcKOhg,7121
+dm_cli/__init__.py,sha256=l_-YHE0jiBFqId_V1IWGEH47UPoJEHPzCoz9PWJCsoM,46
+dm_cli/cli.py,sha256=aUb6lvlHsvcPYzKYPOsMbmpjqoZpsN9e2ARHY5bnpgU,7103
 dm_cli/dmss.py,sha256=bA_jU9lIdY7HizK1DETZViufiWlcmYyFhBXLvFadyeE,5981
 dm_cli/domain.py,sha256=BMBK-WOQwBvDBEr_AoywdXAUPXMHIKIZLnMHpkuzqPs,5650
 dm_cli/enums.py,sha256=7PFPV1u5mexc-p6s8gG-wb7B5SmAORh5esmPQ-zxUtg,1236
-dm_cli/import_entity.py,sha256=mAqVeZlD-uojG4EySPRkNr5biJhFmMe-ziasUiwujqg,6998
-dm_cli/import_package.py,sha256=3dv0GNjRSI1MSFGeQW4_i1G1VaIvsrvfwvY4wKTFeRY,11559
-dm_cli/package_tree_from_zip.py,sha256=bpr9BoRaYKaowaP-zDif6km7mYJLbbby0f0kZHH6DTc,4624
+dm_cli/import_entity.py,sha256=9qjqr3rqPDjSnzJL1YFB8bDy8nETRC9ni6ALtPeqYQQ,6934
+dm_cli/import_package.py,sha256=051FRQuEt9zFx5HuDBg_sQRUUMgCHj9h439X0As03AM,11595
+dm_cli/package_tree_from_zip.py,sha256=L8gJB-sjvmQKYLkW3pAcNUccKXn7GrtMmuq-8d8sMfo,4803
 dm_cli/state.py,sha256=F2L_0bj0P840WDvCmqR0TCsko0AsVyjiOP8SVKocG7s,198
 dm_cli/command_group/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dm_cli/command_group/data_source.py,sha256=XnWMiJ-ScGfauFEeQ8IoftnasUg5lXYr-6D7jvdE6II,7671
-dm_cli/command_group/entities.py,sha256=5HVX-8_Hy4wbeUCBult4LMyyAXhg8IG4hTu08gXOsuE,6240
+dm_cli/command_group/entities.py,sha256=XOkQ-IJAd5lPmsAFI_bAigQrVI-fm94hkC6FYf2TE4k,6234
 dm_cli/dmss_api/__init__.py,sha256=YPL3TK0SH515dzVPW7zobuzH-cTo1IiMTMRuf6N5Pig,4607
 dm_cli/dmss_api/api_client.py,sha256=cm6nf1CFBbNxsYypjaEvN3SdPD5mlt6z4IQyUvnVAzY,28750
 dm_cli/dmss_api/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
@@ -55,12 +55,12 @@ dm_cli/dmss_api/models/storage_data_types.py,sha256=CLRbZfQ1v-b5A7XCOp5XBUNDDB2x
 dm_cli/dmss_api/models/storage_recipe.py,sha256=qlsiNuwM0VDt3yuImGNVZQ9cLzPZ3f6k-q18FFArZKo,3811
 dm_cli/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dm_cli/utils/file_structure.py,sha256=efIcl7kr7LGm9-2AKt6M6uXe0L8NHNBg0Icy1xO8rSM,1020
-dm_cli/utils/reference.py,sha256=V11edpj8mJSCbXlWlv8HW2zO4AwHRqDnmwdxKv5_qpA,5593
+dm_cli/utils/reference.py,sha256=y0Wp81fQ22hywgAQSLvzJftt4ki8BPdWFdf2rVgU_Bo,5835
 dm_cli/utils/resolve_local_ids.py,sha256=I9kXVZTQgqr07eu4CghGQVU99MAEXCdn6hacVX0AYOY,5726
-dm_cli/utils/utils.py,sha256=UEuW3ZfQ4cqNLXqyP-fFRiK1bgmaPdIzvl8Z566cx-s,7345
+dm_cli/utils/utils.py,sha256=wyCNKHXcpPk0Rd_8P1x__XTM_14XJKCjWelUw4gV8XA,7522
 dm_cli/utils/zip.py,sha256=Zdq6Z978i_1iDAvbrqZwJNsw4QersVtK0HeqFiRagdA,2781
-development_framework_cli-1.8.0.dist-info/METADATA,sha256=iEUXZdnBCU0KSBGzMay10r2OP9kMcdiMl0yVznl8Wvs,8234
-development_framework_cli-1.8.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-development_framework_cli-1.8.0.dist-info/entry_points.txt,sha256=PAOXUTc_jhfY9Hfs7BNFzh4TlbrOGYU7HgTM-P7h074,38
-development_framework_cli-1.8.0.dist-info/licenses/LICENSE,sha256=zefthAHZDOYIcHUXefkN_Fvuy4s-nYfoLX_dsycVDxc,1064
-development_framework_cli-1.8.0.dist-info/RECORD,,
+development_framework_cli-1.8.1.dist-info/METADATA,sha256=uf-6LlcdTk_kNdI12zoQzQ7PJgNzVxPgC3MkpSkL-vI,8234
+development_framework_cli-1.8.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+development_framework_cli-1.8.1.dist-info/entry_points.txt,sha256=PAOXUTc_jhfY9Hfs7BNFzh4TlbrOGYU7HgTM-P7h074,38
+development_framework_cli-1.8.1.dist-info/licenses/LICENSE,sha256=zefthAHZDOYIcHUXefkN_Fvuy4s-nYfoLX_dsycVDxc,1064
+development_framework_cli-1.8.1.dist-info/RECORD,,

{development_framework_cli-1.8.0.dist-info → development_framework_cli-1.8.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.31.0
+Generator: hatchling 1.33.0
 Root-Is-Purelib: true
 Tag: py3-none-any

dm_cli/__init__.py

@@ -1 +1 @@
-VERSION = "1.8.0"  # x-release-please-version
+VERSION = "1.8.1"  # x-release-please-version

dm_cli/cli.py

@@ -87,7 +87,7 @@ def import_plugin_blueprints(
 def create_lookup(
     name: Annotated[str, typer.Argument(help="Name of the lookup (application context) to create.")],
     paths: Annotated[
-        List[Path],
+        List[str],
         typer.Argument(
             help="one or more remote location for recursively looking for RecipeLinks. "
             "A remote location is a path in DMSS on the format <dataSource>/<rootPackage>/<subPacakge>/..."
@@ -97,8 +97,8 @@ def create_lookup(
     """
     Create a named Ui-/StorageRecipe-lookup-table from all RecipeLinks in a package existing in DMSS (requires admin privileges).
     """
-    # TODO change type of paths argument to be list of str to avoid this path as strings conversion below
-    paths_as_strings = [str(path) for path in paths]
+    # DMSS addresses, not local paths: a Path would turn '/' into '\' on Windows.
+    paths_as_strings = [path.rstrip("/") for path in paths]
     print(f"Creating lookup table from paths: {paths_as_strings}")
     dmss_exception_wrapper(dmss_api.create_lookup, recipe_package=paths_as_strings, application=name)
 

dm_cli/command_group/entities.py

@@ -42,7 +42,7 @@ def import_entity(
     source_path = Path(source)
     destination = destination.rstrip("/\\")
     # Not replacing a package, but appending to. Can therefore not use "fast mode"
-    fast = destination_is_root(Path(destination))
+    fast = destination_is_root(destination)
 
     def inner_import():
         if source_path.is_dir():

dm_cli/import_entity.py

@@ -59,7 +59,7 @@ def import_document(source_path: Path, destination: str, document: dict):
 
 
 def import_single_entity(source_path: Path, destination: str, validate: bool = False):
-    ensure_package_structure(Path(destination))
+    ensure_package_structure(destination)
     print(f"Importing ENTITY '{source_path.name}' --> '{destination}'")
 
     try:  # Load the JSON document
@@ -96,8 +96,6 @@ def import_folder_entity(
     raw_package_import: bool = False,
     resolve_local_ids: bool = False,
 ) -> dict:
-    destination_path = Path(destination)
-
     # Check if target already exists on remote. Then delete or raise exception
     target = f"{destination}/{source_path.name}"
     exists = dmss_api.document_check(target)
@@ -108,9 +106,9 @@ def import_folder_entity(
         dmss_api.document_remove(target)
 
     dependencies = {}
-    is_root = destination_is_root(destination_path)
+    is_root = destination_is_root(destination)
     if not is_root:
-        ensure_package_structure(destination_path)
+        ensure_package_structure(destination)
         dependencies = dependencies_of(dmss_api.export_meta(destination))
 
     memory_file = io.BytesIO()
@@ -172,7 +170,7 @@ def import_folders_as_one_package(source_path: Path, destination: str, package_n
         console.print(f"'{target}' already exists.  Replacing it...", style="dark_orange")
         dmss_api.document_remove(target)
 
-    ensure_package_structure(Path(destination))
+    ensure_package_structure(destination)
     dependencies = dependencies_of(dmss_api.export_meta(destination))
 
     entries = sorted(source_path.iterdir())

dm_cli/import_package.py

@@ -3,7 +3,7 @@ import json
 import os
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from json import JSONDecodeError
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from typing import Callable, Dict, List, Tuple
 from uuid import uuid4
 
@@ -99,7 +99,7 @@ def _upload_documents(description: str, data_source: str, documents: List[dict])
         run_with_progress(description, documents, lambda document: dmss_api.document_add_simple(data_source, document))
 
 
-def add_object_to_package(path: Path, package: Package, object: io.BytesIO) -> None:
+def add_object_to_package(path: PurePosixPath, package: Package, object: io.BytesIO) -> None:
     if len(path.parts) == 1:  # End of path means the actual document
         file = File(
             uid=str(uuid4()),  # This UID will be the data source ID for this file
@@ -115,11 +115,11 @@ def add_object_to_package(path: Path, package: Package, object: io.BytesIO) -> N
         sub_folder = Package(name=path.parts[0], parent=package)
         package.content.append(sub_folder)
 
-    new_path = str(path).split("/", 1)[1]  # Remove first element in path before stepping down
-    return add_object_to_package(Path(new_path), sub_folder, object)
+    new_path = PurePosixPath(*path.parts[1:])  # Remove first element in path before stepping down
+    return add_object_to_package(new_path, sub_folder, object)
 
 
-def add_file_to_package(path: Path, package: Package, document: dict) -> None:
+def add_file_to_package(path: PurePosixPath, package: Package, document: dict) -> None:
     if len(path.parts) == 1:  # End of path means the actual document
         if path.name.endswith("package.json"):
             # if document is a package.json file, add meta info to package instead of adding it to content list.
@@ -134,11 +134,11 @@ def add_file_to_package(path: Path, package: Package, document: dict) -> None:
         sub_folder = Package(name=path.parts[0], parent=package)
         package.content.append(sub_folder)
 
-    new_path = str(path).split("/", 1)[1]  # Remove first element in path before stepping down
-    return add_file_to_package(Path(new_path), sub_folder, document)
+    new_path = PurePosixPath(*path.parts[1:])  # Remove first element in path before stepping down
+    return add_file_to_package(new_path, sub_folder, document)
 
 
-def add_package_to_package(path: Path, package: Package) -> None:
+def add_package_to_package(path: PurePosixPath, package: Package) -> None:
     if len(path.parts) == 1:
         package.content.append(Package(name=path.parts[0], parent=package))
         return
@@ -148,8 +148,8 @@ def add_package_to_package(path: Path, package: Package) -> None:
         sub_folder = Package(name=path.parts[0], parent=package)
         package.content.append(sub_folder)
 
-    new_path = str(path).split("/", 1)[1]  # Remove first element in path before stepping down
-    return add_package_to_package(Path(new_path), sub_folder)
+    new_path = PurePosixPath(*path.parts[1:])  # Remove first element in path before stepping down
+    return add_package_to_package(new_path, sub_folder)
 
 
 def import_package_tree(package: Package, destination: str, raw_package_import: bool, resolve_local_ids: bool) -> None:

dm_cli/package_tree_from_zip.py

@@ -1,7 +1,7 @@
 import io
 import json
 from json import JSONDecodeError
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from typing import Dict, Union
 from zipfile import ZipFile
 
@@ -58,26 +58,27 @@ def package_tree_from_zip(
             is_root=is_root,
             meta=package_entity.get("_meta_"),
         )
-        # Construct a nested Package object of the package to import
+        # Construct a nested Package object of the package to import.
+        # Zip entry names and DMSS addresses always use '/', so they are handled as POSIX paths on every OS.
         for file_info in zip_file.filelist:
             filename = file_info.filename.split("/", 1)[1]  # Remove RootPackage prefix
             if file_info.is_dir():
                 if filename == "":  # Skip rootPackage
                     continue
-                add_package_to_package(Path(filename), root_package)
+                add_package_to_package(PurePosixPath(filename), root_package)
                 continue
-            if Path(filename).suffix != ".json":
+            if PurePosixPath(filename).suffix != ".json":
                 file_like = io.BytesIO(zip_file.read(f"{folder_name}/{filename}"))
-                file_like.name = Path(filename).name  # stem
-                file_like.destination = Path(f"/{destination}/{folder_name}/{filename}").parent
-                add_object_to_package(Path(filename), root_package, file_like)
+                file_like.name = PurePosixPath(filename).name  # stem
+                file_like.destination = PurePosixPath(f"/{destination}/{folder_name}/{filename}").parent
+                add_object_to_package(PurePosixPath(filename), root_package, file_like)
                 continue
             try:
                 json_doc = json.loads(zip_file.read(f"{folder_name}/{filename}"))
             except JSONDecodeError:
                 raise Exception(f"Failed to load the file '{filename}' as a JSON document")
 
-            add_file_to_package(Path(filename), root_package, json_doc)
+            add_file_to_package(PurePosixPath(filename), root_package, json_doc)
 
             # Add dependencies from entity to the global dependencies list
             dependencies = concat_dependencies(

dm_cli/utils/reference.py

@@ -1,5 +1,6 @@
-from os.path import normpath
+import os
 from pathlib import Path
+from posixpath import normpath  # references are DMSS addresses, always '/'-separated
 from typing import Dict, List, Union
 
 from ..dmss import ApplicationException
@@ -81,8 +82,9 @@ def replace_relative_references(
                 if value["referenceType"] == ReferenceTypes.LINK.value:
                     value["address"] = _resolve_reference(value["address"])
                 else:
-                    # Handle storage references
-                    local_file_path = "/".join(str(source_path).split("/")[:-1])
+                    # Handle storage references. source_path is a folder on disk: take its parent with
+                    # the OS path rules, the address itself is appended as-is ('/' works on Windows too).
+                    local_file_path = os.path.dirname(str(source_path)) if source_path else ""
                     if value["address"][0] == ".":
                         raise ApplicationException(
                             f"Relative references by . are not supported", data=value, debug=file_path

dm_cli/utils/utils.py

@@ -1,7 +1,7 @@
 import json
 import os
 import pprint
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from typing import Callable, Dict, List
 
 import typer
@@ -68,7 +68,7 @@ def document_already_exists(api_exception: ApiException) -> bool:
     return False
 
 
-def add_package_to_path(name: str, path: Path):
+def add_package_to_path(name: str, path: PurePosixPath):
     package = Package(name, is_root=len(path.parts) == 2)
     dmss_api.document_add(
         str(path.parent),
@@ -102,14 +102,16 @@ def replace_global_addresses(
     return document
 
 
-def destination_is_root(destination: Path) -> bool:
-    if len(destination.parts) > 1:
+def destination_is_root(destination: str | PurePosixPath) -> bool:
+    if len(PurePosixPath(destination).parts) > 1:
         return False
     return True
 
 
-def ensure_package_structure(path: Path):
+def ensure_package_structure(path: str | PurePosixPath):
     """Create any missing packages in the provided path (mkdir -R)"""
+    # A DMSS address, not a path on disk: keep it '/'-separated on every OS.
+    path = PurePosixPath(path)
     try:
         dmss_api.document_get(f"dmss://{path}/")
     except NotFoundException as e: