[issue24693] zipfile: change RuntimeError to more appropriate exception type

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Changed cases 3, 4, 5, 7, and 8.

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24693] zipfile: change RuntimeError to more appropriate exception type

[Roundup Robot]

Roundup Robot added the comment:

New changeset 22112359abcf by Serhiy Storchaka in branch 'default':
Issue #24693: Changed some RuntimeError's in the zipfile module to more
https://hg.python.org/cpython/rev/22112359abcf

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24693] zipfile: change RuntimeError to more appropriate exception type

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Updated patch includes changed tests and the documentation. It includes changes 
for new exceptions added in issue26039. Perhaps not all changes should be 
accepted, but I have included them for demonstrating.

RuntimeError was used in following cases:

1. Compressed or uncompressed file size unexpectedly exceeded 32-bit limit. I 
think this should left RuntimeError.

2. Compression requires the (missing) zlib/bz2/lzma module. I think this should 
left RuntimeError.

3. Unsupported compression method. This can be changed to more specific 
NotImplementedError without breaking compatibility.

4. Corrupted extra field. BadZipFile is more appropriate exception. Not 
documented.

5. Invalid mode for ZipFile() or ZipFile.open(). ValueError is more appropriate 
exception, this is programming error. Not documented.

6. File not ending with ".py" for PyZipFile.writepy(). ValueError looks more 
appropriate exception, but RuntimeError is documented.

7. Write in reading mode, use after closing. ValueError or 
io.UnsupportedOperation would be more consistent with files, but RuntimeError 
can be also used in similar cases. RuntimeError is explicitly documented (maybe 
because it is not typical exception for such cases). Unfortunately there is no 
special exception type for using an object in wrong state.

8. Read, write or close when there is other open writing handler. These are new 
exceptions and we are free to change them. There are arguments for using 
ValueError and RuntimeError in similar cases.

9. Absent or incorrect password for encrypted file. If file encryption is 
expected, this is programming error and can be ValueError, but if it is not 
expected, it should be RuntimeError.

I'm going to push changes for cases 3 and 4, this looks safe. Cases 5 and 6 are 
more discussable. There are reasons for RuntimeError in cases 7, 8 and 9. And I 
think RuntimeError is appropriate in cases 1 and 2.

--
Added file: http://bugs.python.org/file42853/zipfile_exceptions2.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24693] zipfile: change RuntimeError to more appropriate exception type

[Martin Panter]

Martin Panter added the comment:

I have hardly used the zipfile module, but here are my thoughts on some of the 
exceptions anyway :)

Some of these exceptions are documented, so the documentation would need 
updating.

BadZipFile for corrupted field seems reasonable.

The purpose of RuntimeError is not clearly documented, but I have the feeling 
it gets used mainly for programmer errors, rather than errors caused by 
external data. So I tend to agree a couple of the changes away from 
RuntimeError, such as the invalid password case.

For programmer errors, I doubt the exception type matters much for 
compatibility. RuntimeError seems fine to me, but I accept that ValueError is 
more consistent with open(..., mode="invalid"), operations on closed files, etc.

--
nosy: +martin.panter

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24693] zipfile: change RuntimeError to more appropriate exception type

[Serhiy Storchaka]

New submission from Serhiy Storchaka:

RuntimeError is raised in the zipfile module in many cases where more 
appropriate exception type is expected. Proposed patch changes a number of 
RuntimeErrors to one of BadZipFile, NotImplementedError, or ValueError. Only 
changing to NotImplementedError is backward compatible (NotImplementedError is 
subclass of RuntimeError), other changes are not.

--
components: Library (Lib)
files: zipfile_exceptions.patch
keywords: patch
messages: 247189
nosy: alanmcintyre, ned.deily, ronaldoussoren, serhiy.storchaka, twouters
priority: normal
severity: normal
stage: patch review
status: open
title: zipfile: change RuntimeError to more appropriate exception type
type: enhancement
versions: Python 3.6
Added file: http://bugs.python.org/file39994/zipfile_exceptions.patch

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24693
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com