oslo.versionedobjects 3.8.0__tar.gz → 3.10.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 (107) hide show
  1. oslo_versionedobjects-3.10.0/.pre-commit-config.yaml +25 -0
  2. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/AUTHORS +1 -0
  3. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/ChangeLog +52 -0
  4. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/PKG-INFO +15 -19
  5. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/README.rst +3 -8
  6. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/conf.py +13 -8
  7. oslo_versionedobjects-3.10.0/doc/source/reference/base.rst +6 -0
  8. oslo_versionedobjects-3.10.0/doc/source/reference/exception.rst +6 -0
  9. oslo_versionedobjects-3.10.0/doc/source/reference/fields.rst +6 -0
  10. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/reference/fixture.rst +3 -3
  11. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/user/index.rst +1 -0
  12. oslo_versionedobjects-3.10.0/doc/source/user/typing.rst +32 -0
  13. oslo_versionedobjects-3.10.0/doc/source/user/usage.rst +405 -0
  14. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/PKG-INFO +15 -19
  15. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/SOURCES.txt +10 -0
  16. oslo_versionedobjects-3.10.0/oslo.versionedobjects.egg-info/pbr.json +1 -0
  17. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/requires.txt +0 -1
  18. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/_i18n.py +0 -1
  19. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/_options.py +3 -1
  20. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/_utils.py +9 -4
  21. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/base.py +648 -280
  22. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/examples/iot_bulb.py +8 -7
  23. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/exception.py +59 -40
  24. oslo_versionedobjects-3.10.0/oslo_versionedobjects/fields.py +1666 -0
  25. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/fixture.py +288 -130
  26. oslo_versionedobjects-3.10.0/oslo_versionedobjects/mypy.py +234 -0
  27. oslo_versionedobjects-3.10.0/oslo_versionedobjects/test.py +130 -0
  28. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/tests/obj_fixtures.py +33 -19
  29. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/tests/test_exception.py +20 -10
  30. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/tests/test_fields.py +470 -303
  31. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/tests/test_fixture.py +334 -230
  32. oslo_versionedobjects-3.10.0/oslo_versionedobjects/tests/test_mypy.py +565 -0
  33. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/tests/test_objects.py +737 -526
  34. oslo_versionedobjects-3.10.0/pyproject.toml +74 -0
  35. oslo_versionedobjects-3.10.0/releasenotes/notes/deprecate-remotable_classmethod-3c7d0f658af39fb6.yaml +18 -0
  36. oslo_versionedobjects-3.10.0/releasenotes/notes/remove-field-staticmethods-62f5a62b2544b603.yaml +6 -0
  37. oslo_versionedobjects-3.10.0/releasenotes/notes/remove-py39-a35bc15c07073b80.yaml +5 -0
  38. oslo_versionedobjects-3.10.0/releasenotes/notes/remove-test-helpers-032475d5bc2ec8ca.yaml +11 -0
  39. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/2024.1.rst +1 -1
  40. oslo_versionedobjects-3.10.0/releasenotes/source/2025.2.rst +6 -0
  41. oslo_versionedobjects-3.10.0/releasenotes/source/2026.1.rst +6 -0
  42. oslo_versionedobjects-3.10.0/releasenotes/source/_templates/.placeholder +0 -0
  43. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/conf.py +23 -13
  44. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/index.rst +2 -0
  45. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/requirements.txt +0 -1
  46. oslo_versionedobjects-3.10.0/setup.cfg +7 -0
  47. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/setup.py +1 -3
  48. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/test-requirements.txt +1 -0
  49. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/tox.ini +24 -6
  50. oslo_versionedobjects-3.8.0/.pre-commit-config.yaml +0 -35
  51. oslo_versionedobjects-3.8.0/doc/source/reference/base.rst +0 -6
  52. oslo_versionedobjects-3.8.0/doc/source/reference/exception.rst +0 -6
  53. oslo_versionedobjects-3.8.0/doc/source/reference/fields.rst +0 -6
  54. oslo_versionedobjects-3.8.0/doc/source/user/usage.rst +0 -131
  55. oslo_versionedobjects-3.8.0/oslo.versionedobjects.egg-info/pbr.json +0 -1
  56. oslo_versionedobjects-3.8.0/oslo_versionedobjects/fields.py +0 -1353
  57. oslo_versionedobjects-3.8.0/oslo_versionedobjects/test.py +0 -207
  58. oslo_versionedobjects-3.8.0/pyproject.toml +0 -3
  59. oslo_versionedobjects-3.8.0/setup.cfg +0 -36
  60. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/.coveragerc +0 -0
  61. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/.mailmap +0 -0
  62. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/.stestr.conf +0 -0
  63. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/.zuul.yaml +0 -0
  64. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/CONTRIBUTING.rst +0 -0
  65. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/HACKING.rst +0 -0
  66. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/LICENSE +0 -0
  67. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/bindep.txt +0 -0
  68. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/requirements.txt +0 -0
  69. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/configuration/index.rst +0 -0
  70. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/contributor/index.rst +0 -0
  71. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/index.rst +0 -0
  72. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/install/index.rst +0 -0
  73. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/reference/index.rst +0 -0
  74. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/user/examples.rst +0 -0
  75. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/doc/source/user/history.rst +0 -0
  76. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/dependency_links.txt +0 -0
  77. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/entry_points.txt +0 -0
  78. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/not-zip-safe +0 -0
  79. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo.versionedobjects.egg-info/top_level.txt +0 -0
  80. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/__init__.py +0 -0
  81. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/examples/__init__.py +0 -0
  82. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/oslo_versionedobjects/locale/en_GB/LC_MESSAGES/oslo_versionedobjects.po +0 -0
  83. /oslo_versionedobjects-3.8.0/oslo_versionedobjects/tests/__init__.py → /oslo_versionedobjects-3.10.0/oslo_versionedobjects/py.typed +0 -0
  84. /oslo_versionedobjects-3.8.0/releasenotes/source/_static/.placeholder → /oslo_versionedobjects-3.10.0/oslo_versionedobjects/tests/__init__.py +0 -0
  85. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/notes/add-reno-996dd44974d53238.yaml +0 -0
  86. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/notes/drop-python27-support-b3e377b0dcfa4f5c.yaml +0 -0
  87. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/notes/remove-py38-f4e8c7ce18a5914b.yaml +0 -0
  88. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/notes/update_md5_for_fips-e5a8f8f438ac81fb.yaml +0 -0
  89. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/2023.1.rst +0 -0
  90. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/2023.2.rst +0 -0
  91. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/2024.2.rst +0 -0
  92. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/2025.1.rst +0 -0
  93. {oslo_versionedobjects-3.8.0/releasenotes/source/_templates → oslo_versionedobjects-3.10.0/releasenotes/source/_static}/.placeholder +0 -0
  94. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po +0 -0
  95. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/ocata.rst +0 -0
  96. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/pike.rst +0 -0
  97. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/queens.rst +0 -0
  98. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/rocky.rst +0 -0
  99. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/stein.rst +0 -0
  100. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/train.rst +0 -0
  101. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/unreleased.rst +0 -0
  102. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/ussuri.rst +0 -0
  103. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/victoria.rst +0 -0
  104. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/wallaby.rst +0 -0
  105. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/xena.rst +0 -0
  106. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/yoga.rst +0 -0
  107. {oslo_versionedobjects-3.8.0 → oslo_versionedobjects-3.10.0}/releasenotes/source/zed.rst +0 -0
