Choose stable check identifiers for a local reporting tool

Direct answer

Automation needs a stable value that is not tied to display copy. The two check IDs use lowercase hyphenated names, while labels are human-facing text. After the example changes “Root README” to “Project README,” the assertion confirms that a saved filter for root-readme still identifies the same observation.

The edge case is editorial rename. Without the separation, a wording improvement can break dashboards, historical comparisons, or suppressions that were keyed by the former label. The uniqueness assertion catches a second failure mode: two checks sharing one ID make a consumer unable to distinguish them.

This convention does not choose a namespace, provide automatic migrations, or determine whether an ID can ever be removed. When an observation changes meaning, add a new ID and publish a mapping. Do not reuse an established ID for a different check merely because its label looks similar.

Complete example

checks = [
    {"id": "root-readme", "label": "Root README"},
    {"id": "license-file", "label": "License file"},
]
identifiers = [check["id"] for check in checks]
assert identifiers == ["root-readme", "license-file"]
assert len(identifiers) == len(set(identifiers))
checks[0]["label"] = "Project README"
assert checks[0]["id"] == "root-readme"
print("ids=root-readme,license-file labels=mutable")

Expected stdout:

ids=root-readme,license-file labels=mutable

Sources

- Official API documentation

Prepared with AI assistance. The example uses synthetic data; its stated limits apply.

Comments

Post a Comment

Popular posts from this blog

Compare Two Text Files in Python Without Modifying Them

Batu Lab Notes · Batu When comparing two versions of a configuration or notes file, “are they the same?” is only the first question. The bytes may be identical, the visible text may be equal despite different line endings, or the content may contain a real change. For small UTF-8 text files, Python’s standard library can show these distinctions without writing to either input. Quick answer For small, stable UTF-8 files, read bounded bytes, compare them first, then decode and produce a bounded unified diff. Decide explicitly whether newline differences matter. Keep both inputs read-only and review the diff for private data before sharing it. Set a limit before reading Loading an input of unknown size directly into memory is a poor default. This example checks both sizes with Path.stat() , then performs a bounded read and applies a 256 KiB limit per file. It rejects directories and other non-regular paths. If reading raises OSError , the result includes the exception ty...
Read more

Seven CSV Quality Checks to Run Before Importing Data

Batu Lab Notes · Batu A CSV file is not ready for import merely because it opens. The wrong delimiter can collapse an entire row into one column. An unexpected encoding can damage non-ASCII characters. A repeated identifier can overwrite an existing record in the destination. A short, read-only check makes these problems visible before data reaches a spreadsheet or application. Quick answer Before importing a CSV, set its encoding and delimiter, validate the exact header and every row width, distinguish empty IDs, duplicate IDs, and duplicate rows, and keep the check read-only. 1. Specify the encoding Python may open a text file with the platform’s default encoding, which can differ across machines. If the expected encoding is UTF-8, encoding="utf-8-sig" is a practical choice: it reads ordinary UTF-8 and skips an optional UTF-8 byte order mark at the start. If decoding fails, verify the source application’s export settings instead of silently trying unrelat...
Read more

Explain why SQLite transactions cannot make an HTTP call atomic

Direct answer A SQLite transaction can atomically commit database statements handled by that connection. It cannot include an HTTP service in the same commit protocol. The example commits an outbox row first, then simulates a network failure. The durable row remains pending , which is exactly the information a later delivery worker needs instead of pretending both actions succeeded or failed together. The edge case is failure after the database commit but before remote acknowledgement. Retrying then requires an idempotency design owned by the remote endpoint or a stable request key; it is not supplied by SQLite’s COMMIT . Conversely, sending the request before storing a durable intent can leave no local evidence when the process stops. This demonstration intentionally does not make an HTTP request, implement an outbox dispatcher, or prove delivery exactly once. It shows the boundary that must be designed around. Use transactions to protect the local state transition, and test remote...
Read more