add internal namespace warning to all modules inside internal namespace

Author: mattsb42-aws

src/dynamodb_encryption_sdk/internal/crypto/__init__.py

@@ -10,4 +10,9 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Inner cryptographic components."""
+"""Inner cryptographic components.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""

src/dynamodb_encryption_sdk/internal/crypto/authentication.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Functions to handle calculating and verifying signatures of encrypted items."""
+"""Functions to handle calculating and verifying signatures of encrypted items.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives import hashes
 

src/dynamodb_encryption_sdk/internal/crypto/encryption.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Functions to handle encrypting and decrypting DynamoDB attributes."""
+"""Functions to handle encrypting and decrypting DynamoDB attributes.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
     from typing import Text  # noqa pylint: disable=unused-import
     from dynamodb_encryption_sdk.internal import dynamodb_types  # noqa pylint: disable=unused-import

src/dynamodb_encryption_sdk/internal/crypto/jce_bridge/__init__.py

@@ -12,4 +12,8 @@
 # language governing permissions and limitations under the License.
 """Components to provide cryptographic primitives based on JCE Standard Names.
 https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
 """

src/dynamodb_encryption_sdk/internal/crypto/jce_bridge/authentication.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Cryptographic authentication resources for JCE bridge."""
+"""Cryptographic authentication resources for JCE bridge.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import abc
 import logging
 

src/dynamodb_encryption_sdk/internal/crypto/jce_bridge/encryption.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Cipher resource for JCE bridge."""
+"""Cipher resource for JCE bridge.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import attr
 
 from dynamodb_encryption_sdk.exceptions import JceTransformationError

src/dynamodb_encryption_sdk/internal/crypto/jce_bridge/primitives.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Cryptographic primitive resources for JCE bridge."""
+"""Cryptographic primitive resources for JCE bridge.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import abc
 import logging
 import os

src/dynamodb_encryption_sdk/internal/dynamodb_types.py

@@ -1,4 +1,9 @@
-"""Types used with mypy for DynamoDB items and attributes."""
+"""Types used with mypy for DynamoDB items and attributes.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
     from typing import Any, AnyStr, ByteString, Dict, List, Text
 

src/dynamodb_encryption_sdk/internal/formatting/__init__.py

@@ -10,4 +10,9 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Data formatting utilities for the DynamoDB Encryption Client."""
+"""Data formatting utilities for the DynamoDB Encryption Client.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""

src/dynamodb_encryption_sdk/internal/formatting/deserialize/__init__.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Helper functions for deserializing values."""
+"""Helper functions for deserializing values.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import struct
 
 from dynamodb_encryption_sdk.exceptions import DeserializationError

src/dynamodb_encryption_sdk/internal/formatting/deserialize/attribute.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Tooling for deserializing attributes."""
+"""Tooling for deserializing attributes.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import codecs
 from decimal import Decimal
 import io

src/dynamodb_encryption_sdk/internal/formatting/material_description.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Tools for serializing and deserializing material descriptions."""
+"""Tools for serializing and deserializing material descriptions.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import io
 import logging
 import struct

src/dynamodb_encryption_sdk/internal/formatting/serialize/__init__.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Helper functions for serializing values."""
+"""Helper functions for serializing values.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import struct
 
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules

src/dynamodb_encryption_sdk/internal/formatting/serialize/attribute.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Tooling for serializing attributes."""
+"""Tooling for serializing attributes.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import io
 import logging
 

src/dynamodb_encryption_sdk/internal/identifiers.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Unique identifiers for internal use only."""
+"""Unique identifiers for internal use only.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 from enum import Enum
 
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules

src/dynamodb_encryption_sdk/internal/str_ops.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Helper functions for consistently obtaining str and bytes objects in both Python2 and Python3."""
+"""Helper functions for consistently obtaining str and bytes objects in both Python2 and Python3.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import codecs
 
 import six

src/dynamodb_encryption_sdk/internal/utils.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Otherwise undifferentiated utility resources."""
+"""Otherwise undifferentiated utility resources.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 import attr
 import botocore.client
 

src/dynamodb_encryption_sdk/internal/validators.py

@@ -10,7 +10,12 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-"""Custom validators for ``attrs``."""
+"""Custom validators for ``attrs``.
+
+.. warning::
+    No guarantee is provided on the modules and APIs within this
+    namespace staying consistent. Directly reference at your own risk.
+"""
 
 __all__ = ('dictionary_validator', 'iterable_validator')