@@ -0,0 +1,25 @@
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: v6.0.0
4
+ hooks:
5
+ - id: trailing-whitespace
6
+ - id: mixed-line-ending
7
+ args: ['--fix', 'lf']
8
+ exclude: '.*\.(svg)$'
9
+ - id: fix-byte-order-marker
10
+ - id: check-executables-have-shebangs
11
+ - id: check-merge-conflict
12
+ - id: debug-statements
13
+ - id: check-yaml
14
+ files: .*\.(yaml|yml)$
15
+ - repo: https://github.com/astral-sh/ruff-pre-commit
16
+ rev: v0.15.4
17
+ hooks:
18
+ - id: ruff-check
19
+ args: ['--fix', '--unsafe-fixes']
20
+ - id: ruff-format
21
+ - repo: https://opendev.org/openstack/hacking
22
+ rev: 8.0.0
23
+ hooks:
24
+ - id: hacking
25
+ additional_dependencies: []
@@ -43,6 +43,7 @@ Armando Migliaccio <armando.migliaccio@eu.citrix.com>
43
43
  Attila Fazekas <afazekas@redhat.com>
44
44
  Avishay Traeger <avishay@il.ibm.com>
45
45
  Balazs Gibizer <balazs.gibizer@ericsson.com>
46
+ Balazs Gibizer <gibi@redhat.com>
46
47
  Belmiro Moreira <moreira.belmiro.email.lists@gmail.com>
