PyLD 2.0.4__tar.gz → 3.0.0__tar.gz

{PyLD-2.0.4 → pyld-3.0.0}/CHANGELOG.md

@@ -1,5 +1,47 @@
 # pyld ChangeLog
 
+## 3.0.0 - 2026-04-02
+
+### Changed
+- **BREAKING**: Require supported Python version >= 3.10.
+- Update aiohttp document loader to work with Python 3.14.
+  - Minimize async related changes to library code in this release.
+  - In sync environment use `asyncio.run`.
+  - In async environment use background thread.
+- The default test manifests or directories now default to the
+  `./specifications` directory.
+- Add ability to run test suites using pytest and make pytest the default way 
+  for running (unit)tests.
+- The functionality to resolve relative IRIs to absolute IRIs has been moved 
+  from `context_resolver.py` to `iri_resolver.py` so it can be maintained 
+  and tested separately.
+  - Migrate the `prepend_base(base, iri)` function to the `resolve(iri, base)` 
+    function.
+  - Move the existing function `remove_dot_segments(path)` and update the 
+    implementation.
+  - Migrate the `remove_base(base, iri)` function to the `unresolve(iri, base)` 
+    function and update the implementation to use stdlib `urllib.parse` and 
+    `urllib.unparse` to replace the custom implementation.
+  - Update code to use `resolve(iri, base)` and `unresolve(iri, base)` instead.
+    Invalid base IRIs (including `None`) are no longer allowed, hence missing 
+    base IRIs in the  JSON-LD context are now handled outside the function call.
+  - Add unittests
+- **BREAKING**: the custom `cause` and `traceback` attributes on `JsonLdError` 
+  are replaced by Python [exception chaining](https://peps.python.org/pep-3134/) 
+  and the built-in `__cause__` attribute.
+- **BREAKING**: The `IdentifierIssuer` class was moved to `identifier_issuer.py`. 
+  It's now available at `pyld.identifier_issuer`.
+- **BREAKING**: The classes `URDNA2015` and `URGNA2012` were moved to `canon.py`. 
+  They are now available at `pyld.canon`. 
+- `jsonld.expand()` now accepts a `on_property_dropped` parameter which is a handler
+  called on every ignored JSON property.
+- **BREAKING**: In cases where there is no document base (for instance, when 
+  using a string as input), 'http://example.org/base/' is used as the base IRI 
+  when `@base` is absent or explicitely set to `null`.
+- **BREAKING**: Some internal parameters were renamed from camelCase to pythonic:
+  - `requestProfile` to `request_profile` in `load_document()` 
+  - `rdfDirection` to `rdf_direction` in `_list_to_rdf()` and `_object_to_rdf()` 
+
 ## 2.0.4 - 2024-02-16
 
 ### Fixed

pyld-3.0.0/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2011-2025 Digital Bazaar, Inc.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+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.

{PyLD-2.0.4/lib/PyLD.egg-info → pyld-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: PyLD
-Version: 2.0.4
+Version: 3.0.0
 Summary: Python implementation of the JSON-LD API
 Home-page: https://github.com/digitalbazaar/pyld
 Author: Digital Bazaar
@@ -15,6 +15,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Topic :: Internet
 Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: cachetools
 Requires-Dist: frozendict
@@ -27,6 +28,17 @@ Provides-Extra: cachetools
 Requires-Dist: cachetools; extra == "cachetools"
 Provides-Extra: frozendict
 Requires-Dist: frozendict; extra == "frozendict"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 PyLD
 ====
@@ -89,7 +101,7 @@ yet supported.
 Requirements
 ------------
 
-- Python_ (3.6 or later)
+- Python_ (3.10 or later)
 - Requests_ (optional)
 - aiohttp_ (optional, Python 3.5 or later)
 
@@ -200,6 +212,23 @@ If Requests_ is not available, the loader is set to aiohttp_. The fallback
 document loader is a dummy document loader that raises an exception on every
 invocation.
 
+Handling ignored properties during JSON-LD expansion
+----------------------------------------------------
+
+If a property in a JSON-LD document does not map to an absolute IRI then it is 
+ignored. You can customize this behaviour by passing a customizable handler to 
+`on_property_dropped` parameter of `jsonld.expand()`.
+
+For example, you can introduce a strict mode by raising a ValueError on every 
+dropped property:
+
+.. code-block:: Python
+
+   def raise_this(value):
+       raise ValueError(value)
+
+   jsonld.expand(doc, None, on_property_dropped=raise_this)
+
 Commercial Support
 ------------------
 
@@ -220,24 +249,92 @@ Tests
 This library includes a sample testing utility which may be used to verify
 that changes to the processor maintain the correct output.
 
-To run the sample tests you will need to get the test suite files by cloning
+To run the sample tests you will need to get the test suite files, which 
+by default, are stored in the `specifications/` folder.
+The test suites can be obtained by either using git submodules or by cloning 
+them manually.
+
+Using git submodules
+####################
+
+The test suites are included as git submodules to ensure versions are in sync.  
+When cloning the repository, use the ``--recurse-submodules`` flag to
+automatically clone the submodules.
+If you have cloned the repository without the submodules, you can initialize 
+them with the following commands:
+
+.. code-block:: bash
+
+    git submodule init
+    git submodule update
+
+Cloning manually
+####################
+
+You can also avoid using git submodules by manually cloning
 the ``json-ld-api``, ``json-ld-framing``, and ``normalization`` repositories
-hosted on GitHub:
+hosted on GitHub using the following commands:
+
+.. code-block:: bash
+
+    git clone https://github.com/w3c/json-ld-api ./specifications/json-ld-api
+    git clone https://github.com/w3c/json-ld-framing ./specifications/json-ld-framing
+    git clone https://github.com/json-ld/normalization ./specifications/normalization
+
+Note that you can clone these repositories into any location you wish; however,
+if you do not clone them into the default ``specifications/`` folder, you will
+need to provide the paths to the test runner as arguments when running the 
+tests, as explained below
+
+Running the sample test suites and unittests using pytest
+#########################################################
+
+If the suites repositories are available in the `specifications/` folder of the 
+PyLD source directory, then all unittests, including the sample test suites, 
+can be run with `pytest`:
 
-- https://github.com/w3c/json-ld-api
-- https://github.com/w3c/json-ld-framing
-- https://github.com/json-ld/normalization
+.. code-block:: bash
+
+    pytest 
+
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld``
+files or directories containing a ``manifest.jsonld``, then you can supply
+these files or directories as arguments:
+
+.. code-block:: bash
+
+    # use: pytest --tests=TEST_PATH [--tests=TEST_PATH...]
+    pytest --tests=./specifications/json-ld-api/tests
+
+The test runner supports different document loaders by setting 
+``--loader requests`` or ``--loader aiohttp``. The default document loader is
+set to Requests_.
+
+.. code-block:: bash
+    
+    pytest --loader=requests --tests=./specifications/json-ld-api/tests
+
+An EARL report can be generated using the ``--earl`` option.
 
-If the suites repositories are available as sibling directories of the PyLD
-source directory, then all the tests can be run with the following:
+.. code-block:: bash
+
+    pytest --earl=./earl-report.json
+
+Running the sample test suites using the original test runner
+#############################################################
+
+You can also run the JSON-LD test suites using the original test runner script
+provided:
 
 .. code-block:: bash
 
     python tests/runtests.py
 
-If you want to test individual manifest ``.jsonld`` files or directories
-containing a ``manifest.jsonld``, then you can supply these files or
-directories as arguments:
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld``
+files or directories containing a ``manifest.jsonld``, then you can supply 
+these files or directories as arguments:
 
 .. code-block:: bash
 
@@ -246,8 +343,16 @@ directories as arguments:
 The test runner supports different document loaders by setting ``-l requests``
 or ``-l aiohttp``. The default document loader is set to Requests_.
 
+.. code-block:: bash
+
+    python tests/runtests.py -l requests ./specifications/json-ld-api/tests
+
 An EARL report can be generated using the ``-e`` or ``--earl`` option.
 
+.. code-block:: bash
+
+    python tests/runtests.py -e ./earl-report.json
+
 
 .. _Digital Bazaar: https://digitalbazaar.com/
 

{PyLD-2.0.4 → pyld-3.0.0}/README.rst

@@ -59,7 +59,7 @@ yet supported.
 Requirements
 ------------
 
-- Python_ (3.6 or later)
+- Python_ (3.10 or later)
 - Requests_ (optional)
 - aiohttp_ (optional, Python 3.5 or later)
 
@@ -170,6 +170,23 @@ If Requests_ is not available, the loader is set to aiohttp_. The fallback
 document loader is a dummy document loader that raises an exception on every
 invocation.
 
+Handling ignored properties during JSON-LD expansion
+----------------------------------------------------
+
+If a property in a JSON-LD document does not map to an absolute IRI then it is 
+ignored. You can customize this behaviour by passing a customizable handler to 
+`on_property_dropped` parameter of `jsonld.expand()`.
+
+For example, you can introduce a strict mode by raising a ValueError on every 
+dropped property:
+
+.. code-block:: Python
+
+   def raise_this(value):
+       raise ValueError(value)
+
+   jsonld.expand(doc, None, on_property_dropped=raise_this)
+
 Commercial Support
 ------------------
 
@@ -190,24 +207,92 @@ Tests
 This library includes a sample testing utility which may be used to verify
 that changes to the processor maintain the correct output.
 
-To run the sample tests you will need to get the test suite files by cloning
+To run the sample tests you will need to get the test suite files, which 
+by default, are stored in the `specifications/` folder.
+The test suites can be obtained by either using git submodules or by cloning 
+them manually.
+
+Using git submodules
+####################
+
+The test suites are included as git submodules to ensure versions are in sync.  
+When cloning the repository, use the ``--recurse-submodules`` flag to
+automatically clone the submodules.
+If you have cloned the repository without the submodules, you can initialize 
+them with the following commands:
+
+.. code-block:: bash
+
+    git submodule init
+    git submodule update
+
+Cloning manually
+####################
+
+You can also avoid using git submodules by manually cloning
 the ``json-ld-api``, ``json-ld-framing``, and ``normalization`` repositories
-hosted on GitHub:
+hosted on GitHub using the following commands:
+
+.. code-block:: bash
+
+    git clone https://github.com/w3c/json-ld-api ./specifications/json-ld-api
+    git clone https://github.com/w3c/json-ld-framing ./specifications/json-ld-framing
+    git clone https://github.com/json-ld/normalization ./specifications/normalization
+
+Note that you can clone these repositories into any location you wish; however,
+if you do not clone them into the default ``specifications/`` folder, you will
+need to provide the paths to the test runner as arguments when running the 
+tests, as explained below
+
+Running the sample test suites and unittests using pytest
+#########################################################
+
+If the suites repositories are available in the `specifications/` folder of the 
+PyLD source directory, then all unittests, including the sample test suites, 
+can be run with `pytest`:
 
-- https://github.com/w3c/json-ld-api
-- https://github.com/w3c/json-ld-framing
-- https://github.com/json-ld/normalization
+.. code-block:: bash
+
+    pytest 
+
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld``
+files or directories containing a ``manifest.jsonld``, then you can supply
+these files or directories as arguments:
+
+.. code-block:: bash
+
+    # use: pytest --tests=TEST_PATH [--tests=TEST_PATH...]
+    pytest --tests=./specifications/json-ld-api/tests
+
+The test runner supports different document loaders by setting 
+``--loader requests`` or ``--loader aiohttp``. The default document loader is
+set to Requests_.
+
+.. code-block:: bash
+    
+    pytest --loader=requests --tests=./specifications/json-ld-api/tests
+
+An EARL report can be generated using the ``--earl`` option.
 
-If the suites repositories are available as sibling directories of the PyLD
-source directory, then all the tests can be run with the following:
+.. code-block:: bash
+
+    pytest --earl=./earl-report.json
+
+Running the sample test suites using the original test runner
+#############################################################
+
+You can also run the JSON-LD test suites using the original test runner script
+provided:
 
 .. code-block:: bash
 
     python tests/runtests.py
 
-If you want to test individual manifest ``.jsonld`` files or directories
-containing a ``manifest.jsonld``, then you can supply these files or
-directories as arguments:
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld``
+files or directories containing a ``manifest.jsonld``, then you can supply 
+these files or directories as arguments:
 
 .. code-block:: bash
 
@@ -216,8 +301,16 @@ directories as arguments:
 The test runner supports different document loaders by setting ``-l requests``
 or ``-l aiohttp``. The default document loader is set to Requests_.
 
+.. code-block:: bash
+
+    python tests/runtests.py -l requests ./specifications/json-ld-api/tests
+
 An EARL report can be generated using the ``-e`` or ``--earl`` option.
 
+.. code-block:: bash
+
+    python tests/runtests.py -e ./earl-report.json
+
 
 .. _Digital Bazaar: https://digitalbazaar.com/
 

{PyLD-2.0.4 → pyld-3.0.0}/README.txt

@@ -59,7 +59,7 @@ yet supported.
 Requirements
 ------------
 
-- Python_ (3.6 or later)
+- Python_ (3.10 or later)
 - Requests_ (optional)
 - aiohttp_ (optional, Python 3.5 or later)
 
@@ -170,6 +170,23 @@ If Requests_ is not available, the loader is set to aiohttp_. The fallback
 document loader is a dummy document loader that raises an exception on every
 invocation.
 
+Handling ignored properties during JSON-LD expansion
+----------------------------------------------------
+
+If a property in a JSON-LD document does not map to an absolute IRI then it is 
+ignored. You can customize this behaviour by passing a customizable handler to 
+`on_property_dropped` parameter of `jsonld.expand()`.
+
+For example, you can introduce a strict mode by raising a ValueError on every 
+dropped property:
+
+.. code-block:: Python
+
+   def raise_this(value):
+       raise ValueError(value)
+
+   jsonld.expand(doc, None, on_property_dropped=raise_this)
+
 Commercial Support
 ------------------
 
@@ -190,24 +207,92 @@ Tests
 This library includes a sample testing utility which may be used to verify
 that changes to the processor maintain the correct output.
 
-To run the sample tests you will need to get the test suite files by cloning
+To run the sample tests you will need to get the test suite files, which 
+by default, are stored in the `specifications/` folder.
+The test suites can be obtained by either using git submodules or by cloning 
+them manually.
+
+Using git submodules
+####################
+
+The test suites are included as git submodules to ensure versions are in sync.  
+When cloning the repository, use the ``--recurse-submodules`` flag to
+automatically clone the submodules.
+If you have cloned the repository without the submodules, you can initialize 
+them with the following commands:
+
+.. code-block:: bash
+
+    git submodule init
+    git submodule update
+
+Cloning manually
+####################
+
+You can also avoid using git submodules by manually cloning
 the ``json-ld-api``, ``json-ld-framing``, and ``normalization`` repositories
-hosted on GitHub:
+hosted on GitHub using the following commands:
+
+.. code-block:: bash
+
+    git clone https://github.com/w3c/json-ld-api ./specifications/json-ld-api
+    git clone https://github.com/w3c/json-ld-framing ./specifications/json-ld-framing
+    git clone https://github.com/json-ld/normalization ./specifications/normalization
+
+Note that you can clone these repositories into any location you wish; however,
+if you do not clone them into the default ``specifications/`` folder, you will
+need to provide the paths to the test runner as arguments when running the 
+tests, as explained below
+
+Running the sample test suites and unittests using pytest
+#########################################################
+
+If the suites repositories are available in the `specifications/` folder of the 
+PyLD source directory, then all unittests, including the sample test suites, 
+can be run with `pytest`:
 
-- https://github.com/w3c/json-ld-api
-- https://github.com/w3c/json-ld-framing
-- https://github.com/json-ld/normalization
+.. code-block:: bash
+
+    pytest 
+
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld``
+files or directories containing a ``manifest.jsonld``, then you can supply
+these files or directories as arguments:
+
+.. code-block:: bash
+
+    # use: pytest --tests=TEST_PATH [--tests=TEST_PATH...]
+    pytest --tests=./specifications/json-ld-api/tests
+
+The test runner supports different document loaders by setting 
+``--loader requests`` or ``--loader aiohttp``. The default document loader is
+set to Requests_.
+
+.. code-block:: bash
+    
+    pytest --loader=requests --tests=./specifications/json-ld-api/tests
+
+An EARL report can be generated using the ``--earl`` option.
 
-If the suites repositories are available as sibling directories of the PyLD
-source directory, then all the tests can be run with the following:
+.. code-block:: bash
+
+    pytest --earl=./earl-report.json
+
+Running the sample test suites using the original test runner
+#############################################################
+
+You can also run the JSON-LD test suites using the original test runner script
+provided:
 
 .. code-block:: bash
 
     python tests/runtests.py
 
-If you want to test individual manifest ``.jsonld`` files or directories
-containing a ``manifest.jsonld``, then you can supply these files or
-directories as arguments:
+If you wish to store the test suites in a different location than the default
+``specifications/`` folder, or you want to test individual manifest ``.jsonld``
+files or directories containing a ``manifest.jsonld``, then you can supply 
+these files or directories as arguments:
 
 .. code-block:: bash
 
@@ -216,8 +301,16 @@ directories as arguments:
 The test runner supports different document loaders by setting ``-l requests``
 or ``-l aiohttp``. The default document loader is set to Requests_.
 
+.. code-block:: bash
+
+    python tests/runtests.py -l requests ./specifications/json-ld-api/tests
+
 An EARL report can be generated using the ``-e`` or ``--earl`` option.
 
+.. code-block:: bash
+
+    python tests/runtests.py -e ./earl-report.json
+
 
 .. _Digital Bazaar: https://digitalbazaar.com/