diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-24 17:30:34 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-24 17:30:34 -0500 |
| commit | d25fd7146131688e934290a3c5bf0407e904dbb2 (patch) | |
| tree | 5fd4b905157eafbf3ea0071bfd625763b109ee78 /docs/api/utils.rst | |
| parent | fea1bc15f4a53aa72d16c2985377fe3987b6b348 (diff) | |
| parent | 803f71a04d7f7290ca1390a164808679f5943178 (diff) | |
| download | cmd2-git-d25fd7146131688e934290a3c5bf0407e904dbb2.tar.gz | |
Merge pull request #899 from python-cmd2/api_docs
API documentation
Diffstat (limited to 'docs/api/utils.rst')
| -rw-r--r-- | docs/api/utils.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/api/utils.rst b/docs/api/utils.rst new file mode 100644 index 00000000..2ae5987b --- /dev/null +++ b/docs/api/utils.rst @@ -0,0 +1,78 @@ +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.remove_duplicates + +.. autofunction:: cmd2.utils.alphabetical_sort + +.. autofunction:: cmd2.utils.natural_sort + +.. autofunction:: cmd2.utils.basic_complete + + +Text Alignment +-------------- + +.. autoclass:: cmd2.utils.TextAlignment + :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 |