haggis

haggis

This is a library of general purpose utility functions and classes written in Python. Much of this code is intended to support the imprint project https://gitlab.com/madphysicist/imprint. The modules of this library are more-or-less standalone utilities, organized by category.

This library contains plenty of code that relies on external programs and less common Python libraries. The code is considered to be "extras", in the setuptools sense. Extras can be omitted without any modification to the python code. The following extras are supported:

• [docx]: Support for docx file utilities requires python-docx to be installed.
• [latex]: Supporting LaTeX requires a host of external programs to work properly, so this feature is optional. See the dependency page in the main documentation for more information.
• [pdf]: Requires the poppler library to be installed.
• [ps]: Requires GhostScript to be installed.
• [plot]: Plotting tools require matplotlib, which is a heavy dependency, and unnecessary for many purposes.
• [qt]: Some optional utilities for pyqt6 are provided if it is installed. Since this a heavy dependency, they are quite optional.
• [term]: Terminal colors work out of the box on Linux, but require the colorama library to work on Windows.
• [scio]: Science I/O depends on the scipy and astropy libraries to deliver IDL and FITS file support, respectively.
• [xlsx]: Support for xlsx file utilities requires openpyxl to be installed.

To install extras such as latex and pdf, do:

pip install haggis[latex,pdf]

See the documentation at https://haggis.readthedocs.io/en/latest for more information, including the API documentation.

This library is licensed under the AGPLv3, and compatible with later versions. You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Changelog

0.14.1 (2024-10-17)

• Fixes:
  • configuration.JSONConfiguration outputs newlines at end of file
  • Improved formatting of multi-line configuration.NumpyObject

0.14.0 (2024-07-15)

• New class:
  • args.StoreVariableNargs
• API change:
  • recipes.islast has a new attribute, last, containing the latest element
  • string_util.format_list accepts last_sep to allow for more natural output
  • string_util.format_list indent defaults to zero
• New unit tests:
  • tests.string_util.TestFormatList
  • tests.test_recipes.TestIsLast
  • tests.test_args.TestStoreVariableNargs
• Bugfixes:
  • Missing raw-string identifiers in tests.string_util.TestParseList
  • string_util.format_list checks for invalid width

0.13.3 (2024-07-15)

• New functions:
  • os.redirect_stderr
  • os.redirect_stdout
  • os.redirect_stream
  • os.suppress_stderr
  • os.suppress_stdout
• Bugfix:
  • logs.ReturnableStreamHandler clears the previous line when it gets a line after a carriage return.

0.13.2 (2024-07-12)

• New class:
  • logs.ReturnableStreamHandler
• API changes:
  • New attribute logs.RETURNABLE == "returnable"
  • New keyword values in logs.configure_logger:
    • log_stderr accepts string RETURNABLE to use ReturnableStreamHandler when logging
    • log_stdout accepts string RETURNABLE to use ReturnableStreamHandler when logging

0.13.1 (2024-07-11)

• Bugfix:
  • Extra newlines printed in configuraition.JSONConfiguration._pprint
• Nominal Qt5 support in gui.qt

0.13.0 (2024-04-29)

• New modules and packages:
  • gui package
  • gui.qt
• New classes:
  • gui.qt.ImageAspectLabel

0.12.1 (2024-06-24)

• Bufixes:
  • islast does not crash on empty iterators
• Typo fixes in documentation

0.12.0 (2023-08-29)

• New functions and classes:
  • string_util.parse_list
  • string_util.parse_pair
  • string_util.func_name
• New unit tests:
  • tests.test_string_util.TestParsePair
  • tests.test_string_util.TestParseList

0.11.0 (2023-08-29)

• Bugfixes:
  • Setting correct stacklevel in logs.add_logging_level
  • Fixes to documentation of properties in recipes.RangeBuilder and time.Stopwatch
  • Counting tabs in prefix rather than entire string in args.SmartHelpFormatter
• API changes:
  • New keywords in string_util.horiz_cat and string_util.split_horiz_cat.
    • titles: optional headings included with each column
    • headers: string or string generator to insert after the title
    • width: minimum width to allow for each column
    • hsep: header separator, similar to sep, which it defaults to
    • Dropped missing='missing' option since it truncated anyway
  • Renamed recipes.shift_left to recipes.shift_up
• New unit tests:
  • tests.test_string_util
• Added pytest-cov to required test dependencies

0.10.1 (2023-08-21)

• Fixes to test and documentation warnings

0.10.0 (2023-08-20)

• New modules:
  • args
• New functions and classes:
  • args.SmartHelpFormatter
• New unit tests:
  • tests.test_args

0.9.2 (2023-08-20)

• Switched to trunk-based development

0.9.1 (2023-03-26)

• Migrated to GitLab hosting

0.9.0 (2023-03-15)

