oslo.versionedobjects 3.10.2__tar.gz → 3.12.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/.pre-commit-config.yaml +2 -2
  2. oslo_versionedobjects-3.12.0/.zuul.yaml +69 -0
  3. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/ChangeLog +31 -0
  4. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/PKG-INFO +3 -5
  5. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/bindep.txt +1 -1
  6. oslo_versionedobjects-3.12.0/doc/source/user/examples.rst +23 -0
  7. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/PKG-INFO +3 -5
  8. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/SOURCES.txt +9 -0
  9. oslo_versionedobjects-3.12.0/oslo.versionedobjects.egg-info/pbr.json +1 -0
  10. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/requires.txt +0 -2
  11. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/base.py +154 -67
  12. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/fields.py +39 -27
  13. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/mypy.py +64 -57
  14. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/test.py +0 -27
  15. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/basic_fields.py +36 -0
  16. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/compound_fields.py +52 -0
  17. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/empty_fields.py +19 -0
  18. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/enum_fields.py +40 -0
  19. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/object_fields.py +47 -0
  20. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/subclassing.py +37 -0
  21. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_data/timestamp_mixin.py +28 -0
  22. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/test_fields.py +47 -4
  23. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/test_fixture.py +1 -1
  24. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/test_mypy.py +259 -204
  25. oslo_versionedobjects-3.12.0/oslo_versionedobjects/tests/test_mypy_integration.py +164 -0
  26. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/test_objects.py +11 -9
  27. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/pyproject.toml +4 -3
  28. oslo_versionedobjects-3.12.0/releasenotes/notes/remove-py310-2e38a61a45ea7584.yaml +5 -0
  29. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/requirements.txt +0 -2
  30. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/tox.ini +4 -6
  31. oslo_versionedobjects-3.10.2/.zuul.yaml +0 -27
  32. oslo_versionedobjects-3.10.2/doc/source/user/examples.rst +0 -23
  33. oslo_versionedobjects-3.10.2/oslo.versionedobjects.egg-info/pbr.json +0 -1
  34. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/.coveragerc +0 -0
  35. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/.mailmap +0 -0
  36. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/.stestr.conf +0 -0
  37. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/AUTHORS +0 -0
  38. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/CONTRIBUTING.rst +0 -0
  39. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/HACKING.rst +0 -0
  40. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/LICENSE +0 -0
  41. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/README.rst +0 -0
  42. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/requirements.txt +0 -0
  43. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/conf.py +0 -0
  44. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/configuration/index.rst +0 -0
  45. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/contributor/index.rst +0 -0
  46. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/index.rst +0 -0
  47. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/install/index.rst +0 -0
  48. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/reference/base.rst +0 -0
  49. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/reference/exception.rst +0 -0
  50. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/reference/fields.rst +0 -0
  51. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/reference/fixture.rst +0 -0
  52. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/reference/index.rst +0 -0
  53. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/user/history.rst +0 -0
  54. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/user/index.rst +0 -0
  55. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/user/typing.rst +0 -0
  56. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/doc/source/user/usage.rst +0 -0
  57. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/dependency_links.txt +0 -0
  58. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/entry_points.txt +0 -0
  59. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/not-zip-safe +0 -0
  60. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo.versionedobjects.egg-info/top_level.txt +0 -0
  61. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/__init__.py +0 -0
  62. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/_i18n.py +0 -0
  63. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/_options.py +0 -0
  64. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/_utils.py +0 -0
  65. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/examples/__init__.py +0 -0
  66. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/examples/iot_bulb.py +0 -0
  67. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/exception.py +0 -0
  68. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/fixture.py +0 -0
  69. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/locale/en_GB/LC_MESSAGES/oslo_versionedobjects.po +0 -0
  70. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/py.typed +0 -0
  71. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/__init__.py +0 -0
  72. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/obj_fixtures.py +0 -0
  73. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/oslo_versionedobjects/tests/test_exception.py +0 -0
  74. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/add-reno-996dd44974d53238.yaml +0 -0
  75. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/deprecate-remotable_classmethod-3c7d0f658af39fb6.yaml +0 -0
  76. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/drop-python27-support-b3e377b0dcfa4f5c.yaml +0 -0
  77. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/remove-field-staticmethods-62f5a62b2544b603.yaml +0 -0
  78. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/remove-py38-f4e8c7ce18a5914b.yaml +0 -0
  79. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/remove-py39-a35bc15c07073b80.yaml +0 -0
  80. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/remove-test-helpers-032475d5bc2ec8ca.yaml +0 -0
  81. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/notes/update_md5_for_fips-e5a8f8f438ac81fb.yaml +0 -0
  82. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2023.1.rst +0 -0
  83. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2023.2.rst +0 -0
  84. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2024.1.rst +0 -0
  85. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2024.2.rst +0 -0
  86. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2025.1.rst +0 -0
  87. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2025.2.rst +0 -0
  88. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/2026.1.rst +0 -0
  89. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/_static/.placeholder +0 -0
  90. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/_templates/.placeholder +0 -0
  91. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/conf.py +0 -0
  92. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/index.rst +0 -0
  93. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po +0 -0
  94. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/ocata.rst +0 -0
  95. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/pike.rst +0 -0
  96. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/queens.rst +0 -0
  97. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/rocky.rst +0 -0
  98. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/stein.rst +0 -0
  99. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/train.rst +0 -0
  100. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/unreleased.rst +0 -0
  101. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/ussuri.rst +0 -0
  102. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/victoria.rst +0 -0
  103. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/wallaby.rst +0 -0
  104. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/xena.rst +0 -0
  105. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/yoga.rst +0 -0
  106. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/releasenotes/source/zed.rst +0 -0
  107. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/setup.cfg +0 -0
  108. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/setup.py +0 -0
  109. {oslo_versionedobjects-3.10.2 → oslo_versionedobjects-3.12.0}/test-requirements.txt +0 -0
