Ubiquerg

Warnings

• gotcha The library is currently in 'Development Status :: 4 - Beta'. While generally stable, this status indicates that the API is not yet final and may undergo minor non-backward-compatible changes in future minor releases.
  Fix: Monitor release notes for potential API changes, especially when updating minor versions. Test your application thoroughly after updates.
• gotcha The `mkabs` function (introduced in v0.8.0) was expanded to handle more cases. If you were relying on specific prior behavior for edge cases, or implicitly expecting a stricter interpretation, new versions might behave differently (e.g., resolving paths that previously failed).
  Fix: Review `mkabs` usage if migrating from versions prior to 0.8.0, especially with unusual path inputs, and test expected outputs to ensure compatibility with the expanded behavior.
• gotcha The `is_url` function (changed in v0.8.0) now explicitly allows `Path` objects as input. While this is an enhancement, if your code implicitly assumed only string inputs and performed pre-processing, this change might subtly affect error handling or validation logic in downstream components.
  Fix: Verify calls to `is_url` if your application handles `Path` objects explicitly or relies on strict input type checking. Ensure no unintended behavior arises from `Path` object acceptance.
• gotcha The `deep_update` function (ported in v0.8.1) was brought over from `yacman`. While designed for recursive dictionary updates, users migrating from `yacman` or expecting a specific recursive merge behavior should test its exact functionality with complex nested structures to ensure it aligns with expectations, as subtle differences might exist.
  Fix: Carefully test the `deep_update` function with various nested dictionary scenarios if its precise behavior is critical to your application, particularly if you are accustomed to its implementation in other libraries.

Install

• pip install ubiquerg Install latest version

Imports

• expandpath

  from ubiquerg.paths import expandpath

• is_filepath_like

  from ubiquerg.files import is_filepath_like

• deep_update

  from ubiquerg.collection import deep_update

Quickstart

Demonstrates how to use `expandpath` to resolve user and environment variables in a path and `is_filepath_like` to check if a string represents a file path.

from ubiquerg.paths import expandpath
from ubiquerg.files import is_filepath_like
import os

# Example 1: Expanding user and environment variables in a path
expanded_path = expandpath("~/my_project/$USER_DATA")
print(f"Expanded path: {expanded_path}")

# Example 2: Checking if a path is file-like
# Create a dummy file for demonstration
dummy_file = "test_file.txt"
with open(dummy_file, "w") as f:
    f.write("Hello, ubiquerg!")

is_file_like = is_filepath_like(dummy_file)
print(f"Is '{dummy_file}' a file-like path? {is_file_like}")

# Clean up the dummy file
os.remove(dummy_file)