midir 1.0.0__tar.gz

midir-1.0.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: midir
+Version: 1.0.0
+Author-email: Jordi Carrera Ventura <jordi.carrera.ventura@gmail.com>
+Project-URL: Google page, https://www.google.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: build
+Requires-Dist: pytest
+Requires-Dist: twine
+Dynamic: license-file
+
+# midir
+
+A library for resolving relative module dependencies.
+
+# Description
+
+`midir` is a Python library designed to handle relative module dependencies by resolving directory paths in an intelligent and system-agnostic way. This library can be used to introspect the file structure of your project and manipulate Python's `sys.path`, allowing for dynamic module imports based on directory hierarchy. It is especially helpful for larger projects where file structure can become complex and static imports cumbersome to manage. 
+
+## Features
+
+1. `midir(path: str) -> str:` Returns the directory name of the given file or directory path.
+
+2. `get_caller() -> str:` Returns the name of the file or the location (directory) where the current execution point is present.
+
+3. `mipath(path: str = None) -> str:` Returns the canonical (absolute) path of the current execution point or a provided path.
+
+4. `midir(path: str = None) -> str:` Returns the directory name where the current execution point is or from a provided path.
+
+5. `root_levels(levels: int = 1) -> None:` Makes directories available for import by adding them to sys.path. It starts from directory of the caller file and move up the directory hierarchy. The number of levels up to move is determined by input argument.
+
+6. `root_suffix(suffix: str) -> None:` Similar to `root_levels`, but instead of moving up a certain number of directories, it continues to move up until it finds a directory whose name ends with the provided suffix and adds that directory to sys.path.
+
+## Exceptions
+
+1. `FolderNotFoundError:` Custom exception raised when no folder matching the required conditions (in `root_suffix`) is found in the directory hierarchy.
+
+## Build instructions
+
+1. Building the package before uploading: 'python -m build' (from "midir").
+2. Upload the package to pypi: 'python -m twine upload --repository {pypi|testpypi} dist/*'
+3. Install the package from pypi: 'python -m pip install --index-url {https://test.pypi.org/simple|https://pypi.org/simple} --no-deps midir'
+4. If any dependencies are required, edit the `pyproject.toml` file, "\[project\]" field, and add a `dependencies` key with a `List\[str\]` value, where each string is a `pip`-readable dependency.

midir-1.0.0/README.md

@@ -0,0 +1,32 @@
+# midir
+
+A library for resolving relative module dependencies.
+
+# Description
+
+`midir` is a Python library designed to handle relative module dependencies by resolving directory paths in an intelligent and system-agnostic way. This library can be used to introspect the file structure of your project and manipulate Python's `sys.path`, allowing for dynamic module imports based on directory hierarchy. It is especially helpful for larger projects where file structure can become complex and static imports cumbersome to manage. 
+
+## Features
+
+1. `midir(path: str) -> str:` Returns the directory name of the given file or directory path.
+
+2. `get_caller() -> str:` Returns the name of the file or the location (directory) where the current execution point is present.
+
+3. `mipath(path: str = None) -> str:` Returns the canonical (absolute) path of the current execution point or a provided path.
+
+4. `midir(path: str = None) -> str:` Returns the directory name where the current execution point is or from a provided path.
+
+5. `root_levels(levels: int = 1) -> None:` Makes directories available for import by adding them to sys.path. It starts from directory of the caller file and move up the directory hierarchy. The number of levels up to move is determined by input argument.
+
+6. `root_suffix(suffix: str) -> None:` Similar to `root_levels`, but instead of moving up a certain number of directories, it continues to move up until it finds a directory whose name ends with the provided suffix and adds that directory to sys.path.
+
+## Exceptions
+
+1. `FolderNotFoundError:` Custom exception raised when no folder matching the required conditions (in `root_suffix`) is found in the directory hierarchy.
+
+## Build instructions
+
+1. Building the package before uploading: 'python -m build' (from "midir").
+2. Upload the package to pypi: 'python -m twine upload --repository {pypi|testpypi} dist/*'
+3. Install the package from pypi: 'python -m pip install --index-url {https://test.pypi.org/simple|https://pypi.org/simple} --no-deps midir'
+4. If any dependencies are required, edit the `pyproject.toml` file, "\[project\]" field, and add a `dependencies` key with a `List\[str\]` value, where each string is a `pip`-readable dependency.

