gigl.common.types.Uri

class gigl.common.types.uri.uri.Uri(uri: str | Path | Uri)

Bases: object

A URI; currently supports GCS (‘gs://foo/bar’), HTTP (‘http://abc.com/xyz’) or local (‘/foo/bar’).

Methods

__init__
get_basename	The base name is the final component of the path, effectively extracting the file or directory name from a full path string.
is_valid	Check if the given URI is valid.
join	Join multiple tokens to create a new Uri instance.

__eq__(other: Any) → bool

Return self==value.

__hash__() → int

Return hash(self).

__init__(uri: str | Path | Uri)

__repr__() → str

Return repr(self).

__weakref__

list of weak references to the object (if defined)

get_basename() → str

The base name is the final component of the path, effectively extracting the file or directory name from a full path string. i.e. get_basename(“/foo/bar.txt”) -> bar.txt get_basename(“gs://bucket/foo”) -> foo

classmethod is_valid(uri: str | Path | Uri, raise_exception: bool = False) → bool

Check if the given URI is valid.

Args:

uri: The URI to check. raise_exception: Whether to raise an exception if the URI is invalid.

Returns:

bool: True if the URI is valid, False otherwise.

classmethod join(token: str | Path | Uri, *tokens: str | Path | Uri) → Uri

Join multiple tokens to create a new Uri instance.

Args:

token: The first token to join. tokens: Additional tokens to join.

Returns:

A new Uri instance representing the joined URI.