File: api.rst

package info (click to toggle)
fpyutils 4.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 268 kB
  • sloc: python: 757; makefile: 92
file content (29 lines) | stat: -rw-r--r-- 911 bytes parent folder | download
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
Developer Interface
===================

.. module:: fpyutils

Main Interface
--------------

Examples for the most relevant api functions can be viewed in the test
file. fpyutils's API uses `type hints`_ instead of assertions to check
input and output types.

.. _type hints: https://docs.python.org/3/library/typing.html

.. autofunction:: fpyutils.filelines.get_line_matches
.. autofunction:: fpyutils.filelines.insert_string_at_line
.. autofunction:: fpyutils.filelines.remove_line_interval
.. autofunction:: fpyutils.shell.execute_command_live_output
.. autofunction:: fpyutils.path.add_trailing_slash
.. autofunction:: fpyutils.path.gen_pseudorandom_path
.. autofunction:: fpyutils.notify.send_email
.. autofunction:: fpyutils.notify.send_gotify_message


Exceptions
----------

.. autoexception:: fpyutils.exceptions.LineOutOfFileBoundsError
.. autoexception:: fpyutils.exceptions.NegativeLineRangeError