pelican-webdav-client 0.1.0__tar.gz

pelican_webdav_client-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+build/
+dist/
+*.egg-info/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+.venv/
+uv.lock

pelican_webdav_client-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# Copyright (C) 2026, Pelican Project, Morgridge Institute for Research
+
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+
+#    http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c  # frozen: v6.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 25bcf95026b96e2dd3c0aec3090c3d6ef6ca2e6c  # frozen: v0.17.3
+    hooks:
+    -   id: ruff-check
+        args: ["--fix"]
+    -   id: ruff-format
+-   repo: https://github.com/RobertCraigie/pyright-python
+    rev: 1aa6dfeb849ae43fb6f16fc17228bcbd358a19c3  # frozen: v1.1.414
+    hooks:
+    -   id: pyright
+        pass_filenames: false
+        additional_dependencies:
+          - aiohttp
+-   repo: https://github.com/zizmorcore/zizmor-pre-commit
+    rev: c92afdf2c6ca336aaa8f39e2bd8d48f62dbd8e1f  # frozen: v1.31.1
+    hooks:
+    -   id: zizmor
+        files: "^\\.github"
+        args: [--persona=pedantic]
+
+# Global exclusion for all hooks: a scratch example against a live federation
+exclude: ^example_test\.py$

pelican_webdav_client-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pelican_webdav_client-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.5
+Name: pelican-webdav-client
+Version: 0.1.0
+Summary: A PROPFIND-only asynchronous WebDAV client for the Pelican Platform
+Project-URL: Source, https://github.com/PelicanPlatform/pelican-webdav-client
+Project-URL: Pelican-Source, https://github.com/PelicanPlatform/pelican
+Project-URL: Bug-Reports, https://github.com/PelicanPlatform/pelican-webdav-client/issues
+Author-email: Pelican Platform Developers <info@pelicanplatform.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: aiohttp,pelican,propfind,webdav
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: aiohttp<4,>=3.9.4
+Description-Content-Type: text/markdown
+
+# pelican-webdav-client
+
+An asynchronous WebDAV client for the [Pelican Platform](https://github.com/PelicanPlatform/pelican) that speaks `PROPFIND` and nothing else.
+
+It exists to serve [PelicanFS](https://github.com/PelicanPlatform/pelicanfs), which uses WebDAV only to list collections and to tell objects from collections. It does not upload, download, copy, move, delete or lock anything. If you need those, use a general-purpose WebDAV client.
+
+- Built on `aiohttp`, with no other runtime dependencies
+- XML is parsed with the standard library, and documents that carry a DTD are rejected
+- Requires Python 3.11 or later
+- Fully typed (`py.typed`)
+
+## Installation
+
+```sh
+pip install pelican-webdav-client
+```
+
+## Quick start
+
+```python
+import asyncio
+
+from pelican_webdav_client import Client, NotFoundError
+
+
+async def main() -> None:
+    async with Client("https://origin.example.org", token="...") as client:
+        for resource in await client.list("/namespace/collection"):
+            print(resource.name, resource.is_collection, resource.size, resource.modified)
+
+        try:
+            info = await client.stat("/namespace/collection/file.txt")
+        except NotFoundError:
+            print("no such object")
+        else:
+            print(info.path, info.size, info.content_type)
+
+
+asyncio.run(main())
+```
+
+## The client
+
+```python
+Client(
+    base_url: str,
+    *,
+    token: str | None = None,
+    ssl: bool | ssl.SSLContext = True,
+    session: aiohttp.ClientSession | None = None,
+    timeout: aiohttp.ClientTimeout | None = None,
+)
+```
+
+| Argument   | Meaning |
+|------------|---------|
+| `base_url` | The server, as an absolute URL, plus any path prefix the resources live under. |
+| `token`    | Sent as `Authorization: Bearer <token>` on every request. |
+| `ssl`      | Passed to aiohttp unchanged: `True` verifies certificates, `False` skips verification, or pass your own `ssl.SSLContext` (for example, one that trusts a private CA). |
+| `session`  | An aiohttp session to send requests through. If you pass one in, you own it and the client leaves it open. If you don't, the client creates its own on first use and closes it in `close()`. |
+| `timeout`  | An `aiohttp.ClientTimeout` for each request. Defaults to the session's timeout. |
+
+`Client` is an async context manager, and leaving the `async with` block calls `close()`.
+
+### Methods
+
+| Method | Returns | What it does |
+|--------|---------|--------------|
+| `list(path)` | `list[Resource]` | The members of the collection at `path`, without the collection itself. Sends `Depth: 1` to the collection's slash form, so a trailing slash on `path` is optional. |
+| `stat(path)` | `Resource` | What the server says about the resource at `path`. Raises `NotFoundError` on a 404, and also when the reply doesn't describe `path`. |
+| `is_collection(path)` | `bool` | Shorthand for `(await stat(path)).is_collection`. |
+| `exists(path)` | `bool` | Judged from the status code alone: a 404 gives `False`, any success gives `True`, and any other error raises. Unlike `stat`, it doesn't care what the body says. |
+| `propfind(path, *, depth=0)` | `list[Resource]` | The raw result: every resource the server describes in the reply, including the target itself. `depth` is `0`, `1` or `"infinity"`. |
+| `url(path)` | `yarl.URL` | The URL a request for `path` is sent to. |
+
+Every method reads or releases its response before it returns or raises, so the client never holds a connection open between calls.
+
+### Paths
+
+- **Paths go in decoded.** Pass paths as the server should see them, and the client percent-encodes them. `"a b"` is sent as `a%20b`, and a `%` in a path is a literal percent sign (`"100%"` is sent as `100%25`). A missing leading slash is added for you.
+- **Paths are relative to `base_url`.** The client adds `base_url`'s path prefix to each request and strips it from each `Resource.path` it returns. If you root the client at an origin's data endpoint, you can work entirely in namespace paths. A resource the server reports outside the prefix keeps its full path.
+- **Trailing slashes matter.** Pelican origins answer a collection's slash form and reject an object's. `stat`, `exists`, `is_collection` and `propfind` send `path` exactly as given, while `list` always adds the slash.
+- **Redirects are followed.** The reply is matched against the URL that finally answered, so a server that redirects one form of a URL to another still gets a correct `stat` or `list`.
+
+## `Resource`
+
+A frozen dataclass describing one entry in a `PROPFIND` reply.
+
+| Field | Type | Notes |
+|-------|------|-------|
+| `path` | `str` | Decoded and relative to `base_url`. Collections end in `/` and nothing else does. |
+| `name` | `str` | The final path component, or `""` for the root (a property). |
+| `is_collection` | `bool` | From `DAV:resourcetype`. |
+| `size` | `int \| None` | From `DAV:getcontentlength`. It is always `None` for a collection, and `None` when the server sent no usable length. |
+| `modified` | `datetime \| None` | From `DAV:getlastmodified`, as a timezone-aware datetime. RFC 1123 and ISO 8601 dates are both accepted, and a date with no zone is taken as UTC. |
+| `content_type` | `str \| None` | From `DAV:getcontenttype`. |
+
+The parser only reads properties from `propstat` blocks with a 2xx status. It accepts `href`s that are relative, path-absolute or full URLs.
+
+## Errors
+
+```
+WebDavError
+├── ResponseError            the server answered with a 4xx or 5xx status
+│   ├── UnauthorizedError    401
+│   ├── ForbiddenError       403
+│   ├── NotFoundError        404, or a stat() reply that doesn't describe the path
+│   └── MethodNotAllowedError 405
+└── InvalidResponseError     a successful reply whose body is not a DAV:multistatus document
+```
+
+A `ResponseError` has `method`, `url`, `status`, `reason` and `body` attributes (`body` is the decoded response body, where servers usually explain themselves). An `InvalidResponseError` has `method`, `url` and `message`.
+
+Transport failures such as refused connections, TLS errors and timeouts are not wrapped. They reach you as aiohttp's own exceptions.
+
+## Logging
+
+Requests and response statuses are logged at `DEBUG` level to the `pelican_webdav_client.client` logger. Tokens are never logged.
+
+## Development
+
+```sh
+git clone https://github.com/PelicanPlatform/pelican-webdav-client
+cd pelican-webdav-client
+python -m venv .venv && source .venv/bin/activate
+pip install -e . --group dev
+pytest
+```
+
+The tests run against a local [`pytest-httpserver`](https://github.com/csernazs/pytest-httpserver), so they need no network access and no Pelican federation. Pytest is set to fail on any warning, which means an unclosed session or connection fails the test that leaked it.
+
+Linting, formatting and type checking (ruff, pyright and zizmor for the workflows) run through pre-commit:
+
+```sh
+pre-commit install
+pre-commit run --all-files
+```
+
+CI runs the same hooks, then runs the test suite on Python 3.11 through 3.15 on Linux, and on 3.11 and 3.15 on macOS and Windows.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

pelican_webdav_client-0.1.0/README.md

@@ -0,0 +1,143 @@
+# pelican-webdav-client
+
+An asynchronous WebDAV client for the [Pelican Platform](https://github.com/PelicanPlatform/pelican) that speaks `PROPFIND` and nothing else.
+
+It exists to serve [PelicanFS](https://github.com/PelicanPlatform/pelicanfs), which uses WebDAV only to list collections and to tell objects from collections. It does not upload, download, copy, move, delete or lock anything. If you need those, use a general-purpose WebDAV client.
+
+- Built on `aiohttp`, with no other runtime dependencies
+- XML is parsed with the standard library, and documents that carry a DTD are rejected
+- Requires Python 3.11 or later
+- Fully typed (`py.typed`)
+
+## Installation
+
+```sh
+pip install pelican-webdav-client
+```
+
+## Quick start
+
+```python
+import asyncio
+
+from pelican_webdav_client import Client, NotFoundError
+
+
+async def main() -> None:
+    async with Client("https://origin.example.org", token="...") as client:
+        for resource in await client.list("/namespace/collection"):
+            print(resource.name, resource.is_collection, resource.size, resource.modified)
+
+        try:
+            info = await client.stat("/namespace/collection/file.txt")
+        except NotFoundError:
+            print("no such object")
+        else:
+            print(info.path, info.size, info.content_type)
+
+
+asyncio.run(main())
+```
+
+## The client
+
+```python
+Client(
+    base_url: str,
+    *,
+    token: str | None = None,
+    ssl: bool | ssl.SSLContext = True,
+    session: aiohttp.ClientSession | None = None,
+    timeout: aiohttp.ClientTimeout | None = None,
+)
+```
+
+| Argument   | Meaning |
+|------------|---------|
+| `base_url` | The server, as an absolute URL, plus any path prefix the resources live under. |
+| `token`    | Sent as `Authorization: Bearer <token>` on every request. |
+| `ssl`      | Passed to aiohttp unchanged: `True` verifies certificates, `False` skips verification, or pass your own `ssl.SSLContext` (for example, one that trusts a private CA). |
+| `session`  | An aiohttp session to send requests through. If you pass one in, you own it and the client leaves it open. If you don't, the client creates its own on first use and closes it in `close()`. |
+| `timeout`  | An `aiohttp.ClientTimeout` for each request. Defaults to the session's timeout. |
+
+`Client` is an async context manager, and leaving the `async with` block calls `close()`.
+
+### Methods
+
+| Method | Returns | What it does |
+|--------|---------|--------------|
+| `list(path)` | `list[Resource]` | The members of the collection at `path`, without the collection itself. Sends `Depth: 1` to the collection's slash form, so a trailing slash on `path` is optional. |
+| `stat(path)` | `Resource` | What the server says about the resource at `path`. Raises `NotFoundError` on a 404, and also when the reply doesn't describe `path`. |
+| `is_collection(path)` | `bool` | Shorthand for `(await stat(path)).is_collection`. |
+| `exists(path)` | `bool` | Judged from the status code alone: a 404 gives `False`, any success gives `True`, and any other error raises. Unlike `stat`, it doesn't care what the body says. |
+| `propfind(path, *, depth=0)` | `list[Resource]` | The raw result: every resource the server describes in the reply, including the target itself. `depth` is `0`, `1` or `"infinity"`. |
+| `url(path)` | `yarl.URL` | The URL a request for `path` is sent to. |
+
+Every method reads or releases its response before it returns or raises, so the client never holds a connection open between calls.
+
+### Paths
+
+- **Paths go in decoded.** Pass paths as the server should see them, and the client percent-encodes them. `"a b"` is sent as `a%20b`, and a `%` in a path is a literal percent sign (`"100%"` is sent as `100%25`). A missing leading slash is added for you.
+- **Paths are relative to `base_url`.** The client adds `base_url`'s path prefix to each request and strips it from each `Resource.path` it returns. If you root the client at an origin's data endpoint, you can work entirely in namespace paths. A resource the server reports outside the prefix keeps its full path.
+- **Trailing slashes matter.** Pelican origins answer a collection's slash form and reject an object's. `stat`, `exists`, `is_collection` and `propfind` send `path` exactly as given, while `list` always adds the slash.
+- **Redirects are followed.** The reply is matched against the URL that finally answered, so a server that redirects one form of a URL to another still gets a correct `stat` or `list`.
+
+## `Resource`
+
+A frozen dataclass describing one entry in a `PROPFIND` reply.
+
+| Field | Type | Notes |
+|-------|------|-------|
+| `path` | `str` | Decoded and relative to `base_url`. Collections end in `/` and nothing else does. |
+| `name` | `str` | The final path component, or `""` for the root (a property). |
+| `is_collection` | `bool` | From `DAV:resourcetype`. |
+| `size` | `int \| None` | From `DAV:getcontentlength`. It is always `None` for a collection, and `None` when the server sent no usable length. |
+| `modified` | `datetime \| None` | From `DAV:getlastmodified`, as a timezone-aware datetime. RFC 1123 and ISO 8601 dates are both accepted, and a date with no zone is taken as UTC. |
+| `content_type` | `str \| None` | From `DAV:getcontenttype`. |
+
+The parser only reads properties from `propstat` blocks with a 2xx status. It accepts `href`s that are relative, path-absolute or full URLs.
+
+## Errors
+
+```
+WebDavError
+├── ResponseError            the server answered with a 4xx or 5xx status
+│   ├── UnauthorizedError    401
+│   ├── ForbiddenError       403
+│   ├── NotFoundError        404, or a stat() reply that doesn't describe the path
+│   └── MethodNotAllowedError 405
+└── InvalidResponseError     a successful reply whose body is not a DAV:multistatus document
+```
+
+A `ResponseError` has `method`, `url`, `status`, `reason` and `body` attributes (`body` is the decoded response body, where servers usually explain themselves). An `InvalidResponseError` has `method`, `url` and `message`.
+
+Transport failures such as refused connections, TLS errors and timeouts are not wrapped. They reach you as aiohttp's own exceptions.
+
+## Logging
+
+Requests and response statuses are logged at `DEBUG` level to the `pelican_webdav_client.client` logger. Tokens are never logged.
+
+## Development
+
+```sh
+git clone https://github.com/PelicanPlatform/pelican-webdav-client
+cd pelican-webdav-client
+python -m venv .venv && source .venv/bin/activate
+pip install -e . --group dev
+pytest
+```
+
+The tests run against a local [`pytest-httpserver`](https://github.com/csernazs/pytest-httpserver), so they need no network access and no Pelican federation. Pytest is set to fail on any warning, which means an unclosed session or connection fails the test that leaked it.
+
+Linting, formatting and type checking (ruff, pyright and zizmor for the workflows) run through pre-commit:
+
+```sh
+pre-commit install
+pre-commit run --all-files
+```
+
+CI runs the same hooks, then runs the test suite on Python 3.11 through 3.15 on Linux, and on 3.11 and 3.15 on macOS and Windows.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

pelican_webdav_client-0.1.0/pyproject.toml

@@ -0,0 +1,109 @@
+[build-system]
+requires = ["hatchling >=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pelican-webdav-client"
+version = "0.1.0"
+description = "A PROPFIND-only asynchronous WebDAV client for the Pelican Platform"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Pelican Platform Developers", email = "info@pelicanplatform.org" }
+]
+keywords = ["pelican", "webdav", "propfind", "aiohttp"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+requires-python = ">=3.11"
+dependencies = [
+    "aiohttp >=3.9.4,<4",
+]
+
+[project.urls]
+Source = "https://github.com/PelicanPlatform/pelican-webdav-client"
+Pelican-Source = "https://github.com/PelicanPlatform/pelican"
+Bug-Reports = "https://github.com/PelicanPlatform/pelican-webdav-client/issues"
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/.github"]
+
+[dependency-groups]
+testing = [
+    "pytest>=9",
+    "pytest-httpserver",
+    "trustme",
+]
+dev = [{ include-group = "testing" }]
+
+[tool.uv]
+exclude-newer = "3 days"
+
+[tool.pytest]
+minversion = "9.0"
+addopts = ["-ra", "--showlocals", "--import-mode=importlib"]
+strict = true
+filterwarnings = ["error"]
+log_level = "INFO"
+testpaths = ["test"]
+
+[tool.ruff]
+line-length = 200
+# A scratch example against a live federation, not part of the package
+exclude = ["example_test.py"]
+show-fixes = true
+
+[tool.ruff.lint]
+extend-select = [
+    "E",    # pycodestyle errors
+    "F",    # pyflakes
+    "W",    # pycodestyle warnings
+    "ANN",  # flake8-annotations
+    "ARG",  # flake8-unused-arguments
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "EM",   # flake8-errmsg
+    "EXE",  # flake8-executable
+    "FURB", # refurb
+    "G",    # flake8-logging-format
+    "I",    # isort
+    "ICN",  # flake8-import-conventions
+    "ISC",  # flake8-implicit-str-concat
+    "LOG",  # flake8-logging
+    "PERF", # perflint
+    "PGH",  # pygrep-hooks
+    "PIE",  # flake8-pie
+    "PL",   # pylint
+    "PT",   # flake8-pytest-style
+    "PTH",  # flake8-use-pathlib
+    "RET",  # flake8-return
+    "RSE",  # flake8-raise
+    "RUF",  # Ruff-specific
+    "SIM",  # flake8-simplify
+    "T20",  # flake8-print
+    "UP",   # pyupgrade
+    "YTT",  # flake8-2020
+]
+ignore = [
+    "ANN401",  # The expat callbacks and the error "message" take whatever the caller hands them
+    "PLR09",   # Too many <...>
+    "PLR2004", # Magic value used in comparison
+]
+
+[tool.ruff.lint.flake8-unused-arguments]
+ignore-variadic-names = true
+
+[tool.ruff.lint.per-file-ignores]
+"test/**" = ["ANN", "ARG001", "PLC0415", "T20"]