Skip to content

tools

This module contains utility functions used in multiple submodules.

is_number(number, *, dtype=float)

Check if argument can be interpreated as number.

Parameters:

  • number ((string, float, int)) –

    Variable to be check if it can be casted to float.

  • dtype (dtype, default: float ) –

    Check for different dtypes, so if is float or if it is int.

Returns:

  • is_number ( bool ) –

    Return if argument can be casted to float.

Source code in src/prettypyplot/tools.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def is_number(number: object, *, dtype: type = float) -> bool:
    """Check if argument can be interpreated as number.

    Parameters
    ----------
    number : string, float, int
        Variable to be check if it can be casted to float.
    dtype : dtype, optional
        Check for different dtypes, so if is float or if it is int.

    Returns
    -------
    is_number : bool
        Return if argument can be casted to float.

    """
    try:
        float(number)
    except (ValueError, TypeError):
        return False
    return float(number) == dtype(number)

invert_sign(num)

Change sign of number or add/remove leading sign of str.

Source code in src/prettypyplot/tools.py 
45
46
47
48
49
50
51
52
53
54
55
def invert_sign(num: float | str) -> float | str:
    """Change sign of number or add/remove leading sign of str."""
    if isinstance(num, (float, int)):
        return -1 * num
    elif isinstance(num, str):
        if num.startswith('-'):
            return num[1:]
        return '-{0}'.format(num)
    raise ValueError(
        'Num needs to be numeric value or string, not ' + '{0}.'.format(num),
    )

parse_axes(*args, ax)

Extract axes from ax, args or returns args and current axes.

Source code in src/prettypyplot/tools.py 
58
59
60
61
62
63
64
65
66
67
68
def parse_axes(*args, ax: Axes | None) -> tuple[tuple, Axes]:
    """Extract axes from ax, args or returns args and current axes."""
    axes = [arg for arg in args if isinstance(arg, mpl.axes.Axes)]
    if axes:
        if isinstance(ax, mpl.axes.Axes) or len(axes) > 1:
            raise ValueError('Multiple axes provided')
        ax = axes[0]
        args = tuple(arg for arg in args if not isinstance(arg, mpl.axes.Axes))
    else:
        ax = gca(ax)
    return args, ax

gca(ax)

Return ax if it is axes instance, else the current active axes.

Source code in src/prettypyplot/tools.py 
71
72
73
74
75
def gca(ax: Axes | None) -> Axes:
    """Return ax if it is axes instance, else the current active axes."""
    if isinstance(ax, mpl.axes.Axes):
        return ax
    return plt.gca()

get_axes(axs)

Return axs if it is all axes instances, else the all current axes.

Source code in src/prettypyplot/tools.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def get_axes(
    axs: Axes | Sequence[Axes] | np.ndarray | None,
) -> list[Axes] | np.ndarray:
    """Return axs if it is all axes instances, else the all current axes."""
    if axs is None:
        return plt.gcf().get_axes()

    axs = np.ravel(axs)
    if not all((isinstance(arg, mpl.axes.Axes) for arg in axs)):
        raise TypeError(
            'If `axs` is given, it needs to be of type matplotlib.axes.Axes.'
            + ' or list of',
        )
    return axs

is_discrete_cmap(cmap)

Return if cmap is discrete or continuos.

Source code in src/prettypyplot/tools.py 
94
95
96
def is_discrete_cmap(cmap: str) -> bool:
    """Return if cmap is discrete or continuos."""
    return plt.get_cmap(cmap).N < 256