@@ -13,13 +13,13 @@ repos:
13
13
  - id: check-yaml
14
14
  files: .*\.(yaml|yml)$
15
15
  - repo: https://github.com/astral-sh/ruff-pre-commit
16
- rev: v0.15.4
16
+ rev: v0.15.19
17
17
  hooks:
18
18
  - id: ruff-check
19
19
  args: ['--fix', '--unsafe-fixes']
20
20
  - id: ruff-format
21
21
  - repo: https://opendev.org/openstack/hacking
22
- rev: 8.0.0
22
+ rev: 8.1.0
23
23
  hooks:
24
24
  - id: hacking
25
25
  additional_dependencies: []
@@ -0,0 +1,69 @@
1
+ ---
2
+
3
+ - project:
4
+ check:
5
+ jobs:
6
+ - oslo.versionedobjects-src-grenade-multinode
7
+ - oslo.versionedobjects-nova-tox-py313
8
+ - oslo.versionedobjects-ironic-tox-py313
9
+ gate:
10
+ jobs:
11
+ - oslo.versionedobjects-nova-tox-py313
12
+ - oslo.versionedobjects-ironic-tox-py313
13
+ templates:
14
+ - check-requirements
15
+ - lib-forward-testing-python3
16
+ - openstack-python3-jobs
17
+ - openstack-python3-next-jobs
18
+ - periodic-stable-jobs
19
+ - publish-openstack-docs-pti
20
+ - release-notes-jobs-python3
21
+
22
+ - job:
23
+ name: oslo.versionedobjects-nova-tox-py313
24
+ parent: openstack-tox-py313
25
+ description: |
26
+ Run cross-project unit tests on nova.
27
+ vars:
28
+ zuul_work_dir: src/opendev.org/openstack/nova
29
+ required-projects:
30
+ - openstack/nova
31
+ - openstack/oslo.versionedobjects
32
+ irrelevant-files: &irrelevant-files
33
+ - ^\.gitignore$
34
+ - ^\.gitreview$
35
+ - ^.*\.rst$
36
+ - ^doc/.*$
37
+ - LICENSE
38
+ - ^releasenotes/.*$
39
+ - ^\.pre-commit-config\.yaml$
40
+ - ^oslo_versionedobjects/tests/.*$
41
+ - ^test-requirements\.txt$
42
+
43
+ - job:
44
+ name: oslo.versionedobjects-ironic-tox-py313
45
+ parent: openstack-tox-py313
46
+ description: |
47
+ Run cross-project unit tests on ironic.
48
+ vars:
49
+ zuul_work_dir: src/opendev.org/openstack/ironic
50
+ required-projects:
51
+ - openstack/ironic
52
+ - openstack/oslo.versionedobjects
53
+ irrelevant-files: *irrelevant-files
54
+
55
+ - job:
56
+ name: oslo.versionedobjects-src-grenade-multinode
57
+ parent: grenade-multinode
58
+ voting: false
59
+ irrelevant-files:
60
+ - ^.*\.rst$
61
+ - ^doc/.*$
62
+ - ^releasenotes/.*$
63
+ - ^.git.*$
64
+ - ^.*/locale/.*po$
65
+ - ^(test-|)requirements.txt$
66
+ - ^setup.cfg$
67
+ - ^\.pre-commit-config\.yaml$
68
+ required-projects:
69
+ - opendev.org/openstack/oslo.versionedobjects
@@ -1,6 +1,32 @@
1
1
  CHANGES
