Abstract¶
The ‘filesysobjects‘ package provides path and name resolution, advanced search and processing operations and arbitrary cross-conversion of addresses of file-like resources between platforms and filesystems.
The provided standard interfaces of the os.path package are extended by new functions for mixed application of local filesystem paths with UNC and URI/URL paths. This includes the extension of literal names and globs, and by the embedded application of regular expressions provided by the re package.
The supported standards are [POSIX]/[IEEE], [IETF], and filesystem conventions from the [MSDN] and [MSOSPEC], for a detailed list refer to Resources
The supported platforms are:
- Linux, BSD, Unix, OS-X, Cygwin, and Windows
- Python2.7+, Python3.5+
Cockpit¶
Command Line Interface¶
Commandline interface for verification and shell binding. For basic concepts on filesystem addressing refer to “Filesystem Address Interfaces on Multiple Platforms”, and “Addresses for File-Like Resources”.
fsysobj¶
Command Line Interface | HowTo | Call Options | API |
---|---|---|---|
`fsysobj - call`_ | `HowTo Use the Command Line Interface`_ | fsysobjCLISYNOPSIS | `optionparser_fsysobj.py`_ |
fsysobjCLIOPTIONS | |||
fsysobjCLIARGUMENTS |
pppathvar¶
Command Line Interface | HowTo | Call Options | API |
---|---|---|---|
`pppathvar - call`_ | HowTo Pretty Print Search Path Variables | pppathvarCLISYNOPSIS | `optionparser_pppathvar.py`_ |
pppathvarCLIOPTIONS | |||
pppathvarCLIARGUMENTS |
API¶
For details refer to “The filesysobjects API”, “Filesystem Address Interfaces on Multiple Platforms”, “Addresses for File-Like Resources”, and “The SW-Design of filesysobjects”. .
Documents¶
Artifacts | Shortcuts |
---|---|
Concepts and Design | Development Documents |
Programming Interfaces | API Shortcuts - filesysinfo |
Example Data | Tests |
Blueprint¶
The ‘filesysobjects’ package provides address calculations for the simplified navigation in local and remote filesystem hierarchies. This comprises functions for the application of object oriented patterns onto files, directories, and branches by various notations including multiple protocols. In general - the application of object oriented concepts combined with advanced search patterns onto cloud and web based distributed resources. The support of multiple platforms in particular spans Posix based filesystems and Windows based filesystems.
The filesysobjects API adds this features to the standard libraries by introducing an abstract address layer.
The addressing support also introduces the common canonical representation for the supported platforms. The overall major advances introduced by the filesysinfo are:
Base 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.
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]
Iterators and Context Manager
Provides in combination with re and glob the iteration over resource trees [details]
The current release of the package filesysobjects contains the following components.
- ‘apppaths‘ - resolution and processing of application resource paths, with optional globs and re
- ‘configdata‘ - file system locations of configuration files
- ‘netfiles‘ - still experimental
- ‘osdata‘ - file system locations of system directories
- ‘paths‘ - resolution and processing of file system paths, with optional globs and re
- ‘pathtools‘ - dynamic sets of file system paths by search and filtering with globs and re
- ‘userdata‘ - file system locations of user data
For further information on concepts, workflows, and the API see ‘Shortcuts’
Table of Contents¶
- Shortcuts
- A Primer on File and Directory Resources
- Filesystem Address Interfaces on Multiple Platforms
- Filename Encoding and Decoding
- Addresses for File-Like Resources
- Normative References
- Valuable Drafts
- Howto
- The SW-Design of filesysobjects
- The filesysobjects API
- ‘filesysobjects.__init__’ - Module
- ‘filesysobjects.apppaths’ - Module
- ‘filesysobjects.paths’ - Module
- ‘filesysobjects.pathtools’ - Module
- ‘filesysobjects.userdata’ - Module
- ‘filesysobjects.osdata’ - Module
- ‘filesysobjects.configdata’ - Module
- ‘filesysobjects.netfiles’ - Module
- Install
Indices and tables¶
Resources¶
Project Data
- PROJECT=filesysobjects
- MISSION=Support advanced navigation on filesystems.
- AUTHOR=Arno-Can Uestuensoez
- COPYRIGHT=Copyright (C) 2010,2011,2015-2018 Arno-Can Uestuensoez @Ingenieurbuero Arno-Can Uestuensoez
- LICENSE=Artistic-License-2.0 + Forced-Fairplay-Constraints
- VERSION=0.1.34
- RELEASE=0.1.34
- STATUS=alpha
Online Documents
- Pythonhosted: https://pythonhosted.org/pyfilesysobjects/
Licenses
Artistic-License-2.0(base license): ArtisticLicense20.html
Forced-Fairplay-Constraints(amendments): licenses-amendments.txt
[xkcd] Support the OpenSource Authors :-)
Downloads
- Python Package Index: https://pypi.python.org/pypi/pyfilesysobjects
- Sourceforge.net: https://sourceforge.net/projects/filesysobjects/
- github.com: https://github.com/ArnoCan/filesysobjects/