How to declare a module deprecated in python

Question

How to declare a module deprecated in python?

I want a warning to be printed whenever a particular module is imported or any of its functions are called.

Add print "Deprecated" to __init__ or add a decorator that does the same. — ForceBru
– ForceBru, Commented May 7, 2015 at 6:32
@ForceBru: How are you going to add a decorator to a module? And where are you going to find its __init__ method? — abarnert
– abarnert, Commented May 7, 2015 at 6:39

abarnert · Accepted Answer · 2015-05-07 06:36:46Z

36

You want to warn with a DeprecationWarning.

Exactly how you call it doesn't matter that much, but the stdlib has a standard pattern for deprecated modules, like this:

# doc string, top-level comments, imports, __all__ =

import warnings
warnings.warn("the spam module is deprecated", DeprecationWarning,
              stacklevel=2)

# normal module code

See the 2.7 sets source for an example.

answered May 7, 2015 at 6:36

abarnert

368k54 gold badges626 silver badges691 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

driven_spider Over a year ago

I have used this piece of code in my init.py of a specific module on which I want to display as deprecated. Its not working, neither its erring out. the function and class of that module can be easily accessible.

chepner Over a year ago

Deprecation does not make something stop working. It gives you advance warning that it will stop working in a future version.

Stefano · Accepted Answer · 2024-10-18 16:14:50Z

-1

Were you not happy with warnings.warn, to print to your console, you could follow this solution, which uses the logging module for Python.

However, in my experience, you need to add a logging.basicConfig() command before your logging.warning function call, so I'd suggest something like:

import logging
logging.basicConfig()
logging.warning(msg="this is a warning")

answered Oct 18, 2024 at 16:14

Stefano

831 gold badge4 silver badges10 bronze badges

1 Comment

chepner Over a year ago

Why do you think someone would be unhappy with warnings, but find this acceptable? Don't use basicConfig in a module; configuration is for the script that uses your module.

Collectives™ on Stack Overflow

How to declare a module deprecated in python

2 Answers 2

2 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related