PyLD 2.0.2__tar.gz → 2.0.4__tar.gz

{PyLD-2.0.2 → PyLD-2.0.4}/CHANGELOG.md

@@ -1,9 +1,20 @@
 # pyld ChangeLog
 
+## 2.0.4 - 2024-02-16
+
+### Fixed
+- Use explicit `None` or `False` for context checks. Fixes an issue while
+  framing with an empty context.
+
+## 2.0.3 - 2020-08-06
+
+### Fixed
+- Fix deprecation warnings due to invalid escape sequences.
+
 ## 2.0.2 - 2020-04-20
 
 ### Fixed
-* Fix inverse context cache indexing to use the uuid field.
+- Fix inverse context cache indexing to use the uuid field.
 
 ## 2.0.1 - 2020-04-15
 
@@ -20,116 +31,116 @@
   spec and some of the defaults changed.
 
 ### Changed
-* **BREAKING**: Versions of Python before 3.6 are no longer supported.
-* Update conformance docs.
-* Add all keywords and update options.
-* Default `processingMode` to `json-ld-1.1`.
-* Implement logic for marking tests as pending, so that it will fail if a
+- **BREAKING**: Versions of Python before 3.6 are no longer supported.
+- Update conformance docs.
+- Add all keywords and update options.
+- Default `processingMode` to `json-ld-1.1`.
+- Implement logic for marking tests as pending, so that it will fail if a
   pending test passes.
-* Consolidate `documentLoader` option and defaults into a `load_document` method
+- Consolidate `documentLoader` option and defaults into a `load_document` method
   to also handle JSON (eventually HTML) parsing.
