Nano-Utils

Utility functions used throughout the various nlesc-nano repositories.

Installation

• PyPi: pip install Nano-Utils

• GitHub: pip install git+https://github.com/nlesc-nano/Nano-Utils@master

API

• nanoutils.utils
  • Index
  • API
    • PartialPrepend
    • SetAttr
      • SetAttr.obj
      • SetAttr.name
      • SetAttr.value
      • SetAttr.attr
    • VersionInfo
      • VersionInfo.major
      • VersionInfo.minor
      • VersionInfo.micro
      • VersionInfo.patch
      • VersionInfo.maintenance
      • VersionInfo.bug
      • VersionInfo.from_str()
    • group_by_values()
    • get_importable()
    • construct_api_doc()
    • split_dict()
    • get_func_name()
    • set_docstring()
    • raise_if()
    • ignore_if()
    • SequenceView
      • SequenceView.pprint_kwargs
      • SequenceView.index()
      • SequenceView.count()
    • CatchErrors
      • CatchErrors.exceptions
      • CatchErrors.caught_exceptions
      • CatchErrors.clear()
    • LazyImporter
      • LazyImporter.module
      • LazyImporter.imports
      • LazyImporter.from_name()
    • MutableLazyImporter
      • MutableLazyImporter.imports
    • positional_only()
    • UserMapping
      • UserMapping.copy()
      • UserMapping.keys()
      • UserMapping.items()
      • UserMapping.values()
      • UserMapping.get()
      • UserMapping.fromkeys()
    • MutableUserMapping
      • MutableUserMapping.clear()
      • MutableUserMapping.popitem()
      • MutableUserMapping.pop()
      • MutableUserMapping.update()
    • warning_filter()
• nanoutils.empty
  • Index
  • API
    • EMPTY_CONTAINER
    • EMPTY_COLLECTION
    • EMPTY_SET
    • EMPTY_SEQUENCE
    • EMPTY_MAPPING
• nanoutils.schema
  • Index
  • API
    • Default
      • Default.value
      • Default.call
      • Default.validate()
    • Formatter
      • Formatter.format()
    • supports_float()
    • supports_int()
    • isinstance_factory()
    • issubclass_factory()
    • import_factory()
• nanoutils.typing_utils
  • Index
  • API
    • PathType
• nanoutils.numpy_utils
  • Index
  • API
    • as_nd_array()
    • array_combinations()
    • fill_diagonal_blocks()
    • DTypeMapping
      • DTypeMapping.dtype
      • DTypeMapping.from_type()
      • DTypeMapping.fromkeys()
    • MutableDTypeMapping
      • MutableDTypeMapping.dtype
      • MutableDTypeMapping.update()
• nanoutils.file_container
  • Index
  • API
    • file_to_context()
    • AbstractFileContainer
      • AbstractFileContainer.read()
      • AbstractFileContainer._read()
      • AbstractFileContainer._read_postprocess()
      • AbstractFileContainer.write()
      • AbstractFileContainer._write()
• nanoutils.testing_utils
  • Index
  • API
    • FileNotFoundWarning
    • delete_finally()
• nanoutils.hdf5_utils
  • Index
  • API
    • RecursiveKeysView
    • RecursiveValuesView
    • RecursiveItemsView
• nanoutils.yaml_utils
  • Index
  • API
    • UniqueLoader