FileHiker 0.3.9.2__py3-none-any.whl

filehiker/__init__.py

@@ -0,0 +1,4 @@
+# file 20250406°0715 filehiker/__init__.py
+
+from .filehiker import FileHiker                                        # … [line 20250729°0845]
+__all__ = ['main']                                                      # Optional but recommended

filehiker/__main__.py

@@ -0,0 +1,249 @@
+## file 20260811°0711 filehikerdev/src/filehiker/__main__.py
+#  summary  : This module allows the package to be executed via `python.exe -m filehiker`
+#  license  : BSD 3-Clause | © 2026 – 2026 Norbert C. Maier
+#  status   : Proof-of-concept
+
+
+import os, sys
+import pathlib
+from typing import Optional
+
+
+## \entry   Function 20260816°1211 retrieve_package_version
+#  \brief   Retrieve the package version number from the package metadata
+def retrieve_package_version(package_name: str) -> Optional[str] :
+
+    """
+    Retrieve the version of a Python package.
+    Works for both installed and local (uninstalled) packages.
+
+    Args:
+        package_name: Name of the package (e.g., "mypackage").
+
+    Returns:
+        Version string if found, otherwise None.
+    """
+
+    # (1) Try importlib.metadata (installed packages, Python 3.8+)
+    try:
+        from importlib.metadata import version
+
+        x = version(package_name)
+        return x                                                       # 🚀
+
+    except (ImportError, Exception):
+        pass
+
+
+    # (2) Try pkg_resources (installed packages, legacy)
+    try:
+        import pkg_resources
+
+        x = pkg_resources.get_distribution(package_name).version
+        return x                                                        # 🚀
+
+    except (ImportError, Exception):
+        pass
+
+
+    # (3) Try pyproject.toml (local development)
+    try:
+        import tomli
+        pyproject_path = Path("pyproject.toml")
+        if pyproject_path.exists():
+            with open(pyproject_path, "rb") as f:
+                pyproject_data = tomli.load(f)
+                # Try Poetry format
+                if "tool" in pyproject_data and "poetry" in pyproject_data["tool"]:
+                    x = pyproject_data["tool"]["poetry"]["version"]
+                    return x                                            # 🚀
+                # Try PEP 621 format
+                elif "project" in pyproject_data:
+                    x = pyproject_data["project"]["version"]
+                    return x                                            # 🚀
+    except (ImportError, Exception):
+        pass
+
+
+    # (4) Try PKG-INFO (local development, legacy)
+    try:
+        from email.parser import Parser
+        pkg_info_path = Path("PKG-INFO")
+        if pkg_info_path.exists():
+            with open(pkg_info_path, "r") as f:
+                pkg_info = f.read()
+            parser = Parser()
+            metadata = parser.parsestr(pkg_info)
+            x = metadata["Version"]
+            return x                                                    # 🚀
+    except (ImportError, Exception):
+        pass
+
+
+    # (5) Try __version__ attribute (common in many packages)
+    try:
+        module = __import__(package_name)
+        x = getattr(module, "__version__", None)
+        return x                                                        # 🚀
+    except (ImportError, AttributeError, Exception):
+        pass
+
+
+    # () None of the above tries was successful
+    return None
+
+
+## \entry   Method 20260806°1423 main
+#  \brief   Perform a selftest…
+def selftest_1_default(b_Use_Builtin_Folder) :
+
+    import filehiker
+
+    # () Prepare test constants
+    i_Steps_Total = 110                                                 # 30 40 45 60 110
+    i_Steps_Per_Direction = 52                                          # 11 17 45 50 52
+
+    # () Determine basepath [seq 20260816°0741]
+    sBpth = ''
+    if not b_Use_Builtin_Folder :
+        sBpth = filehiker.FileHiker.normaleis(os.getcwd())              # CWD
+
+    # () The `selftest = True` parameter is ugly but sorrily necessary, but the easiest way to tell the class about
+    fhk = filehiker.FileHiker(basepath = sBpth, verbose = True, selftest = True)  # Flag 'selftest = True' is mandatory here
+
+    # () …
+    if True :                                                          # Toggle
+        fhk.set_IgnoreList([])
+
+    # () Feedback basepath
+    sBasePath = fhk.get_BasePath()
+    print(f'[Msg_4151] BasePath = "{sBasePath}"')
+
+    # () Test variations
+    caselist = ['', 'dir_1/', 'dir_2/file_01_abc.txt', 'dir_2b.txt']    # Blank is basefolder, others are inside basefolder
+    sTarget = sBasePath + caselist[3]                                   # Select case
+
+    # () Execute total steps
+    iDirecton = 1
+    for iTotal in range(1, i_Steps_Total + 1):
+
+        # () Notification part 1 of 2
+        sMsg = f'            • {iTotal:<3} {iDirecton:2}  {fhk.strip_prefix(sBasePath, sTarget):44} →'
+        print(sMsg, end = '', flush = True)
+
+        # () Prepare next loop
+        sNeighbour = fhk.find_neighbour(sTarget)                        # The payload function
+
+        ## () Notification part 2 of 2
+        print(f' {fhk.strip_prefix(sBasePath, sNeighbour)}')
+
+
+        # () Toggle direction flag?
+        if iTotal % i_Steps_Per_Direction == 0:
+
+            # (.) Yes, toggle direction flag!
+            # (.1) Toggle the flag
+            bDirection = not fhk.get_Direction()
+            fhk.set_Direction(bDirection)
+            print(f'[Msg_4153] Toggle direction to "{'Forward' if bDirection else 'Backward'}"')
+
+            # (.2) Set phase counter
+            iDirecton = 0 if bDirection else i_Steps_Per_Direction + 1
+
+            # (.3) Repeat last target
+            sNeighbour = sTarget
+
+        # () Maintain phase counter
+        iDirecton = iDirecton + 1 if fhk.get_Direction() else iDirecton - 1
+
+        # () Prepare next loop
+        sTarget = sNeighbour
+
+    return 0
+    
+
+    # + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+    # note 20260816°0821 'Test proceedings'
+    # Try the following sequence
+    # python.exe -m filehiker                           — Prints just the help screen
+    # python.exe -m filehiker s                         — Regular run from the base folder
+    # python.exe -m filehiker s dir_2                   — Regular run from inside base folder
+    # python.exe -m filehiker s dir_2/file_01_abc.txt   — Regular run from inside base folder  ✅
+    # python.exe -m filehiker s dir_2/file_02_xxx/      — Run with invalide target folder
+    # python.exe -m filehiker s dir_2/file_02_xxx/y.txt — Run with invalide target file
+    # python.exe -m filehiker t                         — Looks different depending on the start folder
+    #
+    # Te part counter´s output shall forth and back be the same — Does not work yet as wanted
+    # + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+## \register Function 20260811°0721 run
+#  \brief    Dispatch package call …
+#  \remark   Remember issue 20260811°1021 'Command `python.exe -m filehiker`' …
+def main():
+
+    sVersion = retrieve_package_version('filehiker')
+    sMsg = f'*** Welcome to package FileHiker v{sVersion} ***'
+    print(sMsg)
+
+    # (A) Evaluate arguments [seq 20260816°0711]
+    sArg0 = None
+    sArg1 = None
+    sArg2 = None
+    sArg3 = None
+    for iCount in range(0, len(sys.argv)):
+        match iCount:
+            case 0: sArg0 = sys.argv[0]                                 # Is always like e.g. "G:\…\filehikerdev\src\filehiker\__main__.py"
+            case 1: sArg1 = sys.argv[1]
+            case 2: sArg2 = sys.argv[2]
+            case 3: sArg3 = sys.argv[3]
+            case _: pass                                                # Actually a program flow error!
+    print(f'[Dbg_4155] Arguments: • "{sArg0}"\n            • "{sArg1}" • "{sArg2}" • "{sArg3}"')
+
+    # (B) Dispatch calls [seq 20260816°0721]
+    # (B.1) Help [seq 20260816°0723]
+    if sArg1 == None or sArg1 == 'h' or  sArg1 == 'help' :
+        sMsg = '[Msg_4157] FileHiker Help Screen' \
+             + '\n 1.1 python.exe -m filehiker           — Show this help screen' \
+             + '\n 1.2 python.exe -m filehiker help      — Show this help screen' \
+             + '\n 2   python.exe -m filehiker info      — Show environment infos' \
+             + '\n 3.1 python.exe -m filehiker self      — Selftest on the built-in sample folder' \
+             + '\n 3.2 python.exe -m filehiker self x…   — Selftest on sample folder with offset x…' \
+             + '\n 4.1 python.exe -m filehiker test      — Selftest on CWD (where Phyton was called from)' \
+             + '\n 4.2 python.exe -m filehiker test x…   — Selftest on CWD with offset x…' \
+             + '\n For help, info, self and test also the first letter suffices.'
+ 
+        print(sMsg)
+
+    # (B.2) Selftest [seq 20260816°0725]
+    elif sArg1 == 'i' or sArg1 == 'info' :
+        print('[Msg_4159] FileHiker info feature is yet to be implemented')
+
+    # (B.3) Selftest [seq 20260816°0727]
+    elif sArg1 == 's' or sArg1 == 'self' :
+        selftest_1_default(True)
+
+    # (B.3) Foldertest [seq 20260816°0729]
+    elif sArg1 == 't' or sArg1 == 'test' :
+        selftest_1_default(False)
+
+    # (B.4) Invalid argument [seq 20260816°0731]
+    else :
+        print('[Msg_4163] Invalid argument(s)')
+
+    # (C) Finish [seq 20260816°0733]
+    print('*** Bye FileHiker***')
+    return 0
+
+
+## \register Sequence 20260811°0713
+#  \brief    Main idiom
+if __name__ == "__main__":
+
+    if False :  # True False                                            # Toggle for debugging
+        if len(sys.argv) < 2 :                                          # Bad workaround, just quicker than fiddling with the VSCodium *.json [seq 20260816°0731]
+            sys.argv.append('')
+            sys.argv[1] = 's'
+            #sys.argv[1] = 't'
+
+    main()

