xrootdpyfs 0.2.2__tar.gz → 2.0.0__tar.gz

xrootdpyfs-2.0.0/.dockerignore

@@ -0,0 +1,11 @@
+*.pyc
+*.swp
+*.swo
+*.~
+
+docker-compose.yml
+
+.tox
+.cache
+.coverage
+__pycache__

xrootdpyfs-2.0.0/.editorconfig

@@ -0,0 +1,31 @@
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# Python files
+[*.py]
+indent_size = 4
+# isort plugin configuration
+multi_line_output = 2
+default_section = THIRDPARTY
+
+# RST files (used by sphinx)
+[*.rst]
+indent_size = 4
+
+# CSS, HTML, JS, JSON, YML
+[*.{css,html,js,json,yml}]
+indent_size = 2
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_size = 2
+
+# Dockerfile
+[Dockerfile]
+indent_size = 4

xrootdpyfs-2.0.0/.git-blame-ignore-revs

@@ -0,0 +1 @@
+07f4d277f102ded42a1a44d9ddc3a9f0a1122e86

{xrootdpyfs-0.2.2 → xrootdpyfs-2.0.0}/.github/workflows/pypi-publish.yml

@@ -18,12 +18,12 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.6
+          python-version: 3.9
 
       - name: Install dependencies
         run: |

{xrootdpyfs-0.2.2 → xrootdpyfs-2.0.0}/.github/workflows/tests.yml

@@ -20,27 +20,23 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        include:
-          - xrootd-version: 4.8.5
-            cmake: cmake3
-          - xrootd-version: 4.9.1
-            cmake: cmake3
-          - xrootd-version: 4.11.3
-            cmake: cmake
-          - xrootd-version: 4.12.2
-            cmake: cmake
-          - xrootd-version: 4.12.7
-            cmake: cmake3
+        # empty string "" is for latest
+        xrootd-version: [
+          5.5.5,
+          5.6.1,
+          5.6.2,
+          5.6.7,
+          ""
+        ]
 
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
       - name: Build Docker image
-        run: docker build -t xrootd --build-arg xrootd_version=$XROOTD_VERSION --build-arg cmake=$CMAKE --progress=plain .
+        run: docker build -t xrootd --build-arg xrootd_version=$XROOTD_VERSION --progress=plain .
         env:
           XROOTD_VERSION: ${{ matrix.xrootd-version }}
-          CMAKE: ${{ matrix.cmake }}
 
       - name: Run tests
         run: docker run -h xrootdpyfs -t xrootd

{xrootdpyfs-0.2.2 → xrootdpyfs-2.0.0}/CHANGES

@@ -1,6 +1,22 @@
 Changes
 =======
 
+Version 2.0.0 (released 2024-02-14)
+
+- stable release
+- fs: align error code changes (3005, 3018) to comply with
+      https://github.com/xrootd/xrootd/commit/3715a81a5807a2fd2aee5dbbcd2aac1a74d5acc6
+
+Version 2.0.0a1 (released 2023-05-03)
+
+- upgrade xrootd to version 5.
+- fix testing xrootd responses
+
+Version 1.0.0a1 (released 2023-04-19)
+
+- Upgrade pyfs to version 2.
+- Improve module's files organization and code formatting.
+
 Version 0.2.2 (released 2021-12-13)
 
 - Supports `xrootd@4.12.7`

xrootdpyfs-2.0.0/CONTRIBUTING.rst

@@ -0,0 +1,39 @@
+Contributing
+============
+
+Bug reports, feature requests, and other contributions are welcome.
+If you find a demonstrable problem that is caused by the code of this
+library, please:
+
+1. Search for `already reported problems
+   <https://github.com/inveniosoftware/xrootdpyfs/issues>`_.
+2. Check if the issue has been fixed or is still reproducible on the
+   latest `master` branch.
+3. Create an issue with **a test case**.
+
+If you create a feature branch, you can run the tests to ensure everything is
+operating correctly. The easiest is to run the tests using Docker:
+
+.. code-block:: console
+
+    $ docker build -t xrootd .
+    $ docker run -h xrootdpyfs -it xrootd
+
+You can also run the tests locally:
+
+.. code-block:: console
+
+    $ ./run-tests.sh
+
+You will however need to start a local XRootD server, e.g.:
+
+.. code-block:: console
+
+    $ xrootd -b -l /dev/null /tmp <tmpfolder>
+
+where, ``<tmpfolder>`` is dependent on your system (e.g. on OS X it is
+``/var/folders``, while on Linux it can be left empty).
+
+.. note::
+   XRootD have issues with Docker's default hostname, thus it is important to
+   supply a host name to ``docker run`` via the ``-h`` option.

xrootdpyfs-2.0.0/MANIFEST.in

