File: _env_var.py

package info (click to toggle)
python-cyclopts 3.12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,288 kB
  • sloc: python: 11,445; makefile: 24
file content (61 lines) | stat: -rw-r--r-- 1,571 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
import os
from pathlib import Path
from typing import Any, Optional, get_args


def _is_path(type_) -> bool:
    from cyclopts._convert import resolve

    if type_ is Path:
        return True

    for inner_type in get_args(type_):
        inner_type = resolve(inner_type)
        if _is_path(inner_type):
            return True

    return False


def env_var_split(
    type_: Any,
    val: str,
    *,
    delimiter: Optional[str] = None,
) -> list[str]:
    """Type-dependent environment variable value splitting.

    Converts a single string into a list of strings. Splits when:

    * The ``type_`` is some variant of ``Iterable[pathlib.Path]`` objects.
      If Windows, split on ``;``, otherwise split on ``:``.

    * Otherwise, if the ``type_`` is an ``Iterable``, split on whitespace.
      Leading/trailing whitespace of each output element will be stripped.

    This function is the default value for :attr:`cyclopts.App.env_var_split`.

    Parameters
    ----------
    type_: type
        Type hint that we will eventually coerce into.
    val: str
        String to split.
    delimiter: Optional[str]
        Delimiter to split ``val`` on.
        If ``None``, defaults to whitespace.

    Returns
    -------
    list[str]
        List of individual string tokens.
    """
    from cyclopts._convert import resolve, token_count

    type_ = resolve(type_)
    count, consume_all = token_count(type_)

    if count > 1 or consume_all:
        return val.split(os.pathsep) if _is_path(type_) else val.split(delimiter)
    else:
        return [val]