utilities.admin module

Collection of tools that are useful for repo administration such as:

• deprecation warnings

• renames / backwards compatibility

• etc

utilities.admin.add_copyright(authors: List[str], start_year: int, end_year: Optional[int] = None)

Add copyright stub to module under __copyright__ attribute

Args:

authors:

List[str], list of author names

start_year:

int, starting year

end_year:

int, default None, ending year. If not specified uses current year

Returns:

None

utilities.admin.deprecated(reason: Optional[str] = None)

Deprecation decorator factory, can be used to decorate a class or function

Args:

reason:

str, string to display as part of deprecation warning

Returns:

Function, the decorator