@@ -0,0 +1,28 @@
+# This file is part of xrootdpyfs
+# Copyright (C) 2015-2023 CERN.
+#
+# xrootdpyfs is free software; you can redistribute it and/or modify it under the
+# terms of the Revised BSD License; see LICENSE file for more details.
+
+exclude .coveragerc
+exclude Dockerfile
+include .dockerignore
+include .editorconfig
+include .tx/config
+include *.rst
+include *.sh
+include *.txt
+include CHANGES
+include LICENSE
+prune docs/_build
+recursive-include docs *.bat
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+recursive-include tests *.py
+recursive-include tests *.html
+recursive-include tests *.dat
+recursive-include tests *.txt
+recursive-include .github/workflows *.yml
+include .git-blame-ignore-revs

xrootdpyfs-2.0.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: xrootdpyfs
+Version: 2.0.0
+Summary: XRootDPyFS is a PyFilesystem interface for XRootD.
+Home-page: https://github.com/inveniosoftware/xrootdpyfs
+Author: CERN
+Author-email: info@inveniosoftware.org
+License: BSD
+Keywords: xrootdpyfs
+Platform: any
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Topic :: Utilities
+Requires-Python: >=3.6
+Provides-Extra: tests
+License-File: LICENSE
+License-File: AUTHORS
+
+============
+ XRootDPyFS
+============
+
+.. image:: https://github.com/inveniosoftware/xrootdpyfs/actions?query=workflow%3ACI.svg?branch=master
+    :target: https://github.com/inveniosoftware/xrootdpyfs/actions?query=workflow%3ACI
+.. image:: https://coveralls.io/repos/inveniosoftware/xrootdpyfs/badge.svg?branch=master
+    :target: https://coveralls.io/r/inveniosoftware/xrootdpyfs
+.. image:: https://pypip.in/v/xrootdpyfs/badge.svg
+   :target: https://crate.io/packages/xrootdpyfs/
+
+
+XRootDPyFS is a PyFilesystem interface to XRootD.
+
+XRootD protocol aims at giving high performance, scalable fault tolerant access
+to data repositories of many kinds. The XRootDPyFS adds a high-level interface
+on top of the existing Python interface (pyxrootd) and makes it easy to e.g.
+copy a directory in parallel or recursively remove a directory.
+
+Further documentation is available on https://xrootdpyfs.readthedocs.io/.
+
+Getting started
+===============
+
+If you just want to try out the library, the easiest is to use Docker.
+
+Build the image:
+
+.. code-block:: console
+
+   $ docker build --platform linux/amd64 -t xrootd .
+
+Run the container and launch `xrootd`:
+
+.. code-block:: console
+
+   $ docker run --platform linux/amd64 -h xrootdpyfs -it xrootd bash
+
+You will see the logs in the stdout. Next, in another shell, connect the container
+and fire up an ipython shell:
+
+.. code-block:: console
+
+   $ docker ps  # find the container id
+   $ docker exec -it <container-id> bash
+   [xrootdpyfs@xrootdpyfs code]$ ipython
+
+
+Quick examples
+--------------
+
+Here is a quick example of a file listing with the xrootd PyFilesystem
+integration:
+
+    >>> from xrootdpyfs import XRootDPyFS
+    >>> fs = XRootDPyFS("root://localhost//tmp/")
+    >>> fs.listdir("xrootdpyfs")
+    ['test.txt']
+
+Or, alternatively using the PyFilesystem opener (note the first
+``import xrootdpyfs`` is required to ensure the XRootDPyFS opener is registered):
+
+    >>> import xrootdpyfs
+    >>> from fs.opener import open_fs
+    >>> fs = open_fs("root://localhost//tmp/")
+    >>> fs.listdir("xrootdpyfs")
+    ['test.txt']
+
+Reading files:
+
+    >>> f = fs.open("xrootdpyfs/test.txt")
+    >>> f.read()
+    b'Hello XRootD!\n'
+    >>> f.close()
+
+Reading files using the ``readtext()`` method:
+
+    >>> fs.readtext("xrootdpyfs/test.txt")
+    b'Hello XRootD!\n'
+
+Writing files:
+
+    >>> f = fs.open("xrootdpyfs/hello.txt", "w+")
+    >>> f.write("World")
+    >>> f.close()
+
+Writing files using the ``writetext()`` method:
+
+    >>> fs.writetext("xrootdpyfs/test.txt", "World")
+
+Development
+===========
+
+The easiest way to develop is to build the Docker image and mount
+the source code as a volume to test any code modification with a
+running XRootD server:
+
+.. code-block:: console
+
+   $ docker build --platform linux/amd64 -t xrootd --progress=plain .
+   $ docker run --platform linux/amd64 -h xrootdpyfs -it -v <absolute path to this project>:/code xrootd bash
+   [xrootdpyfs@xrootdpyfs code]$ xrootd
+
+In another shell:
+
+.. code-block:: console
+
+   $ docker ps  # find the container id
+   $ docker exec -it <container-id> bash
+   [xrootdpyfs@xrootdpyfs code]$ python -m pytest -vvv tests
+
+If you want to test a specific version of xrootd, run:
+
+.. code-block:: console
+
+   $ docker build --platform linux/amd64 --build-arg xrootd_version=4.12.7 -t xrootd --progress=plain .
+
+Documentation
+=============
+Documentation is available at <http://xrootdpyfs.readthedocs.io/> or can be
+build using Sphinx::
+
+    pip install Sphinx
+    python setup.py build_sphinx
+
+Testing
+=======
+Running the tests are most easily done using docker:
+
+.. code-block:: console
+
+    $ docker build --platform linux/amd64 -t xrootd . && docker run --platform linux/amd64 -h xrootdpyfs -it xrootd
+
+

