node.ext.directory
==================
.. image:: https://img.shields.io/pypi/v/node.ext.directory.svg
:target: https://pypi.python.org/pypi/node.ext.directory
:alt: Latest PyPI version
.. image:: https://img.shields.io/pypi/dm/node.ext.directory.svg
:target: https://pypi.python.org/pypi/node.ext.directory
:alt: Number of PyPI downloads
.. image:: https://github.com/conestack/node.ext.directory/actions/workflows/test.yaml/badge.svg
:target: https://github.com/conestack/node.ext.directory/actions/workflows/test.yaml
:alt: Test node.ext.directory
Maintenance mode
----------------
This package is in maintenance mode. The successor of this package is
`https://pypi.python.org/pypi/node.ext.fs <https://pypi.python.org/pypi/node.ext.fs>`_.
Overview
--------
``node.ext.directory`` is a node implementation for file system directories.
For more information about ``node`` see
`https://pypi.python.org/pypi/node <https://pypi.python.org/pypi/node>`_.
Usage
-----
Create new file:
.. code-block:: python
from node.ext.directory import File
file_path = 'file.txt'
f = File(name=file_path)
# set contents via data attribute
f.data = 'data\n'
# set contents via lines attribute
f.lines = ['data']
# set permissions
f.fs_mode = 0o644
# persist
f()
Read existing file:
.. code-block:: python
file_path = 'file.txt'
f = File(name=file_path)
assert(f.data == 'data\n')
assert(f.lines == ['data'])
assert(f.fs_mode == 0o644)
Files with binary data:
.. code-block:: python
from node.ext.directory import MODE_BINARY
file_path = 'file.txt'
f = File(name=file_path)
f.mode = MODE_BINARY
f.data = b'\x00\x00'
assert(f.data == b'\x00\x00')
# lines property won't work if file in binary mode
f.lines # raises RuntimeError
Create directory:
.. code-block:: python
from node.ext.directory import Directory
dir_path = '.'
d = Directory(name=dir_path)
# add subdirectories and files
d['sub'] = Directory()
d['file.txt'] = File()
# set permissions for directory
d['sub'].fs_mode = 0o755
# persist
d()
Read existing directory:
.. code-block:: python
dir_path = '.'
d = Directory(name=dir_path)
.. code-block:: pycon
>>> d.printtree()
<class 'node.ext.directory.directory.Directory'>: .
<class 'node.ext.directory.directory.File'>: file.txt
<class 'node.ext.directory.directory.Directory'>: sub
Define file factories:
.. code-block:: python
from node.ext import directory
class PyFile(File):
pass
# set global factories
directory.file_factories['.py'] = PyFile
# set local factories
d = Directory(name='.', factories={'.py': PyFile})
when reading .py files, PyFile is used to instanciate children:
.. code-block:: pycon
>>> with open('foo.py', 'w') as f:
... f.write('#')
>>> d = Directory(name='.', factories={'.py': PyFile})
>>> d.printtree()
<class 'node.ext.directory.directory.Directory'>: .
<class '...PyFile'>: foo.py
Python Versions
===============
- Python 2.7, 3.7+
- May work with other versions (untested)
Contributors
============
- Robert Niederreiter (Author)
Changes
=======
0.8.1 (2024-05-23)
------------------
- Fix deprecated imports.
[rnix]
- Add note about successor package.
[rnix]
0.8 (2022-03-21)
----------------
- Replace deprecated use of ``Nodify`` by ``MappingNode``.
[rnix]
- Replace deprecated use of ``Adopt`` by ``MappingAdopt``.
[rnix]
0.7
---
- Python 3 support.
[rnix, 2017-06-06]
- ``fs_mode`` is read from filesystem if file or directory exists and
fs_mode not set explicitely.
[rnix, 2017-06-06]
- Remove ``backup`` option from ``IDirectory`` interface. It never really
worked properly and conceptually ``IDirectory`` is the wrong place for
handling backups of files.
[rnix, 2017-06-04]
0.6
---
- Introduce ``node.ext.directory.interfaces.IFile.direct_sync`` setting.
[rnix, 2017-01-30]
- Complete ``node.ext.directory.interfaces.IFile`` and
``node.ext.directory.interfaces.IDirectory`` to reflect implemented features.
[rnix, 2017-01-30]
- Move ``node.ext.directory.directory.MODE_TEXT`` and
``node.ext.directory.directory.MODE_BINARY`` to
``node.ext.directory.interfaces``.
[rnix, 2017-01-30]
0.5.4
-----
- Check whether directory to be peristed already exists by name as file in
``node.ext.directory.FileStorage.__call__``.
[rnix, 2015-10-05]
- Implement fallback to ``path`` in
``node.ext.directory.FileStorage.__call__`` if ``fs_path`` not exists.
[rnix, 2015-10-05]
- Implement fallback to ``path`` in
``node.ext.directory.FileStorage._get_data`` if ``fs_path`` not exists.
[rnix, 2015-10-05]
- Set initial mode with ``self.mode`` property setter instead of internal
``self._mode`` in ``node.ext.directory.FileStorage._get_mode``.
[rnix, 2015-10-05]
0.5.3
-----
- Remove deleted keys from internal reference after ``__call__`` in order
to return the correct result when adding a file or directory with the same
key again.
[rnix, 2015-07-20]
0.5.2
-----
- Use try/except instead of iteration to check whether directory child already
in memory.
[rnix, 2015-05-12]
0.5.1
-----
- Always use ``os.chmod`` for setting directory permissions, not only if
already exists.
[rnix, 2015-03-03]
0.5
---
- Introduce ``fs_mode`` on directories and files.
[rnix, 2015-03-03]
0.4
---
- Return empty list in ``File.lines`` if no data.
[rnix, 2015-02-18]
- Consider filesystem encoding. Defaults to UTF-8.
[rnix, 2015-02-18]
- Tree locking on modification.
[rnix, 2014-09-02]
- Prevent empty keys in ``__setitem__``.
[rnix, 2014-09-02]
- Use ``plumbing`` decorator.
[rnix, 2014-08-25]
0.3
---
- introduce ``default_file_factory`` on directories for controlling default
file child creation.
[rnix, 2013-12-09]
- move file logic in ``FileStorage`` behavior.
[rnix, 2013-08-06]
- make ``file_factories`` a class property on directory storage.
[rnix, 2013-08-06]
- make ``ignores`` a class property on directory storage.
[rnix, 2013-08-06]
- Cleanup interfaces.
[rnix, 2013-08-06]
0.2
---
- Almost complete rewrite. Fits now paradigms of node based API's.
[rnix, 2012-01-30]
0.1
---
- initial
License
=======
Copyright (c) 2010-2021, BlueDynamics Alliance, Austria
Copyright (c) 2021-2024, Node Contributors
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "http://github.com/conestack/node.ext.directory",
"name": "node.ext.directory",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "node directory file",
"author": "Node Contributors",
"author_email": "dev@conestack.org",
"download_url": "https://files.pythonhosted.org/packages/d8/ef/31295f70c13d64888b8f695e13c23f2bd3191f3d65531ea04b6d6d0cc008/node_ext_directory-0.8.1.tar.gz",
"platform": null,
"description": "node.ext.directory\n==================\n\n.. image:: https://img.shields.io/pypi/v/node.ext.directory.svg\n :target: https://pypi.python.org/pypi/node.ext.directory\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/pypi/dm/node.ext.directory.svg\n :target: https://pypi.python.org/pypi/node.ext.directory\n :alt: Number of PyPI downloads\n\n.. image:: https://github.com/conestack/node.ext.directory/actions/workflows/test.yaml/badge.svg\n :target: https://github.com/conestack/node.ext.directory/actions/workflows/test.yaml\n :alt: Test node.ext.directory\n\n\nMaintenance mode\n----------------\n\nThis package is in maintenance mode. The successor of this package is\n`https://pypi.python.org/pypi/node.ext.fs <https://pypi.python.org/pypi/node.ext.fs>`_.\n\n\nOverview\n--------\n\n``node.ext.directory`` is a node implementation for file system directories.\n\nFor more information about ``node`` see\n`https://pypi.python.org/pypi/node <https://pypi.python.org/pypi/node>`_.\n\nUsage\n-----\n\nCreate new file:\n\n.. code-block:: python\n\n from node.ext.directory import File\n\n file_path = 'file.txt'\n f = File(name=file_path)\n\n # set contents via data attribute\n f.data = 'data\\n'\n\n # set contents via lines attribute\n f.lines = ['data']\n\n # set permissions\n f.fs_mode = 0o644\n\n # persist\n f()\n\nRead existing file:\n\n.. code-block:: python\n\n file_path = 'file.txt'\n f = File(name=file_path)\n\n assert(f.data == 'data\\n')\n assert(f.lines == ['data'])\n assert(f.fs_mode == 0o644)\n\nFiles with binary data:\n\n.. code-block:: python\n\n from node.ext.directory import MODE_BINARY\n\n file_path = 'file.txt'\n f = File(name=file_path)\n f.mode = MODE_BINARY\n\n f.data = b'\\x00\\x00'\n\n assert(f.data == b'\\x00\\x00')\n\n # lines property won't work if file in binary mode\n f.lines # raises RuntimeError\n\nCreate directory:\n\n.. code-block:: python\n\n from node.ext.directory import Directory\n\n dir_path = '.'\n d = Directory(name=dir_path)\n\n # add subdirectories and files\n d['sub'] = Directory()\n d['file.txt'] = File()\n\n # set permissions for directory\n d['sub'].fs_mode = 0o755\n\n # persist\n d()\n\nRead existing directory:\n\n.. code-block:: python\n\n dir_path = '.'\n d = Directory(name=dir_path)\n\n.. code-block:: pycon\n\n >>> d.printtree()\n <class 'node.ext.directory.directory.Directory'>: .\n <class 'node.ext.directory.directory.File'>: file.txt\n <class 'node.ext.directory.directory.Directory'>: sub\n\nDefine file factories:\n\n.. code-block:: python\n\n from node.ext import directory\n\n class PyFile(File):\n pass\n\n # set global factories\n directory.file_factories['.py'] = PyFile\n\n # set local factories\n d = Directory(name='.', factories={'.py': PyFile})\n\nwhen reading .py files, PyFile is used to instanciate children:\n\n.. code-block:: pycon\n\n >>> with open('foo.py', 'w') as f:\n ... f.write('#')\n\n >>> d = Directory(name='.', factories={'.py': PyFile})\n >>> d.printtree()\n <class 'node.ext.directory.directory.Directory'>: .\n <class '...PyFile'>: foo.py\n\n\nPython Versions\n===============\n\n- Python 2.7, 3.7+\n- May work with other versions (untested)\n\n\nContributors\n============\n\n- Robert Niederreiter (Author)\n\n\nChanges\n=======\n\n0.8.1 (2024-05-23)\n------------------\n\n- Fix deprecated imports.\n [rnix]\n\n- Add note about successor package.\n [rnix]\n\n\n0.8 (2022-03-21)\n----------------\n\n- Replace deprecated use of ``Nodify`` by ``MappingNode``.\n [rnix]\n\n- Replace deprecated use of ``Adopt`` by ``MappingAdopt``.\n [rnix]\n\n\n0.7\n---\n\n- Python 3 support.\n [rnix, 2017-06-06]\n\n- ``fs_mode`` is read from filesystem if file or directory exists and\n fs_mode not set explicitely.\n [rnix, 2017-06-06]\n\n- Remove ``backup`` option from ``IDirectory`` interface. It never really\n worked properly and conceptually ``IDirectory`` is the wrong place for\n handling backups of files.\n [rnix, 2017-06-04]\n\n\n0.6\n---\n\n- Introduce ``node.ext.directory.interfaces.IFile.direct_sync`` setting.\n [rnix, 2017-01-30]\n\n- Complete ``node.ext.directory.interfaces.IFile`` and\n ``node.ext.directory.interfaces.IDirectory`` to reflect implemented features.\n [rnix, 2017-01-30]\n\n- Move ``node.ext.directory.directory.MODE_TEXT`` and\n ``node.ext.directory.directory.MODE_BINARY`` to\n ``node.ext.directory.interfaces``.\n [rnix, 2017-01-30]\n\n\n0.5.4\n-----\n\n- Check whether directory to be peristed already exists by name as file in\n ``node.ext.directory.FileStorage.__call__``.\n [rnix, 2015-10-05]\n\n- Implement fallback to ``path`` in\n ``node.ext.directory.FileStorage.__call__`` if ``fs_path`` not exists.\n [rnix, 2015-10-05]\n\n- Implement fallback to ``path`` in\n ``node.ext.directory.FileStorage._get_data`` if ``fs_path`` not exists.\n [rnix, 2015-10-05]\n\n- Set initial mode with ``self.mode`` property setter instead of internal\n ``self._mode`` in ``node.ext.directory.FileStorage._get_mode``.\n [rnix, 2015-10-05]\n\n\n0.5.3\n-----\n\n- Remove deleted keys from internal reference after ``__call__`` in order\n to return the correct result when adding a file or directory with the same\n key again.\n [rnix, 2015-07-20]\n\n\n0.5.2\n-----\n\n- Use try/except instead of iteration to check whether directory child already\n in memory.\n [rnix, 2015-05-12]\n\n\n0.5.1\n-----\n\n- Always use ``os.chmod`` for setting directory permissions, not only if\n already exists.\n [rnix, 2015-03-03]\n\n\n0.5\n---\n\n- Introduce ``fs_mode`` on directories and files.\n [rnix, 2015-03-03]\n\n\n0.4\n---\n\n- Return empty list in ``File.lines`` if no data.\n [rnix, 2015-02-18]\n\n- Consider filesystem encoding. Defaults to UTF-8.\n [rnix, 2015-02-18]\n\n- Tree locking on modification.\n [rnix, 2014-09-02]\n\n- Prevent empty keys in ``__setitem__``.\n [rnix, 2014-09-02]\n\n- Use ``plumbing`` decorator.\n [rnix, 2014-08-25]\n\n\n0.3\n---\n\n- introduce ``default_file_factory`` on directories for controlling default\n file child creation.\n [rnix, 2013-12-09]\n\n- move file logic in ``FileStorage`` behavior.\n [rnix, 2013-08-06]\n\n- make ``file_factories`` a class property on directory storage.\n [rnix, 2013-08-06]\n\n- make ``ignores`` a class property on directory storage.\n [rnix, 2013-08-06]\n\n- Cleanup interfaces.\n [rnix, 2013-08-06]\n\n\n0.2\n---\n\n- Almost complete rewrite. Fits now paradigms of node based API's.\n [rnix, 2012-01-30]\n\n\n0.1\n---\n\n- initial\n\n\nLicense\n=======\n\nCopyright (c) 2010-2021, BlueDynamics Alliance, Austria\nCopyright (c) 2021-2024, Node Contributors\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice, this\n list of conditions and the following disclaimer in the documentation and/or\n other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\nON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "Simplified BSD",
"summary": "Filesystem directory abstraction based on nodes",
"version": "0.8.1",
"project_urls": {
"Homepage": "http://github.com/conestack/node.ext.directory"
},
"split_keywords": [
"node",
"directory",
"file"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b90ab75ba2a1148ce1f689f91bcd3585f331fb6c3e3a0f85e63cda4b91b2327",
"md5": "ec59420ff2b2faa6123536dcf847a2e6",
"sha256": "1258880bcc7a17c5f2ae0220a283838b82c95205a921664c4502b00a32a4d5df"
},
"downloads": -1,
"filename": "node.ext.directory-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec59420ff2b2faa6123536dcf847a2e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13981,
"upload_time": "2024-05-23T13:59:31",
"upload_time_iso_8601": "2024-05-23T13:59:31.426668Z",
"url": "https://files.pythonhosted.org/packages/7b/90/ab75ba2a1148ce1f689f91bcd3585f331fb6c3e3a0f85e63cda4b91b2327/node.ext.directory-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8ef31295f70c13d64888b8f695e13c23f2bd3191f3d65531ea04b6d6d0cc008",
"md5": "8dab0e751fc65e055a40402e76f9ac7e",
"sha256": "fc70073167129e82fa75932818bf80ae0098a578652cd899638f392046377bae"
},
"downloads": -1,
"filename": "node_ext_directory-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "8dab0e751fc65e055a40402e76f9ac7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14228,
"upload_time": "2024-05-23T13:59:32",
"upload_time_iso_8601": "2024-05-23T13:59:32.872859Z",
"url": "https://files.pythonhosted.org/packages/d8/ef/31295f70c13d64888b8f695e13c23f2bd3191f3d65531ea04b6d6d0cc008/node_ext_directory-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-23 13:59:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "conestack",
"github_project": "node.ext.directory",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "node.ext.directory"
}
JSON