47
48
  Ben Nemec <bnemec@redhat.com>
48
49
  Ben Nemec <openstack@nemebean.com>
@@ -1,6 +1,58 @@
1
1
  CHANGES
2
2
  =======
3
3
 
4
+ 3.10.0
5
+ ------
6
+
7
+ * Remove webob dependency
8
+ * Add strict typing
9
+ * Drop useless override of assertNotIsInstance
10
+ * typing: Add type hints to oslo\_versionedobjects.base
11
+ * typing: Add type hints to oslo\_versionedobjects.test
12
+ * typing: Add type hints to oslo\_versionedobjects.\_utils
13
+ * typing: Add type hints to oslo\_versionedobjects.\_options
14
+ * typing: Add type hints to oslo\_versionedobjects.exception
15
+ * typing: Add type hints to oslo\_versionedobjects.fixtures
16
+ * typing: Add type hints to oslo\_versionedobjects.fields
17
+ * Add initial typing
18
+ * Add support for nested types
19
+ * Add tests for mypy plugin
20
+ * Add mypy plugin
21
+ * tests: Remove dead code
22
+ * exceptions: Remove unused attribute
23
+ * Remove eventlet monkey-patch from test base class
24
+ * trivial: Split up remoteable decorator
25
+ * trivial: Disable H904 check
26
+ * base: Deprecate remotable\_classmethod
27
+ * base: Swap location of remoteable decorators
28
+ * fields: Move Coerced\* helpers
29
+ * fields: Remove unnecessary indentation
30
+ * fields: Remove use of staticmethod
31
+ * Update master for stable/2026.1
32
+ * tests: Fix tz-naive test
33
+ * tests: Replace reference to invalid field
34
+ * tests: Add usedforsecurity
35
+ * tests: Correct attribute type
36
+ * trivial: Fix logging issues
37
+ * tests: Rewrap strings
38
+ * Add ruff
39
+ * pre-commit: Bump dependencies
40
+ * docs: Expand usage guide with worked example
41
+ * docs: Rework reference, usage docs
42
+
43
+ 3.9.0
44
+ -----
45
+
46
+ * Delay string interpolations at logging calls
47
+ * Remove reference to tag framework
48
+ * reno: Update master for unmaintained/2024.1
49
+ * Bump pyupgrade target to 3.10+
50
+ * Migrate bandit options to pyproject.toml
51
+ * pre-commit: Bump dependencies
52
+ * Migrate setup configuration to pyproject.toml
53
+ * Drop Python 3.9 support
54
+ * Update master for stable/2025.2
55
+
4
56
  3.8.0
5
57
  -----
6
58
 
@@ -1,10 +1,11 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: oslo.versionedobjects
3
- Version: 3.8.0
3
+ Version: 3.10.0
4
4
  Summary: Oslo Versioned Objects library
