py-serializable 2.1.0__tar.gz → 2.2.0__tar.gz

{py_serializable-2.1.0 → py_serializable-2.2.0}/CHANGELOG.md

@@ -2,41 +2,60 @@
 
 
 
+## v2.1.0 (2025-07-21)
+
+### Documentation
+
+* docs: fix typo in CONTRIBUTING guidelines
+
+Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`f6b6629`](https://github.com/madpah/serializable/commit/f6b6629b506e1fa9cc8825593129ed08fb20c9c8))
+
+### Feature
+
+* feat: add support to ignore  unknown properties/attributes/elements during deserialization (#178)
+
+
+
+---------
+
+Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`3c51231`](https://github.com/madpah/serializable/commit/3c512313f5f1ab8d06fe24da01936ece2693cdc0))
+
+
 ## v2.0.0 (2025-02-09)
 
 ### Breaking
 
 * refactor!: rename python package `serializable` -> `py_serializable` (#155)
 
-The python package was renamed from `serializable` to `py_serializable`.
-Therefore, you need to adjust your imports.
-
-The following shows a quick way to adjust imports in the most efficient way.
-
-### OLD imports
-```py
-import serializable
-from serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
-from serializable.helpers import BaseHelper, Iso8601Date
-```
-
-### ADJUSTED imports
-```py
-import py_serializable as serializable
-from py_serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
-from py_serializable.helpers import BaseHelper, Iso8601Date
-```
-
-see migration path: <https://py-serializable.readthedocs.io/en/refactor-rename-installable-py_serializable/migration.html>
-
-----
-
-fixes #151
-
----------
-
-Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
-Signed-off-by: semantic-release <semantic-release>
+The python package was renamed from `serializable` to `py_serializable`.
+Therefore, you need to adjust your imports.
+
+The following shows a quick way to adjust imports in the most efficient way.
+
+### OLD imports
+```py
+import serializable
+from serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
+from serializable.helpers import BaseHelper, Iso8601Date
+```
+
+### ADJUSTED imports
+```py
+import py_serializable as serializable
+from py_serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
+from py_serializable.helpers import BaseHelper, Iso8601Date
+```
+
+see migration path: <https://py-serializable.readthedocs.io/en/refactor-rename-installable-py_serializable/migration.html>
+
+----
+
+fixes #151
+
+---------
+
+Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
+Signed-off-by: semantic-release <semantic-release>
 Co-authored-by: semantic-release <semantic-release> ([`67afaef`](https://github.com/madpah/serializable/commit/67afaef4a5e670c533409f1ccbc3d2dbb263d2de))
 
 ### Unknown
@@ -52,11 +71,11 @@ we have a codeowners file in root already ([`b64cdde`](https://github.com/madpah
 
 * fix: date/time deserialization with fractional seconds (#138)
 
-fix multiple where fractional seconds were not properly deserialized or deserialization caused unexpected crashes in py<3.11
-
----------
-
-Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
+fix multiple where fractional seconds were not properly deserialized or deserialization caused unexpected crashes in py<3.11
+
+---------
+
+Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
 Co-authored-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`f4b1c27`](https://github.com/madpah/serializable/commit/f4b1c27110d1becc76771efffd8dc0a96d629cb5))
 
 
@@ -66,8 +85,8 @@ Co-authored-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`f4b1c27`](https
 
 * fix: serializer omit `None` values as expected (#136)
 
-
-
+
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`1a0e14b`](https://github.com/madpah/serializable/commit/1a0e14b8ee0866621a388a09e41c7f173e874e25))
 
 
@@ -83,11 +102,11 @@ Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`aabb5e9`](https:
 
 * feat: XML string formats for `normalizedString` and `token` (#119)
 
-fixes #114 
-fixes #115 
-
----------
-
+fixes #114 
+fixes #115 
+
+---------
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`3a1728d`](https://github.com/madpah/serializable/commit/3a1728d43a13e57ecad2b3feebadf1d9fdc132c3))
 
 
@@ -115,8 +134,8 @@ Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`46a8d9e`](https:
 
 * fix: serialization of `datetime` without timezone with local time offset (#76)
 
-
-
+
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`06776ba`](https://github.com/madpah/serializable/commit/06776baef2cc4b893550320c474128317f6276c1))
 
 
@@ -126,13 +145,13 @@ Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`06776ba`](https:
 
 * feat!: v1.0.0 (#55)
 
-  **Release of first major version 🎉**
-
-  ## BREAKING Changes
-  * Dropped support for python <3.8
-
----------
-
+  **Release of first major version 🎉**
+
+  ## BREAKING Changes
+  * Dropped support for python <3.8
+
+---------
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`2cee4d5`](https://github.com/madpah/serializable/commit/2cee4d5f48d59a737f4fc7b0e3d26fbce33c2392))
 
 ### Documentation
@@ -189,11 +208,11 @@ Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`c0074ce`](https:
 
 * feat: logger (#47)
 
-Reworked the way this library does  logging/warning. It utilizes the logger named `serializable` for everything, now.
-
----------
-
-Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
+Reworked the way this library does  logging/warning. It utilizes the logger named `serializable` for everything, now.
+
+---------
+
+Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
 Co-authored-by: Kyle Roeschley <kyle.roeschley@ni.com> ([`9269b0e`](https://github.com/madpah/serializable/commit/9269b0e681665abaef3f110925cd098b2438880f))
 
 ### Unknown
@@ -228,7 +247,7 @@ Automatically generated by python-semantic-release ([`b444fd7`](https://github.c
 
 * feat: allow custom (de)normalization (#32)
 
-
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`aeecd6b`](https://github.com/madpah/serializable/commit/aeecd6b2e8c4e8febc84ebfa24fe7ec96fd9cb10))
 
 ### Unknown
@@ -246,8 +265,8 @@ Automatically generated by python-semantic-release ([`e80c514`](https://github.c
 
 * fix: JSON deserialize `Decimal` (#31)
 
-
-
+
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`b6dc66a`](https://github.com/madpah/serializable/commit/b6dc66acfb7fdc82b3dd18caf4ad79ec0e87eef0))
 
 ### Unknown
@@ -265,12 +284,12 @@ Automatically generated by python-semantic-release ([`0183a17`](https://github.c
 
 * feat: enhanced typehints and typing (#27)
 
-Even tough some structures are refactored, no public API is changed.
-No runtime is changed.
-TypeCheckers might behave differently, which is intentional due to bug fixes. This is considered a non-breaking change, as it does not affect runtime. 
-
----------
-
+Even tough some structures are refactored, no public API is changed.
+No runtime is changed.
+TypeCheckers might behave differently, which is intentional due to bug fixes. This is considered a non-breaking change, as it does not affect runtime. 
+
+---------
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`410372a`](https://github.com/madpah/serializable/commit/410372a0fa2713c5a36d790f08d2d4b52a6a187c))
 
 ### Unknown
@@ -319,30 +338,30 @@ Automatically generated by python-semantic-release ([`bd604c8`](https://github.c
 
 * feat: format specific (de)serialize (#25)
 
-Added functionality to implement custom (de)serialization specific for XML or JSON ([#13](https://github.com/madpah/serializable/issues/13)).
-
-
-Changed
--------------
-* Class `BaseHelper` is no longer abstract.  
-  This class does not provide any functionality, it is more like a Protocol with some fallback implementations.
-* Method `BaseHelper.serialize()` is no longer abstract.
-  Will raise `NotImplementedError` per default. 
-* Method `BaseHelper.deserialize()` is no longer abstract.
-  Will raise `NotImplementedError` per default. 
-
-Added
-----------
-* New method `BaseHelper.json_serialize()` predefined.  
-  Will call `cls.serialize()` per default. 
-* New method `BaseHelper.json_deserialize()` predefined.  
-  Will call `cls.deserialize()` per default. 
-
-
-
-----
-
-
+Added functionality to implement custom (de)serialization specific for XML or JSON ([#13](https://github.com/madpah/serializable/issues/13)).
+
+
+Changed
+-------------
+* Class `BaseHelper` is no longer abstract.  
+  This class does not provide any functionality, it is more like a Protocol with some fallback implementations.
+* Method `BaseHelper.serialize()` is no longer abstract.
+  Will raise `NotImplementedError` per default. 
+* Method `BaseHelper.deserialize()` is no longer abstract.
+  Will raise `NotImplementedError` per default. 
+
+Added
+----------
+* New method `BaseHelper.json_serialize()` predefined.  
+  Will call `cls.serialize()` per default. 
+* New method `BaseHelper.json_deserialize()` predefined.  
+  Will call `cls.deserialize()` per default. 
+
+
+
+----
+
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`dc998df`](https://github.com/madpah/serializable/commit/dc998df37a2ba37fa43d10c8a1ce044a5b9f5b1e))
 
 ### Unknown
@@ -370,19 +389,19 @@ Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`fcc5d8e`](https:
 
 * docs: set codeblock language and caption (#15)
 
-
-
+
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`5d5cf7b`](https://github.com/madpah/serializable/commit/5d5cf7bc29ed70f4024c714b2326012a9db54cea))
 
 ### Fix
 
 * fix: xml defaultNamespace serialization and detection (#20)
 
-* fixes:  serialization with defaultNS fails [#12](https://github.com/madpah/serializable/issues/12)
-* fixes: defaultNamespace detection fails on XML-attributes when deserializing [#11](https://github.com/madpah/serializable/issues/11)
-
----------
-
+* fixes:  serialization with defaultNS fails [#12](https://github.com/madpah/serializable/issues/12)
+* fixes: defaultNamespace detection fails on XML-attributes when deserializing [#11](https://github.com/madpah/serializable/issues/11)
+
+---------
+
 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`59eaa5f`](https://github.com/madpah/serializable/commit/59eaa5f28eb2969e9d497669ef0436eb87b7525d))
 
 ### Unknown
@@ -574,8 +593,8 @@ Automatically generated by python-semantic-release ([`58d42ad`](https://github.c
 
 * Merge pull request #3 from madpah/feat/recursive-parsing-differing-schemas
 
-feat: `xml_array` has higher priority than `type_mapping`
-
+feat: `xml_array` has higher priority than `type_mapping`
+
 feat: handle `ForwardRef` types ([`664f947`](https://github.com/madpah/serializable/commit/664f947add279dad90ac9cf447a59059ab10d2cc))
 
 * work to handle `ForwardRef` when we have cyclic references in models

{py_serializable-2.1.0 → py_serializable-2.2.0}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: py-serializable
-Version: 2.1.0
+Version: 2.2.0
 Summary: Library for serializing and deserializing Python Objects to and from JSON and XML.
 License: Apache-2.0
+License-File: LICENSE
 Keywords: serialization,deserialization,JSON,XML
 Author: Paul Horton
 Author-email: paul.horton@owasp.org
@@ -20,10 +21,13 @@ 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: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
 Project-URL: Bug Tracker, https://github.com/madpah/serializable/issues
+Project-URL: Changelog, https://github.com/madpah/serializable/releases
 Project-URL: Documentation, https://py-serializable.readthedocs.io/
 Project-URL: Homepage, https://github.com/madpah/serializable#readme
 Project-URL: Repository, https://github.com/madpah/serializable

{py_serializable-2.1.0 → py_serializable-2.2.0}/docs/conf.py

@@ -24,7 +24,7 @@ author = 'Paul Horton'
 
 # The full version, including alpha/beta/rc tags
 # !! version is managed by semantic_release
-release = "2.1.0"
+release = "2.2.0"
 
 # -- General configuration ---------------------------------------------------
 

py_serializable-2.2.0/docs/requirements.txt

@@ -0,0 +1,4 @@
+m2r2>=0.3.2
+sphinx>=8.1.3,<9
+sphinx-autoapi>=3.8.1,<4
+sphinx-rtd-theme>=3.1.0,<4

{py_serializable-2.1.0 → py_serializable-2.2.0}/py_serializable/__init__.py

@@ -58,7 +58,7 @@ import typing  # noqa: F401 # isort: skip
 
 # !! version is managed by semantic_release
 # do not use typing here, or else `semantic_release` might have issues finding the variable
-__version__ = '2.1.0'
+__version__ = '2.2.0'
 
 _logger = getLogger(__name__)
 _logger.addHandler(NullHandler())

{py_serializable-2.1.0 → py_serializable-2.2.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "py-serializable"
-version = "2.1.0"
+version = "2.2.0"
 description = "Library for serializing and deserializing Python Objects to and from JSON and XML."
 authors = ["Paul Horton <paul.horton@owasp.org>"]
 maintainers = [
@@ -44,6 +44,9 @@ classifiers = [
     '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',
     'Typing :: Typed'
 ]
 keywords = [
@@ -51,6 +54,7 @@ keywords = [
 ]
 
 [tool.poetry.urls]
+"Changelog" = "https://github.com/madpah/serializable/releases"
 "Bug Tracker" = "https://github.com/madpah/serializable/issues"
 
 [tool.poetry.dependencies]
@@ -71,16 +75,22 @@ flake8-isort = "6.1.1"
 flake8-quotes = "3.4.0"
 flake8-use-fstring = "1.4"
 flake8-logging = "1.6.0"
-pyupgrade = { version="3.20.0", python=">=3.9" }
+pyupgrade = { version="3.21.0", python=">=3.9" }
 
 
 
 [tool.semantic_release]
 # see https://python-semantic-release.readthedocs.io/en/latest/configuration.html
-commit_author = "semantic-release <semantic-release>"
-commit_message = "chore(release): {version}\n\nAutomatically generated by python-semantic-release\n\nSigned-off-by: semantic-release <semantic-release>"
+logging_use_named_masks = true
+commit_parser = "conventional"
+commit_parser_options = { parse_squash_commits = true, ignore_merge_commits = true }
+commit_author = "semantic-release <semantic-release@bot.local>"
+commit_message = "chore(release): {version}\n\nAutomatically generated by python-semantic-release\n\nSigned-off-by: semantic-release <semantic-release@bot.local>"
 upload_to_vcs_release = true
-build_command = "pip install poetry && poetry build"
+build_command = """
+  pip install poetry
+  poetry build
+"""
 version_toml = ["pyproject.toml:tool.poetry.version"]
 version_variables = [
     "py_serializable/__init__.py:__version__",
@@ -92,7 +102,7 @@ dist_glob_patterns = ["dist/*"]
 upload_to_vcs_release = true
 
 [tool.semantic_release.changelog]
-changelog_file = "CHANGELOG.md"
+default_templates = { changelog_file = "CHANGELOG.md" }
 exclude_commit_patterns = [
   '''chore(?:\([^)]*?\))?: .+''',
   '''ci(?:\([^)]*?\))?: .+''',
@@ -107,7 +117,7 @@ match = "(main|master)"
 prerelease = false
 
 [tool.semantic_release.branches."step"]
-match = "(build|chore|ci|docs|feat|fix|perf|style|refactor|test)"
+match = "(build|chore|ci|docs|feat|fix|perf|style|refactor|tests?)"
 prerelease = true
 prerelease_token = "alpha"
 

{py_serializable-2.1.0 → py_serializable-2.2.0}/tests/model.py

@@ -239,7 +239,7 @@ class BookReference:
         return False
 
     def __hash__(self) -> int:
-        return hash((self.ref, tuple(self.references)))
+        return hash((self.ref, tuple(sorted(self.references, key=hash))))
 
     def __repr__(self) -> str:
         return f'<BookReference ref={self.ref}, targets={len(self.references)}>'

py_serializable-2.1.0/docs/requirements.txt

@@ -1,5 +0,0 @@
-
-m2r2>=0.3.2
-sphinx>=7.2.6,<9
-sphinx-autoapi>=3.0.0,<4
-sphinx-rtd-theme>=2.0.0,<3