Abstract

The ‘filesysobjects’ package provides utilities for the simplified navigation in filesystem hierarchies. This comprises advanced search features with the management of multiple search path lists and ‘sys.path’, including the mixed application of ‘re’ and ‘glob’ patterns.

The additional enhancement results in providing OO features on files and directory trees by enhanced search features, This comprises patterns and functions on files, directories, and branches.

Blueprint

The ‘filesysobjects’ package provides utilities for the simplified navigation in filesystem hierarchies. This comprises basic functions for the application of object oriented patterns onto files, directories, and branches.

• Manage multiple search lists and support ‘re’ and ‘glob’ for path search

  Provides the creation and usage of multiple search paths including the full scale pattern matching on search paths by ‘re’ and ‘glob’ [details].

• Gears for filesystem objects - Files, Directories, and Branches

  The package provides a set of basic functions for implementing file system items conceptually as classes and objects. Just a few interfaces are required in order to represent some basic OO features on filesystems. This in particular comprises superposition and encapsulation, polymorphism, class and object hierachies.

  • Filesystem elements as classes and objects with multiple search and iteration sets [details]

  • Standards compliant multiplatform native path support: [details] [examples].

  • Programming Interface: [API], [UseCases].

    .

• Yet another attempt for file address processing on network storage

  Evaluation for an extension modul of the interface ‘os.path.normpath’. Thus the function is named for now ‘filesysobjects.NetFiles.normpathX’.

  • Extended Filesystems - Network Features

    .

• RTTI for native Python source files

  see PySourceInfo @ https://pypi.python.org/pypi/pysourceinfo

Fur further information on concepts and workflows refer to:

• Filesystem Elements as Objects [details]
• Variants of Pathname Parameters - Literals, RegExpr, and Glob [details]
• Syntax Elements [details]
• Call Parameters of the API [details]

See the API and subdocument collection in section ‘Shortcuts’

Install - HowTo - FAQ - Help

• Install:

  Standard procedure online local install by sources:

  python setup.py install --user
  

  Custom procedure offline by:

  python setup.py install --user --offline
  

  Documents, requires Sphinx and Epydoc:

  python setup.py build_doc install_doc
  

• Introduction:

  For now refer to the listed API and subdocument collection in section ‘Shortcuts’

Shortcuts

Concepts and workflows:

• Filesystem Elements as Objects [details]
• Variants of Pathname Parameters - Literals, RegExpr, and Glob [details]
• Syntax Elements [details]
• Call Parameters of the API [details]

Common Interfaces:

• Programming Interface
• Selected Common UsesCases

Complete technical API:

• Interface in javadoc-style [API]

Table of Contents

• API Shortcuts - filesysobjects
  • filesysobjects.FileSysObjects
  • Canonical Node Address
• UseCase-Shortcuts - Selected Common UsesCases
  • Manage Search Paths
  • Search for Files, Directories, and Branches
  • Match on Path Strings
  • Patterns for Library Functions
  • Project Applications
• ‘filesysobjects.FileSysObjects’ - Module
  • Functions
    • addPathToSearchPath
    • clearPath
    • delPathFromSearchPath
    • escapeFilePath
    • findRelPathInSearchPath
    • findRelPathInSearchPathIter
    • findRelPathInUpperTree
    • getAppPrefixLocalPath
    • getHome
    • getDirUserData
    • getDirUserConfigData
    • getDirUserAppData
    • getTopFromPathString
    • getTopFromPathStringIter
    • normpathX
    • setUpperTreeSearchPath
    • splitAppPrefix
    • splitPathVar
    • unescapeFilePath
  • Exceptions
    • FileSysObjectsException
• ‘filesysobjects.NetFiles’ - Module
  • Functions
    • netNormpathX
  • See also
• UseCases package
  • Subpackages
    • UseCases.FileSysObjects package
    • UseCases.SupportedResourcePathNames package
  • Submodules
  • UseCases.CallCase module
  • Module contents
• tests package
  • Subpackages
    • tests.30_libs package
    • tests.dummymodules package
  • Submodules
  • tests.CallCase module
  • tests.CheckEscUnesc module
  • tests.CheckNormpathX module
  • tests.MyTestCase module
  • Module contents
    • 30_libs
• testdata package
  • Subpackages
    • testdata.a package
    • testdata.examples package
    • testdata.findnodes package
  • Module contents
    • Common test data

• setup.py

  For help on extensions to standard options call onlinehelp:

  python setup.py --help-filesysobjects
  

Indices and tables

• Index
• Module Index
• Search Page

Resources

For available downloads refer to:

• Python Package Index: https://pypi.python.org/pypi/pyfilesysobjects
• Sourceforge.net: https://sourceforge.net/projects/filesysobjects/
• github.com: https://github.com/ArnoCan/filesysobjects/

For Licenses refer to enclosed documents:

• Artistic-License-2.0(base license): ArtisticLicense20.html
• Forced-Fairplay-Constraints(amendments): licenses-amendments.txt / Protect OpenSource Authors

Project data summary:

• PROJECT=filesysobjects

• MISSION=Support advanced navigation on filesystems.

• AUTHOR=Arno-Can Uestuensoez

• COPYRIGHT=Copyright (C) 2010,2011,2015-2016 Arno-Can Uestuensoez @Ingenieurbuero Arno-Can Uestuensoez

• LICENSE=Artistic-License-2.0 + Forced-Fairplay-Constraints

• VERSION=0.1.15

• RELEASE=0.1.15

• STATUS=pre-alpha

• NICKNAME=Yggdrasil

  Filesystem based class trees for Python by Yggdrasil see Yggdrasil, the mythical tree that connects the nine worlds...