2
2
  =======
3
3
 
4
+ 3.12.0
5
+ ------
6
+
7
+ * bindep: Remove stale marker
8
+
9
+ 3.11.0
10
+ ------
11
+
12
+ * Deprecate item\_cls argument to obj\_make\_list
13
+ * trivial: Fix docstrings
14
+ * tests: Use isolated cache dirs for mypy integration tests
15
+ * zuul: Use openstack-python3-next-jobs template
16
+ * pre-commit: Bump versions
17
+ * Do not install code to build release notes
18
+ * tests: Add mypy plugin integration tests
19
+ * Drop support for Python 3.10
20
+ * typing: Correct return type of obj\_make\_list
21
+ * mypy: Fix cross-module field inheritance for mixin classes
22
+ * mypy: Resolve ObjectField types in a second pass
23
+ * mypy: Drop field caching
24
+ * mypy: Derive field types from generic parameter
25
+ * tests: De-dupe AST generation
26
+ * trivial: Remove unnecessary quotes
27
+ * Replace tabs with spaces
28
+ * tox: Use new constraints option
29
+
4
30
  3.10.2
5
31
  ------
6
32
 
@@ -8,12 +34,17 @@ CHANGES
8
34
  3.10.1
9
35
  ------
10
36
 
37
+ * Add cross-testing for nova, ironic
11
38
  * Remove abstractmethod from deprecated object\_backport method
12
39
  * Accept context passed by kwarg
13
40
  * typing: Resolve ObjectField and ListOfObjectsField to concrete types
41
+ * test: Remove use of oslo\_concurrency.lockutils
42
+ * fields: Add primitive field types from nova
14
43
  * Rename args -> kwargs
15
44
  * Remove unecessary try-except login in mypy plugin
16
45
  * Remove some duplication in the mypy plugin
46
+ * base: Add docs for obj\_extra\_fields attribute
47
+ * base: Make variables comments readable by Sphinx
17
48
 
18
49
  3.10.0
19
50
  ------
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oslo.versionedobjects
3
- Version: 3.10.2
3
+ Version: 3.12.0
4
4
  Summary: Oslo Versioned Objects library
5
5
  Author-email: OpenStack <openstack-discuss@lists.openstack.org>
6
6
  License: Apache-2.0
@@ -13,19 +13,17 @@ Classifier: License :: OSI Approved :: Apache Software License
13
13
  Classifier: Operating System :: POSIX :: Linux
14
14
  Classifier: Programming Language :: Python
