Merge pull request #5 from jsconan/release-0.1.1

Release 0.1.1

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.1] - 2023-09-05
+
+### Changed
+
+-   `get_application_path()`, `get_application_name()`, and `get_file_path()` now all require the name of the main package for getting the application's path.
+
+### Fixed
+
+-   Wrong detection of the application path (`__main__` has no attribute)"
+
 ## [0.1.0] - 2023-09-05
 
 ### Added

README.md

@@ -75,33 +75,42 @@ The package `toolbox.files` offers file related utilities.
 
     ***
 
--   `get_application_name() -> str`:
+-   `get_application_name(name: str) -> str`:
 
     Gets the name of the application, based on the root folder.
 
+    Args:
+
+    -   name (`str`): The main package of the application.
+
     Returns:
 
     -   `str`: The name of the application.
 
     ***
 
--   `get_application_path() -> PurePath`:
+-   `get_application_path(name: str) -> PurePath`:
 
     Gets the path to the application's root.
 
+    Args:
+
+    -   name (`str`): The main package of the application.
+
     Returns:
 
     -   `PurePath`: The path to the application's root.
 
     ***
 
--   `get_file_path(relative) -> PurePath`:
+-   `get_file_path(relative: str, name: str) -> PurePath`:
 
     Gets a full path for a file inside the application.
 
     Args:
 
     -   relative (`str`): The internal path the file from the application's root.
+    -   name (`str`): The main package of the application.
 
     Returns:
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "py-toolbox"
-version = "0.1.0"
+version = "0.1.1"
 authors = [{ name = "Jean-Sébastien CONAN", email = "[email protected]" }]
 description = "A set of utilities for Python projects"
 readme = "README.md"

toolbox/files/path.py

@@ -30,42 +30,52 @@ def get_module_folder_path(name: str) -> PurePath():
         - name (str): The module for which get the path.
 
     Returns:
-        PurePath|None: The path to the folder containing the given module.
+        PurePath: The path to the folder containing the given module.
     """
-    return get_module_path(name).parent
+    if name in sys.modules:
+        return PurePath(sys.modules[name].__path__)
+
+    return PurePath()
 
 
-def get_application_path() -> PurePath:
+def get_application_path(name: str) -> PurePath:
     """
     Gets the path to the application's root.
 
+    Args:
+        - name (str): The main package of the application.
+
     Returns:
         PurePath: The path to the application's root.
     """
-    return get_module_folder_path("__main__")
+    return get_module_folder_path(name).parent
 
 
-def get_application_name() -> str:
+def get_application_name(name: str) -> str:
     """
     Gets the name of the application, based on the root folder.
 
+    Args:
+        - name (str): The main package of the application.
+
     Returns:
         - str: The name of the application.
     """
-    return get_application_path().name
+    return get_application_path(name).name
 
 
-def get_file_path(relative) -> PurePath:
+def get_file_path(relative: str, name: str) -> PurePath:
     """
     Gets a full path for a file inside the application.
 
     Args:
         - relative (str): The internal path the file from the application's root.
+        - name (str): The main package of the application.
 
     Returns:
         PurePath: The full path.
     """
-    return get_application_path().joinpath(relative)
+    return get_application_path(name).joinpath(relative)
 
 
 def create_file_path(path: str) -> bool:

toolbox/files/test/test_path.py

@@ -20,15 +20,21 @@ def test_get_module_path(self):
         """
         mock_namespace = "app.package.module"
         mock_path = "/root/app/package/module.py"
+        mock_folder = "/root/app/package"
 
         module_mock = Mock()
         module_mock.__file__ = mock_path
+        module_mock.__path__ = mock_folder
 
         with patch.dict(sys.modules, {mock_namespace: module_mock}):
             result = path.get_module_path(mock_namespace)
             self.assertIsInstance(result, PurePath)
             self.assertEqual(str(result), mock_path)
 
+        result = path.get_module_path("foo")
+        self.assertIsInstance(result, PurePath)
+        self.assertEqual(str(result), ".")
+
     def test_get_module_folder(self):
         """
         Tests the helper get_module_folder().
@@ -39,60 +45,82 @@ def test_get_module_folder(self):
 
         module_mock = Mock()
         module_mock.__file__ = mock_path
+        module_mock.__path__ = mock_folder
 
         with patch.dict(sys.modules, {mock_namespace: module_mock}):
             result = path.get_module_folder_path(mock_namespace)
             self.assertIsInstance(result, PurePath)
             self.assertEqual(str(result), mock_folder)
 
+        result = path.get_module_folder_path("foo")
+        self.assertIsInstance(result, PurePath)
+        self.assertEqual(str(result), ".")
+
     def test_get_application_path(self):
         """
         Tests the helper get_application_path().
         """
-        mock_namespace = "__main__"
-        mock_path = "/root/app/main.py"
+        mock_namespace = "app"
+        mock_path = "/root/app/package/module.py"
+        mock_folder = "/root/app/package"
         mock_root = "/root/app"
 
         module_mock = Mock()
         module_mock.__file__ = mock_path
+        module_mock.__path__ = mock_folder
 
         with patch.dict(sys.modules, {mock_namespace: module_mock}):
-            result = path.get_application_path()
+            result = path.get_application_path(mock_namespace)
             self.assertIsInstance(result, PurePath)
             self.assertEqual(str(result), mock_root)
 
+        result = path.get_application_path("foo")
+        self.assertIsInstance(result, PurePath)
+        self.assertEqual(str(result), ".")
+
     def test_get_application_name(self):
         """
         Tests the helper get_application_name().
         """
-        mock_namespace = "__main__"
-        mock_path = "/root/app/main.py"
+        mock_namespace = "app"
+        mock_path = "/root/app/package/module.py"
+        mock_folder = "/root/app/package"
         mock_name = "app"
 
         module_mock = Mock()
         module_mock.__file__ = mock_path
+        module_mock.__path__ = mock_folder
 
         with patch.dict(sys.modules, {mock_namespace: module_mock}):
-            result = path.get_application_name()
+            result = path.get_application_name(mock_namespace)
             self.assertIsInstance(result, str)
             self.assertEqual(result, mock_name)
 
+        result = path.get_application_name("foo")
+        self.assertEqual(result, "")
+
     def test_get_file_path(self):
         """
         Tests the helper get_file_path().
         """
-        mock_namespace = "__main__"
-        mock_path = "/root/app/main.py"
+        mock_namespace = "app"
+        mock_path = "/root/app/package/module.py"
+        mock_folder = "/root/app/package"
         mock_root = "/root/app"
-        test_param = "subfolder/file"
+        file_path = "subfolder/file"
 
         module_mock = Mock()
         module_mock.__file__ = mock_path
+        module_mock.__path__ = mock_folder
 
         with patch.dict(sys.modules, {mock_namespace: module_mock}):
-            result = path.get_file_path(test_param)
+            result = path.get_file_path(file_path, mock_namespace)
             self.assertIsInstance(result, PurePath)
-            self.assertEqual(str(result), f"{mock_root}/{test_param}")
+            self.assertEqual(str(result), f"{mock_root}/{file_path}")
+
+        result = path.get_file_path(file_path, "foo")
+        self.assertIsInstance(result, PurePath)
+        self.assertEqual(str(result), file_path)
 
     def test_create_file_path(self):
         """