]> granicus.if.org Git - python/commitdiff
bpo-37150: Throw ValueError if FileType class object was passed in add_argument ...
authorzygocephalus <grrrr@protonmail.com>
Fri, 7 Jun 2019 20:08:36 +0000 (23:08 +0300)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 7 Jun 2019 20:08:36 +0000 (13:08 -0700)
There is a possibility that someone (like me) accidentally will omit parentheses with `FileType` arguments after `FileType`, and parser will contain wrong file until someone will try to use it.

Example:
```python
parser = argparse.ArgumentParser()
parser.add_argument('-x', type=argparse.FileType)
```

https://bugs.python.org/issue37150

Lib/argparse.py
Lib/test/test_argparse.py
Misc/NEWS.d/next/Library/2019-06-04-14-44-41.bpo-37150.TTzHxj.rst [new file with mode: 0644]

index ef888f063b328641e45d586c35284df9b8532505..9a67b41ae00ead42ba9fc950e9d89e96d9f0a55e 100644 (file)
@@ -1361,6 +1361,10 @@ class _ActionsContainer(object):
         if not callable(type_func):
             raise ValueError('%r is not callable' % (type_func,))
 
+        if type_func is FileType:
+            raise ValueError('%r is a FileType class object, instance of it'
+                             ' must be passed' % (type_func,))
+
         # raise an error if the metavar does not match the type
         if hasattr(self, "_get_formatter"):
             try:
index 9d68f40571fe6f6bde9a88f61b58b2c9388ab576..bcf2cc9b26a319a7e8a2bd82192de7cc536eda82 100644 (file)
@@ -1619,6 +1619,24 @@ class TestFileTypeOpenArgs(TestCase):
                 m.assert_called_with('foo', *args)
 
 
+class TestFileTypeMissingInitialization(TestCase):
+    """
+    Test that add_argument throws an error if FileType class
+    object was passed instead of instance of FileType
+    """
+
+    def test(self):
+        parser = argparse.ArgumentParser()
+        with self.assertRaises(ValueError) as cm:
+            parser.add_argument('-x', type=argparse.FileType)
+
+        self.assertEqual(
+            '%r is a FileType class object, instance of it must be passed'
+            % (argparse.FileType,),
+            str(cm.exception)
+        )
+
+
 class TestTypeCallable(ParserTestCase):
     """Test some callables as option/argument types"""
 
diff --git a/Misc/NEWS.d/next/Library/2019-06-04-14-44-41.bpo-37150.TTzHxj.rst b/Misc/NEWS.d/next/Library/2019-06-04-14-44-41.bpo-37150.TTzHxj.rst
new file mode 100644 (file)
index 0000000..c5be46e
--- /dev/null
@@ -0,0 +1 @@
+`argparse._ActionsContainer.add_argument` now throws error, if someone accidentally pass FileType class object instead of instance of FileType as `type` argument
\ No newline at end of file