Skip to content

gh-58032: Deprecate the argparse.FileType type converter #124664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
serhiy-storchaka merged 9 commits into from
Oct 23, 2024
Merged

gh-58032: Deprecate the argparse.FileType type converter #124664

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8527cfa
gh-58032: Deprecate the argparse.FileType type converter
serhiy-storchaka Sep 27, 2024
1eaeebf
Update Lib/argparse.py
serhiy-storchaka Sep 27, 2024
f00457c
Update pending-removal-in-future.rst.
serhiy-storchaka Sep 28, 2024
2353a98
Wrap long line.
serhiy-storchaka Sep 28, 2024
17ec344
Fix Sphinx warning.
serhiy-storchaka Sep 28, 2024
d899deb
Merge branch 'main' into argparse-filetype-deprecate
serhiy-storchaka Oct 10, 2024
6c9660f
Emit a PendingDeprecationWarning.
serhiy-storchaka Oct 10, 2024
8e8e2ec
Update Lib/test/test_argparse.py
serhiy-storchaka Oct 11, 2024
9e3b098
Merge branch 'main' into argparse-filetype-deprecate
serhiy-storchaka Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Emit a PendingDeprecationWarning.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Oct 10, 2024
commit 6c9660f6efa9206ad1b5322b0f0a5a6be418bae3
6 changes: 6 additions & 0 deletions Lib/argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1266,6 +1266,12 @@ class FileType(object):
"""

def __init__(self, mode='r', bufsize=-1, encoding=None, errors=None):
import warnings
warnings.warn(
"FileType is deprecated. Simply open files after parsing arguments.",
category=PendingDeprecationWarning,
stacklevel=2
)
self._mode = mode
self._bufsize = bufsize
self._encoding = encoding
Expand Down
58 changes: 37 additions & 21 deletions Lib/test/test_argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1744,27 +1744,44 @@ def convert_arg_line_to_args(self, arg_line):
# Type conversion tests
# =====================

def FileType(*args, **kwargs):
with warnings.catch_warnings():
warnings.filterwarnings('ignore', 'FileType is deprecated',
PendingDeprecationWarning, __name__)
return argparse.FileType(*args, **kwargs)


class TestFileTypeDeprecation(TestCase):

def test(self):
parser = argparse.ArgumentParser()
Comment thread
serhiy-storchaka marked this conversation as resolved.
Outdated
with self.assertWarns(PendingDeprecationWarning) as cm:
argparse.FileType()
self.assertIn('FileType is deprecated', str(cm.warning))
self.assertEqual(cm.filename, __file__)


class TestFileTypeRepr(TestCase):

def test_r(self):
type = argparse.FileType('r')
type = FileType('r')
self.assertEqual("FileType('r')", repr(type))

def test_wb_1(self):
type = argparse.FileType('wb', 1)
type = FileType('wb', 1)
self.assertEqual("FileType('wb', 1)", repr(type))

def test_r_latin(self):
type = argparse.FileType('r', encoding='latin_1')
type = FileType('r', encoding='latin_1')
self.assertEqual("FileType('r', encoding='latin_1')", repr(type))

def test_w_big5_ignore(self):
type = argparse.FileType('w', encoding='big5', errors='ignore')
type = FileType('w', encoding='big5', errors='ignore')
self.assertEqual("FileType('w', encoding='big5', errors='ignore')",
repr(type))

def test_r_1_replace(self):
type = argparse.FileType('r', 1, errors='replace')
type = FileType('r', 1, errors='replace')
self.assertEqual("FileType('r', 1, errors='replace')", repr(type))


Expand Down Expand Up @@ -1818,7 +1835,6 @@ def __eq__(self, other):
text = text.decode('ascii')
return self.name == other.name == text


class TestFileTypeR(TempDirMixin, ParserTestCase):
"""Test the FileType option/argument type for reading files"""

Expand All @@ -1831,8 +1847,8 @@ def setUp(self):
self.create_readonly_file('readonly')

argument_signatures = [
Sig('-x', type=argparse.FileType()),
Sig('spam', type=argparse.FileType('r')),
Sig('-x', type=FileType()),
Sig('spam', type=FileType('r')),
]
failures = ['-x', '', 'non-existent-file.txt']
successes = [
Expand All @@ -1852,7 +1868,7 @@ def setUp(self):
file.close()

argument_signatures = [
Sig('-c', type=argparse.FileType('r'), default='no-file.txt'),
Sig('-c', type=FileType('r'), default='no-file.txt'),
]
# should provoke no such file error
failures = ['']
Expand All @@ -1871,8 +1887,8 @@ def setUp(self):
file.write(file_name)

argument_signatures = [
Sig('-x', type=argparse.FileType('rb')),
Sig('spam', type=argparse.FileType('rb')),
Sig('-x', type=FileType('rb')),
Sig('spam', type=FileType('rb')),
]
failures = ['-x', '']
successes = [
Expand Down Expand Up @@ -1910,8 +1926,8 @@ def setUp(self):
self.create_writable_file('writable')

argument_signatures = [
Sig('-x', type=argparse.FileType('w')),
Sig('spam', type=argparse.FileType('w')),
Sig('-x', type=FileType('w')),
Sig('spam', type=FileType('w')),
]
failures = ['-x', '', 'readonly']
successes = [
Expand All @@ -1933,8 +1949,8 @@ def setUp(self):
self.create_writable_file('writable')

argument_signatures = [
Sig('-x', type=argparse.FileType('x')),
Sig('spam', type=argparse.FileType('x')),
Sig('-x', type=FileType('x')),
Sig('spam', type=FileType('x')),
]
failures = ['-x', '', 'readonly', 'writable']
successes = [
Expand All @@ -1948,8 +1964,8 @@ class TestFileTypeWB(TempDirMixin, ParserTestCase):
"""Test the FileType option/argument type for writing binary files"""

argument_signatures = [
Sig('-x', type=argparse.FileType('wb')),
Sig('spam', type=argparse.FileType('wb')),
Sig('-x', type=FileType('wb')),
Sig('spam', type=FileType('wb')),
]
failures = ['-x', '']
successes = [
Expand All @@ -1965,8 +1981,8 @@ class TestFileTypeXB(TestFileTypeX):
"Test the FileType option/argument type for writing new binary files only"

argument_signatures = [
Sig('-x', type=argparse.FileType('xb')),
Sig('spam', type=argparse.FileType('xb')),
Sig('-x', type=FileType('xb')),
Sig('spam', type=FileType('xb')),
]
successes = [
('-x foo bar', NS(x=WFile('foo'), spam=WFile('bar'))),
Expand All @@ -1978,7 +1994,7 @@ class TestFileTypeOpenArgs(TestCase):
"""Test that open (the builtin) is correctly called"""

def test_open_args(self):
FT = argparse.FileType
FT = FileType
cases = [
(FT('rb'), ('rb', -1, None, None)),
(FT('w', 1), ('w', 1, None, None)),
Expand All @@ -1993,7 +2009,7 @@ def test_open_args(self):

def test_invalid_file_type(self):
with self.assertRaises(ValueError):
argparse.FileType('b')('-test')
FileType('b')('-test')


class TestFileTypeMissingInitialization(TestCase):
Expand Down