API Shortcuts - filesysobjects

The applicable match scope for a filepathname input is displayed in the column [scope].

The search path list is supported as literal only.

• L,l: literal
• R,r: regexpr by ‘re’
• G,g: ‘glob’

The case of the characters for resolution ‘[scope]’ indicate their handling:

• upper case - L, R, G - Upper case letters indicate active resolution including in-memory processing and filesystem access.
• lower case - l, r, g - Lower case letters indicate passive string acceptance with some in-memory processing.

The column ‘[fs]’ displays whether the filesystem is accessed, or in mem file search paths only. Function calls which access the filesystem are marked in the column ‘[fs]’ with ‘X’.

filesysobjects.FileSysObjects

Filesystem Positions and Navigation for sys.path, and extended alternatives. [docs]

• manage search paths - checks filesystem

  [docs]	[source]	[scope]	[fs]
  addPathToSearchPath	FileSysObjects.addPathToSearchPath	L	X
  clearPath	FileSysObjects.clearPath	L	X
  delPathFromSearchPath	FileSysObjects.delPathFromSearchPath	LRG	X
  setUpperTreeSearchPath	FileSysObjects.setUpperTreeSearchPath	L	X

• search for appended paths of files, directories, and branches - check filesystem

  [docs]	[source]	[scope]	[fs]
  findRelPathInSearchPath	FileSysObjects.findRelPathInSearchPath	LG	X
  findRelPathInSearchPathIter	FileSysObjects.findRelPathInSearchPathIter	LG	X

• match files, directories, and branches into path strings - work on strings only

  [docs]	[source]	[scope]	[fs]
  getTopFromPathString	FileSysObjects.getTopFromPathString	LRg	–
  getTopFromPathStringIter	FileSysObjects.getTopFromPathStringIter	LRg	–

• canonical user data hooks - provide major context directories for os.platform

  [docs]	[source]	[scope]	[fs]
  getHome	FileSysObjects.getHome	lrg	–
  getDirUserData	FileSysObjects.getDirUserData	lrg	–
  getDirUserConfigData	FileSysObjects.getDirUserConfigData	lrg	–
  getDirUserAppData	FileSysObjects.getDirUserAppData	lrg	–

Canonical Node Address

• Manage pathnames - files, directories, and branches

  [docs]	[source]	[scope]	[fs]
  escapeFilePath	FileSysObjects.escapeFilePath	lg	–
  getAppPrefixLocalPath	FileSysObjects.getAppPrefixLocalPath	lrg	–
  normpathX	FileSysObjects.normpathX	l	–
  splitAppPrefix	FileSysObjects.splitAppPrefix	lrg	–
  splitPathVar	FileSysObjects.splitPathVar	lrg	–
  unescapeFilePath	FileSysObjects.unescapeFilePath	lg	–

• For now experimental and non-productive, for review and comments [docs]

  [docs]	[source]	[scope]	[fs]
  netNormpathX	NetFiles.netNormpathX