nti.externalization 3.0.0__tar.gz → 3.2.0__tar.gz

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/.github/workflows/tests.yml

@@ -18,11 +18,18 @@ jobs:
           - "3.12"
           - "3.13"
           - "3.14"
+          - "3.15-dev"
         extras:
-          - "[test,docs,zodb]"
-        # include:
-        #   - python-version: "3.13"
-        #     extras: "[test,docs,gevent,pyramid]"
+          - "[test,docs,zodb,orjson]"
+        include:
+          # orjson 3.11.9 doesn't currently support
+          # being built for free-threaded python, so if we wanted
+          # to test there, we'd need to substitute it, most likely by
+          # moving it to an extra.
+          - python-version: "3.14t"
+            extras: "[test,docs,zodb]"
+          - python-version: "3.15t-dev"
+            extras: "[test,docs,zodb]"
 
     runs-on: ubuntu-latest
     steps:
@@ -38,13 +45,20 @@ jobs:
         python -m pip install -U pip setuptools wheel
         python -m pip install -U coverage
         python -m pip install -v -U -e ".${{ matrix.extras }}"
+    - name: Disable GIL
+      if: ${{endsWith(matrix.python-version, 't') || endsWith(matrix.python-version, 't-dev')}}
+      # zope.hookable 8.2/zope.proxy 7.2 currently enables the gil
+      run: |
+        echo PYTHON_GIL=0 >> $GITHUB_ENV
     - name: Test
       run: |
         python -m coverage run -m zope.testrunner --test-path=src  --auto-color --auto-progress
         PURE_PYTHON=1 coverage run -a -m zope.testrunner --test-path=src  --auto-color --auto-progress
+    - name: Docs
+      if: matrix.python-version == '3.14'
+      # Requires orjson
+      run: |
         coverage run -a -m sphinx -b doctest -d docs/_build/doctrees docs docs/_build/doctests
-        coverage combine || true
-        coverage report -i || true
     - name: Lint
       if: matrix.python-version == '3.14'
       run: |
@@ -54,6 +68,10 @@ jobs:
       run: |
         python -m pip uninstall -y ZODB zope.dublincore  persistent zope.container BTrees
         PURE_PYTHON=1 coverage run -a -m zope.testrunner --test-path=src  --auto-color --auto-progress
+    - name: Combine Coverage
+      run: |
+        coverage combine || true
+        coverage report -i || true
     - name: Submit to Coveralls
       uses: coverallsapp/github-action@v2
       with:
@@ -75,7 +93,7 @@ jobs:
     # We use a regular Python matrix entry to share as much code as possible.
     strategy:
       matrix:
-        python-version: [3.12]
+        python-version: [3.14]
         image:
           - manylinux_2_28_x86_64
           - manylinux_2_28_aarch64

nti_externalization-3.2.0/.readthedocs.yml

@@ -0,0 +1,35 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Some things can only be configured on the RTD dashboard.
+# Those that we may have changed from the default include:
+
+# Analytics code:
+# Show Version Warning: False
+# Single Version: True
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+
+# Set the version of Python and requirements required to build your
+# docs
+
+build:
+  # os is required for some reason
+  os: ubuntu-22.04
+  tools:
+    python: "3.14"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - orjson

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/CHANGES.rst

@@ -3,6 +3,32 @@
 =========
 
 
+3.2.0 (2026-05-19)
+==================
+
+- Drop support for Python 3.10.
+- Add support for Python 3.15.
+- Move the ``orjson`` dependency to the ``orjson`` extra
+  for compatibility with free-threaded Python. If you're using regular
+  Python, it is highly recommended to install this extra.
+- Add support for free-threaded CPython. However, note that some
+  dependencies, most notably orjson, cannot
+  currently be installed on free-threaded CPython, and other
+  dependencies may currently require enabling the GIL.
+
+
+3.1.0 (2026-05-08)
+==================
+
+- Document the ``to_json_representation`` variants and add one
+  that guarantees sorted keys. Make the "fast" variant not dependent
+  on second-chance externalization.
+- Renamed the "datetime" module to "datetime_ext" to avoid conflicts
+  with the standard library. Backwards compatibility shims are in place.
+- Remove some long-deprecated parameters that were typically
+  undocumented.
+- Introduce some basic type annotations.
+
 3.0.0 (2026-05-07)
 ==================
 

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/MANIFEST.in

