PathNavigator documentation

PathNavigator is a Python package designed to navigate directories and files for a project. 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.

For quick start, see the Readme page.

Contents:

Contents:

• pathnavigator package
  • Submodules
  • pathnavigator.att_name_convertor module
    • AttributeNameConverter
      • AttributeNameConverter.to_valid_name()
      • AttributeNameConverter.get()
      • AttributeNameConverter.get_org()
      • AttributeNameConverter.get_valid()
      • AttributeNameConverter.remove()
      • AttributeNameConverter.to_valid_name()
      • AttributeNameConverter.update_invalid_name_list()
  • pathnavigator.folder module
    • Folder
      • Folder.name
      • Folder.parent_path
      • Folder.subfolders
      • Folder.files
      • Folder._pn_object
      • Folder._pn_converter
      • Folder.add_to_sys_path()
      • Folder.chdir()
      • Folder.exists()
      • Folder.files
      • Folder.get()
      • Folder.get_str()
      • Folder.join()
      • Folder.list()
      • Folder.ls()
      • Folder.mkdir()
      • Folder.name
      • Folder.parent_path
      • Folder.remove()
      • Folder.scan()
      • Folder.set_all_to_sc()
      • Folder.set_sc()
      • Folder.subfolders
      • Folder.tree()
  • pathnavigator.pathnavigator module
    • PathNavigator
  • pathnavigator.shortcut module
    • Shortcut
      • Shortcut.add()
      • Shortcut.add_all()
      • Shortcut.clear()
      • Shortcut.get()
      • Shortcut.get_str()
      • Shortcut.load_dict()
      • Shortcut.load_json()
      • Shortcut.load_yaml()
      • Shortcut.ls()
      • Shortcut.remove()
      • Shortcut.to_dict()
      • Shortcut.to_json()
      • Shortcut.to_yaml()
  • Module contents
    • create()