astar-utils 0.6.0

Contains commonly-used utilities for AstarVienna's projects.

Astar Utils

This package is devloped and maintained by Astar Vienna and contains commonly-used utilities for the group's projects to avoid both duplicating code and circular dependencies.

Contents

The package currently contains the following public functions and classes:

• NestedMapping: a dict-like structure supporting !-style nested keys.
• RecursiveNestedMapping: a subclass of NestedMapping also supporting keys that reference other !-style keys.
• NestedChainMap: a subclass of collections.ChainMap supporting instances of RecursiveNestedMapping as levels and referencing !-style keys across chain map levels.
• is_bangkey(): simple convenience function to check if something is a !-style key.
• is_nested_mapping(): convenience function to check if something is a mapping containing a least one other mapping as a value.
• UniqueList: a list-like structure with no duplicate elements and some convenient methods.
• Badge and subclasses: a family of custom markdown report badges. See docstring for details.
• BadgeReport: context manager for collection and generation of report badges. See docstring for details and usage.
• get_logger(): convenience function to get (or create) a logger with given name as a child of the universal astar logger.
• get_astar_logger(): convenience function to get (or create) a logger with the name astar, which serves as the root for all A*V packages and applications.
• SpectralType: a class to parse, store and compare spectral type designations.
• iter_read_cache_dirs(), find_cached_file() and get_write_cache_dir(): convenience functions to get the cache path for a A*V package, checking ScopeSim_Data first.

Loggers module

• loggers.ColoredFormatter: a subclass of logging.Formatter to produce colored logging messages for console output.

Dependencies

Dependencies are intentionally kept to a minimum for simplicity. Current dependencies are:

• more-itertools
• pyyaml

Version requirement for these dependencies can be found in the pyproject.toml file.