15
15
  Classifier: Programming Language :: Python :: 3
16
- Classifier: Programming Language :: Python :: 3.10
17
16
  Classifier: Programming Language :: Python :: 3.11
18
17
  Classifier: Programming Language :: Python :: 3.12
19
18
  Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
20
  Classifier: Typing :: Typed
21
- Requires-Python: >=3.10
21
+ Requires-Python: >=3.11
22
22
  Description-Content-Type: text/x-rst
23
23
  License-File: LICENSE
24
- Requires-Dist: oslo.concurrency>=3.26.0
25
24
  Requires-Dist: oslo.config>=5.2.0
26
25
  Requires-Dist: oslo.context>=2.19.2
27
26
  Requires-Dist: oslo.messaging>=5.29.0
28
- Requires-Dist: oslo.serialization>=2.18.0
29
27
  Requires-Dist: oslo.utils>=7.4.0
30
28
  Requires-Dist: oslo.log>=3.36.0
31
29
  Requires-Dist: oslo.i18n>=3.15.3
@@ -2,6 +2,6 @@
2
2
  # see http://docs.openstack.org/infra/bindep/ for additional information.
3
3
 
4
4
  locales [platform:debian]
5
- python3-all-dev [platform:ubuntu !platform:ubuntu-precise]
5
+ python3-all-dev [platform:ubuntu]
6
6
  python3-dev [platform:dpkg]
7
7
  python3-devel [platform:fedora]
@@ -0,0 +1,23 @@
1
+ ==========
2
+ Examples
3
+ ==========
4
+
5
+ IOT lightbulb
6
+ =============
7
+
8
+ .. note::
9
+
10
+ Full source located at :example:`iot_bulb`.
11
+
12
+ .. literalinclude:: ../../../oslo_versionedobjects/examples/iot_bulb.py
13
+ :language: python
14
+ :linenos:
15
+ :lines: 14-
16
+
17
+ Expected (or similar) output::
18
+
19
+ The __str__() output of this new object: IOTLightbulb(manufactured_on=2017-03-15T23:25:01Z,serial='abc-123')
20
+ The 'serial' field of the object: abc-123
21
+ Primitive representation of this object: {'versioned_object.version': '1.0', 'versioned_object.changes': ['serial', 'manufactured_on'], 'versioned_object.name': 'IOTLightbulb', 'versioned_object.data': {'serial': u'abc-123', 'manufactured_on': '2017-03-15T23:25:01Z'}, 'versioned_object.namespace': 'versionedobjects.examples'}
22
+ The __str__() output of this new (reconstructed) object: IOTLightbulb(manufactured_on=2017-03-15T23:25:01Z,serial='abc-123')
23
+ After serial number change, the set of fields that have been mutated is: set(['serial'])
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oslo.versionedobjects
3
- Version: 3.10.2
3
+ Version: 3.12.0
4
4
  Summary: Oslo Versioned Objects library
5
5
  Author-email: OpenStack <openstack-discuss@lists.openstack.org>
6
6
  License: Apache-2.0
@@ -13,19 +13,17 @@ Classifier: License :: OSI Approved :: Apache Software License
13
13
  Classifier: Operating System :: POSIX :: Linux
14
14
  Classifier: Programming Language :: Python
15
15
  Classifier: Programming Language :: Python :: 3
16
- Classifier: Programming Language :: Python :: 3.10
17
16
  Classifier: Programming Language :: Python :: 3.11
18
17
  Classifier: Programming Language :: Python :: 3.12
19
18
  Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
20
  Classifier: Typing :: Typed
21
- Requires-Python: >=3.10
21
+ Requires-Python: >=3.11
22
22
  Description-Content-Type: text/x-rst
23
23
  License-File: LICENSE
24
- Requires-Dist: oslo.concurrency>=3.26.0
25
24
  Requires-Dist: oslo.config>=5.2.0
26
25
  Requires-Dist: oslo.context>=2.19.2
27
26
  Requires-Dist: oslo.messaging>=5.29.0
