repomatic.metadata.output module

Serialization of the metadata a workflow reads.

dump() computes the values, and Dialect writes them in the shape a consumer parses: GitHub Actions step outputs, or plain JSON.

class repomatic.metadata.output.JSONMetadata(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: JSONEncoder

JSON encoder for metadata values: a matrix and a path serialize too.

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float, bool or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII and non-printable characters escaped. If ensure_ascii is false, the output can contain non-ASCII and non-printable characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (’, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

default(o)

Implement this method in a subclass such that it returns a serializable object for o, or calls the base implementation (to raise a TypeError).

For example, to support arbitrary iterators, you could implement default like this:

def default(self, o):
    try:
        iterable = iter(o)
    except TypeError:
        pass
    else:
        return list(iterable)
    # Let the base class default method raise the TypeError
    return super().default(o)

Return type:

Any

repomatic.metadata.output.format_github_value(value)

Transform Python value to GitHub-friendly, JSON-like, console string.

Renders:

• str as-is

• None into empty string

• bool into lower-cased string

• Matrix into JSON string

• Iterable of mixed strings and Path into a serialized space-separated string, where Path items are double-quoted

• other Iterable into a JSON string

• dict[str, str] into a JSON object string

A mapping serializes as a JSON object so a workflow can index it by key (fromJSON(...).runner_arch[matrix.os]), which an array of pairs cannot do in a GitHub expression. Only a flat string-to-string mapping is accepted: a nested one is almost always a Matrix or a config dataclass, and the assertion below keeps it from serializing into a shape no consumer expects.

Todo

Widen the JSON branch beyond an iterable of dict[str, str] and a flat dict[str, str], the two shapes it asserts on today, when a metadata key needs a richer one.

Return type:

str

class repomatic.metadata.output.Dialect(*values)

Bases: StrEnum

Output dialect for metadata serialization.

github = 'github'

github_json = 'github-json'

json = 'json'

serialize(metadata)

Render metadata in this dialect.

Parameters:

metadata (dict[str, Any]) – Raw key-to-value mapping from dump().

Return type:

str

Returns:

The serialized payload.