{xrootdpyfs-0.2.2 → xrootdpyfs-2.0.0}/README.rst

@@ -24,16 +24,25 @@ Getting started
 
 If you just want to try out the library, the easiest is to use Docker.
 
+Build the image:
+
+.. code-block:: console
+
+   $ docker build --platform linux/amd64 -t xrootd .
+
+Run the container and launch `xrootd`:
+
 .. code-block:: console
 
-   $ docker build -t xrootd .
-   $ docker run -h xrootdpyfs -it xrootd bash
+   $ docker run --platform linux/amd64 -h xrootdpyfs -it xrootd bash
 
-Next, start a XRootD server in the container and fire up an ipython shell:
+You will see the logs in the stdout. Next, in another shell, connect the container
+and fire up an ipython shell:
 
 .. code-block:: console
 
-   [xrootdpyfs@xrootdpyfs code]$ xrootd -b -l /dev/null
+   $ docker ps  # find the container id
+   $ docker exec -it <container-id> bash
    [xrootdpyfs@xrootdpyfs code]$ ipython
 
 
@@ -52,8 +61,8 @@ Or, alternatively using the PyFilesystem opener (note the first
 ``import xrootdpyfs`` is required to ensure the XRootDPyFS opener is registered):
 
     >>> import xrootdpyfs
-    >>> from fs.opener import opener
-    >>> fs, path = opener.parse("root://localhost//tmp/")
+    >>> from fs.opener import open_fs
+    >>> fs = open_fs("root://localhost//tmp/")
     >>> fs.listdir("xrootdpyfs")
     ['test.txt']
 
@@ -64,9 +73,9 @@ Reading files:
     b'Hello XRootD!\n'
     >>> f.close()
 
-Reading files using the ``getcontents()`` method:
+Reading files using the ``readtext()`` method:
 
-    >>> fs.getcontents("xrootdpyfs/test.txt")
+    >>> fs.readtext("xrootdpyfs/test.txt")
     b'Hello XRootD!\n'
 
 Writing files:
@@ -75,9 +84,9 @@ Writing files:
     >>> f.write("World")
     >>> f.close()
 
-Writing files using the ``setcontents()`` method:
+Writing files using the ``writetext()`` method:
 
-    >>> fs.setcontents("xrootdpyfs/test.txt", "World")
+    >>> fs.writetext("xrootdpyfs/test.txt", "World")
 
 Development
 ===========
@@ -88,15 +97,23 @@ running XRootD server:
 
 .. code-block:: console
 
-   $ docker build -t xrootd --progress=plain .
-   $ docker run -h xrootdpyfs -it -v <absolute path to this project>:/code xrootd bash
-   [xrootdpyfs@xrootdpyfs code]$ xrootd -b -l /dev/null
+   $ docker build --platform linux/amd64 -t xrootd --progress=plain .
+   $ docker run --platform linux/amd64 -h xrootdpyfs -it -v <absolute path to this project>:/code xrootd bash
+   [xrootdpyfs@xrootdpyfs code]$ xrootd
+
+In another shell:
+
+.. code-block:: console
+
+   $ docker ps  # find the container id
+   $ docker exec -it <container-id> bash
+   [xrootdpyfs@xrootdpyfs code]$ python -m pytest -vvv tests
 
 If you want to test a specific version of xrootd, run:
 
 .. code-block:: console
 
-   $ docker build --build-arg xrootd_version=4.8.5 -t xrootd --progress=plain .
+   $ docker build --platform linux/amd64 --build-arg xrootd_version=4.12.7 -t xrootd --progress=plain .
 
 Documentation
 =============
@@ -112,4 +129,4 @@ Running the tests are most easily done using docker:
 
 .. code-block:: console
 
-    $ docker build -t xrootd . && docker run -h xrootdpyfs -it xrootd
+    $ docker build --platform linux/amd64 -t xrootd . && docker run --platform linux/amd64 -h xrootdpyfs -it xrootd