Add keyword arguments open and delete

Applies to function and mehtods (storage, compressed files).

Signed-off-by: Roberto Rosario <[email protected]>

Author: Roberto Rosario

HISTORY.rst

@@ -45,6 +45,8 @@
 - Remove the fragment "(object):" from all base class declarations.
 - Remove settings ``DOCUMENTS_DISABLE_BASE_IMAGE_CACHE`` and
   ``DOCUMENTS_DISABLE_TRANSFORMED_IMAGE_CACHE``.
+- Add keyword arguments to all the ``open()`` and ``delete()`` methods
+  and functions.
 
 3.4.9 (2020-05-26)
 ==================

contrib/scripts/code_statistics.py

@@ -6,7 +6,7 @@
 
 
 def print_views_summary(module_filename):
-    with open(module_filename) as file_object:
+    with open(file=module_filename) as file_object:
         print('    module:', module_filename)
         count_class_based_views = 0
         count_function_based_views = 0
@@ -23,7 +23,7 @@ def print_views_summary(module_filename):
 
 
 def print_tests_summary(module_filename):
-    with open(module_filename) as file_object:
+    with open(file=module_filename) as file_object:
         print('    module:', module_filename)
         count_tests = 0
         for line in file_object:

contrib/scripts/generate_setup.py

@@ -48,7 +48,7 @@ def generate_commit_timestamp():
 def get_requirements(base_directory, filename):
     result = []
 
-    with open(os.path.join(base_directory, filename)) as file_object:
+    with open(file=os.path.join(base_directory, filename)) as file_object:
         for line in file_object:
             if line.startswith('-r'):
                 line = line.split('\n')[0][3:]
@@ -72,16 +72,16 @@ def get_requirements(base_directory, filename):
         base_directory=BASE_DIR, filename=REQUIREMENTS_FILE
     )
 
-    with open(SETUP_TEMPLATE) as file_object:
+    with open(file=SETUP_TEMPLATE) as file_object:
         template = file_object.read()
         result = Template(template).render(
             context=Context({'requirements': requirements})
         )
 
-    with open('setup.py', 'w') as file_object:
+    with open(file='setup.py', mode='w') as file_object:
         file_object.write(result)
 
-    with open(MAYAN_TEMPLATE) as file_object:
+    with open(file=MAYAN_TEMPLATE) as file_object:
         template = file_object.read()
 
         # Ignore local version if any
@@ -102,5 +102,5 @@ def get_requirements(base_directory, filename):
             )
         )
 
-    with open(os.path.join(BASE_DIR, 'mayan', '__init__.py'), 'w') as file_object:
+    with open(file=os.path.join(BASE_DIR, 'mayan', '__init__.py'), mode='w') as file_object:
         file_object.write(result)

docs/chapters/rest_api.txt

@@ -63,7 +63,7 @@ Upload a new document:
 
 .. code-block:: python
 
-    with open('test_document.pdf', mode='rb') as file_object:
+    with open(file='test_document.pdf', mode='rb') as file_object:
         requests.post('http://127.0.0.1:8000/api/documents/', auth=('username', 'password'), files={'file': file_object}, data={'document_type': 1}).json()
 
     {u'description': u'',

docs/utils.py

@@ -7,7 +7,7 @@
 
 def load_env_file(filename='../config.env'):
     result = {}
-    with open(filename) as file_object:
+    with open(file=filename) as file_object:
         for line in file_object:
             if not line.startswith('#'):
                 key, value = line.strip().split('=')

mayan/__init__.py

@@ -1,7 +1,7 @@
 __title__ = 'Mayan EDMS'
 __version__ = '3.5a1'
 __build__ = 0x030407
-__build_string__ = 'v3.4.7_Tue Apr 28 17:14:27 2020 -0400'
+__build_string__ = 'v3.4.9-26-g48f099a168_Tue Jun 2 00:59:10 2020 -0400'
 __django_version__ = '2.2'
 __author__ = 'Roberto Rosario'
 __author_email__ = '[email protected]'

mayan/apps/cabinets/tests/test_wizard_steps.py

@@ -16,7 +16,7 @@
 
 class CabinetDocumentUploadTestMixin:
     def _request_upload_interactive_document_create_view(self):
-        with open(TEST_SMALL_DOCUMENT_PATH, mode='rb') as file_object:
+        with open(file=TEST_SMALL_DOCUMENT_PATH, mode='rb') as file_object:
             return self.post(
                 viewname='sources:document_upload_interactive', kwargs={
                     'source_id': self.test_source.pk

mayan/apps/checkouts/tests/test_models.py

@@ -88,7 +88,7 @@ def test_blocking_new_versions(self):
         NewVersionBlock.objects.block(document=self.test_document)
 
         with self.assertRaises(expected_exception=NewDocumentVersionNotAllowed):
-            with open(TEST_SMALL_DOCUMENT_PATH, mode='rb') as file_object:
+            with open(file=TEST_SMALL_DOCUMENT_PATH, mode='rb') as file_object:
                 self.test_document.new_version(file_object=file_object)
 
     def test_unblocking(self):
@@ -120,5 +120,5 @@ def test_version_creation_blocking(self):
         self._check_out_test_document()
 
         with self.assertRaises(expected_exception=NewDocumentVersionNotAllowed):
-            with open(TEST_SMALL_DOCUMENT_PATH, mode='rb') as file_object:
+            with open(file=TEST_SMALL_DOCUMENT_PATH, mode='rb') as file_object:
                 self.test_document.new_version(file_object=file_object)

mayan/apps/common/compressed_files.py

@@ -209,7 +209,7 @@ def write(self, filename=None):
         self.string_buffer.seek(0)
 
         if filename:
-            with open(filename, 'w') as file_object:
+            with open(file=filename, mode='w') as file_object:
                 file_object.write(self.string_buffer.read())
         else:
             return self.string_buffer

mayan/apps/common/forms.py

@@ -204,7 +204,7 @@ def __init__(self, *args, **kwargs):
             file_path = os.path.join(
                 settings.BASE_DIR, os.sep.join(self.DIRECTORY), self.FILENAME
             )
-            with open(file_path) as file_object:
+            with open(file=file_path) as file_object:
                 self.fields['text'].initial = file_object.read()