28
- Requires-Dist: oslo.serialization>=2.18.0
29
27
  Requires-Dist: oslo.utils>=7.4.0
30
28
  Requires-Dist: oslo.log>=3.36.0
31
29
  Requires-Dist: oslo.i18n>=3.15.3
@@ -60,11 +60,20 @@ oslo_versionedobjects/tests/test_exception.py
60
60
  oslo_versionedobjects/tests/test_fields.py
61
61
  oslo_versionedobjects/tests/test_fixture.py
62
62
  oslo_versionedobjects/tests/test_mypy.py
63
+ oslo_versionedobjects/tests/test_mypy_integration.py
63
64
  oslo_versionedobjects/tests/test_objects.py
65
+ oslo_versionedobjects/tests/test_data/basic_fields.py
66
+ oslo_versionedobjects/tests/test_data/compound_fields.py
67
+ oslo_versionedobjects/tests/test_data/empty_fields.py
68
+ oslo_versionedobjects/tests/test_data/enum_fields.py
69
+ oslo_versionedobjects/tests/test_data/object_fields.py
70
+ oslo_versionedobjects/tests/test_data/subclassing.py
71
+ oslo_versionedobjects/tests/test_data/timestamp_mixin.py
64
72
  releasenotes/notes/add-reno-996dd44974d53238.yaml
65
73
  releasenotes/notes/deprecate-remotable_classmethod-3c7d0f658af39fb6.yaml
66
74
  releasenotes/notes/drop-python27-support-b3e377b0dcfa4f5c.yaml
67
75
  releasenotes/notes/remove-field-staticmethods-62f5a62b2544b603.yaml
76
+ releasenotes/notes/remove-py310-2e38a61a45ea7584.yaml
68
77
  releasenotes/notes/remove-py38-f4e8c7ce18a5914b.yaml
69
78
  releasenotes/notes/remove-py39-a35bc15c07073b80.yaml
70
79
  releasenotes/notes/remove-test-helpers-032475d5bc2ec8ca.yaml
@@ -0,0 +1 @@
1
+ {"git_version": "6fc2dcc", "is_release": true}
@@ -1,8 +1,6 @@
1
- oslo.concurrency>=3.26.0
2
1
  oslo.config>=5.2.0
3
2
  oslo.context>=2.19.2
4
3
  oslo.messaging>=5.29.0
5
- oslo.serialization>=2.18.0
6
4
  oslo.utils>=7.4.0
7
5
  oslo.log>=3.36.0
8
6
  oslo.i18n>=3.15.3
@@ -34,8 +34,8 @@ from typing import (
34
34
  Concatenate,
35
35
  overload,
36
36
  ParamSpec,
37
+ Self,
37
38
  TypeVar,
38
- TYPE_CHECKING,
39
39
  )
40
40
  import warnings
41
41
 
@@ -47,12 +47,10 @@ from oslo_versionedobjects._i18n import _
47
47
  from oslo_versionedobjects import exception
48
48
  from oslo_versionedobjects import fields as obj_fields
49
49
 
50
- if TYPE_CHECKING:
51
- from typing_extensions import Self
52
-
53
50
  LOG = logging.getLogger('object')
54
51
 
55
52
  _VO = TypeVar('_VO', bound='VersionedObject')
53
+ _VOL = TypeVar('_VOL', bound='ObjectListBase[Any]')
56
54
 
57
55
 
58
56
  class _NotSpecifiedSentinel:
@@ -401,62 +399,83 @@ class VersionedObject:
401
399
 
402
400
  indirection_api: VersionedObjectIndirectionAPI | None = None
403
401
 