@@ -11,6 +11,7 @@ include tox.ini
 include *.txt
 include .isort.cfg
 include pyproject.toml
+include .readthedocs.yml
 include .pylintrc
 include make-manylinux
 exclude .nti_cover_package

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nti.externalization
-Version: 3.0.0
+Version: 3.2.0
 Summary: NTI Externalization
 Home-page: https://github.com/OpenNTI/nti.externalization
 Author: Jason Madden
@@ -12,20 +12,19 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 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: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 License-File: LICENSE
 License-File: AUTHORS
 Requires-Dist: nti.schema>=1.17.0
 Requires-Dist: PyYAML>=5.1
 Requires-Dist: isodate
 Requires-Dist: pytz
-Requires-Dist: orjson>=3.11.9
 Requires-Dist: transaction
 Requires-Dist: zope.component>=4.6.1
 Requires-Dist: zope.configuration>=4.4.0
@@ -58,6 +57,8 @@ Requires-Dist: repoze.sphinx.autointerface; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Provides-Extra: benchmarks
 Requires-Dist: pyperf; extra == "benchmarks"
+Provides-Extra: orjson
+Requires-Dist: orjson>=3.11.9; extra == "orjson"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -105,6 +106,32 @@ Documentation is hosted at https://ntiexternalization.readthedocs.io/
 =========
 
 
+3.2.0 (2026-05-19)
+==================
+
+- Drop support for Python 3.10.
+- Add support for Python 3.15.
+- Move the ``orjson`` dependency to the ``orjson`` extra
+  for compatibility with free-threaded Python. If you're using regular
+  Python, it is highly recommended to install this extra.
+- Add support for free-threaded CPython. However, note that some
+  dependencies, most notably orjson, cannot
+  currently be installed on free-threaded CPython, and other
+  dependencies may currently require enabling the GIL.
+
+
+3.1.0 (2026-05-08)
+==================
+
+- Document the ``to_json_representation`` variants and add one
+  that guarantees sorted keys. Make the "fast" variant not dependent
+  on second-chance externalization.
+- Renamed the "datetime" module to "datetime_ext" to avoid conflicts
+  with the standard library. Backwards compatibility shims are in place.
+- Remove some long-deprecated parameters that were typically
+  undocumented.
+- Introduce some basic type annotations.
+
 3.0.0 (2026-05-07)
 ==================
 

nti_externalization-3.2.0/docs/api/datetime.rst

@@ -0,0 +1,5 @@
+==========
+ Datetime
+==========
+
+.. automodule:: nti.externalization.datetime_ext

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/docs/basics.rst

@@ -60,6 +60,23 @@ concerns should be kept as separated as possible from our model
 objects. Ideally, we should be able to use third-party objects that we
 have no control over seamlessly in external and internal data.
 
+Installation
+============
+
+This package is installed from PyPI::
+
+  pip install nti.externalization[orjson,zodb]
+
+It has some extras:
+
+orjson
+   Highly recommended for a faster dumping and loading experience. As
+   of at least orjson 3.11.9, however, this is incompatible with
+   free-threaded Python.
+zodb
+   Optional; provides support for BTrees, persistent objects, intids, and
+   container proxies.
+
 Getting Started
 ===============
 
@@ -248,7 +265,7 @@ others:
 
   >>> internal.creator = u'sjohnson'
   >>> internal.createdTime = 123456