midir-1.0.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=75.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "midir"
+version = "1.0.0"
+authors = [
+  { name="Jordi Carrera Ventura", email="jordi.carrera.ventura@gmail.com" },
+]
+description = ""
+readme = "README.md"
+requires-python = ">=3.14"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+  "build",
+  "pytest",
+  "twine",
+]
+
+[project.urls]
+"Google page" = "https://www.google.com"

midir-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

midir-1.0.0/src/midir/__init__.py

@@ -0,0 +1,131 @@
+import inspect
+import os
+import sys
+
+def midir(path: str) -> str:
+    """
+    Returns the directory name of the given path
+
+    Parameters
+    ----------
+    path: str
+        Path to a file or a directory 
+
+    Returns
+    -------
+    str: Directory name of the given path
+    """
+    return os.path.dirname(path)
+
+class FolderNotFoundError(OSError):
+    """
+    Custom exception class to handle the situations when folder is not found
+    """
+    pass
+
+
+def get_caller() -> str:
+    """
+    Returns the filename of the caller
+
+    Returns
+    -------
+    str: The name of the file that contains the current execution point 
+    """
+    return inspect.stack()[2].filename
+
+def mipath(path: str = None) -> str:
+    """
+    Returns the canonical path
+
+    Parameters
+    ----------
+    path: (str, optional)
+        File or directory path. Defaults to None.
+
+    Returns
+    -------
+    str: Canonical path of the current execution point or given path
+    """
+    if path is None:
+        return os.path.realpath(get_caller())
+    else:
+        return os.path.realpath(path)
+
+def midir(path: str = None) -> str:
+    """
+    Returns the directory name from the given path
+
+    Parameters
+    ----------
+    path: str, optional
+        File or directory path. Defaults to None.
+
+    Returns
+    -------
+    str: Directory name of the current execution point or given path
+    """
+    if path is None:
+        return os.path.dirname(get_caller())
+    else:
+        return os.path.dirname(path)
+
+def root_levels(levels: int = 1) -> None:
+    """
+    Adds directories to sys.path
+    Starts from the directory of the caller file and move up the directory hierarchy.
+    Number of levels to move up is determined by input argument.
+
+    Parameters
+    ----------
+    levels: int
+        Levels to move up the directory hierarchy. Defaults to 1.
+    
+    Raises
+    ------
+    TypeError
+    ValueError
+    """
+    folder = midir(get_caller())
+    if not isinstance(levels, int):
+        raise TypeError(levels)
+    elif levels < 0:
+        raise ValueError(f'Expects a positive integer: {levels}')
+    while levels:
+        if folder not in sys.path:
+            sys.path.append(folder)
+        folder = os.path.dirname(folder)
+        levels -= 1
+
+def root_suffix(suffix: str) -> None:
+    """
+    Adds directories to sys.path
+    Starts from the directory of the caller, moves up the directory hierarchy 
+    and adds the first folder with the given suffix to sys.path.
+
+    Parameters
+    ----------
+    suffix: str
+        Suffix to match
+
+    Raises
+    ------
+    TypeError
+    ValueError
+    FolderNotFoundError: if no folder with the given suffix is found
+    """
+    if not isinstance(suffix, str):
+        raise TypeError(suffix)
+    elif not suffix.strip():
+        raise ValueError(f'Expects a non-null string: {suffix}')
+    folder = midir(get_caller())
+    while True:
+        if (
+            os.path.basename(folder).endswith(suffix)
+            and folder not in sys.path
+        ):
+            sys.path.append(folder)
+            return
+        folder = os.path.dirname(folder)
+        if folder == '/':
+            raise FolderNotFoundError(suffix)