404
- # Object versioning rules
405
- #
406
- # Each service has its set of objects, each with a version attached. When
407
- # a client attempts to call an object method, the server checks to see if
408
- # the version of that object matches (in a compatible way) its object
409
- # implementation. If so, cool, and if not, fail.
410
- #
411
- # This version is allowed to have three parts, X.Y.Z, where the .Z element
412
- # is reserved for stable branch backports. The .Z is ignored for the
413
- # purposes of triggering a backport, which means anything changed under
414
- # a .Z must be additive and non-destructive such that a node that knows
415
- # about X.Y can consider X.Y.Z equivalent.
402
+ #: Object version field
403
+ #:
404
+ #: Each service has its set of objects, each with a version attached. When
405
+ #: a client attempts to call an object method, the server checks to see if
406
+ #: the version of that object matches (in a compatible way) its object
407
+ #: implementation. If so, cool, and if not, fail.
408
+ #:
409
+ #: This version is allowed to have three parts, ``X.Y.Z``, where the ``.Z``
410
+ #: element is reserved for stable branch backports. The ``.Z`` is ignored
411
+ #: for the purposes of triggering a backport, which means anything changed
412
+ #: under a ``.Z`` must be additive and non-destructive such that a node
413
+ #: that knows about ``X.Y`` can consider ``X.Y.Z`` equivalent.
416
414
  VERSION: str = '1.0'
417
415
 
418
- # Object namespace for serialization
419
- # NB: Generally this should not be changed, but is needed for backwards
420
- # compatibility
416
+ #: Object namespace for serialization
417
+ #:
418
+ #: This should generally not be changed, but is needed for backwards
419
+ #: compatibility
421
420
  OBJ_SERIAL_NAMESPACE: str = 'versioned_object'
422
421
 
423
- # Object project namespace for serialization
424
- # This is used to disambiguate owners of objects sharing a common RPC
425
- # medium
422
+ #: Object project namespace for serialization
423
+ #:
424
+ #: This is used to disambiguate owners of objects sharing a common RPC
425
+ #: medium.
426
426
  OBJ_PROJECT_NAMESPACE: str = 'versionedobjects'
427
427
 
428
- # The fields present in this object as key:field pairs. For example:
429
- #
430
- # fields = { 'foo': obj_fields.IntegerField(),
431
- # 'bar': obj_fields.StringField(),
432
- # }
428
+ #: The fields present in this object as ``key:field`` pairs.
429
+ #:
430
+ #: For example::
431
+ #:
432
+ #: fields = {
433
+ #: 'foo': obj_fields.IntegerField(),
434
+ #: 'bar': obj_fields.StringField(),
435
+ #: }
436
+ #:
433
437
  fields: MutableMapping[str, obj_fields.Field[Any]] = {}
438
+
439
+ #: List of additional object attributes to expose alongside :attr:`fields`.
440
+ #:
441
+ #: Names listed here are typically implemented as Python properties and
442
+ #: are included in :attr:`obj_fields` and exposed through iteration, but
443
+ #: they are not versioned and not serialized during RPC::
444
+ #:
445
+ #: class MyObject(VersionedObject):
446
+ #: fields = {'foo': obj_fields.IntegerField()}
447
+ #: obj_extra_fields = ['bar']
448
+ #:
449
+ #: @property
450
+ #: def bar(self):
451
+ #: return self.foo * 2
434
452
  obj_extra_fields: Sequence[str] = []
435
453
 
