maintenance.py: Utilities for Maintenance

Usage

todo(fn: Optional[Callable[P, R]] = None) -> Callable[P, NoReturn] | NoReturn

deprecated(
    message: Optional[str] = None,
    *,
    since: Optional[str] = None,
    new: Any = None,
    add_sphinx_directive: bool = False
) -> Callable[[Callable[P, R]], Callable[P, R]]

Parameters

message

Overrides the default warn message.

since

The version since when the object is deprecated.

new

The new object that replaces the deprecated one. This may be the object itself or its name as a string.

add_sphinx_directive

Adds the deprecated directive to the beginning of the docstring of the object.

Examples

def new():
    return 1

@deprecated(since="1.2.3.post4", new=new)
def old():
    return None

unstable(
    message: Optional[str] = None,
    *,
    until: Optional[str] = None
) -> Callable[[Callable[P, R]], Callable[P, R]]

Metadata

Release files for maintenance.py 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for maintenance.py 0.2.0
File	Size	Uploaded
maintenance.py-0.2.0.tar.gz	4.8 kB	Mar 4, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for maintenance.py 0.2.0
File	Interpreter	ABI	Platform	Reset
maintenance.py-0.2.0-py3-none-any.whl 3.8 kB Mar 4, 2023	Python 3	none	any	Details

Total release size: 8.6 kB

Release files / maintenance.py-0.2.0.tar.gz

Download URL	maintenance.py-0.2.0.tar.gz
Size	4.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`55961fe023a972e9fbf3bd61ab8c21334db1d6ea06717902c9d3bddeec5ecbb3`
BLAKE2b-256 checksum How to use checksums	`fb4dc7dfb777385969c7ce7513e82a91df6096d0f760fad38c4797d686c7eaac`
Upload date	Mar 4, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.10.6`

Release files / maintenance.py-0.2.0-py3-none-any.whl

Download URL	maintenance.py-0.2.0-py3-none-any.whl
Size	3.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2084dcf088c53fa61adb1d24b4ddb038fa2df030b81a9c19a1492ae1926fa1b7`
BLAKE2b-256 checksum How to use checksums	`5abd391825346976f7f3e1f62db95ac2fb0bdb833db591e112a34147904649b9`
Upload date	Mar 4, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.10.6`