-  >>> pprint(to_external_object(internal))
+  >>> pprint(to_external_object(internal), compact=True, indent=1)
   {'Class': 'ExternalObject',
    'CreatedTime': 123456,
    'Creator': 'sjohnson',
@@ -337,7 +354,7 @@ Now we can register and use it as before:
    ...    postal_code=u'95014',
    ...    country=u'USA')
    >>> external = to_external_object(address)
-   >>> pprint(external)
+   >>> pprint(external, compact=True, indent=1)
    {'Class': 'Address',
     'city': 'Cupertino',
     'country': 'USA',
@@ -473,7 +490,7 @@ demonstrating that nested schemas and objects are possible.
    ...     realname=u'Steve Jobs',
    ... )
    >>> external = to_external_object(user_profile)
-   >>> pprint(external)
+   >>> pprint(external, compact=True, indent=1)
    {'Class': 'UserProfile',
     'MimeType': 'application/vnd.nextthought.benchmarks.userprofile',
     'addresses': {'home': {'Class': 'Address',
@@ -556,16 +573,18 @@ keyword arguments to change that:
     >>> as_bytes = to_external_representation(address, EXT_REPR_JSON, sort_keys=False, as_str=False)
     >>> assert isinstance(as_bytes, bytes)
 
-There are also some convenience functions, but note that these do not
-use the registered utility, they directly invoke the default utility:
+There are also some convenience functions. The "fast" and "sorted"
+variants bypass utility lookup and directly use the default ``JsonRepresenter``.
 
     >>> from nti.externalization import to_json_representation
     >>> from nti.externalization import to_json_representation_fast
+    >>> from nti.externalization import to_json_representation_sorted
     >>> to_json_representation(address)
     '{"Class":"Address",...
     >>> as_bytes = to_json_representation_fast(address)
     >>> assert isinstance(as_bytes, bytes)
-
+    >>> to_json_representation_sorted(address)
+    '{"Class":"Address","city":"Cupertino",...
 
 Loading from a string doesn't have a shortcut, we need to use the
 utility:

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/docs/conf.py

@@ -78,7 +78,7 @@ release = rqmt
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/docs/externalization.rst

@@ -85,7 +85,7 @@ We'll register our adapter and externalize:
    >>> from zope import component
    >>> component.provideSubscriptionAdapter(PrivateAddressDecorator)
    >>> from pprint import pprint
-   >>> pprint(to_external_object(home_address))
+   >>> pprint(to_external_object(home_address), compact=True, indent=1)
    {'Class': 'Address',
     'MimeType': 'application/vnd.nextthought.benchmarks.address',
     'country': 'USA',
@@ -118,7 +118,7 @@ look for a request):
    :pyversion: > 3.3
 
    >>> component.provideSubscriptionAdapter(LinkAddressDecorator)
-   >>> pprint(to_external_object(home_address, request=Request()))
+   >>> pprint(to_external_object(home_address, request=Request()), compact=True, indent=1)
    {'Class': 'Address',
     'MimeType': 'application/vnd.nextthought.benchmarks.address',
     'country': 'USA',

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/make-manylinux

@@ -13,7 +13,7 @@ export TRAVIS=true
 # know. The env var works for pip 20.
 export PIP_NO_PYTHON_VERSION_WARNING=1
 export PIP_NO_WARN_SCRIPT_LOCATION=1
-
+export PIP_ROOT_USER_ACTION=ignore
 
 if [ -d /project ] && [ -d /opt/python ]; then
     # Running inside docker
@@ -44,9 +44,9 @@ if [ -d /project ] && [ -d /opt/python ]; then
     OPATH="$PATH"
     which auditwheel
     echo @@@@@@@@@@@@@@@@@@@@@@
-    echo Will build /opt/python/cp{310,311,312,313,314}*
+    echo Will build /opt/python/cp{311,312,313,314,315}*
 
-    for variant in `ls -d /opt/python/cp{314,313,310,311,312}*`; do
+    for variant in `ls -d /opt/python/cp{315,314,313,311,312}*`; do
 
         export PATH="$variant/bin:$OPATH"
         echo "Building $variant $(python --version)"

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/pyproject.toml

@@ -17,8 +17,54 @@ requires = [
      # failing in Python 2 (https://travis-ci.org/github/gevent/gevent/jobs/683782800);
      # This was fixed in 3.0a5 (https://github.com/cython/cython/issues/3578)
      # 3.0a6 fixes an issue cythonizing source on 32-bit platforms
-     "Cython >= 3.2.1",
+     "Cython >= 3.2.4",
 ]
 
 [tool.check-manifest]
 ignore = ["*.c"]
+
+
+[tool.mypy]
+# Must be present for mypy to read this file.
+follow_imports = "normal"
+check_untyped_defs = true
+allow_redefinition = true
+disable_error_code = [
+  "method-assign"
+]
+# Our tests are in terrible shape
+# and will need some work to be clean
+exclude = [
+  'test_.*\.py',
+]
+
+[[tool.mypy.overrides]]
+# third-party untyped code
+module = [
+  "ZODB.*",
+  "zope.*",
+  "persistent.*",
+  "cpuinfo",
+  "nti.*",
+  "botocore.*",
+  "fsspec.*",
+  "transaction",
+  "grpc",
+  "grpc_health.*",
+  "google.type.*",
+  "zc.*",
+  "z3c.*",
+  "netaddr.*",
+  "dnslib",
+  "cytoolz.*",
+  "toolz.*",
+  "boto3.*",
+  "pg8000",
+  "urllib3.*",
+  "indexed_gzip",
+  "pyperf",
+  "isodate",
+  "vmprof"
+
+]
+ignore_missing_imports = true

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/setup.py

@@ -133,6 +133,7 @@ if not PYPY:
                 'language_level': '3',
                 'always_allow_keywords': False,
                 'nonecheck': False,
+                'freethreading_compatible': True,
             },
         )
     except ValueError:
@@ -147,7 +148,7 @@ if not PYPY:
 
 setup(
     name='nti.externalization',
-    version='3.0.0',
+    version='3.2.0',
     author='Jason Madden',
     author_email='jason@seecoresoftware.com',
     description="NTI Externalization",
@@ -160,11 +161,11 @@ setup(
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3 :: Only',
-        'Programming Language :: Python :: 3.10',
         '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 :: Implementation :: CPython',
     ],
     url="https://github.com/OpenNTI/nti.externalization",
@@ -179,7 +180,7 @@ setup(
         'PyYAML >= 5.1',
         'isodate',
         'pytz',
-        'orjson >= 3.11.9',
+
         'transaction',
         'zope.component >= 4.6.1',
         'zope.configuration >= 4.4.0',
@@ -212,7 +213,10 @@ setup(
         'benchmarks': [
             'pyperf',
         ],
+        'orjson': [
+            'orjson >= 3.11.9',
+        ]
     },
     entry_points=entry_points,
-    python_requires=">=3.10",
+    python_requires=">=3.11",
 )

{nti_externalization-3.0.0 → nti_externalization-3.2.0}/src/nti/externalization/__init__.py

@@ -10,6 +10,7 @@ __all__ = [
     'update_from_external_object',
     'to_json_representation_fast',
     'to_json_representation',
+    'to_json_representation_sorted',
 ]
 
 from nti.externalization.externalization import to_external_object
@@ -17,6 +18,12 @@ from nti.externalization.externalization import to_standard_external_dictionary
 
 from nti.externalization.representation import to_external_representation
 from nti.externalization.representation import to_json_representation_fast
+from nti.externalization.representation import to_json_representation_sorted
 from nti.externalization.representation import to_json_representation
 from nti.externalization.internalization import new_from_external_object
 from nti.externalization.internalization import update_from_external_object
+
+# BWC hacks
+import sys
+import nti.externalization.datetime_ext as datetime
+sys.modules['nti.externalization.datetime'] = datetime