py-serializable 1.0.2__tar.gz → 1.0.3__tar.gz

{py_serializable-1.0.2 → py_serializable-1.0.3}/CHANGELOG.md

@@ -2,6 +2,65 @@
 
 
 
+## v1.0.2 (2024-03-01)
+
+### Build
+
+* build: use poetry v1.8.1 (#81)
+
+Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> ([`46a8d9e`](https://github.com/madpah/serializable/commit/46a8d9e629ac502864a99acaa9418d1c5cd32388))
+
+### Chore
+
+* chore(deps-dev): update coverage requirement from 7.4.1 to 7.4.3 (#79)
+
+Updates the requirements on [coverage](https://github.com/nedbat/coveragepy) to permit the latest version.
+- [Release notes](https://github.com/nedbat/coveragepy/releases)
+- [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst)
+- [Commits](https://github.com/nedbat/coveragepy/compare/7.4.1...7.4.3)
+
+---
+updated-dependencies:
+- dependency-name: coverage
+  dependency-type: direct:development
+...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`fbf9b06`](https://github.com/madpah/serializable/commit/fbf9b0609227ebb31ee3f652358f3e18e5ef71b8))
+
+* chore(deps): bump Gr1N/setup-poetry from 8 to 9 (#80)
+
+Bumps [Gr1N/setup-poetry](https://github.com/gr1n/setup-poetry) from 8 to 9.
+- [Release notes](https://github.com/gr1n/setup-poetry/releases)
+- [Commits](https://github.com/gr1n/setup-poetry/compare/v8...v9)
+
+---
+updated-dependencies:
+- dependency-name: Gr1N/setup-poetry
+  dependency-type: direct:production
+  update-type: version-update:semver-major
+...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`3264bc6`](https://github.com/madpah/serializable/commit/3264bc6cf7ff7473968d506ea85ebc04ced0ea79))
+
+* chore(deps-dev): update flake8-quotes requirement from 3.3.2 to 3.4.0 (#77)
+
+Updates the requirements on [flake8-quotes](https://github.com/zheller/flake8-quotes) to permit the latest version.
+- [Commits](https://github.com/zheller/flake8-quotes/compare/3.3.2...3.4.0)
+
+---
+updated-dependencies:
+- dependency-name: flake8-quotes
+  dependency-type: direct:development
+...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> ([`8a5460a`](https://github.com/madpah/serializable/commit/8a5460a453eaad49faf0245e435147bac727eb9e))
+
+* chore: typo in SECURITY.md ([`06f557d`](https://github.com/madpah/serializable/commit/06f557db1200f019029ed5646274862f3be62643))
+
+
 ## v1.0.1 (2024-02-13)
 
 ### Chore

{py_serializable-1.0.2 → py_serializable-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-serializable
-Version: 1.0.2
+Version: 1.0.3
 Summary: Library for serializing and deserializing Python Objects to and from JSON and XML.
 Home-page: https://github.com/madpah/serializable#readme
 License: Apache-2.0

{py_serializable-1.0.2 → py_serializable-1.0.3}/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 = "1.0.2"
+release = "1.0.3"
 
 # -- General configuration ---------------------------------------------------
 

{py_serializable-1.0.2 → py_serializable-1.0.3}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "py-serializable"
-version = "1.0.2"
+version = "1.0.3"
 description = "Library for serializing and deserializing Python Objects to and from JSON and XML."
 authors = ["Paul Horton <paul.horton@owasp.org>"]
 maintainers = [
@@ -59,10 +59,10 @@ defusedxml = "^0.7.1"
 
 [tool.poetry.dev-dependencies]
 tox = "4.11.4"
-coverage = "7.4.3"
+coverage = "7.4.4"
 xmldiff = "2.6.3"
-mypy =  "1.8.0"
-autopep8 = "2.0.4"
+mypy =  "1.9.0"
+autopep8 = "2.1.0"
 isort = "5.13.2"
 flake8 = { version="7.0.0", python=">=3.8.1" }
 flake8-annotations = { version="3.0.1", python=">=3.8.1" }
@@ -70,7 +70,7 @@ flake8-bugbear = { version="24.2.6", python=">=3.8.1" }
 flake8-isort = "6.1.1"
 flake8-quotes = "3.4.0"
 flake8-use-fstring = "1.4"
-flake8-logging = "1.5.0"
+flake8-logging = "1.6.0"
 
 
 

{py_serializable-1.0.2 → py_serializable-1.0.3}/serializable/__init__.py

@@ -59,7 +59,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__ = '1.0.2'
+__version__ = '1.0.3'
 
 _logger = getLogger(__name__)
 _logger.addHandler(NullHandler())
@@ -557,6 +557,14 @@ class _XmlSerializable(Protocol):
         # Handle Sub-Elements
         for child_e in data:
             decoded_k = CurrentFormatter.formatter.decode(strip_default_namespace(child_e.tag))
+
+            if decoded_k not in klass_properties:
+                for p, pi in klass_properties.items():
+                    if pi.xml_array_config:
+                        array_type, nested_name = pi.xml_array_config
+                        if nested_name == strip_default_namespace(child_e.tag):
+                            decoded_k = p
+
             if decoded_k in klass.ignore_during_deserialization:
                 _logger.debug('Ignoring %s when deserializing %s.%s', decoded_k, cls.__module__, cls.__qualname__)
                 continue

{py_serializable-1.0.2 → py_serializable-1.0.3}/tests/fixtures/the-phoenix-project-camel-case-1-v4.xml

@@ -41,4 +41,6 @@
         <reference ref="my-ref-1" />
     </references>
     <rating>9.8</rating>
-</book>
+    <stockId>stock-id-1</stockId>
+    <stockId>stock-id-2</stockId>
+</book>

{py_serializable-1.0.2 → py_serializable-1.0.3}/tests/fixtures/the-phoenix-project-camel-case-v4.json

@@ -7,6 +7,10 @@
     "number": 5,
     "name": "5th Anniversary Limited Edition"
   },
+  "stockIds": [
+    "stock-id-1",
+    "stock-id-2"
+  ],
   "publishDate": "2018-04-16",
   "type": "fiction",
   "authors": [
@@ -53,4 +57,4 @@
       "reference": "my-ref-1"
     }
   ]
-}
+}

{py_serializable-1.0.2 → py_serializable-1.0.3}/tests/fixtures/the-phoenix-project-defaultNS-isset-v4.xml

@@ -41,4 +41,6 @@
         </chapter>
     </chapters>
     <rating>9.8</rating>
-</book>
+    <stockId>stock-id-1</stockId>
+    <stockId>stock-id-2</stockId>
+</book>

{py_serializable-1.0.2 → py_serializable-1.0.3}/tests/fixtures/the-phoenix-project-defaultNS-mixed-v4.xml

@@ -42,4 +42,6 @@
         </my:chapter>
     </my:chapters>
     <my:rating>9.8</my:rating>
-</my:book>
+    <my:stockId>stock-id-1</my:stockId>
+    <my:stockId>stock-id-2</my:stockId>
+</my:book>

{py_serializable-1.0.2 → py_serializable-1.0.3}/tests/fixtures/the-phoenix-project-defaultNS-unset-v4.xml

@@ -41,4 +41,6 @@
         </my:chapter>
     </my:chapters>
     <my:rating>9.8</my:rating>
-</my:book>
+    <my:stockId>stock-id-1</my:stockId>
+    <my:stockId>stock-id-2</my:stockId>
+</my:book>

{py_serializable-1.0.2 → py_serializable-1.0.3}/tests/model.py

@@ -226,6 +226,54 @@ class BookReference:
         return f'<BookReference ref={self.ref}, targets={len(self.references)}>'
 
 
+@serializable.serializable_class
+class StockId(serializable.helpers.BaseHelper):
+
+    def __init__(self, id: str) -> None:
+        self._id = id
+
+    @property
+    @serializable.json_name('.')
+    @serializable.xml_name('.')
+    def id(self) -> str:
+        return self._id
+
+    @classmethod
+    def serialize(cls, o: Any) -> str:
+        if isinstance(o, StockId):
+            return str(o)
+        raise Exception(
+            f'Attempt to serialize a non-StockId: {o!r}')
+
+    @classmethod
+    def deserialize(cls, o: Any) -> 'StockId':
+        try:
+            return StockId(id=str(o))
+        except ValueError as err:
+            raise Exception(
+                f'StockId string supplied does not parse: {o!r}'
+            ) from err
+
+    def __eq__(self, other: Any) -> bool:
+        if isinstance(other, StockId):
+            return hash(other) == hash(self)
+        return False
+
+    def __lt__(self, other: Any) -> bool:
+        if isinstance(other, StockId):
+            return self._id < other._id
+        return NotImplemented
+
+    def __hash__(self) -> int:
+        return hash(self._id)
+
+    def __repr__(self) -> str:
+        return f'<StockId {self._id}>'
+
+    def __str__(self) -> str:
+        return self._id
+
+
 @serializable.serializable_class(name='bigbook',
                                  ignore_during_deserialization=['something_to_be_ignored', 'ignore_me', 'ignored'])
 class Book:
@@ -234,7 +282,7 @@ class Book:
                  publisher: Optional[Publisher] = None, chapters: Optional[Iterable[Chapter]] = None,
                  edition: Optional[BookEdition] = None, type: BookType = BookType.FICTION,
                  id: Optional[UUID] = None, references: Optional[Iterable[BookReference]] = None,
-                 rating: Optional[Decimal] = None) -> None:
+                 rating: Optional[Decimal] = None, stock_ids: Optional[Iterable[StockId]] = None) -> None:
         self._id = id or uuid4()
         self._title = title
         self._isbn = isbn
@@ -246,6 +294,7 @@ class Book:
         self._type = type
         self.references = set(references or [])
         self.rating = Decimal('NaN') if rating is None else rating
+        self._stock_ids = set(stock_ids or [])
 
     @property
     @serializable.xml_sequence(1)
@@ -322,6 +371,13 @@ class Book:
     def rating(self, rating: Decimal) -> None:
         self._rating = rating
 
+    @property
+    @serializable.view(SchemaVersion4)
+    @serializable.xml_array(XmlArraySerializationType.FLAT, 'stockId')
+    @serializable.xml_sequence(21)
+    def stock_ids(self) -> Set[StockId]:
+        return self._stock_ids
+
 
 ThePhoenixProject_v1 = Book(
     title='The Phoenix Project', isbn='978-1942788294', publish_date=date(year=2018, month=4, day=16),
@@ -343,7 +399,8 @@ ThePhoenixProject_v2 = Book(
     publisher=Publisher(name='IT Revolution Press LLC', address='10 Downing Street'),
     edition=BookEdition(number=5, name='5th Anniversary Limited Edition'),
     id=UUID('f3758bf0-0ff7-4366-a5e5-c209d4352b2d'),
-    rating=Decimal('9.8')
+    rating=Decimal('9.8'),
+    stock_ids=[StockId('stock-id-1'), StockId('stock-id-2')]
 )
 
 ThePhoenixProject_v2.chapters.append(Chapter(number=1, title='Tuesday, September 2'))
@@ -370,6 +427,7 @@ if __name__ == '__main__':
 
     import io
     import json
+
     tpp_from_xml = ThePhoenixProject.from_xml(  # type:ignore[attr-defined]
         io.StringIO(tpp_as_xml))
     tpp_from_json = ThePhoenixProject.from_json(  # type:ignore[attr-defined]