5
- Home-page: https://docs.openstack.org/oslo.versionedobjects/latest/
6
- Author: OpenStack
7
- Author-email: openstack-discuss@lists.openstack.org
5
+ Author-email: OpenStack <openstack-discuss@lists.openstack.org>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://docs.openstack.org/oslo.versionedobjects
8
+ Project-URL: Repository, https://opendev.org/openstack/oslo.versionedobjects
8
9
  Classifier: Environment :: OpenStack
9
10
  Classifier: Intended Audience :: Information Technology
10
11
  Classifier: Intended Audience :: System Administrators
@@ -12,13 +13,13 @@ Classifier: License :: OSI Approved :: Apache Software License
12
13
  Classifier: Operating System :: POSIX :: Linux
13
14
  Classifier: Programming Language :: Python
14
15
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.9
16
16
  Classifier: Programming Language :: Python :: 3.10
17
17
  Classifier: Programming Language :: Python :: 3.11
18
18
  Classifier: Programming Language :: Python :: 3.12
19
- Classifier: Programming Language :: Python :: 3 :: Only
20
- Classifier: Programming Language :: Python :: Implementation :: CPython
21
- Requires-Python: >=3.9
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Typing :: Typed
21
+ Requires-Python: >=3.10
22
+ Description-Content-Type: text/x-rst
22
23
  License-File: LICENSE
23
24
  Requires-Dist: oslo.concurrency>=3.26.0
24
25
  Requires-Dist: oslo.config>=5.2.0
@@ -28,22 +29,18 @@ Requires-Dist: oslo.serialization>=2.18.0
28
29
  Requires-Dist: oslo.utils>=7.4.0
29
30
  Requires-Dist: oslo.log>=3.36.0
30
31
  Requires-Dist: oslo.i18n>=3.15.3
31
- Requires-Dist: WebOb>=1.7.1
32
32
  Requires-Dist: netaddr>=0.7.18
33
+ Dynamic: license-file
34
+ Dynamic: requires-dist
33
35
 
34
- ========================
35
- Team and repository tags
36
- ========================
36
+ =====================
37
+ oslo.versionedobjects
38
+ =====================
37
39
 
38
40
  .. image:: https://governance.openstack.org/tc/badges/oslo.versionedobjects.svg
39
- :target: https://governance.openstack.org/tc/reference/tags/index.html
40
41
 
41
42
  .. Change things from this point on
42
43
 
43
- =====================
44
- oslo.versionedobjects
45
- =====================
46
-
47
44
  .. image:: https://img.shields.io/pypi/v/oslo.versionedobjects.svg
48
45
  :target: https://pypi.org/project/oslo.versionedobjects/
49
46
  :alt: Latest Version
@@ -63,4 +60,3 @@ upgrade compatibility across distributed services.
63
60
  * Source: http://opendev.org/openstack/oslo.versionedobjects
64
61
  * Bugs: http://bugs.launchpad.net/oslo.versionedobjects
65
62
  * Release notes: https://docs.openstack.org/releasenotes/oslo.versionedobjects/
66
-
@@ -1,16 +1,11 @@
1
- ========================
2
- Team and repository tags
3
- ========================
1
+ =====================
2
+ oslo.versionedobjects
3
+ =====================
4
4
 
5
5
  .. image:: https://governance.openstack.org/tc/badges/oslo.versionedobjects.svg
6
- :target: https://governance.openstack.org/tc/reference/tags/index.html
7
6
 
8
7
  .. Change things from this point on
9
8
 
10
- =====================
11
- oslo.versionedobjects
12
- =====================
13
-
14
9
  .. image:: https://img.shields.io/pypi/v/oslo.versionedobjects.svg
15
10
  :target: https://pypi.org/project/oslo.versionedobjects/
16
11
  :alt: Latest Version
@@ -46,7 +46,7 @@ master_doc = 'index'
46
46
  # General information about the project.
47
47
  project = 'oslo.versionedobjects'
48
48
  copyright = '2014, OpenStack Foundation'
