Release 0.4.0

Author: pcisar

.gitignore

@@ -133,4 +133,7 @@ dmypy.json
 *.wpu
 
 # Sphinx build
-python/docs/_build
+python/docs/_build
+
+# Local dev
+python/work

README.md

@@ -24,38 +24,38 @@ The UUID RFC pre-defines four namespaces:
 
 ## ISO OID
 
-An OID is a globally unique [ISO](http://www.iso.org/iso/en/ISOOnline.frontpage) identifier. 
-There are multiple ways that this identifier may be represented, and Firebird Foundation has 
-chosen to represent OID registered here using a form that consists only of numbers and dots 
-(e.g., "1.3.6.1.4.1.53446.1"). OIDs are paths in a tree structure, with the left-most number 
+An OID is a globally unique [ISO](http://www.iso.org/iso/en/ISOOnline.frontpage) identifier.
+There are multiple ways that this identifier may be represented, and Firebird Foundation has
+chosen to represent OID registered here using a form that consists only of numbers and dots
+(e.g., "1.3.6.1.4.1.53446.1"). OIDs are paths in a tree structure, with the left-most number
 representing the root and the right-most number representing a leaf.
 
-Each OID is created by a Registration Authority. Each of these authorities may, in turn, 
-delegate assignment of new OIDs under it to other registration authorities that work under its 
-auspices, and so on down the line. Eventually, one of these authorities assigns a unique (to it) 
-number that corresponds to a leaf node on the tree. The leaf may represent a registration authority 
-(in which case the OID identifies the authority), or an instance of an object. A registration 
+Each OID is created by a Registration Authority. Each of these authorities may, in turn,
+delegate assignment of new OIDs under it to other registration authorities that work under its
+auspices, and so on down the line. Eventually, one of these authorities assigns a unique (to it)
+number that corresponds to a leaf node on the tree. The leaf may represent a registration authority
+(in which case the OID identifies the authority), or an instance of an object. A registration
 authority owns the namespace consisting of its sub-tree.
 
-The [Firebird Foundation Incorporated](https://firebirdsql.org/en/firebird-foundation) obtained 
-a [PEN](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers) (Private Enterprise 
-Number) from [IANA](https://www.iana.org), and thus become a registered owner of OID _1.3.6.1.4.1.53446_ 
-(iso.org.dod.internet.private.enterprise.firebird-foundation-inc). This repository is used to manage 
-sub-tree of OIDs under this namespace, that are used by Firebird Foundation and 
+The [Firebird Foundation Incorporated](https://firebirdsql.org/en/firebird-foundation) obtained
+a [PEN](https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers) (Private Enterprise
+Number) from [IANA](https://www.iana.org), and thus become a registered owner of OID _1.3.6.1.4.1.53446_
+(iso.org.dod.internet.private.enterprise.firebird-foundation-inc). This repository is used to manage
+sub-tree of OIDs under this namespace, that are used by Firebird Foundation and
 the [Firebird Project](https://www.firebirdsql.org).
 
 # How it works
 
-The OID hierarchy is controlled by a set of YAML files, each file describing one level 
-in the tree hierarchy (that is, the root node of the child tree and all assigned nodes 
-for children). The [root.oid](https://github.com/FirebirdSQL/firebird-uuid/blob/master/root.oid) file 
+The OID hierarchy is controlled by a set of YAML files, each file describing one level
+in the tree hierarchy (that is, the root node of the child tree and all assigned nodes
+for children). The [root.oid](https://github.com/FirebirdSQL/firebird-uuid/blob/master/root.oid) file
 in this repository describes the OID of highest level (assigned by IANA).
 
 Each file has the following format:
 
 ```yaml
 # Description of root node for this sub-tree
-node:            
+node:
   oid:           # Full OID, for example 1.3.6.1.4.1.53446
   name:          # Node name
   description:   # Node description
@@ -67,7 +67,7 @@ node:
 
 # List of children nodes in order of numbers assigned to them
 # could be omitted for leaf node (see node.type)
-children:        
+children:
   - number:      # Number assigned to this child node, oid = node.oid + '.' + number
     name:        # Node name
     description: # Node description, could be empty
@@ -79,10 +79,10 @@ children:
 
 **All fields must be present, and if not specified otherwise, they must have a value.**
 
-Fields `name`,`description`,`contact`,`email` and `site` in `children` record SHOULD have 
-the same values like fields of the same name in `node` record of the YAML file describing 
-the child node. If they differ in content, the values present in `node` record take precedence 
-over values present in `children` record.
+Fields `name`,`description`,`contact`,`email` and `site` in `children` record SHOULD have
+the same values like fields of the same name in `node` record of the YAML file describing
+the child node. If they differ in content, the values present in `children` record (parent)
+take precedence over values present in `node` record (child).
 
 # Using OIDs to generate UUIDs
 

python/CHANGELOG.md

@@ -4,10 +4,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.3.0] - 2023-10-03
+## [0.4.0] - 2025-04-29
 
 ### Added
 
+- New `pytest` tests, 97% code coverage.
+
+### Changed
+
+- Minimal Python version raised to 3.11.
+- Code cleanup and optimization for Python 3.11 features.
+- Improved documentation.
+- Changed dependency from `toml` to `tomli-w`.
+- Breaking changes: `Node` renamed to `OIDNode`, `NodeTYpe` renamed to `OIDNodeType`
+
+## [0.3.0] - 2023-10-03
+
+
 - Stub pytest test
 
 ### Changed

python/docs/changelog.txt

@@ -2,20 +2,34 @@
 Changelog
 #########
 
+Version 0.4.0
+=============
+Released: 2025-04-29
+
+* New `pytest` tests, 97% code coverage.
+* Minimal Python version raised to 3.11.
+* Code cleanup and optimization for Python 3.11 features.
+* Improved documentation.
+* Changed dependency from `toml` to `tomli-w`.
+* Breaking changes: `Node` renamed to `.OIDNode`, `NodeTYpe` renamed to `.OIDNodeType`
+
 Version 0.3.0
 =============
+Released: 2023-10-03
 
 * Switch from setuptools to `hatch <https://hatch.pypa.io/latest/>`_.
 * Update dependency to firebird-base >=1.7.0
 * Package version is now defined in firebird.uuid.__about__.py (__version__)
 
 Version 0.2.0
 =============
+Released: 2023-03-02
 
 Breaking change: `registry` renamed to `.oid_registry`.
 
 Version 0.1.0
 =============
+Released: 2022-11-28
 
 Initial release.
 

python/docs/reference.txt

@@ -12,6 +12,6 @@ Firebird-uuid Reference
 .. autofunction:: get_specifications
 .. autofunction:: parse_specifications
 
-.. autoclass:: NodeType
-.. autoclass:: Node
+.. autoclass:: OIDNodeType
+.. autoclass:: OIDNode
 .. autoclass:: OIDRegistry

python/pyproject.toml

@@ -7,19 +7,18 @@ name = "firebird-uuid"
 dynamic = ["version"]
 description = 'Official tools for working with OID namespace managed by the Firebird Project.'
 readme = "README.md"
-requires-python = ">=3.8, <4"
+requires-python = ">=3.11, <4"
 license = { file = "LICENSE" }
 keywords = ["Firebird", "UUID"]
 authors = [
   { name = "Pavel Cisar", email = "[email protected]" },
 ]
 classifiers = [
   "Development Status :: 4 - Beta",
-  "Programming Language :: Python",
-  "Programming Language :: Python :: 3.8",
-  "Programming Language :: Python :: 3.9",
-  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3 :: Only",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
   "License :: OSI Approved :: MIT License",
@@ -31,10 +30,10 @@ classifiers = [
   "Topic :: Software Development :: Libraries",
 ]
 dependencies = [
-  "toml>=0.10.2",
-  "PyYAML>=6.0.1, <7",
-  "requests>=2.31.0",
-  "firebird-base>=1.7.0",
+  "tomli-w>=1.2",
+  "PyYAML~=6.0",
+  "requests~=2.31",
+  "firebird-base~=2.0",
 ]
 
 [project.urls]
@@ -53,6 +52,9 @@ include = ["src"]
 [tool.hatch.build.targets.wheel]
 packages = ["src/firebird"]
 
+[tool.hatch.metadata]
+allow-direct-references = true
+
 [tool.hatch.envs.default]
 dependencies = [
 ]
@@ -75,77 +77,32 @@ cov = [
 ]
 version = "python --version"
 
-[[tool.hatch.envs.test.matrix]]
-python = ["3.8", "3.9", "3.10", "3.11"]
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.11", "3.12", "3.13"]
 
 [tool.hatch.envs.doc]
 detached = false
 platforms = ["linux"]
 dependencies = [
-  "Sphinx>=7.1",
+  "Sphinx==7.2.6",
   "sphinx-bootstrap-theme>=0.8.1",
   "sphinx-autodoc-typehints>=1.24.0",
+  "doc2dash>=3.0.0"
 ]
 [tool.hatch.envs.doc.scripts]
 build = "cd docs ; make html"
-
-[tool.hatch.envs.lint]
-detached = true
-dependencies = [
-  "black>=23.1.0",
-  "mypy>=1.0.0",
-  "ruff>=0.0.243",
-]
-[tool.hatch.envs.lint.scripts]
-typing = "mypy --install-types --non-interactive {args:src/firebird/uuid tests}"
-style = [
-  "ruff {args:.}",
-  "black --check --diff {args:.}",
-]
-fmt = [
-  "black {args:.}",
-  "ruff --fix {args:.}",
-  "style",
+docset = [
+  "cd docs ; doc2dash -u https://firebird-uuid.readthedocs.io/en/latest/ -f -i ./_static/fb-favicon.png -n firebird-uuid ./_build/html/",
+  "cd docs; VERSION=`hatch version` ; tar --exclude='.DS_Store' -cvzf ../dist/firebird-uuid-$VERSION-docset.tgz firebird-uuid.docset",
 ]
-all = [
-  "style",
-  "typing",
-]
-
-[tool.black]
-target-version = ["py38"]
-line-length = 120
-skip-string-normalization = true
 
 [tool.ruff]
-target-version = "py38"
+target-version = "py311"
 line-length = 120
-select = [
-  "A",
-  "ARG",
-  "B",
-  "C",
-  "DTZ",
-  "E",
-  "EM",
-  "F",
-  "FBT",
-  "I",
-  "ICN",
-  "ISC",
-  "N",
-  "PLC",
-  "PLE",
-  "PLR",
-  "PLW",
-  "Q",
-  "RUF",
-  "S",
-  "T",
-  "TID",
-  "UP",
-  "W",
-  "YTT",
+
+[tool.ruff.lint]
+select = ["A", "ARG", "B", "C", "DTZ", "E", "EM", "F", "FBT", "I", "ICN", "ISC", "N",
+  "PLC", "PLE", "PLR", "PLW", "Q", "RUF", "S", "T", "TID", "UP", "W", "YTT",
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
@@ -156,21 +113,34 @@ ignore = [
   "S105", "S106", "S107",
   # Ignore complexity
   "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+  #
+  "E741",
+  # Allow relative imports
+  "TID252",
+  # Allow literals in exceptions
+  "EM101", "EM102",
+  # Single quotes instead double
+  "Q000"
 ]
 unfixable = [
   # Don't touch unused imports
   "F401",
+  # Don't change single quotes to double
+  "Q000"
 ]
+exclude = ["*_pb2.py", "*.pyi", "tests/*", "docs/*", "work/*"]
 
-[tool.ruff.isort]
-known-first-party = ["firebird.uuid"]
+[tool.ruff.lint.isort]
+known-first-party = ["firebird.uuid", "firebird.base"]
 
-[tool.ruff.flake8-tidy-imports]
+[tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "all"
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
 "tests/**/*" = ["PLR2004", "S101", "TID252"]
+"__init__.py" = ["F401"]
+"_spec.py" = ["E501"]
 
 [tool.coverage.run]
 source_pkgs = ["firebird.uuid", "tests"]
@@ -181,8 +151,8 @@ omit = [
 ]
 
 [tool.coverage.paths]
-firebird_uuid = ["src/python", "*/python/src/firebird/uuid"]
-tests = ["tests", "*/python/tests"]
+firebird_base = ["src/firebird/uuid"]
+tests = ["tests"]
 
 [tool.coverage.report]
 exclude_lines = [

python/src/firebird/uuid/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present The Firebird Projects <www.firebirdsql.org>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.3.0"
+__version__ = "0.4.0"

python/src/firebird/uuid/__init__.py

@@ -37,6 +37,6 @@
 
 """
 
-from ._model import NodeType, Node, IANA_ROOT_NAME
-from ._spec import get_specification, get_specifications, parse_specifications, ROOT_SPEC
-from ._registry import oid_registry, OIDRegistry
+from ._model import IANA_ROOT_NAME, OIDNode, OIDNodeType
+from ._registry import OIDRegistry, oid_registry
+from ._spec import ROOT_SPEC, get_specification, get_specifications, parse_specifications