Move python-fsutil and requests to [io] optional dependencies.

Author: fabiocaccamo

benedict/dicts/io/io_util.py

@@ -15,9 +15,14 @@
 except ModuleNotFoundError:
     s3_installed = False
 
-import fsutil
+try:
+    import fsutil
+
+    fsutil_installed = True
+except ModuleNotFoundError:
+    fsutil_installed = False
 
-from benedict.extras import require_s3
+from benedict.extras import require_fsutil, require_s3
 from benedict.serializers import (
     get_format_by_path,
     get_serializer_by_format,
@@ -88,7 +93,7 @@ def is_data(s: str | bytes) -> bool:
 
 
 def is_filepath(s: Path | str) -> bool:
-    if fsutil.is_file(s):
+    if fsutil_installed and fsutil.is_file(s):
         return True
     return bool(
         get_format_by_path(s)
@@ -147,15 +152,18 @@ def read_content(
 
 
 def read_content_from_file(filepath: str, format: str | None = None) -> str:
+    require_fsutil(installed=fsutil_installed)
     binary_format = is_binary_format(format)
     if binary_format:
         return filepath
-    return fsutil.read_file(filepath)  # type: ignore[no-any-return]
+    content = fsutil.read_file(filepath)
+    return str(content)
 
 
 def read_content_from_s3(
     url: str, s3_options: Mapping[str, Any], format: str | None = None
 ) -> str:
+    require_fsutil(installed=fsutil_installed)
     require_s3(installed=s3_installed)
     s3_url = parse_s3_url(url)
     dirpath = tempfile.gettempdir()
@@ -171,12 +179,14 @@ def read_content_from_s3(
 def read_content_from_url(
     url: str, requests_options: Mapping[str, Any], format: str | None = None
 ) -> str:
+    require_fsutil(installed=fsutil_installed)
     binary_format = is_binary_format(format)
     if binary_format:
         dirpath = tempfile.gettempdir()
         filepath = fsutil.download_file(url, dirpath=dirpath, **requests_options)
-        return filepath  # type: ignore[no-any-return]
-    return fsutil.read_file_from_url(url, **requests_options)  # type: ignore[no-any-return]
+        return str(filepath)
+    content = fsutil.read_file_from_url(url, **requests_options)
+    return str(content)
 
 
 def write_content(filepath: str, content: str, **options: Any) -> None:
@@ -187,12 +197,14 @@ def write_content(filepath: str, content: str, **options: Any) -> None:
 
 
 def write_content_to_file(filepath: str, content: str, **options: Any) -> None:
+    require_fsutil(installed=fsutil_installed)
     fsutil.write_file(filepath, content)
 
 
 def write_content_to_s3(
     url: str, content: str, s3_options: Mapping[str, Any], **options: Any
 ) -> None:
+    require_fsutil(installed=fsutil_installed)
     require_s3(installed=s3_installed)
     s3_url = parse_s3_url(url)
     dirpath = tempfile.gettempdir()

benedict/extras.py

@@ -1,6 +1,7 @@
 from benedict.exceptions import ExtrasRequireModuleNotFoundError
 
 __all__ = [
+    "require_fsutil",
     "require_html",
     "require_parse",
     "require_s3",
@@ -20,6 +21,10 @@ def require_html(*, installed: bool) -> None:
     _require_optional_dependencies(target="html", installed=installed)
 
 
+def require_fsutil(*, installed: bool) -> None:
+    _require_optional_dependencies(target="io", installed=installed)
+
+
 def require_parse(*, installed: bool) -> None:
     _require_optional_dependencies(target="parse", installed=installed)
 

benedict/serializers/xls.py

@@ -1,6 +1,11 @@
 from __future__ import annotations
 
-import fsutil
+try:
+    import fsutil
+
+    fsutil_installed = True
+except ModuleNotFoundError:
+    fsutil_installed = False
 
 try:
     from openpyxl import load_workbook
@@ -15,7 +20,7 @@
 
 from slugify import slugify
 
-from benedict.extras import require_xls
+from benedict.extras import require_fsutil, require_xls
 from benedict.serializers.abstract import AbstractSerializer
 
 
@@ -175,6 +180,7 @@ def _decode(self, s: str, **kwargs: Any) -> list[dict[str, Any]]:
 
     def decode(self, s: str, **kwargs: Any) -> list[dict[str, Any]]:
         require_xls(installed=xls_installed)
+        require_fsutil(installed=fsutil_installed)
         extension = fsutil.get_file_extension(s)
         if extension in ["xlsx", "xlsm"]:
             return self._decode(s, **kwargs)

pyproject.toml

@@ -90,9 +90,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "python-fsutil >= 0.16.0, < 1.0.0",
     "python-slugify >= 7.0.0, < 9.0.0",
-    "requests >= 2.33.0, < 3.0.0",
     "typing_extensions >= 4.13.2, < 4.16.0",
 ]
 dynamic = ["version"]
@@ -120,11 +118,9 @@ Twitter = "https://twitter.com/fabiocaccamo"
 all = [
     "python-benedict[io,parse,s3]",
 ]
-html = [
-    "beautifulsoup4 >= 4.12.0, < 5.0.0",
-    "python-benedict[xml]",
-]
 io = [
+    "python-fsutil >= 0.16.1, < 1.0.0",
+    "requests >= 2.33.0, < 3.0.0",
     "python-benedict[html,toml,xls,xml,yaml]",
 ]
 parse = [
@@ -135,12 +131,14 @@ parse = [
 ]
 s3 = [
     "boto3 >= 1.24.89, < 2.0.0",
+    "python-fsutil >= 0.16.1, < 1.0.0",
 ]
 toml = [
     "toml >= 0.10.2, < 1.0.0",
 ]
 xls = [
     "openpyxl >= 3.0.0, < 4.0.0",
+    "python-fsutil >= 0.16.1, < 1.0.0",
     "xlrd >= 2.0.0, < 3.0.0",
 ]
 xml = [