Merge 97a7be0 into 1044271

OpenNTI · Jul 25, 2018 · 0f11d3e · 0f11d3e
2 parents 1044271 + 97a7be0
commit 0f11d3e
Show file tree

Hide file tree

Showing 65 changed files with 2,146 additions and 552 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -59,6 +59,9 @@
   automatically internalize their values by treating the ``Dict`` as
   anonymous external data.
 
+- Strings can automatically be adapted into ``ITimeDelta`` objects.
+
+
 1.0.0a2 (2018-07-05)
 ====================
 

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/ADVANCED.rst b/docs/api/ADVANCED.rst
@@ -0,0 +1,9 @@
+========================
+ Advanced Customization
+========================
+
+.. toctree::
+   :maxdepth: 2
+
+   extension_points
+   proxy
diff --git a/docs/api/BASICS.rst b/docs/api/BASICS.rst
@@ -0,0 +1,25 @@
+========
+ Basics
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   interfaces
+   externalization
+   internalization
+   datastructures
+   zcml
+   autopackage
+
+``nti.externalization``
+=======================
+
+.. module:: nti.externalization
+
+The ``nti.externalization`` module has the top-level APIs.
+
+.. autofunction:: nti.externalization.to_external_object
+.. autofunction:: nti.externalization.to_external_representation
+.. autofunction:: nti.externalization.new_from_external_object
+.. autofunction:: nti.externalization.update_from_external_object
diff --git a/docs/api/HELPERS.rst b/docs/api/HELPERS.rst
@@ -0,0 +1,11 @@
+=========
+ Helpers
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   factory
+   datetime
+   dublincore
+   singleton
diff --git a/docs/api/STRINGS.rst b/docs/api/STRINGS.rst
@@ -0,0 +1,9 @@
+=========
+ Strings
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   integer_strings
+   representation
diff --git a/docs/api/ZODB.rst b/docs/api/ZODB.rst
@@ -0,0 +1,10 @@
+==================
+ ZODB Integration
+==================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: ZODB Integration
+
+   oids
+   persistence
diff --git a/docs/api/autopackage.rst b/docs/api/autopackage.rst
@@ -0,0 +1,7 @@
+============
+ Package IO
+============
+
+.. automodule:: nti.externalization.autopackage
+   :private-members:
+   :special-members:
diff --git a/docs/api/datastructures.rst b/docs/api/datastructures.rst
@@ -0,0 +1,6 @@
+================
+ Datastructures
+================
+
+.. automodule:: nti.externalization.datastructures
+   :private-members:
diff --git a/docs/api/datetime.rst b/docs/api/datetime.rst
@@ -0,0 +1,5 @@
+==========
+ Datetime
+==========
+
+.. automodule:: nti.externalization.datetime
diff --git a/docs/api/dublincore.rst b/docs/api/dublincore.rst
@@ -0,0 +1,5 @@
+============
+ Dublincore
+============
+
+.. automodule:: nti.externalization.dublincore
diff --git a/docs/api/extension_points.rst b/docs/api/extension_points.rst
@@ -0,0 +1,12 @@
+==================================================================
+ ``nti.externalization.extension_points``: Pluggable integrations
+==================================================================
+
+.. automodule:: nti.externalization.extension_points
+
+..
+  Things decorated with @hookable have to be manually listed,
+  even when they are in __all__
+
+.. autofunction:: nti.externalization.extension_points.get_current_request
+.. autofunction:: nti.externalization.extension_points.set_external_identifiers
diff --git a/docs/api/externalization.rst b/docs/api/externalization.rst
@@ -0,0 +1,5 @@
+=================
+ Externalization
+=================
+
+.. automodule:: nti.externalization.externalization
diff --git a/docs/api/factory.rst b/docs/api/factory.rst
@@ -0,0 +1,5 @@
+===================================================
+ ``nti.externalization.factory``: Object factories
+===================================================
+
+.. automodule:: nti.externalization.factory
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,12 @@
+=============
+ API Details
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   BASICS
+   STRINGS
+   ADVANCED
+   ZODB
+   HELPERS
diff --git a/docs/api/integer_strings.rst b/docs/api/integer_strings.rst
@@ -0,0 +1,5 @@
+=====================================================================================
+ ``nti.externalization.integer_strings``: Short readable strings from large integers
+=====================================================================================
+
+.. automodule:: nti.externalization.integer_strings
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
@@ -0,0 +1,8 @@
+==============================================================
+ ``nti.externalization.interfaces``: Interfaces and constants
+==============================================================
+
+.. autoclass:: nti.externalization._base_interfaces.LocatedExternalDict
+.. autoclass:: nti.externalization._base_interfaces.StandardExternalFields
+.. autoclass:: nti.externalization._base_interfaces.StandardInternalFields
+.. automodule:: nti.externalization.interfaces
diff --git a/docs/api/internalization.rst b/docs/api/internalization.rst
@@ -0,0 +1,5 @@
+=================
+ Internalization
+=================
+
+.. automodule:: nti.externalization.internalization
diff --git a/docs/api/oids.rst b/docs/api/oids.rst
@@ -0,0 +1,5 @@
+=========================================================
+ ``nti.externalization.oids``: Stable object identifiers
+=========================================================
+
+.. automodule:: nti.externalization.oids
diff --git a/docs/api/persistence.rst b/docs/api/persistence.rst
@@ -0,0 +1,5 @@
+================================================================
+ ``nti.externalization.persistence``: Pickling and ZODB support
+================================================================
+
+.. automodule:: nti.externalization.persistence
diff --git a/docs/api/proxy.rst b/docs/api/proxy.rst
@@ -0,0 +1,5 @@
+================================================================
+ ``nti.externalization.proxy``: Support for transparent proxies
+================================================================
+
+.. automodule:: nti.externalization.proxy
diff --git a/docs/api/representation.rst b/docs/api/representation.rst
@@ -0,0 +1,5 @@
+================================================================================
+ ``nti.externalization.representation``: Reading and writing objects to strings
+================================================================================
+
+.. automodule:: nti.externalization.representation
diff --git a/docs/api/singleton.rst b/docs/api/singleton.rst
@@ -0,0 +1,5 @@
+===========
+ Singleton
+===========
+
+.. automodule:: nti.externalization.singleton
diff --git a/docs/api/zcml.rst b/docs/api/zcml.rst
@@ -0,0 +1,7 @@
+======
+ ZCML
+======
+
+.. automodule:: nti.externalization.zcml
+
+.. autofunction:: nti.externalization.internalization.legacy_factories.find_factories_in_module