dandi.utils

class dandi.utils.Hasher(*args, **kwargs)

hexdigest() → str

update(data: bytes) → None

dandi.utils.Parallel(**kwargs: Any) → Any

Adapter for joblib.Parallel so we could if desired, centralize control

class dandi.utils.ServerInfo(*, version: str, services: ServerServices, cli_minimal_version: str, cli_bad_versions: List[str])

cli_bad_versions: List[str]

cli_minimal_version: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

services: ServerServices

version: str

class dandi.utils.ServerServices(*, api: ServiceURL, webui: ServiceURL | None = None, jupyterhub: ServiceURL | None = None)

api: ServiceURL

jupyterhub: ServiceURL | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

webui: ServiceURL | None

class dandi.utils.ServiceURL(*, url: str)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: str

class dandi.utils.StrEnum(value)

A variation of Enum that is also a subclass of str, akin to IntEnum

Member instances of a subclass of this class assigned to auto() will have their own name as their value.

dandi.utils.abbrev_prompt(msg: str, *options: str) → str

Prompt the user to input one of several options, which can be entered as either a whole word or the first letter of a word. All input is handled case-insensitively. Returns the complete word corresponding to the input, lowercased.

For example, abbrev_prompt("Delete assets?", "yes", "no", "list") prompts the user with the message Delete assets? ([y]es/[n]o/[l]ist): `` and accepts as input ``y`, ``yes, n, no, l, and list.

dandi.utils.check_dandi_version() → None

dandi.utils.chunked(iterable: Iterable[T], size: int) → Iterator[list[T]]

dandi.utils.copy_file(src: str | Path, dst: str | Path) → None

Copy file from src to dst

dandi.utils.delayed(*args, **kwargs)

Adapter for joblib.delayed so we could if desired, centralize control

dandi.utils.ensure_datetime(t: datetime | int | float | str, strip_tzinfo: bool = False, tz: tzinfo | None = None) → datetime

Ensures that time is a datetime

strip_tzinfo applies only to str records passed in

epoch time assumed to be local (not utc)

dandi.utils.ensure_strtime(t: str | int | float | datetime, isoformat: bool = True) → str

Ensures that time is a string in iso format

Note: if t is already a string, no conversion of any kind is done.

epoch time assumed to be local (not utc)

Parameters:

isoformat (bool, optional) – If True, use .isoformat() and otherwise str(). With .isoformat() there is no space but T to separate date from time.

dandi.utils.exclude_from_zarr(path: Path) → bool

Returns True if the path is a file or directory that should be excluded from consideration when located in a Zarr

dandi.utils.find_files(regex: str, paths: str | Path | Iterable[str | Path] = '.', exclude: str | None = None, exclude_dotfiles: bool = True, exclude_dotdirs: bool = True, exclude_vcs: bool = True, exclude_datalad: bool = False, dirs: bool = False, dirs_avoid: str | None = None) → Iterator[str]

Generator to find files matching regex

Parameters:

• regex (string) – Regex to search target files. Is not applied to filter out directories

• paths (string or list, optional) – Directories or files to search among (directories are searched recursively)

• exclude (string, optional) – Matches to exclude

• exclude_vcs – If True, excludes commonly known VCS subdirectories. If string, used as regex to exclude those files (regex: %r)

• exclude_dotdirs – If True, does not descend into directories starting with “.”.

• exclude_datalad – If True, excludes files known to be datalad meta-data files (e.g. under .datalad/ subdirectory) (regex: %r)

• dirs (bool, optional) – Whether to match directories as well as files

• dirs_avoid (string, optional) – Regex for directories to not rercurse under (they might still be reported if dirs=True)

dandi.utils.find_parent_directory_containing(filename: str | Path, path: str | Path | None = None) → Path | None

Find a directory, on the path to ‘path’ containing filename

if no ‘path’ - path from cwd. If ‘path’ is not absolute, absolute path is taken assuming relative to cwd.

Returns None if no such found, pathlib’s Path (absolute) to the directory if found.

dandi.utils.flatten(it: Iterable) → Iterator

Yield items flattened if list, tuple or a generator

dandi.utils.flattened(it: Iterable) → list

Return list with items flattened if list, tuple or a generator

dandi.utils.fromisoformat(t: str) → datetime

dandi.utils.get_instance(dandi_instance_id: str | DandiInstance) → DandiInstance

dandi.utils.get_mime_type(filename: str, strict: bool = False) → str

Like mimetypes.guess_type(), except that if the file is compressed, the MIME type for the compression is returned. Also, the default return value is now 'application/octet-stream' instead of None.

dandi.utils.get_module_version(module: str | ModuleType) → str | None

Return version of the module

Return module’s __version__ if present, or use importlib to get version.

Return type:

object

dandi.utils.get_retry_after(response: Response) → int | None

If provided and parsed ok, returns duration in seconds to sleep before retry.

If not provided in the response header Retry-After, would return None. If parsing fails, or provided date/sleep does not make sense since either too far in the past (over 2 seconds) or in the future (over a week), would return None.

dandi.utils.get_utcnow_datetime(microseconds: bool = True) → datetime

Return current time as datetime with time zone information.

Microseconds are stripped away.

If string representation is desired, just “apply” .isoformat()

dandi.utils.is_interactive() → bool

Return True if all in/outs are tty

dandi.utils.is_page2_url(page1: str, page2: str) → bool

Tests whether the URL page2 is the same as page1 but with the page query parameter set to 2

dandi.utils.is_same_time(*times: datetime | int | float | str, tolerance: float = 1e-06, strip_tzinfo: bool = False) → bool

Helper to do comparison between time points

Time zone information gets stripped Does it by first normalizing all times to datetime, and then comparing to the first entry

Parameters:

tolerance (float, optional) – Seconds of difference between times to tolerate. By default difference up to a microsecond is ok

dandi.utils.is_url(s: str) → bool

Determines whether the input string s is a valid URL (standard URL or DANDI URL).

dandi.utils.joinurl(base: str, path: str) → str

Append a slash-separated path to a base HTTP(S) URL base. The two components are separated by a single slash, removing any excess slashes that would be present after naïve concatenation.

If path is already an absolute HTTP(S) URL, it is returned unchanged.

Note that this function differs from urllib.parse.urljoin() when the path portion of base is nonempty and does not end in a slash.

dandi.utils.list_paths(dirpath: str | Path, dirs: bool = False, exclude_vcs: bool = True) → list[Path]

dandi.utils.load_jsonl(filename: str | Path) → list

Load json lines formatted file

dandi.utils.move_file(src: str | Path, dst: str | Path) → Any

Move file from src to dst

dandi.utils.path_is_subpath(path: str, prefix: str) → bool

Return True if path is a subpath of prefix

It will return False if path == prefix.

Parameters:

• path (str)

• prefix (str)

dandi.utils.pluralize(n: int, word: str, plural: str | None = None) → str

dandi.utils.post_upload_size_check(path: Path, pre_check_size: int, erroring: bool) → None

dandi.utils.pre_upload_size_check(path: Path) → int

dandi.utils.setup_exceptionhook(ipython: bool = False) → None

Overloads default sys.excepthook with our exceptionhook handler.

If interactive, our exceptionhook handler will invoke pdb.post_mortem; if not interactive, then invokes default handler.

dandi.utils.shortened_repr(value: Any, length: int = 30) → str

dandi.utils.under_paths(paths: Iterable[str | PurePath], filter_paths: Iterable[str | PurePath]) → Iterator[PurePosixPath]

Return all elements of paths (converted to PurePosixPath instances) that are equal to or under/start with one or more paths in filter_paths. The elements of both iterables must be relative & normalized.

Based on get_filtered_paths_ from datalad’s datalad/support/path.py

dandi.utils.with_pathsep(path: str) → str

Little helper to guarantee that path ends with /

dandi.utils.yaml_dump(rec: Any) → str

Consistent dump into yaml

Of primary importance is default_flow_style=False to assure proper formatting on versions of pyyaml before 5.1: https://github.com/yaml/pyyaml/pull/256

dandi.utils.yaml_load(f: str | IO[str], typ: str | None = None) → Any

Load YAML source from a file or string.

Parameters:

• f (str or IO[str]) – The YAML source to load

• typ (str, optional) – The value of typ to pass to ruamel.yaml.YAML. May be “rt” (default), “safe”, “unsafe”, or “base”

Returns:

The parsed YAML value

Return type:

Any