pathnavigator 0.5.2

A Python library for efficient directory and file navigation

PathNavigator

PathNavigator is a Python package designed to navigate directories and files efficiently. It provides tools to interact with the filesystem, allowing users to create, delete, and navigate folders and files, while also maintaining an internal representation of the directory structure. Customized shortcuts can be added. The paths are stored as Path objects from pathlib, which adapt automatically across platforms.

Installation

pip install PathNavigator

Install the latest version from GitHub repo:

pip install git+https://github.com/philip928lin/PathNavigator.git

Getting Started

# Import pathnavigator and initialize a PathNavigator object
## Method 1
from pathnavigator import PathNavigator
pn = PathNavigator("root_dir")
# Method 2 
import pathnavigator
pn = pathnavigator.creat("root_dir")

# Retrieve the full path of folder1
pn.folder1.get()        # returns the full path to folder1 as a Path object
pn.folder1.get_str()    # returns the full path to folder1 as a string. Same as str(pn.folder1.get()).
pn.folder1.get("file.txt")        # returns the full path to file.txt as a Path object
pn.folder1.get_str("file.txt")    # returns the full path to file.txt as a string. Same as str(pn.folder1.get("file.txt")).

# Set shortcuts
pn.folder1.set_sc('my_folder')  # set the shortcut for folder1 (accessed by pn.sc.my_folder or pn.sc.get("my_folder") or pn.sc.get_str)
pn.folder1.set_sc('my_file', 'file.txt')  # set the shortcut for file.txt (accessed by pn.sc.my_file or pn.sc.get("my_file") or pn.sc.get_str("my_file"))
pn.folder1.set_all_files_to_sc() # set all files in the current directory to shortcuts
pn.sc.get("my_file") # get the shortcut

# List directory contents
pn.folder1.ls()         # prints the contents (subfolders and files) of folder1

# Check the existence of a file or subfolder
pn.folder1.exists("fileX.txt")
pn.folder1.exists("subfolder")

# Print the nested folder structure
pn.tree()

# Directory management
pn.mkdir('folder1', 'folder2')  # create a subfolder structure
pn.remove('folder1')    # remove a file or subfolder and delete it

Features

Directory and File Operations

# Returns the full path to folder1.
pn.folder1.get()        # Return a Path object
pn.folder1.get_str()    # Return a string

# Return the full path to file1.
pn.folder1.get("file.csv")      # Return a Path object
pn.folder1.get_str("file.csv")  # Return a string

# Rrints the contents (subfolders and files) of folder1.
pn.folder1.ls()         

# Make the nested directories.
# Directory root/folder1/subfolder1/subsubfolder2 will be created
pn.folder1.mkdir("subfolder1", "subsubfolder2")

# Removes a file or a folder and deletes it from the filesystem including all nested items.
# The following code will delete the directory of root/folder1/folder2
pn.folder1.remove('folder2')    

# Combine folder1 directory with "subfolder1/fileX.txt" and return it.
pn.folder1.join("subfolder1", "fileX.txt") 

# Or, you can utilize Path feature to join the paths.
pn.folder1.get() / "subfolder1/fileX.txt"

Reloading folder structure

# Update the folder structure to the current file system.
pn.reload() 

Check the existence of a file or subfolder

pn.folder1.exists("fileX.txt")
pn.folder1.exists("subfolder")

System Path Management

# Add the directory to folder1 to sys path.
pn.forlder1.add_to_sys_path()   

Changing Directories

# Change the working directory to folder2.
pn.forlder1.forlder2.chdir()    

Listing folders or files

# List all directories
pn.forlder1.list()
# List all subfolders
pn.forlder1.list(type="folder")
# List all files
pn.forlder1.list(type="file")

Shortcuts Management

Add shortcuts

# Set a shortcut named "f1" to folder1.
# Can be accessed by pn.sc.f1 or pn.sc.get("f1") or pn.sc.get_str("f1").
pn.folder1.set_sc("f1")

# Set a shortcut named "x" to the file "x.txt" in folder1.
# Can be accessed by pn.sc.x or pn.sc.get("x") or pn.sc.get_str("x").
pn.folder1.set_sc("x", "x.txt")
pn.folder1.set_all_files_to_sc() # set all files in the current directory to shortcuts

# Directly add shortcuts in pn.sc
pn.sc.add('f', pn.folder1.get("file"))  
pn.sc.add('f', r"new/path")  
pn.sc.add_all_files(directory=pn.folder1.get())

Retrieve shortcuts

# Retrieve the path of "f1" shortcut
pn.sc.f1
pn.sc.get("f1")  
pn.sc.get_str("f1") 

Other shortcut operations

# Print all shortcuts
pn.sc.ls()       

# Remove a shortcut
pn.sc.remove('f')   

# Return a dictionary of shortcuts
pn.sc.to_dict()  

# Output of shortcuts json file
pn.sc.to_json(filename)  

# Output of shortcuts yaml file
pn.sc.to_yaml(filename)

# Load shortcuts from a dictionary
pn.sc.load_dict()  

# Load shortcuts from a json file
pn.sc.load_json(filename)  

# Load shortcuts from a yaml file
pn.sc.load_yaml(filename)  

API reference