-* Add support for `rel=alternate` for non-JSON-LD docs.
-* Use `lxml.html` to load HTML and parse in `load_html`.
-  * For HTML, the API base option can be updated from base element.
-* Context processing:
-  * Support `@propagate` in context processing and propagate option.
-  * Support for `@import`. (Some issues confusing recursion errors for invalid
+- Add support for `rel=alternate` for non-JSON-LD docs.
+- Use `lxml.html` to load HTML and parse in `load_html`.
+  - For HTML, the API base option can be updated from base element.
+- Context processing:
+  - Support `@propagate` in context processing and propagate option.
+  - Support for `@import`. (Some issues confusing recursion errors for invalid
     contexts).
-  * Make `override_protected` and `propagate` optional arguments to
+  - Make `override_protected` and `propagate` optional arguments to
     `_create_term_definition` and `_process_context` instead of using option
     argument.
-  * Improve management of previous contexts.
-  * Imported contexts must resolve to an object.
-  * Do remote context processing from within `_process_contexts`, as logic is
+  - Improve management of previous contexts.
+  - Imported contexts must resolve to an object.
+  - Do remote context processing from within `_process_contexts`, as logic is
     too complicated for pre-loading. Removes `_find_context_urls` and
     `_retrieve_context_urls`.
-  * Added a `ContextResolver` which can use a shared LRU cache for storing
+  - Added a `ContextResolver` which can use a shared LRU cache for storing
     externally retrieved contexts, and the result of processing them relative
     to a particular active context.
-  * Return a `frozendict` from context processing and reduce deepcopies.
-  * Store inverse context in an LRU cache rather than trying to modify a frozen context.
-  * Don't set `@base` in initial context and don't resolve a relative IRI
+  - Return a `frozendict` from context processing and reduce deepcopies.
+  - Store inverse context in an LRU cache rather than trying to modify a frozen context.
+  - Don't set `@base` in initial context and don't resolve a relative IRI
     when setting `@base` in a context, so that the document location can
     be kept separate from the context itself.
-  * Use static initial contexts composed of just `mappings` and `processingMode`
+  - Use static initial contexts composed of just `mappings` and `processingMode`
     to enhance preprocessed context cachability.
-* Create Term Definition:
-  * Allow `@type` as a term under certain circumstances.
-  * Reject and warn on keyword-like terms.
-  * Support protected term definitions.
-  * Look for keyword patterns and warn/return.
-  * Look for terms that are compact IRIs that don't expand to the same thing.
-  * Basic support for `@json` and `@none` as values of `@type`.
-  * If `@container` includes `@type`, `@type` must be `@id` or `@vocab`.
-  * Support `@index` and `@direction`.
-  * Corner-case checking for `@prefix`.
-  * Validate scoped contexts even if not used.
-  * Support relative vocabulary IRIs.
-  * Fix check that term has the form of an IRI.
-  * Delay adding mapping to end of `_create_term_definition`.
-  * If a scoped context is null, wrap it in an array so it doesn't seem to be
+- Create Term Definition:
+  - Allow `@type` as a term under certain circumstances.
+  - Reject and warn on keyword-like terms.
+  - Support protected term definitions.
+  - Look for keyword patterns and warn/return.
+  - Look for terms that are compact IRIs that don't expand to the same thing.
+  - Basic support for `@json` and `@none` as values of `@type`.
+  - If `@container` includes `@type`, `@type` must be `@id` or `@vocab`.
+  - Support `@index` and `@direction`.
+  - Corner-case checking for `@prefix`.
+  - Validate scoped contexts even if not used.
+  - Support relative vocabulary IRIs.
+  - Fix check that term has the form of an IRI.
+  - Delay adding mapping to end of `_create_term_definition`.
+  - If a scoped context is null, wrap it in an array so it doesn't seem to be
     undefined.
-* IRI Expansion:
-  * Find keyword patterns.
-  * Don't treat terms starting with a colon as IRIs.
-  * Only return a resulting IRI if it is absolute.
-  * Fix `_is_absolute_iri` to use a reasonable regular expression and some
+- IRI Expansion:
+  - Find keyword patterns.
+  - Don't treat terms starting with a colon as IRIs.
+  - Only return a resulting IRI if it is absolute.
+  - Fix `_is_absolute_iri` to use a reasonable regular expression and some
     other `_expand_iri issues`.
-  * Fix to detecting relative IRIs.
-  * Fix special case where relative path should not have a leading '/'
-  * Pass in document location (through 'base' option) and use when resolving
+  - Fix to detecting relative IRIs.
+  - Fix special case where relative path should not have a leading '/'
+  - Pass in document location (through 'base' option) and use when resolving
     document-relative IRIs.
-* IRI Compaction:
-  * Pass in document location (through 'base' option) and use when compacting
+- IRI Compaction:
+  - Pass in document location (through 'base' option) and use when compacting
     document-relative IRIs.
-* Compaction:
-  * Compact `@direction`.
-  * Compact `@type`: `@none`.
-  * Compact `@included`.
-  * Honor `@container`: `@set` on `@type`.
-  * Lists of Lists.
-  * Improve handling of scoped contexts and propagate.
-  * Improve map compaction, including indexed properties.
-  * Catch Absolute IRI confused with prefix.
-* Expansion:
-  * Updates to expansion algorithm.
-  * `_expand_value` adds `@direction` from term definition.
-  * JSON Literals.
-  * Support `@direction` when expanding.
-  * Support lists of lists.
-  * Support property indexes.
-  * Improve graph container expansion.
-  * Order types when applying scoped contexts.
-  * Use `type_scoped_ctx` when expanding values of `@type`.
-  * Use propagate and `override_protected` properly when creating expansion
+- Compaction:
+  - Compact `@direction`.
+  - Compact `@type`: `@none`.
+  - Compact `@included`.
+  - Honor `@container`: `@set` on `@type`.
+  - Lists of Lists.
+  - Improve handling of scoped contexts and propagate.
+  - Improve map compaction, including indexed properties.
+  - Catch Absolute IRI confused with prefix.
+- Expansion:
+  - Updates to expansion algorithm.
+  - `_expand_value` adds `@direction` from term definition.
+  - JSON Literals.
+  - Support `@direction` when expanding.
+  - Support lists of lists.
+  - Support property indexes.
+  - Improve graph container expansion.
+  - Order types when applying scoped contexts.
+  - Use `type_scoped_ctx` when expanding values of `@type`.
+  - Use propagate and `override_protected` properly when creating expansion
     contexts.
-* Flattening:
-  * Rewrite `_create_node_map` based on 1.1 algorithm.
-  * Flatten `@included`.
-  * Flatten lists of lists.
-  * Update `merge_node_maps` for `@type`.
-* Framing:
-  * Change default for `requireAll` from True to False.
-  * Change default for 'embed' from '@last' to '@once'.
-  * Add defaults for `omitGraph` and `pruneBlankNodeIdentifiers`
+- Flattening:
+  - Rewrite `_create_node_map` based on 1.1 algorithm.
+  - Flatten `@included`.
+  - Flatten lists of lists.
+  - Update `merge_node_maps` for `@type`.
+- Framing:
+  - Change default for `requireAll` from True to False.
+  - Change default for 'embed' from '@last' to '@once'.
+  - Add defaults for `omitGraph` and `pruneBlankNodeIdentifiers`
     based on processing mode.
-  * Change `_remove_preserve` to `_cleanup_preserve` which happens before
+  - Change `_remove_preserve` to `_cleanup_preserve` which happens before
     compaction.
-  * Add `_cleanup_null` which happens after compaction.
-  * Update frame matching to 1.1 spec.
-  * Support `@included`.
-* ToRdf:
-  * Support for I18N direction.
-  * Support for Lists of Lists.
-  * Partial support for JSON canonicalization of JSON literals.
-    * Includes local copy of JCS library, but doesn't load.
-  * Lists of Lists.
-  * Text Direction 'i18n-datatype'.
-* Testing
-  * Switched to argparse.
-  * **BREAKING**: Removed `-d` and `-m` test runner options in favor of just
+  - Add `_cleanup_null` which happens after compaction.
+  - Update frame matching to 1.1 spec.
+  - Support `@included`.
+- ToRdf:
+  - Support for I18N direction.
+  - Support for Lists of Lists.
+  - Partial support for JSON canonicalization of JSON literals.
+    - Includes local copy of JCS library, but doesn't load.
+  - Lists of Lists.
+  - Text Direction 'i18n-datatype'.
+- Testing
+  - Switched to argparse.
+  - **BREAKING**: Removed `-d` and `-m` test runner options in favor of just
     listing as arguments.
-  * If no test manifests or directories are specified, default to sibling
+  - If no test manifests or directories are specified, default to sibling
     directories for json-ld-api, json-ld-framing, and normalization.
 
 ## 1.0.5 - 2019-05-09

PyLD-2.0.4/MANIFEST.in

@@ -0,0 +1 @@
+include README.rst README.txt LICENSE CHANGELOG.md

PyLD-2.0.4/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.1
+Name: PyLD
+Version: 2.0.4
+Summary: Python implementation of the JSON-LD API
+Home-page: https://github.com/digitalbazaar/pyld
+Author: Digital Bazaar
+Author-email: support@digitalbazaar.com
+License: BSD 3-Clause license
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries
+License-File: LICENSE
+Requires-Dist: cachetools
+Requires-Dist: frozendict
+Requires-Dist: lxml
+Provides-Extra: requests
+Requires-Dist: requests; extra == "requests"
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == "aiohttp"
+Provides-Extra: cachetools
+Requires-Dist: cachetools; extra == "cachetools"
+Provides-Extra: frozendict
+Requires-Dist: frozendict; extra == "frozendict"
+
+PyLD
+====
+
+.. image:: https://travis-ci.org/digitalbazaar/pyld.png?branch=master
+   :target: https://travis-ci.org/digitalbazaar/pyld
+   :alt: Build Status
+
+Introduction
+------------
+
+This library is an implementation of the JSON-LD_ specification in Python_.
+
+JSON, as specified in RFC7159_, is a simple language for representing
+objects on the Web. Linked Data is a way of describing content across
+different documents or Web sites. Web resources are described using
+IRIs, and typically are dereferencable entities that may be used to find
+more information, creating a "Web of Knowledge". JSON-LD_ is intended
+to be a simple publishing method for expressing not only Linked Data in
+JSON, but for adding semantics to existing JSON.
+
+JSON-LD is designed as a light-weight syntax that can be used to express
+Linked Data. It is primarily intended to be a way to express Linked Data
+in JavaScript and other Web-based programming environments. It is also
+useful when building interoperable Web Services and when storing Linked
+Data in JSON-based document storage engines. It is practical and
+designed to be as simple as possible, utilizing the large number of JSON
+parsers and existing code that is in use today. It is designed to be
+able to express key-value pairs, RDF data, RDFa_ data,
+Microformats_ data, and Microdata_. That is, it supports every
+major Web-based structured data model in use today.
+
+The syntax does not require many applications to change their JSON, but
+easily add meaning by adding context in a way that is either in-band or
+out-of-band. The syntax is designed to not disturb already deployed
+systems running on JSON, but provide a smooth migration path from JSON
+to JSON with added semantics. Finally, the format is intended to be fast
+to parse, fast to generate, stream-based and document-based processing
+compatible, and require a very small memory footprint in order to operate.
+
+Conformance
+-----------
+
+This library aims to conform with the following:
+
+- `JSON-LD 1.1 <JSON-LD WG 1.1_>`_,
+  W3C Candidate Recommendation,
+  2019-12-12 or `newer <JSON-LD WG latest_>`_
+- `JSON-LD 1.1 Processing Algorithms and API <JSON-LD WG 1.1 API_>`_,
+  W3C Candidate Recommendation,
+  2019-12-12 or `newer <JSON-LD WG API latest_>`_
+- `JSON-LD 1.1 Framing <JSON-LD WG 1.1 Framing_>`_,
+  W3C Candidate Recommendation,
+  2019-12-12 or `newer <JSON-LD WG Framing latest_>`_
+- Working Group `test suite <WG test suite_>`_
+
+The `test runner`_ is often updated to note or skip newer tests that are not
+yet supported.
+
+Requirements
+------------
+
+- Python_ (3.6 or later)
+- Requests_ (optional)
+- aiohttp_ (optional, Python 3.5 or later)
+
+Installation
+------------
+
+PyLD can be installed with a pip_ `package <https://pypi.org/project/PyLD/>`_
+
+.. code-block:: bash
+
+    pip install PyLD
+
+Defining a dependency on pyld will not pull in Requests_ or aiohttp_.  If you
+need one of these for a `Document Loader`_ then either depend on the desired
+external library directly or define the requirement as ``PyLD[requests]`` or
+``PyLD[aiohttp]``.
+
+Quick Examples
+--------------
+
+.. code-block:: Python
+
+    from pyld import jsonld
+    import json
+
+    doc = {
+        "http://schema.org/name": "Manu Sporny",
+        "http://schema.org/url": {"@id": "http://manu.sporny.org/"},
+        "http://schema.org/image": {"@id": "http://manu.sporny.org/images/manu.png"}
+    }
+
+    context = {
+        "name": "http://schema.org/name",
+        "homepage": {"@id": "http://schema.org/url", "@type": "@id"},
+        "image": {"@id": "http://schema.org/image", "@type": "@id"}
+    }
+
+    # compact a document according to a particular context
+    # see: https://json-ld.org/spec/latest/json-ld/#compacted-document-form
+    compacted = jsonld.compact(doc, context)
+
+    print(json.dumps(compacted, indent=2))
+    # Output:
+    # {
+    #   "@context": {...},
+    #   "image": "http://manu.sporny.org/images/manu.png",
+    #   "homepage": "http://manu.sporny.org/",
+    #   "name": "Manu Sporny"
+    # }
+
+    # compact using URLs
+    jsonld.compact('http://example.org/doc', 'http://example.org/context')
+
+    # expand a document, removing its context
+    # see: https://json-ld.org/spec/latest/json-ld/#expanded-document-form
+    expanded = jsonld.expand(compacted)
+
+    print(json.dumps(expanded, indent=2))
+    # Output:
+    # [{
+    #   "http://schema.org/image": [{"@id": "http://manu.sporny.org/images/manu.png"}],
+    #   "http://schema.org/name": [{"@value": "Manu Sporny"}],
+    #   "http://schema.org/url": [{"@id": "http://manu.sporny.org/"}]
+    # }]
+
+    # expand using URLs
+    jsonld.expand('http://example.org/doc')
+
+    # flatten a document
+    # see: https://json-ld.org/spec/latest/json-ld/#flattened-document-form
+    flattened = jsonld.flatten(doc)
+    # all deep-level trees flattened to the top-level
+
+    # frame a document
+    # see: https://json-ld.org/spec/latest/json-ld-framing/#introduction
+    framed = jsonld.frame(doc, frame)
+    # document transformed into a particular tree structure per the given frame
+
+    # normalize a document using the RDF Dataset Normalization Algorithm
+    # (URDNA2015), see: https://www.w3.org/TR/rdf-canon/
+    normalized = jsonld.normalize(
+        doc, {'algorithm': 'URDNA2015', 'format': 'application/n-quads'})
+    # normalized is a string that is a canonical representation of the document
+    # that can be used for hashing, comparison, etc.
+
+Document Loader
+---------------
+
+The default document loader for PyLD uses Requests_. In a production
+environment you may want to setup a custom loader that, at a minimum, sets a
+timeout value. You can also force requests to use https, set client certs,
+disable verification, or set other Requests_ parameters.
+
+.. code-block:: Python
+
+    jsonld.set_document_loader(jsonld.requests_document_loader(timeout=...))
+
+An asynchronous document loader using aiohttp_ is also available. Please note
+that this document loader limits asynchronicity to fetching documents only.
+The processing loops remain synchronous.
+
+.. code-block:: Python
+
+    jsonld.set_document_loader(jsonld.aiohttp_document_loader(timeout=...))
+
+When no document loader is specified, the default loader is set to Requests_.
+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.
+
+Commercial Support
+------------------
+
+Commercial support for this library is available upon request from
+`Digital Bazaar`_: support@digitalbazaar.com.
+
+Source
+------
+
+The source code for the Python implementation of the JSON-LD API
+is available at:
+
+https://github.com/digitalbazaar/pyld
+
+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
+the ``json-ld-api``, ``json-ld-framing``, and ``normalization`` repositories
+hosted on GitHub:
+
+- https://github.com/w3c/json-ld-api
+- https://github.com/w3c/json-ld-framing
+- https://github.com/json-ld/normalization
+
+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
+
+    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:
+
+.. code-block:: bash
+
+    python tests/runtests.py TEST_PATH [TEST_PATH...]
+
+The test runner supports different document loaders by setting ``-l requests``
+or ``-l aiohttp``. The default document loader is set to Requests_.
+
+An EARL report can be generated using the ``-e`` or ``--earl`` option.
+
+
+.. _Digital Bazaar: https://digitalbazaar.com/
+
+.. _JSON-LD WG 1.1 API: https://www.w3.org/TR/json-ld11-api/
+.. _JSON-LD WG 1.1 Framing: https://www.w3.org/TR/json-ld11-framing/
+.. _JSON-LD WG 1.1: https://www.w3.org/TR/json-ld11/
+
+.. _JSON-LD WG API latest: https://w3c.github.io/json-ld-api/
+.. _JSON-LD WG Framing latest: https://w3c.github.io/json-ld-framing/
+.. _JSON-LD WG latest: https://w3c.github.io/json-ld-syntax/
+
+.. _JSON-LD Benchmarks: https://json-ld.org/benchmarks/
+.. _JSON-LD WG: https://www.w3.org/2018/json-ld-wg/
+.. _JSON-LD: https://json-ld.org/
+.. _Microdata: http://www.w3.org/TR/microdata/
+.. _Microformats: http://microformats.org/
+.. _Python: https://www.python.org/
+.. _Requests: http://docs.python-requests.org/
+.. _aiohttp: https://aiohttp.readthedocs.io/
+.. _RDFa: http://www.w3.org/TR/rdfa-core/
+.. _RFC7159: http://tools.ietf.org/html/rfc7159
+.. _WG test suite: https://github.com/w3c/json-ld-api/tree/master/tests
+.. _errata: http://www.w3.org/2014/json-ld-errata
+.. _pip: http://www.pip-installer.org/
+.. _test runner: https://github.com/digitalbazaar/pyld/blob/master/tests/runtests.py
+.. _test suite: https://github.com/json-ld/json-ld.org/tree/master/test-suite

{PyLD-2.0.2 → PyLD-2.0.4}/README.rst

@@ -139,7 +139,7 @@ Quick Examples
     # document transformed into a particular tree structure per the given frame
 
     # normalize a document using the RDF Dataset Normalization Algorithm
-    # (URDNA2015), see: https://json-ld.github.io/normalization/spec/
+    # (URDNA2015), see: https://www.w3.org/TR/rdf-canon/
     normalized = jsonld.normalize(
         doc, {'algorithm': 'URDNA2015', 'format': 'application/n-quads'})
     # normalized is a string that is a canonical representation of the document