49
- source_tree = 'https://opendev.org/openstack/%s' % project
49
+ source_tree = f'https://opendev.org/openstack/{project}'
50
50
 
51
51
  # If true, '()' will be appended to :func: etc. cross-reference text.
52
52
  add_function_parentheses = True
@@ -57,8 +57,10 @@ add_module_names = True
57
57
 
58
58
  # Shortened external links.
59
59
  extlinks = {
60
- 'example': (source_tree +
61
- '/%s/examples/%%s.py' % project.replace(".", "_"), None),
60
+ 'example': (
61
+ source_tree + '/{}/examples/%s.py'.format(project.replace(".", "_")),
62
+ None,
63
+ ),
62
64
  }
63
65
 
64
66
  # The name of the Pygments (syntax highlighting) style to use.
@@ -75,14 +77,17 @@ html_theme = 'openstackdocs'
75
77
 
76
78
 
77
79
  # Output file base name for HTML help builder.
78
- htmlhelp_basename = '%sdoc' % project
80
+ htmlhelp_basename = f'{project}doc'
79
81
 
80
82
  # Grouping the document tree into LaTeX files. List of tuples
81
83
  # (source start file, target name, title, author, documentclass
82
84
  # [howto/manual]).
83
85
  latex_documents = [
84
- ('index',
85
- '%s.tex' % project,
86
- '%s Documentation' % project,
87
- 'OpenStack Foundation', 'manual'),
86
+ (
87
+ 'index',
88
+ f'{project}.tex',
89
+ f'{project} Documentation',
90
+ 'OpenStack Foundation',
91
+ 'manual',
92
+ ),
88
93
  ]
@@ -0,0 +1,6 @@
1
+ ==========================
2
+ oslo_versionedobjects.base
3
+ ==========================
4
+
5
+ .. automodule:: oslo_versionedobjects.base
6
+ :members:
@@ -0,0 +1,6 @@
1
+ ===============================
2
+ oslo_versionedobjects.exception
3
+ ===============================
4
+
5
+ .. automodule:: oslo_versionedobjects.exception
6
+ :members:
@@ -0,0 +1,6 @@
1
+ ============================
2
+ oslo_versionedobjects.fields
3
+ ============================
4
+
5
+ .. automodule:: oslo_versionedobjects.fields
6
+ :members:
@@ -1,6 +1,6 @@
1
- =========
2
- Fixture
3
- =========
1
+ =============================
2
+ oslo_versionedobjects.fixture
3
+ =============================
4
4
 
5
5
  .. automodule:: oslo_versionedobjects.fixture
6
6
  :members:
@@ -7,6 +7,7 @@ Using oslo.versionedobjects
7
7
 
8
8
  usage
9
9
  examples
10
+ typing
10
11
 
11
12
  .. history contains a lot of sections, toctree with maxdepth 1 is used.
12
13
  .. toctree::
@@ -0,0 +1,32 @@
1
+ ======
2
+ Typing
3
+ ======
4
+
5
+ oslo.versionedobjects ships a mypy plugin that improves type checking of
6
+ projects that use oslo.versionedobjects.
7
+
8
+ .. note::
9
+
10
+ The plugin is a temporary solution pending a larger rework. It is only
11
+ supported when used with the mypy type checker.
12
+
13
+ Enabling the plugin
14
+ -------------------
15
+
16
+ To enable the plugin, add the following to your ``pyproject.toml``:
17
+
18
+ .. code-block:: toml
19
+
20
+ [tool.mypy]
21
+ plugins = ["oslo_versionedobjects.mypy"]
22
+
23
+ What the plugin does
24
+ --------------------
25
+
26
+ oslo.versionedobjects dynamically generates attributes on versioned object
27
+ classes from the ``fields`` dict defined in the class body. This means mypy
28
+ cannot infer the types of these attributes without additional help.
29
+
30
+ The plugin inspects the ``fields`` dict of each versioned object class and
31
+ inserts typed attribute definitions into the class, allowing mypy to type-check
32
+ code that accesses these attributes.