filehiker/cases/20260806o1211.sorted.txt

@@ -0,0 +1,49 @@
+ 1  cases
+ 2  cases\20260806o1211.sorted.txt
+ 3  cases\20260806o1213.invert.py
+ 4  cases\20260806o1215.inverted.txt
+ 5  cases\^^file-to-ignore^^.txt
+ 6  cases\^^folder-to-ignore^^
+ 7  cases\^^folder-to-ignore^^\more123.txt
+ 8  cases\dir_1
+ 9  cases\dir_2
+10  cases\dir_2\file_01_abc.txt
+11  cases\dir_2b.txt
+12  cases\dir_3
+13  cases\dir_3\dir_31
+14  cases\dir_3\dir_31\dir_311
+15  cases\dir_3\dir_31\dir_311\^^dir_3111^^
+16  cases\dir_3\dir_31\dir_311\^^dir_3111^^\file_03_more.txt
+17  cases\dir_3\dir_31\dir_311\dir_3112
+18  cases\dir_3\dir_31\dir_311\dir_3113
+19  cases\dir_3\dir_31\dir_311\dir_3113\file_04_bcd.txt
+20  cases\dir_3\dir_31\dir_311\dir_3114
+21  cases\dir_3\dir_31\file_02_abc.txt
+22  cases\dir_4.txt
+23  cases\dir_5
+24  cases\dir_5\dir_51
+25  cases\dir_5\dir_51\dir_511
+26  cases\dir_5\dir_51\dir_511\dir_5111
+27  cases\dir_5\dir_51\dir_511\dir_5111\dir_51111
+28  cases\dir_5\dir_51\dir_511\dir_5111\file_08_k.txt
+29  cases\dir_5\dir_51\dir_511\dir_5111\file_10_m.txt
+30  cases\dir_5\dir_51\dir_511\dir_5111\file_11_n.txt
+31  cases\dir_5\dir_52
+32  cases\dir_5\dir_52\dir_521
+33  cases\dir_5\dir_52\dir_521\dir_5211
+34  cases\dir_5\dir_52\dir_521\dir_5212
+35  cases\dir_5\dir_52\dir_521\dir_5212\file_08_g.txt
+36  cases\dir_5\dir_52\file_07_c.txt
+37  cases\dir_5\dir_53
+38  cases\dir_5\dir_53\dir_531
+39  cases\dir_5\dir_53\dir_531\dir_5311
+40  cases\dir_5\dir_53\dir_531\dir_5311\dir_53111
+41  cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111
+42  cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\dir_5311111
+43  cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\file_12_x.txt
+44  cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\file_13_y.txt
+45  cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\file_14_z.txt
+46  cases\dir_5\file_05_a.txt
+47  cases\dir_5\file_06_h.txt
+48  cases\dir_5\file_07_p.txt
+49  cases\README.md

