summaryrefslogtreecommitdiff
path: root/docs/api/utils.rst
blob: d9166401e2bf7d4efb5b8dc66999008a55a05da5 (plain)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
cmd2.utils
==========


Settings
--------

.. autoclass:: cmd2.utils.Settable
    :members:

    .. automethod:: __init__


Quote Handling
--------------

.. autofunction:: cmd2.utils.is_quoted

.. autofunction:: cmd2.utils.quote_string

.. autofunction:: cmd2.utils.quote_string_if_needed

.. autofunction:: cmd2.utils.strip_quotes


IO Handling
-----------

.. autoclass:: cmd2.utils.StdSim
    :members:

.. autoclass:: cmd2.utils.ByteBuf
    :members:

.. autoclass:: cmd2.utils.ProcReader
    :members:


Tab Completion
--------------

.. autoclass:: cmd2.utils.CompletionError
    :members:

.. autofunction:: cmd2.utils.basic_complete


Text Alignment
--------------

.. autoclass:: cmd2.utils.TextAlignment
    :members:
    :undoc-members:

.. autofunction:: cmd2.utils.align_text

.. autofunction:: cmd2.utils.align_left

.. autofunction:: cmd2.utils.align_right

.. autofunction:: cmd2.utils.align_center

.. autofunction:: cmd2.utils.truncate_line


Miscellaneous
-------------

.. autofunction:: cmd2.utils.str_to_bool

.. autofunction:: cmd2.utils.namedtuple_with_defaults

.. autofunction:: cmd2.utils.categorize

.. autofunction:: cmd2.utils.remove_duplicates

.. autofunction:: cmd2.utils.alphabetical_sort

.. autofunction:: cmd2.utils.natural_sort