chore: use pathlib for path manipulations

This simplifies the code and allows use to simplify error handling.

Author: nijel

examples/addfile.py

@@ -20,10 +20,8 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-
-import os
-import pathlib
 import sys
+from pathlib import Path
 
 import gammu
 
@@ -33,7 +31,8 @@ def main() -> None:
         print("This requires two parameters: file to upload and path!")
         sys.exit(1)
 
-    data = pathlib.Path(sys.argv[1]).read_bytes()
+    test_file = Path(sys.argv[1])
+    data = test_file.read_bytes()
 
     state_machine = gammu.StateMachine()
     state_machine.ReadConfig()
@@ -43,7 +42,7 @@ def main() -> None:
     print("\n\nExpection: Put specified file onto Memorycard on phone")
     file_f = {
         "ID_FullName": sys.argv[2],
-        "Name": os.path.basename(sys.argv[1]),
+        "Name": test_file.name,
         "Buffer": data,
         "Protected": 0,
         "ReadOnly": 0,

examples/filesystem_test.py

@@ -47,7 +47,6 @@
 
 import argparse
 import datetime
-import os
 import sys
 from pathlib import Path
 
@@ -91,7 +90,7 @@ def main() -> None:  # noqa: PLR0912, PLR0915, C901
         print("And even better, you should read the script before you run it.")
         sys.exit(1)
 
-    if not os.path.exists(args.testfile):
+    if not Path(args.testfile).exists():
         print("You have to select file which will be used for testing!")
         sys.exit(1)
 
@@ -120,8 +119,9 @@ def main() -> None:  # noqa: PLR0912, PLR0915, C901
 
     # Check AddFilePart
     print("\n\nExpectation: Put cgi.jpg onto Memorycard on phone")
-    file_content = Path(args.testfile).read_bytes()
-    file_stat = os.stat(args.testfile)
+    file_object = Path(args.testfile)
+    file_content = file_object.read_bytes()
+    file_stat = file_object.stat()
     ttime = datetime.datetime.fromtimestamp(file_stat[8])
     file_f = {
         "ID_FullName": args.folder,
@@ -159,7 +159,7 @@ def main() -> None:  # noqa: PLR0912, PLR0915, C901
     else:
         print("Files differ!")
 
-    os.remove("./test.jpg")
+    Path("./test.jpg").unlink()
 
     # Check GetNextRootFolder
     print("\n\nExpectation: Root Folder List")

examples/savesmspercontact.py

@@ -21,21 +21,12 @@
 #
 
 
-import errno
-import os
 import re
+from pathlib import Path
 
 import gammu
 
 
-def createFolderIfNotExist(path) -> None:
-    try:
-        os.makedirs(path)
-    except OSError as exception:
-        if exception.errno != errno.EEXIST:
-            raise
-
-
 def getInternationalizedNumber(number):
     if not number:
         return "Unknown"
@@ -45,16 +36,14 @@ def getInternationalizedNumber(number):
     return number
 
 
-def getFilename(mydir, mysms):
+def getFilename(mydir: Path, mysms) -> str:
     if mysms[0]["DateTime"]:
         return mysms[0]["DateTime"].strftime("%Y-%m-%d-%Hh%Mm%Ss")
 
     # no date available so calculate unknown number
-    myfiles = os.listdir(mydir)
-
     nextitem = 0
-    for i in myfiles:
-        match = re.match(r"^Unknown-([0-9]*)", i)
+    for i in mydir.glob("Unknown-*"):
+        match = re.match(r"^Unknown-([0-9]*)", i.name)
         if match and int(match.group(1)) > nextitem:
             nextitem = int(match.group(1))
 
@@ -65,15 +54,17 @@ def saveSMS(mysms, all_contacts) -> None:
     my_number = getInternationalizedNumber(mysms[0]["Number"])
 
     try:
-        mydir = all_contacts[my_number]
+        mydir = Path(all_contacts[my_number])
     except KeyError:
-        mydir = my_number
+        mydir = Path(my_number)
 
-    createFolderIfNotExist(mydir)
+    mydir.mkdir(parents=True, exist_ok=True)
 
     myfile = getFilename(mydir, mysms)
 
-    with open(os.path.join(mydir, myfile), "a", encoding="utf-8") as handle:
+    outfile = mydir / myfile
+
+    with outfile.open("a", encoding="utf-8") as handle:
         handle.writelines(i["Text"] for i in mysms)
         handle.write("\n")
 

pyproject.toml

@@ -151,7 +151,6 @@ ignore = [
   "PERF203",  # WONFIX: affects only old Python versions
   "PLR2004",
   "PLR6301",
-  "PTH",
   "RUF012",
   "S607",
   "SIM115",

setup.py

@@ -21,11 +21,12 @@
 #
 """python-gammu - Phone communication library."""
 
-import glob
 import os
 import platform
 import subprocess  # noqa: S404
 import sys
+from pathlib import Path
+from typing import cast
 
 from packaging.version import parse
 from setuptools import Extension, setup
@@ -40,7 +41,7 @@ def __init__(self) -> None:
         self.on_windows = platform.system() == "Windows"
         self.has_pkgconfig = self.check_pkconfig()
         self.has_env = "GAMMU_PATH" in os.environ
-        self.path = self.lookup_path()
+        self.path: Path = cast("Path", self.lookup_path())
         self.use_pkgconfig = self.has_pkgconfig and not self.has_env
 
     def check_pkconfig(self) -> bool:
@@ -50,28 +51,29 @@ def check_pkconfig(self) -> bool:
         except (subprocess.CalledProcessError, OSError):
             return False
 
-    def config_path(self, base):
-        return os.path.join(base, "include", "gammu", "gammu-config.h")
+    def config_path(self, base: Path) -> Path:
+        return base / "include" / "gammu" / "gammu-config.h"
 
-    def lookup_path(self):
+    def lookup_path(self) -> Path | None:
+        paths: list[Path]
         if self.has_env:
-            paths = [os.environ["GAMMU_PATH"]]
+            paths = [Path(os.environ["GAMMU_PATH"])]
         elif self.on_windows:
             paths = [
-                "C:\\Gammu",
-                "C:\\Program Files\\Gammu",
-                "C:\\Program Files (x86)\\Gammu",
+                Path("C:\\Gammu"),
+                Path("C:\\Program Files\\Gammu"),
+                Path("C:\\Program Files (x86)\\Gammu"),
             ]
-            paths += glob.glob("C:\\Program Files\\Gammu*")
-            paths += glob.glob("C:\\Program Files (x86)\\Gammu*")
+            paths += Path("C:\\Program Files").glob("Gammu*")
+            paths += Path("C:\\Program Files (x86)").glob("Gammu*")
         else:
-            paths = ["/usr/local/", "/usr/"]
-            paths += glob.glob("/opt/gammu*")
+            paths = [Path("/usr/local/"), Path("/usr/")]
+            paths += Path("/opt").glob("gammu*")
 
         for path in paths:
             include = self.config_path(path)
-            if os.path.exists(include):
-                return path
+            if include.exists():
+                return Path(path)
         return None
 
     def check_version(self) -> None:
@@ -91,7 +93,7 @@ def check_version(self) -> None:
                 print("Can not find supported Gammu version using pkg-config!")
                 sys.exit(100)
 
-        if self.path is None:
+        if not self.path:
             print("Failed to find Gammu!")
             print("Either it is not installed or not found.")
             print("After install Gammu ensure that setup finds it by any of:")
@@ -100,7 +102,7 @@ def check_version(self) -> None:
             sys.exit(101)
 
         version = None
-        with open(self.config_path(self.path), encoding="utf-8") as handle:
+        with self.config_path(self.path).open(encoding="utf-8") as handle:
             for line in handle:
                 if line.startswith("#define GAMMU_VERSION "):
                     version = parse(line.split('"')[1])
@@ -109,7 +111,7 @@ def check_version(self) -> None:
             print("Too old Gammu version, please upgrade!")
             sys.exit(100)
 
-    def get_libs(self):
+    def get_libs(self) -> list[str]:
         if self.use_pkgconfig:
             output = subprocess.check_output(
                 ["pkg-config", "--libs-only-l", "gammu", "gammu-smsd"]
@@ -122,7 +124,7 @@ def get_libs(self):
             libs.append("m")
         return libs
 
-    def get_cflags(self):
+    def get_cflags(self) -> str:
         if self.use_pkgconfig:
             return (
                 subprocess.check_output(
@@ -131,9 +133,9 @@ def get_cflags(self):
                 .decode("utf-8")
                 .strip()
             )
-        return "-I{}".format(os.path.join(self.path, "include", "gammu"))
+        return "-I{}".format((self.path / "include" / "gammu").as_posix())
 
-    def get_ldflags(self):
+    def get_ldflags(self) -> str:
         if self.use_pkgconfig:
             return (
                 subprocess.check_output(
@@ -143,8 +145,8 @@ def get_ldflags(self):
                 .strip()
             )
         if self.on_windows:
-            return "/LIBPATH:{}".format(os.path.join(self.path, "lib"))
-        return "-L{}".format(os.path.join(self.path, "lib"))
+            return "/LIBPATH:{}".format(self.path / "lib")
+        return "-L{}".format((self.path / "lib").as_posix())
 
 
 def get_module():

test/test_backup.py

@@ -18,19 +18,15 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
-import glob
-import os
-import os.path
 import tempfile
 import unittest
+from pathlib import Path
 
 import gammu
 
-TEST_DIR = os.path.join(os.path.dirname(__file__), "data")
-TEST_FILES_CALENDAR = glob.glob(os.path.join(TEST_DIR, "*.ics")) + glob.glob(
-    os.path.join(TEST_DIR, "*.vcs")
-)
-TEST_FILES_CONTACTS = glob.glob(os.path.join(TEST_DIR, "*.vcf"))
+TEST_DIR = Path(__file__).parent / "data"
+TEST_FILES_CALENDAR = TEST_DIR.glob("*.ics") + TEST_DIR.glob("*.vcs")
+TEST_FILES_CONTACTS = TEST_DIR.glob("*.vcf")
 TEST_CONTACTS = (".lmb", ".vcf", ".backup")
 TEST_CALENDAR = (".vcs", ".ics", ".backup")
 
@@ -69,8 +65,8 @@ def perform_test(self, filename, extensions) -> None:
                 gammu.SaveBackup(out_backup.name, backup)
         finally:
             for handle in out_files:
-                os.unlink(handle.name)
-            os.unlink(out_backup.name)
+                Path(handle.name).unlink()
+            Path(out_backup.name).unlink()
 
     def test_convert_contacts(self) -> None:
         for filename in TEST_FILES_CONTACTS:
@@ -81,7 +77,7 @@ def test_convert_calendar(self) -> None:
             self.perform_test(filename, TEST_CALENDAR)
 
     def test_calendar(self) -> None:
-        entry = gammu.ReadBackup(os.path.join(TEST_DIR, "rrule.ics"))["Calendar"][0]
+        entry = gammu.ReadBackup((TEST_DIR / "rrule.ics").as_posix())["Calendar"][0]
 
         # Convert it to vCard
         vc_entry = gammu.EncodeVCALENDAR(entry)
@@ -94,7 +90,7 @@ def test_calendar(self) -> None:
         assert entry2["Type"] == entry3["Type"]
 
     def test_todo(self) -> None:
-        entry = gammu.ReadBackup(os.path.join(TEST_DIR, "02.vcs"))["ToDo"][0]
+        entry = gammu.ReadBackup((TEST_DIR / "02.vcs").as_posix())["ToDo"][0]
 
         # Convert it to vCard
         vt_entry = gammu.EncodeVTODO(entry)
@@ -107,7 +103,7 @@ def test_todo(self) -> None:
         assert entry2["Type"] == entry3["Type"]
 
     def test_contact(self) -> None:
-        entry = gammu.ReadBackup(os.path.join(TEST_DIR, "gammu.vcf"))["PhonePhonebook"][
+        entry = gammu.ReadBackup((TEST_DIR, "gammu.vcf").as_posix())["PhonePhonebook"][
             0
         ]
 

test/test_config.py

@@ -18,9 +18,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
-import pathlib
 import tempfile
 import unittest
+from pathlib import Path
 
 import pytest
 
@@ -103,19 +103,19 @@ def check_operation(self, filename, handle=None) -> None:
         if handle:
             handle.close()
         if filename is not None:
-            content = pathlib.Path(filename).read_text(encoding="utf-8")
+            content = Path(filename).read_text(encoding="utf-8")
             assert "SMS type: Status report" in content
 
     def test_file(self) -> None:
         testfile = tempfile.NamedTemporaryFile(suffix=".debug", delete=False)
         testfile.close()
         try:
-            handle = pathlib.Path(testfile.name).open("w", encoding="utf-8")
+            handle = Path(testfile.name).open("w", encoding="utf-8")
             gammu.SetDebugFile(handle)
             self.check_operation(testfile.name, handle)
         finally:
             gammu.SetDebugFile(None)
-            pathlib.Path(testfile.name).unlink()
+            Path(testfile.name).unlink()
 
     def test_filename(self) -> None:
         testfile = tempfile.NamedTemporaryFile(suffix=".debug", delete=False)
@@ -125,7 +125,7 @@ def test_filename(self) -> None:
             self.check_operation(testfile.name)
         finally:
             gammu.SetDebugFile(None)
-            pathlib.Path(testfile.name).unlink()
+            Path(testfile.name).unlink()
 
     def test_none(self) -> None:
         gammu.SetDebugFile(None)
@@ -138,8 +138,8 @@ def test_nothing(self) -> None:
         try:
             gammu.SetDebugFile(testfile.name)
             self.check_operation(None)
-            content = pathlib.Path(testfile.name).read_text(encoding="utf-8")
+            content = Path(testfile.name).read_text(encoding="utf-8")
             assert not content
         finally:
             gammu.SetDebugFile(None)
-            pathlib.Path(testfile.name).unlink()
+            Path(testfile.name).unlink()