Merge pull request #140 from casework/export_local_uuid

Export local_uuid

Author: kchason

README.md

@@ -122,7 +122,7 @@ case_sparql_select output.md input.sparql input.json [input-2.json ...]
 
 ### `local_uuid`
 
-This [module](case_utils/local_uuid.py) provides a wrapper UUID generator, `local_uuid()`.  Its main purpose is making example data generate consistent identifiers, and intentionally includes mechanisms to make it difficult to activate this mode without awareness of the caller.
+_Migration:_ Functionality previously in [`case_utils.local_uuid`](case_utils/local_uuid.py) has been exported to [`cdo-local-uuid`](https://github.com/Cyber-Domain-Ontology/CDO-Utility-Local-UUID).  A future `case-utils` release will drop this re-export.
 
 
 ### Built versions

case_utils/local_uuid.py

@@ -15,146 +15,18 @@
 # We would appreciate acknowledgement if the software is used.
 
 """
-This library is a wrapper for uuid, provided to generate repeatable UUIDs if requested.
-
-The function local_uuid() should be used in code where a user could be expected to opt in to non-random UUIDs.
+This library was a wrapper for uuid, provided to generate repeatable UUIDs if requested.  It is now a temporary re-export of functionality migrated to cdo_local_uuid.
 """
 
 __version__ = "0.4.0"
 
 __all__ = ["configure", "local_uuid"]
 
-import logging
-import os
-import pathlib
-import sys
-import typing
-import uuid
 import warnings
 
-DEMO_UUID_BASE: typing.Optional[str] = None
-
-DEMO_UUID_COUNTER: int = 0
-
-_logger = logging.getLogger(pathlib.Path(__file__).name)
-
-
-def configure() -> None:
-    """
-    This function is part of setting up _demo_uuid() to generate non-random UUIDs.  See _demo_uuid() documentation for further setup notes.
-    """
-    global DEMO_UUID_BASE
-
-    if os.getenv("DEMO_UUID_REQUESTING_NONRANDOM") == "NONRANDOM_REQUESTED":
-        warnings.warn(
-            "Environment variable DEMO_UUID_REQUESTING_NONRANDOM is deprecated.  See case_utils.local_uuid._demo_uuid for usage notes on its replacement, CASE_DEMO_NONRANDOM_UUID_BASE.  Proceeding with random UUIDs.",
-            FutureWarning,
-        )
-        return
-
-    env_base_dir_name = os.getenv("CASE_DEMO_NONRANDOM_UUID_BASE")
-    if env_base_dir_name is None:
-        return
-
-    base_dir_original_path = pathlib.Path(env_base_dir_name)
-    if not base_dir_original_path.exists():
-        warnings.warn(
-            "Environment variable CASE_DEMO_NONRANDOM_UUID_BASE is expected to refer to an existing directory.  Proceeding with random UUIDs.",
-            RuntimeWarning,
-        )
-        return
-    if not base_dir_original_path.is_dir():
-        warnings.warn(
-            "Environment variable CASE_DEMO_NONRANDOM_UUID_BASE is expected to refer to a directory.  Proceeding with random UUIDs.",
-            RuntimeWarning,
-        )
-        return
-
-    # Component: An emphasis this is an example.
-    demo_uuid_base_parts = ["example.org"]
-
-    # Component: Present working directory, relative to CASE_DEMO_NONRANDOM_UUID_BASE if that environment variable is an ancestor of pwd.
-    base_dir_resolved_path = base_dir_original_path.resolve()
-    srcdir_original_path = pathlib.Path(os.getcwd())
-    srcdir_resolved_path = srcdir_original_path.resolve()
-    # _logger.debug("base_dir_resolved_path = %r.", base_dir_resolved_path)
-    # _logger.debug("srcdir_resolved_path = %r.", srcdir_resolved_path)
-    try:
-        srcdir_relative_path = srcdir_resolved_path.relative_to(base_dir_resolved_path)
-        # _logger.debug("srcdir_relative_path = %r.", srcdir_relative_path)
-        demo_uuid_base_parts.append(str(srcdir_relative_path))
-    except ValueError:
-        # If base_dir is not an ancestor directory of srcdir, default to srcdir.
-        # _logger.debug("PWD is not relative to base path.")
-        demo_uuid_base_parts.append(str(srcdir_resolved_path))
-
-    # Component: Command of argument vector.
-    env_venv_name = os.getenv("VIRTUAL_ENV")
-    if env_venv_name is None:
-        demo_uuid_base_parts.append(sys.argv[0])
-    else:
-        command_original_path = pathlib.Path(sys.argv[0])
-        command_resolved_path = command_original_path.resolve()
-        venv_original_path = pathlib.Path(env_venv_name)
-        venv_resolved_path = venv_original_path.resolve()
-        try:
-            command_relative_path = command_resolved_path.relative_to(
-                venv_resolved_path
-            )
-            # _logger.debug("command_relative_path = %r.", command_relative_path)
-            demo_uuid_base_parts.append(str(command_relative_path))
-        except ValueError:
-            # _logger.debug("Command path is not relative to virtual environment path.")
-            demo_uuid_base_parts.append(str(command_resolved_path))
-
-    if len(sys.argv) > 1:
-        # Component: Arguments of argument vector.
-        demo_uuid_base_parts.extend(sys.argv[1:])
-
-    # _logger.debug("demo_uuid_base_parts = %r.", demo_uuid_base_parts)
-
-    DEMO_UUID_BASE = "/".join(demo_uuid_base_parts)
-
-
-def _demo_uuid() -> str:
-    """
-    This function generates a repeatable UUID, drawing on non-varying elements of the environment and process call for entropy.
-
-    This function is not intended to be called outside of this module.  Instead, local_uuid() should be called.
-
-    WARNING: This function was developed for use ONLY for reducing (but not eliminating) version-control edits to identifiers when generating sample data.  It creates UUIDs that are decidedly NOT random, and should remain consistent on repeated calls to the importing script.
-
-    To prevent accidental non-random UUID usage, two setup steps need to be done before calling this function:
-
-    * An environment variable, CASE_DEMO_NONRANDOM_UUID_BASE, must be set to a string provided by the caller.  The variable's required value is the path to some directory.  The variable's recommended value is the equivalent of the Make variable "top_srcdir" - that is, the root directory of the containing Git repository, some parent of the current process's current working directory.
-    * The configure() function in this module must be called.
-    """
-    global DEMO_UUID_BASE
-    global DEMO_UUID_COUNTER
-
-    if os.getenv("CASE_DEMO_NONRANDOM_UUID_BASE") is None:
-        raise ValueError(
-            "demo_uuid() called without CASE_DEMO_NONRANDOM_UUID_BASE in environment."
-        )
-
-    if DEMO_UUID_BASE is None:
-        raise ValueError("demo_uuid() called with DEMO_UUID_BASE unset.")
-
-    parts = [DEMO_UUID_BASE]
-
-    # Component: Incrementing counter.
-    DEMO_UUID_COUNTER += 1
-    parts.append(str(DEMO_UUID_COUNTER))
-
-    return str(uuid.uuid5(uuid.NAMESPACE_URL, "/".join(parts)))
-
+from cdo_local_uuid import configure, local_uuid
 
-def local_uuid() -> str:
-    """
-    Generate either a UUID4, or if requested via environment configuration, a non-random demo UUID.
-    """
-    global DEMO_UUID_BASE
-    if DEMO_UUID_BASE is None:
-        return str(uuid.uuid4())
-    else:
-        return _demo_uuid()
+warnings.warn(
+    "case_utils.local_uuid has exported its functionality to cdo_local_uuid.  Imports should be changed to use cdo_local_uuid.  case_utils currently re-exports that functionality, but this will cease in a future release.",
+    DeprecationWarning,
+)

setup.cfg

@@ -19,6 +19,7 @@ license_files =
 [options]
 include_package_data = true
 install_requires =
+    cdo-local-uuid >= 0.4.0, < 0.5.0
     pandas
     pyshacl >= 0.24.0
     rdflib < 8