436
- # Table of sub-object versioning information
437
- #
438
- # This contains a list of version mappings, by the field name of
439
- # the subobject. The mappings must be in order of oldest to
440
- # newest, and are tuples of (my_version, subobject_version). A
441
- # request to backport this object to $my_version will cause the
442
- # subobject to be backported to $subobject_version.
443
- #
444
- # obj_relationships = {
445
- # 'subobject1': [('1.2', '1.1'), ('1.4', '1.2')],
446
- # 'subobject2': [('1.2', '1.0')],
447
- # }
448
- #
449
- # In the above example:
450
- #
451
- # - If we are asked to backport our object to version 1.3,
452
- # subobject1 will be backported to version 1.1, since it was
453
- # bumped to version 1.2 when our version was 1.4.
454
- # - If we are asked to backport our object to version 1.5,
455
- # no changes will be made to subobject1 or subobject2, since
456
- # they have not changed since version 1.4.
457
- # - If we are asked to backlevel our object to version 1.1, we
458
- # will remove both subobject1 and subobject2 from the primitive,
459
- # since they were not added until version 1.2.
454
+ #: Table of sub-object versioning information
455
+ #:
456
+ #: This contains a list of version mappings, by the field name of
457
+ #: the subobject. The mappings must be in order of oldest to
458
+ #: newest, and are tuples of ``(my_version, subobject_version)``. A
459
+ #: request to backport this object to ``my_version`` will cause the
460
+ #: subobject to be backported to ``subobject_version``::
461
+ #:
462
+ #: obj_relationships = {
463
+ #: 'subobject1': [('1.2', '1.1'), ('1.4', '1.2')],
464
+ #: 'subobject2': [('1.2', '1.0')],
465
+ #: }
466
+ #:
467
+ #: In the above example:
468
+ #:
469
+ #: * If we are asked to backport our object to version 1.3,
470
+ #: ``subobject1`` will be backported to version 1.1, since it was
471
+ #: bumped to version 1.2 when our version was 1.4.
472
+ #: * If we are asked to backport our object to version 1.5,
473
+ #: no changes will be made to ``subobject1`` or ``subobject2``, since
474
+ #: they have not changed since version 1.4.
475
+ #: * If we are asked to backlevel our object to version 1.1, we
476
+ #: will remove both ``subobject1`` and ``subobject2`` from the primitive,
477
+ #: since they were not added until version 1.2.
478
+ #:
460
479
  obj_relationships: dict[str, list[tuple[str, str]]] = {}
461
480
 
462
481
  _changed_fields: set[str]
@@ -507,7 +526,7 @@ class VersionedObject:
507
526
 
508
527
  @classmethod
509
528
  def obj_name(cls) -> str:
510
- """Return the object's name
529
+ """Return the object's name.
511
530
 
512
531
  Return a canonical name for this object which will be used over
513
532
  the wire for remote hydration.
@@ -663,9 +682,9 @@ class VersionedObject:
663
682
  requires that the obj_relationships table in this object is
664
683
  correct and up-to-date.
665
684
 
666
- :param:primitive: The primitive version of this object
667
- :param:target_version: The version string requested for this object
668
- :param:field: The name of the field in this object containing the
685
+ :param primitive: The primitive version of this object
686
+ :param target_version: The version string requested for this object
687
+ :param field: The name of the field in this object containing the
669
688
  sub-object to be backported
670
689
  """
671
690
  relationship_map = self._obj_relationship_for(field, target_version)
@@ -946,7 +965,32 @@ class ComparableVersionedObject:
946
965
  return NotImplemented
947
966
 
948
967
 
949
- class TimestampedObject:
968
+ class VersionedObjectMixin:
969
+ """Marker base class for OVO mixin classes that contribute fields.
970
+
971
+ Mixin classes that define an OVO ``fields`` dict should inherit from this
972
+ class so that the ``oslo_versionedobjects.mypy`` plugin can discover and
973
+ type-check their fields in the same way it handles registered
974
+ ``VersionedObject`` subclasses.
975
+
976
+ Example::
977
+
978
+ class MyFieldsMixin(VersionedObjectMixin):
979
+ fields: MutableMapping[str, fields.Field[Any]] = {
980
+ 'name': fields.StringField(),
981
+ }
982
+
983
+
984
+ @base.VersionedObjectRegistry.register
985
+ class MyObject(MyFieldsMixin, base.VersionedObject):
986
+ VERSION = '1.0'
987
+ fields = {
988
+ 'count': fields.IntegerField(),
989
+ }
990
+ """
991
+
992
+
993
+ class TimestampedObject(VersionedObjectMixin):
950
994
  """Mixin class for db backed objects with timestamp fields.
951
995
 
952
996
  Sqlalchemy models that inherit from the oslo_db TimestampMixin will include