filehiker/cases/20260806o1213.invert.py

@@ -0,0 +1,30 @@
+#  file        : 20260806o1213.invert.py
+#  summary     : Invert the order of the lines of a textfile
+#  license     : BSD 3-Clause | © 2026 – 2026 Norbert C. Maier
+#  status      : It works
+
+
+sFILE_INPUT = './20260806o1211.sorted.txt'
+sFILE_OUTPUT = './20260806o1215.inverted.txt'
+
+
+def invert_file_lines(input_file_path, output_file_path) :              # [func 20260806°1321]
+
+    with open(input_file_path, 'r') as file:
+        lines = file.readlines()
+
+    inverted_lines = lines[::-1]
+
+    with open(output_file_path, 'w') as file:
+        file.writelines(inverted_lines)
+
+
+def main() :                                                            # [func 20260806°1331]
+
+    invert_file_lines(sFILE_INPUT, sFILE_OUTPUT)
+
+
+if __name__ == '__main__':                                              # Main idiom [seq 20260806°1311]
+
+    #i = main(sys.argv)
+    i = main()

filehiker/cases/20260806o1215.inverted.txt

@@ -0,0 +1,49 @@
+cases\README.md
+cases\dir_5\file_07_p.txt
+cases\dir_5\file_06_h.txt
+cases\dir_5\file_05_a.txt
+cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\file_14_z.txt
+cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\file_13_y.txt
+cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\file_12_x.txt
+cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111\dir_5311111
+cases\dir_5\dir_53\dir_531\dir_5311\dir_53111\dir_531111
+cases\dir_5\dir_53\dir_531\dir_5311\dir_53111
+cases\dir_5\dir_53\dir_531\dir_5311
+cases\dir_5\dir_53\dir_531
+cases\dir_5\dir_53
+cases\dir_5\dir_52\file_07_c.txt
+cases\dir_5\dir_52\dir_521\dir_5212\file_08_g.txt
+cases\dir_5\dir_52\dir_521\dir_5212
+cases\dir_5\dir_52\dir_521\dir_5211
+cases\dir_5\dir_52\dir_521
+cases\dir_5\dir_52
+cases\dir_5\dir_51\dir_511\dir_5111\file_11_n.txt
+cases\dir_5\dir_51\dir_511\dir_5111\file_10_m.txt
+cases\dir_5\dir_51\dir_511\dir_5111\file_08_k.txt
+cases\dir_5\dir_51\dir_511\dir_5111\dir_51111
+cases\dir_5\dir_51\dir_511\dir_5111
+cases\dir_5\dir_51\dir_511
+cases\dir_5\dir_51
+cases\dir_5
+cases\dir_4.txt
+cases\dir_3\dir_31\file_02_abc.txt
+cases\dir_3\dir_31\dir_311\dir_3114
+cases\dir_3\dir_31\dir_311\dir_3113\file_04_bcd.txt
+cases\dir_3\dir_31\dir_311\dir_3113
+cases\dir_3\dir_31\dir_311\dir_3112
+cases\dir_3\dir_31\dir_311\^^dir_3111^^\file_03_more.txt
+cases\dir_3\dir_31\dir_311\^^dir_3111^^
+cases\dir_3\dir_31\dir_311
+cases\dir_3\dir_31
+cases\dir_3
+cases\dir_2b.txt
+cases\dir_2\file_01_abc.txt
+cases\dir_2
+cases\dir_1
+cases\^^folder-to-ignore^^\more123.txt
+cases\^^folder-to-ignore^^
+cases\^^file-to-ignore^^.txt
+cases\20260806o1215.inverted.txt
+cases\20260806o1213.invert.py
+cases\20260806o1211.sorted.txt
+cases

