Utilities (sunpy.util
)#
sunpy.util Package#
Functions#
|
A decorator to cache the value of a property based on the output of a different class attribute. |
A decorator to check if an arithmetic operation can be performed between a map instance and some other operation. |
|
|
Decorator for methods that issues warnings for positional arguments. |
|
Used to mark a function or class as deprecated. |
|
Deprecate a _renamed_ or _removed_ function argument. |
|
Makes sure that a list of dictionaries all have the same keys. |
|
Expand a list of lists or tuples. |
|
List installed and missing dependencies. |
|
Returns a new documentation string such that there are notes section duplication in in |
|
Returns a set of keyword names from |
|
Returns a set of keyword names that can be handled by an object's |
Gets the width of the current terminal. |
|
|
Returns the SHA-256 hash of a file. |
|
Get all the specified extras for a package and report any missing dependencies. |
|
Return a replacement path if input path is currently in use. |
|
A decorator that tracks the entry and exit of a context manager, setting the key's value to True on entry and False on exit. |
Prints ones' system info in an "attractive" fashion. |
|
|
Return only unique elements of a sequence. |
|
Raise a |
|
Raise a |
|
Raise a |
|
Raise a |
Classes#
|
A class to hold metadata associated with a |
An error raised when a file is opened and no maps are found. |
|
A warning class to indicate a connection warning. |
|
A warning class to indicate a deprecated feature. |
|
Warning class for cases metadata is missing. |
|
A warning class to indicate a soon-to-be deprecated feature. |
|
The primary warning class for Sunpy. |
|
The base warning class from which all Sunpy warnings should inherit. |
|
|
A function decorator that will append and/or prepend an addendum to the docstring of the target function. |
Class Inheritance Diagram#
sunpy.util.config Module#
This module provides SunPy’s configuration file functionality.
Functions#
Read the "sunpyrc" configuration file. |
|
|
Copies the default sunpy config file to the user's config directory. |
Print current configuration options. |
sunpy.util.datatype_factory_base Module#
This module provides the base registration factory used for all SunPy data/net factories.
Classes#
|
Generalized registerable factory type. |
Exception for when no candidate class is found. |
|
Exception for when too many candidate classes are found. |
|
Exception for when no candidate class is found. |
Class Inheritance Diagram#
sunpy.util.net Module#
This module provides general net utility functions.
Functions#
|
Parse a Content-type like header. |
|
Slugify given unicode text. |
|
Get the content disposition filename from given header. |
|
Get filename from given |
|
Get filename from given |
|
Download a file from a url into a directory. |
|
Download a file from a url into a directory. |
sunpy.util.xml Module#
This module provides XML helper functions.
Functions#
|
Converts an XML string to a Python dictionary. |
|
Scans through the children of the node and makes a dictionary from the content. |
|
Scans through all children of |
Classes#
Class Inheritance Diagram#
sunpy.util.sphinx Package#
Helpers and extensions for sphinx.
This subpackage contains two sphinx directives:
.. generate::
which includes raw output generated by a Python script into a.. raw::
block. This can be used to for example, include HTML output into the built docs... changelog::
which renders the latest changelog with towncrier and includes it in the documentation.
To use them add 'sunpy.util.sphinx.generate'
and
'sunpy.util.sphinx.changelog'
to the extensions
list in your conf.py
file.
sunpy.util.sphinx.generate Module#
Classes#
|
Custom directive to include raw output generated using supplied Python code |
Class Inheritance Diagram#
sunpy.util.functools Module#
This file defines wrappers and variants of things in the functools standard lib.
Functions#
|
A variant of |