Changelog
Notable changes to rn-forge-commons, newest first, in the
Keep a Changelog format.
[Unreleased]
[0.10.1] - 2026-11-20
Added
ArtifactKind.KEYS, withArtifact.keysandStateEntry.key_paths: the generator owns named key paths in a JSON or TOML file.difftakes an optionalentrieskeyword.DocumentUtils.serialize_document, the textwrite_documentwould write.
Changed
- The
testingextra requiresassertpy>=2.36.0.
[0.10.0] - 2026-11-17
Changed
- File digests no longer read the whole file into memory.
TaskPool.submitcounts duplicate names in one pass.DictUtils.mergecopies override values only when assigning them.AppLoggerno longer replaces the process record factory; its own records format braces over any factory.ApplyResult.writtenreports each write path once in plan order and no longer lists unchanged, skipped, forgotten or dry-run paths.
Fixed
- Configuring the logger no longer logs a
NOTICE; it isDEBUGnow. A plain-format timestamp shows its milliseconds once. AppLoggerlevel methods report the caller's file, line and function.
[0.9.0] - 2026-11-13
Added
- Log redaction in
rn_forge.commons.logging.redaction:redact,RedactionPolicyandREDACTED, exported fromrn_forge.commons. A value under a key whose final segment isauthorization,cookie,password,secretortokenis replaced, andBearer/Basiccredentials andscheme://user:password@hostpasswords are scrubbed from any string. RedactFilter(exported fromrn_forge.commons) applies redaction to a record's message,argsandextrafields on everyAppLoggerhandler.LoggingConfig.redactandAppLogger.initialize(redact=...)control it.redact_processorinrn_forge.commons.logging.structlogredacts structlog events before they are rendered.PathUtils.atomic_replace: a context manager that yields a temporary sibling of a file, then publishes it over the file atomically;atomic_writeis now built on it.PathUtils.move_no_clobber: moves a file without ever overwriting the destination, including across filesystems.PathUtils.prune_empty_parents: removes a directory and its empty ancestors up to, but never including, a stop directory.ThreadActorinrn_forge.commons.runtime.actor: builds a resource on a dedicated owner thread and runs every call against it there, throughsubmit(aFuture) orrun(awaitable).TaskPool.map_settledruns a function over items on the pool and returns aSucceededorFailedper item in input order;Succeeded,FailedandSettledare exported fromrn_forge.commons.ManagedBlock.end_indent: leading whitespace of the end marker alone, for a block whose body is indented but whose end marker sits at a different indent.None(the default) usesindent, so existing blocks render the same bytes.
Changed
output_pathnow writes under.tmp/<scope>/tests/output/instead of.out/. Breaking: consumers that read or ignore.out/must use.tmp/.- Log redaction is on by default, so secrets logged in messages, arguments
or
extrafields now appear as[redacted]. Passredact=FalsetoAppLogger.initializeto keep the old output. Exception tracebacks are not redacted. MarkdownUtilsparses a document once and shares the result acrossheadings,anchors,title,links,tablesandstrip_fenced_code, through a process-local cache of at most 2048 documents keyed by text. The API and its results are unchanged.
[0.8.1] - 2026-10-30
Changed
- Files on PyPI carry PEP 740 attestations. There is no code change.
[0.8.0] - 2026-10-29
Changed
- The package declares the MIT licence and is published to PyPI.
Removed
- Breaking:
rn_forge.commons.integration.authand theauthextra.JwtVerifier,discover_oidc,fetch_json,FetchJson,OidcConfigurationandTokenVerificationErrormoved torn_forge.auth.oidcinrn-forge-auth;JwksCacheis deleted in favour of PyJWT'sPyJWKClient.
[0.7.0] - 2026-10-25
Added
DocumentUtils.readof a package resource;headerandmultiline_arraysondumpsandwrite;DocumentUtils.multiline_arrays;DictUtils.as_mapping,ListUtils.as_listandListUtils.as_strings.rn_forge.commons.generation, moved from rn-forge-tooling.StateStore(rn_forge.commons.fs.state), moved from rn-forge-tooling.rn_forge.commons.text.templates, moved from rn-forge-tooling, withautoescapeandTemplateEngine.cached.- The
templatesextra. rn_forge.commons.text.markdown(MarkdownUtils,MarkdownHeading,MarkdownTable) and themarkdownextra.TemplateArtifactandrender_artifactsinrn_forge.commons.generation.templated(extratemplates).diffanddisk_contentinrn_forge.commons.generation.
Changed
- Plain YAML loads use libyaml (
ruamel.yaml[oldlibyaml]); plain TOML reads usetomllib;DocumentUtils.readnames the file in a parse error. - Breaking:
DocumentUtils.readtreats a path that exists but is not a file as missing.
Fixed
- A parser message containing a brace now raises
DocumentError. - A Jinja error whose message contains a brace now raises
RenderError.
[0.6.0] - 2026-10-16
Removed
- Breaking:
rn_forge.commons.data.excelandrn_forge.commons.data.pandas, and the pandas aliasesSeriesRow,series_valueandseries_columnsinrn_forge.commons.lang.types. They moved torn-forge-data, with the same class names; import them fromrn_forge.dataandrn_forge.data.pandas. - Breaking: the
excelandpandasextras. Depend onrn-forge-data, orrn-forge-data[pandas], instead.
[0.5.0] - 2026-09-27
Released with pykit's first coordinated set of tags (release-1).
rn-forge-commons-v0.1.0 to rn-forge-commons-v0.2.2 predate this file; their
notes are on the GitHub Releases
page.