completely remove validate_zimfile_creatable function

Author: elfkuzco

CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Breaking Changes
 
 - Renamed `filesystem.validate_zimfile_creatable` to `filesystem.file_creatable` to reflect general applicability to check file creation beyond ZIM files #200
-- Remove any "ZIM" reference in exceptions while working with files.
+- Remove any "ZIM" reference in exceptions while working with files #200
 
 ### Added
 

src/zimscraperlib/zim/filesystem.py

@@ -32,7 +32,6 @@
 import pathlib
 import re
 import tempfile
-import warnings
 from collections.abc import Sequence
 
 from zimscraperlib import logger
@@ -306,25 +305,3 @@ def validate_file_creatable(folder: str | pathlib.Path, filename: str):
         fpath.unlink()
     except Exception as exc:
         raise IncorrectFilenameError(f"File is not creatable: {fpath}") from exc
-
-
-def validate_zimfile_creatable(folder: str | pathlib.Path, filename: str):
-    """Validate that a ZIM can be created in given folder with given filename
-
-    Any problem encountered raises an exception inheriting from IncorrectPathError
-
-    Checks that:
-    - folder passed exists (or raise MissingFolderError exception)
-    - folder passed is a directory (or raise NotADirectoryFolderError exception)
-    - folder is writable, i.e. it is possible to create a file in folder (or raise
-    NotWritableFolderError exception with inner exception details)
-    - filename is creatable, i.e. there is no bad characters in filename (or raise
-    IncorrectFilenameError exception with inner exception details)
-    """
-    warnings.warn(
-        "'validate_zimfile_creatable' is deprecated and will be removed. "
-        "Use 'validate_file_creatable` to ensure future compatibility.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-    validate_file_creatable(folder, filename)

tests/zim/test_fs.py

@@ -18,7 +18,6 @@
     make_zim_file,
     validate_file_creatable,
     validate_folder_writable,
-    validate_zimfile_creatable,
 )
 
 
@@ -173,37 +172,6 @@ def valid_zim_filename():
     return "myfile.zim"
 
 
-def test_validate_zimfile_creatable_ok(tmp_path, valid_zim_filename):
-
-    validate_zimfile_creatable(tmp_path, valid_zim_filename)
-
-
-def test_validate_zimfile_creatable_folder_not_exists(tmp_path, valid_zim_filename):
-
-    with pytest.raises(MissingFolderError):
-        validate_zimfile_creatable(tmp_path / "foo", valid_zim_filename)
-
-
-def test_validate_zimfile_creatable_bad_folder(tmp_path, valid_zim_filename):
-
-    with pytest.raises(NotADirectoryFolderError):
-        (tmp_path / "foo.txt").touch()
-        validate_zimfile_creatable(tmp_path / "foo.txt", valid_zim_filename)
-
-
-def test_validate_zimfile_creatable_folder_not_writable(tmp_path, valid_zim_filename):
-
-    with pytest.raises(NotWritableFolderError):
-        (tmp_path / "foo").mkdir(mode=111)
-        validate_zimfile_creatable(tmp_path / "foo", valid_zim_filename)
-
-
-def test_validate_zimfile_creatable_bad_name(tmp_path):
-
-    with pytest.raises(IncorrectFilenameError):
-        validate_zimfile_creatable(tmp_path, "t\0t\0.zim")
-
-
 def test_validate_folder_writable_not_exists(tmp_path):
 
     with pytest.raises(MissingFolderError):