filehiker/cases/README.md

@@ -0,0 +1,24 @@
+[Home](./../README.md)
+
+# FileHiker → Cases <span class="lmp-title-type">Demo-Data</span>
+
+This are some files and folders for the FileHiker **selftest** …
+
+The demo folder shall cover edge cases like
+- Empty folder
+- Foldername with blank *`Still missing`*
+- Filename with blank *`Still missing`*
+- Ignored file
+- Ignored folder
+- Invalid file path — Must be done by the caller
+- Invalid folder path — Must be done by the caller
+- Symlinks — *`Still missing`*
+- …
+
+About the ignore cases.
+For ignored files and folders the **pattern `^^*^^`** was choosen, because the
+ real-world pattern `__*__` is already used by the repositories ignore feature,
+ so the real-world pattern files would not even be committed.
+
+
+<sup>Page 20260725°1311 ⬞Ω</sup>

filehiker/cases/^^file-to-ignore^^.txt

@@ -0,0 +1,3 @@
+This file shall be ignored by FileHiker
+
+[file 20260725°1231]

filehiker/cases/^^folder-to-ignore^^/more123.txt

@@ -0,0 +1,3 @@
+This file shall be ignored because it resides in an ignored folder
+
+[file 20260725°1233]

filehiker/cases/dir_2/file_01_abc.txt

