nti.externalization 3.0.0__tar.gz → 3.1.0__tar.gz

nti_externalization-3.1.0/.readthedocs.yml

@@ -0,0 +1,34 @@
+# .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.11"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

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

@@ -3,6 +3,18 @@
 =========
 
 
+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.1.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.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nti.externalization
-Version: 3.0.0
+Version: 3.1.0
 Summary: NTI Externalization
 Home-page: https://github.com/OpenNTI/nti.externalization
 Author: Jason Madden
@@ -105,6 +105,18 @@ Documentation is hosted at https://ntiexternalization.readthedocs.io/
 =========
 
 
+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.1.0/docs/api/datetime.rst

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

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

@@ -556,16 +556,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.1.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.1.0}/setup.py

@@ -147,7 +147,7 @@ if not PYPY:
 
 setup(
     name='nti.externalization',
-    version='3.0.0',
+    version='3.1.0',
     author='Jason Madden',
     author_email='jason@seecoresoftware.com',
     description="NTI Externalization",

{nti_externalization-3.0.0 → nti_externalization-3.1.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