obspy.core.util.base

Base utilities and constants for ObsPy.

copyright:

The ObsPy Development Team (devs@obspy.org)

license:

GNU Lesser General Public License, Version 3 (https://www.gnu.org/copyleft/lesser.html)

Public Functions

create_empty_data_chunk	Creates an NumPy array depending on the given data type and fill value.
download_to_file	Helper function to download a potentially large file.
get_bytes_stream	Return a file-like object streaming bytes data (bytes objects)
get_dependency_version	Get version information of a dependency package.
get_example_file	Function to find the absolute path of a data file
get_script_dir_name	Get the directory of the current script file.
get_text_stream	Return a file-like object streaming text data (str objects)
make_format_plugin_table	Returns a markdown formatted table with read waveform plugins to insert in docstrings.
open_bytes_stream	Context manager to read bytes data stream from the argument, e.g.: with open_bytes_stream(file_or_stream)
open_text_stream	Context manager releasing a text data stream from the argument, e.g.: with open_text_stream(file_or_stream)
sanitize_filename	Adapted from Django's slugify functions.

Private Functions

Warning

Private functions are mainly for internal/developer use and their API might change without notice.

_add_format_plugin_table	A function to populate the docstring of func with its plugin table.
_generic_reader
_get_deprecated_argument_action	Specifies deprecated command-line arguments to scripts
_get_entry_points	Gets a dictionary of all available plug-ins of a group or subgroup.
_get_function_from_entry_point	A "automagic" function searching a given dict of entry points for a valid entry point and returns the function call.
_get_ordered_entry_points	Gets a ordered dictionary of all available plug-ins of a group or subgroup.
_read_from_plugin	Reads a single file from a plug-in's readFormat function.

Classes

CatchAndAssertWarnings
ComparingObject	Simple base class that implements == and != based on self.__dict__
NamedTemporaryFile	Weak replacement for the Python's tempfile.TemporaryFile.