midir-1.0.0/src/midir.egg-info/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: midir
+Version: 1.0.0
+Author-email: Jordi Carrera Ventura <jordi.carrera.ventura@gmail.com>
+Project-URL: Google page, https://www.google.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: build
+Requires-Dist: pytest
+Requires-Dist: twine
+Dynamic: license-file
+
+# midir
+
+A library for resolving relative module dependencies.
+
+# Description
+
+`midir` is a Python library designed to handle relative module dependencies by resolving directory paths in an intelligent and system-agnostic way. This library can be used to introspect the file structure of your project and manipulate Python's `sys.path`, allowing for dynamic module imports based on directory hierarchy. It is especially helpful for larger projects where file structure can become complex and static imports cumbersome to manage. 
+
+## Features
+
+1. `midir(path: str) -> str:` Returns the directory name of the given file or directory path.
+
+2. `get_caller() -> str:` Returns the name of the file or the location (directory) where the current execution point is present.
+
+3. `mipath(path: str = None) -> str:` Returns the canonical (absolute) path of the current execution point or a provided path.
+
+4. `midir(path: str = None) -> str:` Returns the directory name where the current execution point is or from a provided path.
+
+5. `root_levels(levels: int = 1) -> None:` Makes directories available for import by adding them to sys.path. It starts from directory of the caller file and move up the directory hierarchy. The number of levels up to move is determined by input argument.
+
+6. `root_suffix(suffix: str) -> None:` Similar to `root_levels`, but instead of moving up a certain number of directories, it continues to move up until it finds a directory whose name ends with the provided suffix and adds that directory to sys.path.
+
+## Exceptions
+
+1. `FolderNotFoundError:` Custom exception raised when no folder matching the required conditions (in `root_suffix`) is found in the directory hierarchy.
+
+## Build instructions
+
+1. Building the package before uploading: 'python -m build' (from "midir").
+2. Upload the package to pypi: 'python -m twine upload --repository {pypi|testpypi} dist/*'
+3. Install the package from pypi: 'python -m pip install --index-url {https://test.pypi.org/simple|https://pypi.org/simple} --no-deps midir'
+4. If any dependencies are required, edit the `pyproject.toml` file, "\[project\]" field, and add a `dependencies` key with a `List\[str\]` value, where each string is a `pip`-readable dependency.

midir-1.0.0/src/midir.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/midir/__init__.py
+src/midir.egg-info/PKG-INFO
+src/midir.egg-info/SOURCES.txt
+src/midir.egg-info/dependency_links.txt
+src/midir.egg-info/requires.txt
+src/midir.egg-info/top_level.txt
+tests/test_unit.py

midir-1.0.0/src/midir.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

midir-1.0.0/src/midir.egg-info/requires.txt

@@ -0,0 +1,3 @@
+build
+pytest
+twine

midir-1.0.0/src/midir.egg-info/top_level.txt

@@ -0,0 +1 @@
+midir

midir-1.0.0/tests/test_unit.py

@@ -0,0 +1,41 @@
+import sys
+
+from src.midir import (
+    root_levels,
+    root_suffix,
+    midir,
+    mipath
+)
+
+def test_midir():
+    #print(midir(__file__))
+    assert midir().endswith("midir/tests")
+
+def test_mipath():
+    assert mipath().endswith("midir/tests/test_unit.py")
+
+def test_root_levels():
+    assert not [path for path in sys.path if path.endswith("/tests")]
+    with_midir = [path for path in sys.path if path.endswith("/midir")]
+    root_levels(levels=1)
+    assert [path for path in sys.path if path.endswith("/tests")]
+    root_levels(levels=2)
+    assert with_midir == [path for path in sys.path if path.endswith("/midir")]
+
+def test_root_suffix():
+    assert '/Users/jordi' not in sys.path
+    root_suffix("jordi")
+    assert '/Users/jordi' in sys.path
+
+def test_root_suffix_oserror():
+    try:
+        root_suffix("jona")
+    except Exception:
+        assert True
+
+if __name__ == '__main__':
+    test_midir()
+    test_mipath()
+    test_root_levels()
+    test_root_suffix()
+    test_root_suffix_oserror()