Misleading __version__ attribute of modules in standard library

@warsaw

BPO	31826
Nosy	@warsaw, @rhettinger, @ncoghlan, @pitrou, @merwok, @encukou, @serhiy-storchaka, @abukaj, @cryvate
PRs	bpo-31826: remove unused __version__ from mock.py #17977

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2017-10-20.13:21:04.010>
labels = ['3.7', 'type-bug', 'library']
title = 'Misleading __version__ attribute of modules in standard library'
updated_at = <Date 2020-02-04.10:54:36.743>
user = 'https://github.com/abukaj'

bugs.python.org fields:

activity = <Date 2020-02-04.10:54:36.743>
actor = 'cryvate'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2017-10-20.13:21:04.010>
creator = 'abukaj'
dependencies = []
files = []
hgrepos = []
issue_num = 31826
keywords = ['patch']
message_count = 7.0
messages = ['304654', '304763', '304765', '304779', '304780', '304823', '361340']
nosy_count = 9.0
nosy_names = ['barry', 'rhettinger', 'ncoghlan', 'pitrou', 'eric.araujo', 'petr.viktorin', 'serhiy.storchaka', 'abukaj', 'cryvate']
pr_nums = ['17977']
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue31826'
versions = ['Python 3.7']

Linked PRs

Several modules of the standard library (at least re and csv) have __version__ strings.

The string is the same for Python 2.7-3.6:

    >>> import re, csv; print(re.__version__, csv.__version__)
    2.2.1 1.0

while documentation indicates changes in the modules.

Semantic versioning (recommended by PEP-440) suggests that at least minor version should change in such case.

I suspect it to be a "code fossil" which may be removed according to PEP-396.

I would support just removing the version attributes for csv and re.

+1 for removing __version__ on all stdlib modules which are not externally maintained.

+1 from me for dropping these, and noting which modules were affected in the Porting section of the 3.7 What's New (I'd be surprised if anyone was depending on them existing, but it doesn't hurt to mention it, and may help if someone is trying to figure out what changed)

Please do leave version in the decimal module where it has a precise meaning, tracking a particular version of the spec that was implemented and tested.

The version in distutils is derived from sys.version and should be left as is too. Thanks!

PR for removing __version__ from mock: #17977

@encukou

@encukou The issue seems to have been resolved. Can we close the issue?

There are still a lot of modules with __version__
IMO, to resolve it properly:

There should be a test, similar to test___all__, to avoid regressions
For modules where __version__ has a meaning, that fact should be documented -- either we want users to use it, or there's no point exposing it

Note that nowadays, the proper way to remove an attribute is with a deprecation period using module __getattr__.

I just migrated __version__ from _csv.c to csv.py. I was unaware of this discussion. I'm happy to remove it altogether. Can someone explain to me how this trend came about? I was a bit surprised to see it at all w.r.t. the csv module.

Note that nowadays, the proper way to remove an attribute is with a deprecation period using module __getattr__.

Related issue:

Deprecate sqlite3.version and sqlite3.version_info #93370

pythongh-76007: remove curses.__version__ doc (python#141052)

gh-76007: Deprecate `__version__` attribute in `http.server` (#142658)

gh-76007: `pydoc`: Catch `DeprecationWarning` for stdlib module `__ve…

I think we're done with __version__ once #142675 and #142679 are merged, or are there any more to do?

There's also a VERSION and a couple of versions we could deprecate:

cpython/Lib/xml/etree/ElementTree.py

Line 93 in 04da416

VERSION = "1.3.0"

cpython/Lib/xml/sax/expatreader.py

Line 6 in 04da416

version = "0.20"

cpython/Lib/xml/sax/handler.py

Line 12 in 04da416

version = '2.0beta'

Thoughts?

gh-76007: Deprecate `__version__` attribute in `ctypes` (#142679)

pythongh-76007: `pydoc`: Catch `DeprecationWarning` for stdlib module…

pythongh-76007: Deprecate `__version__` attribute in `ctypes` (python…

gh-76007: Deprecate `__version__` attribute in `wsgiref.simple_server` (

There's also a VERSION and a couple of versions we could deprecate:

PR #142898 for that, to close this issue.

gh-76007: Deprecate `VERSION` in `xml.etree.ElementTree` & `version` …

pythongh-76007: Deprecate `VERSION` in `xml.etree.ElementTree` & `ver…

gh-76007: Deprecate `tarfile.version` (#145326)

pythongh-76007: Deprecate `tarfile.version` (python#145326)

Navigation Menu

Repository navigation

Misleading version attribute of modules in standard library #76007

Linked PRs

35 remaining items

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Misleading __version__ attribute of modules in standard library #76007

Description

Linked PRs

Activity

abukaj commented on Oct 20, 2017

rhettinger commented on Oct 22, 2017

pitrou commented on Oct 22, 2017

ncoghlan commented on Oct 23, 2017

rhettinger commented on Oct 23, 2017

merwok commented on Oct 23, 2017

encukou commented on Feb 4, 2020

furkanonder commented on May 13, 2023

encukou commented on May 15, 2023

smontanaro commented on Jan 17, 2024

erlend-aasland commented on Jan 17, 2024

35 remaining items

hugovk commented on Dec 14, 2025

hugovk commented on Dec 17, 2025

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

Misleading version attribute of modules in standard library #76007