@@ -1222,9 +1266,9 @@ class VersionedObjectSerializer(messaging.NoOpSerializer): # type: ignore[misc]
1222
1266
  ) -> tuple[Any, ...] | list[Any] | dict[str, Any]:
1223
1267
  """Process an iterable, taking an action on each value.
1224
1268
 
1225
- :param:context: Request context
1226
- :param:action_fn: Action to take on each item in values
1227
- :param:values: Iterable container of things to take action on
1269
+ :param context: Request context
1270
+ :param action_fn: Action to take on each item in values
1271
+ :param values: Iterable container of things to take action on
1228
1272
  :returns: A new container of the same type (except set) with
1229
1273
  items from values having had action applied.
1230
1274
  """
@@ -1437,25 +1481,68 @@ class VersionedObjectIndirectionAPI(metaclass=abc.ABCMeta):
1437
1481
  raise NotImplementedError('Multi-version backport not supported')
1438
1482
 
1439
1483
 
1484
+ @overload
1440
1485
  def obj_make_list(
1441
1486
  context: Any,
1442
- list_obj: ObjectListBase[_VO],
1443
- item_cls: type[_VO],
1487
+ list_obj: _VOL,
1444
1488
  db_list: list[dict[str, Any]],
1445
1489
  **extra_args: Any,
1446
- ) -> ObjectListBase[_VO]:
1490
+ ) -> _VOL: ...
1491
+
1492
+
1493
+ @overload
1494
+ def obj_make_list(
1495
+ context: Any,
1496
+ list_obj: _VOL,
1497
+ item_cls: type[Any],
1498
+ db_list: list[dict[str, Any]],
1499
+ **extra_args: Any,
1500
+ ) -> _VOL: ...
1501
+
1502
+
1503
+ def obj_make_list(
1504
+ context: Any,
1505
+ list_obj: _VOL,
1506
+ *args: Any,
1507
+ **extra_args: Any,
1508
+ ) -> _VOL:
1447
1509
  """Construct an object list from a list of primitives.
1448
1510
 
1449
1511
  This calls item_cls._from_db_object() on each item of db_list, and
1450
1512
  adds the resulting object to list_obj.
1451
1513
 
1452
- :param:context: Request context
1453
- :param:list_obj: An ObjectListBase object
1454
- :param:item_cls: The VersionedObject class of the objects within the list
1455
- :param:db_list: The list of primitives to convert to objects
1456
- :param:extra_args: Extra arguments to pass to _from_db_object()
1514
+ :param context: Request context
1515
+ :param list_obj: An ObjectListBase object
1516
+ :param item_cls: Deprecated. The VersionedObject class of the objects
1517
+ within the list. If not provided, derived from the list object's field
1518
+ definition
1519
+ :param db_list: The list of primitives to convert to objects
1520
+ :param extra_args: Extra arguments to pass to _from_db_object()
1457
1521
  :returns: list_obj
1458
1522
  """
1523
+ if len(args) == 1:
1524
+ db_list = args[0]
1525
+ objects_field = cast(
1526
+ obj_fields.ListOfObjectsField, list_obj.fields['objects']
1527
+ )
1528
+ obj_name = objects_field.objname
1529
+ item_cls: type[Any] = VersionedObjectRegistry.obj_classes()[obj_name][
1530
+ 0
1531
+ ]
1532
+ elif len(args) == 2:
1533
+ warnings.warn(
1534
+ "Passing item_cls to obj_make_list() is deprecated. The item "
1535
+ "class is now derived from the list object's field definition.",
1536
+ DeprecationWarning,
1537
+ stacklevel=2,
1538
+ )
1539
+ item_cls, db_list = args
1540
+ else:
1541
+ raise TypeError(
1542
+ f"obj_make_list() takes 3 or 4 positional arguments but "
1543
+ f"{2 + len(args)} were given"
1544
+ )
1545
+
1459
1546
  list_obj.objects = []
1460
1547
  for db_item in db_list:
1461
1548
  # _from_db_object is a convention classmethod for VersionedObject