@@ -0,0 +1 @@
+abc.txt

filehiker/cases/dir_2b.txt

@@ -0,0 +1 @@
+This is dir_2b.txt

filehiker/cases/dir_3/dir_31/dir_311/^^dir_3111^^/file_03_more.txt

@@ -0,0 +1,3 @@
+This file shall be ignored because it resides in an ignored folder
+
+[file 20260725°1235]

filehiker/cases/dir_3/dir_31/dir_311/dir_3113/file_04_bcd.txt

@@ -0,0 +1 @@
+bcd.txt

filehiker/cases/dir_3/dir_31/file_02_abc.txt

@@ -0,0 +1 @@
+abc

filehiker/cases/dir_4.txt

@@ -0,0 +1 @@
+This is dir_4.txt

filehiker/cases/dir_5/dir_51/dir_511/dir_5111/file_08_k.txt

@@ -0,0 +1 @@
+File 'file_08_k.txt'

filehiker/cases/dir_5/dir_51/dir_511/dir_5111/file_10_m.txt

@@ -0,0 +1 @@
+m.txt

filehiker/cases/dir_5/dir_51/dir_511/dir_5111/file_11_n.txt

@@ -0,0 +1 @@
+n.txt

filehiker/cases/dir_5/dir_52/dir_521/dir_5212/file_08_g.txt

@@ -0,0 +1 @@
+g.txt

filehiker/cases/dir_5/dir_52/file_07_c.txt

@@ -0,0 +1 @@
+c.txt

filehiker/cases/dir_5/dir_53/dir_531/dir_5311/dir_53111/dir_531111/file_12_x.txt

@@ -0,0 +1 @@
+x.txt

filehiker/cases/dir_5/dir_53/dir_531/dir_5311/dir_53111/dir_531111/file_13_y.txt

@@ -0,0 +1 @@
+y.txt

filehiker/cases/dir_5/dir_53/dir_531/dir_5311/dir_53111/dir_531111/file_14_z.txt

@@ -0,0 +1 @@
+z.txt

filehiker/cases/dir_5/file_05_a.txt

@@ -0,0 +1 @@
+a.txt

filehiker/cases/dir_5/file_06_h.txt

@@ -0,0 +1 @@
+h.txt

filehiker/cases/dir_5/file_07_p.txt

@@ -0,0 +1 @@
+p.txt