• New functions and classes:
  • logs.add_detail_level
• Bugfixes:
  • Added missing default kwargs to monkeypatched version of logging.LogAdapter method in logs.add_log_level
  • Updated bondary handling in npy_util.prune_mask
• logs.add_logging_level verifies exception info settings if prior calls are found

0.8.0 (2022-11-04)

• New functions and classes:
  • recipes.chained_getter
• New unit tests:
  • tests.test_logs.TestAddLoggingLevel
  • tests.test_logs.TestResetHandlers
  • tests.test_logs.TestLogMaxFilter
  • tests.test_logs.TestMetaLoggableType
  • tests.test_recipes.TestChainedGetter
• Bugfixes:
  • Fixed sense of inclusive in logs.LogMaxFilter
• logs.add_logging_level updates logging.LoggerAdapter

0.7.1 (2022-10-24)

• New functions and classes:
  • npy_util.prune_mask

0.7.0 (2022-10-17)

• New functions and classes:
  • npy_util.masked_index
  • npy_util.unmasked_index
  • npy_util.find_peaks
• New unit tests:
  • tests.test_npy_util.TestMaskedIndex
  • tests.test_npy_util.TestUnmaskedIndex
  • tests.test_npy_util.TestFindPeaks

0.6.0 (2022-10-11)

• API changes:
  • Parameter stop in recipes.RangeBuilder.update is now optional
  • Property span in recipes.RangeBuilder
• Bugfixes:
  • Fixed handling of bulleted list styles in files.docx.list_number

0.5.0 (2022-06-17)

• New functions and classes:
  • multiline_repr in string_util
  • RangeBuilder in recipes

0.4.0 (2022-06-02)

• New functions and classes:
  • npy_util.replace_field
• New unit tests:
  • tests.test_npy_util.TestReplaceField

0.3.0 (2022-03-29)

• New functions and classes:
  • load.load_module no longer nested in load.module_as_dict
  • npy_util.iterate_dtype
• Bugfixes:
  • files.PreOpenedFile object is now properly iterable
• New unit tests:
  • tests.test_load.TestLoadModule
  • tests.test_load.TestModuleAsDict

0.2.0 (2022-01-27)

• New modules:
  • npy_util
  • tests.test_numbers
  • tests.test_objects
• New functions and classes:
  • getsizeof, size_type_mapping in objects
  • ndarray_handler added to size_type_mapping in objects
  • isolate_dtype in npy_util
  • as_base, digit_count in numbers
• New unit tests:
  • tests.test_objects.TestGetsizeof
  • tests.test_numbers.TestAsBase
  • tests.test_numbers.TestDigitCount
• Added docs to sdist
• Moved map_array, mask2runs, runs2mask from math to npy_util

0.1.1 (2022-01-16)

Minor updates to first release.

• New functions and classes:
  • segment_distance in math
• Bugfixes:
  • math.read_divide correctly handles scalar inputs
• Created pytest configuration, added first set of unit tests
  • files.tests.test_csv
  • tests.test_math.TestSegmentDistance
• Improved documentation with autosummary
• Added this CHANGELOG to installed data

0.1 (2022-01-10)

First release.

• New modules
  • time
  • files.ui
• New functions and classes:
  • json_registry made public in configuration
  • semilogx_base, semilogy_base, loglog_base in mpl_util
  • map_array, rms in math
  • split_extension in files
• API changes:
  • string_util.timestamp moved to time
  • Added mask2runs and runs2mask to math
  • Improvements to NumpyObject in configuration
  • Improvements to copy_func in objects
  • Added n argument to insert_suffix in files
• Bufixes:
  • mpl_util.show_extents axis confusion
  • Broken imports in submodules
• Officially supporting Python versions up to 3.10
• README -> README.md so GitHub can pick it up

0.1a2 (2021-01-09)

Second alpha release.

• Major additions to API
• New modules:
  • threads
  • configuration
  • structures
  • mapping
  • ctypes_util
• New functions and classes:
  • CloseableMixin in recipes
  • to_hex, camel2snake, snake2camel, timestamp in string_util
  • set_labels in mpl_utils
  • real_divide, threshold, ang_diff_* in math
• API changes:
  • Moved half of recipes to mapping
  • Updated Namespace, (in mapping), added setdefaults

0.1a1 (2021-04-03)

First alpha release.

• API changes:
  • SentinelType made public in root package
  • ensure_extension.modes renamed to ensure_exntension.policies in files

0.1a1.dev2 (2019-03-31)

Second development pre-release.

• Major overhaul of documentation

0.1a1.dev1 (2019-03-20)

First development pre-release.

• First release on PyPI.
• Created Read the Docs pages.
• Only code required for imprint present initially.
• Documentation 90% complete.
• No tests worth speaking of.