Compare commits
9 Commits
b39fd8f1d3
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 591bd86235 | |||
| 62a4fce866 | |||
| 8be290a859 | |||
| ef06c9c166 | |||
| 688b3ca31b | |||
| 800ded7819 | |||
| dc401be837 | |||
| 721d21a603 | |||
| 709d4ca60d |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -9,5 +9,8 @@ venv/
|
|||||||
.idea/
|
.idea/
|
||||||
.vscode/
|
.vscode/
|
||||||
|
|
||||||
# assignment brief - kept locally, not published
|
# assignment brief
|
||||||
instructions.md
|
instructions.md
|
||||||
|
|
||||||
|
# local experiments
|
||||||
|
scratch/
|
||||||
|
|||||||
90
README.md
90
README.md
@@ -36,42 +36,71 @@ xnhjrfyjvth3nxr 1
|
|||||||
|
|
||||||
## Design decisions
|
## Design decisions
|
||||||
|
|
||||||
The assignment leaves a few points open. The choices made here are:
|
The assignment leaves a few points open:
|
||||||
|
|
||||||
**"Total number of symbols replaced" counts source symbols.** A line where
|
**"Total number of symbols replaced" counts source symbols.** A line where `bb`
|
||||||
`bb` and `a` were both replaced counts 3, being the combined length of the
|
and `a` were replaced counts 3, the combined length of the matched `value1`
|
||||||
matched `value1` strings, not the number of replacements and not the length of
|
strings, not the number of replacements.
|
||||||
the substituted text. This makes the count a measure of how much of the
|
|
||||||
original line changed.
|
|
||||||
|
|
||||||
**Overlapping patterns resolve to the longest match.** If the configuration
|
**Overlapping patterns resolve to the longest match.** With both `b` and `bb`
|
||||||
contains both `b` and `bb`, the input `bbbb` is read as two `bb` matches rather
|
configured, `bbbb` is two `bb` matches, not four `b`. Values are unique but may
|
||||||
than four `b` matches. The assignment guarantees unique values but not that
|
still be prefixes of one another, so `prepare_pairs` orders by descending length
|
||||||
none is a prefix of another, so `prepare_pairs` orders the pairs by descending
|
and `replace_line` takes the first match at each position. Otherwise the output
|
||||||
length once, and `replace_line` takes the first match at each position. Without
|
would depend on configuration file ordering.
|
||||||
a rule like this the output would depend on configuration file ordering.
|
|
||||||
|
|
||||||
**Ties keep their original file order.** The final sort keys only on the
|
**Ties keep their original file order.** The sort keys only on the count, and
|
||||||
replacement count and Python's sort is stable, so lines replaced an equal
|
Python's sort is stable.
|
||||||
number of times appear in the order they had in the input file.
|
|
||||||
|
|
||||||
**Unchanged lines are still printed.** The assignment says to sort the changed
|
**Unchanged lines are still printed.** Dropping lines that matched nothing
|
||||||
lines but also to output the resulting text. Dropping lines that happened to
|
would silently lose content, so every line is printed; those with no
|
||||||
match nothing would silently lose content, so every line is printed and lines
|
replacements sort last.
|
||||||
with zero replacements simply sort last.
|
|
||||||
|
|
||||||
**Input is preserved apart from the line terminator.** Both `\n` and `\r\n` are
|
**Only the line terminator is stripped.** `\n` and `\r\n` both; every other
|
||||||
stripped; every other character is kept and eligible for replacement. The
|
character stays replaceable. The format has no quoting, so the trailing space in
|
||||||
configuration format has no quoting either, so whitespace inside a value is
|
`a=z ` is part of the value.
|
||||||
significant — the trailing space in `a=z ` is part of the replacement value.
|
|
||||||
|
## Performance characteristics
|
||||||
|
|
||||||
|
`replace_line` tries every pair at each position, so cost grows with both the
|
||||||
|
line length and the number of pairs. Two alternatives, measured on the same
|
||||||
|
20,000-line input of 40-character lines and producing identical output:
|
||||||
|
|
||||||
|
| Pairs | this implementation | regex alternation | prefix tree |
|
||||||
|
| ----: | ------------------: | ----------------: | ----------: |
|
||||||
|
| 3 | 1x | 1x | 1x |
|
||||||
|
| 100 | 20x | 1.2x | 1.1x |
|
||||||
|
| 1000 | 207x | 1.1x | 1.1x |
|
||||||
|
|
||||||
|
Median of repeated runs, relative to each column's own three-pair baseline, so
|
||||||
|
the figures do not depend on the machine. The three-pair run takes about a
|
||||||
|
quarter of a second. Neither alternative is quite flat, because the larger
|
||||||
|
configurations in this benchmark also use longer keys, which cost slightly more
|
||||||
|
to match.
|
||||||
|
|
||||||
|
The regex alternation joins every `value1` into one pattern (`a|bb|c`) that
|
||||||
|
Python's `re` module scans in C: a constant-factor win, the same work done
|
||||||
|
faster. The prefix tree is the algorithmic one, taking the pair count out of the
|
||||||
|
complexity rather than making each step cheaper. The explicit loop is kept
|
||||||
|
because at the sizes described here the difference is not observable, and it
|
||||||
|
keeps the longest-match rule visible in the code.
|
||||||
|
|
||||||
|
The alternation is only equivalent because `prepare_pairs` orders the patterns
|
||||||
|
longest first: `re` is leftmost-first rather than leftmost-longest, so `b|bb`
|
||||||
|
would otherwise match `b` against the input `bb`.
|
||||||
|
|
||||||
|
Memory is proportional to the input size, since every line is held before
|
||||||
|
sorting.
|
||||||
|
|
||||||
## Error handling
|
## Error handling
|
||||||
|
|
||||||
The configuration file is validated while loading: a line without `=` is
|
The configuration file is validated while loading: a line without `=`, and a
|
||||||
rejected, reporting the offending line number. Missing files, unreadable
|
line whose `value1` is empty, are both rejected, reporting the offending line
|
||||||
files, and input that is not valid UTF-8 are reported as messages on stderr
|
number. An empty `value1` would match at every position without consuming
|
||||||
rather than tracebacks, and exit with status 1. Status 2 is reserved by
|
anything, which is why it is refused rather than ignored.
|
||||||
`argparse` for command line misuse.
|
|
||||||
|
Missing files, unreadable files, and input that is not valid UTF-8 are reported
|
||||||
|
as messages on stderr rather than tracebacks, and exit with status 1. Status 2
|
||||||
|
is reserved by `argparse` for command line misuse.
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
@@ -81,8 +110,9 @@ pytest
|
|||||||
```
|
```
|
||||||
|
|
||||||
- `tests/unit/` covers configuration parsing and the replacement algorithm,
|
- `tests/unit/` covers configuration parsing and the replacement algorithm,
|
||||||
including the overlapping-pattern and empty-input edge cases, plus a line by
|
including the overlapping-pattern case, empty input, and the rejection of an
|
||||||
line check of the worked example in `test_sample_data.py`.
|
empty `value1`, plus a line by line check of the worked example in
|
||||||
|
`test_sample_data.py`.
|
||||||
- `tests/integration/test_cli.py` invokes `main.py` as a subprocess to cover
|
- `tests/integration/test_cli.py` invokes `main.py` as a subprocess to cover
|
||||||
what unit tests cannot: argument handling, exit status, stderr messages, and
|
what unit tests cannot: argument handling, exit status, stderr messages, and
|
||||||
the sort order as actually printed.
|
the sort order as actually printed.
|
||||||
|
|||||||
@@ -18,6 +18,15 @@ def load_config(filename: str) -> list[tuple[str, str]]:
|
|||||||
)
|
)
|
||||||
|
|
||||||
value1, value2 = line.split("=", 1)
|
value1, value2 = line.split("=", 1)
|
||||||
|
|
||||||
|
# An empty value1 would match at every position without
|
||||||
|
# consuming anything, leaving replace_line unable to advance.
|
||||||
|
if not value1:
|
||||||
|
raise ValueError(
|
||||||
|
f"Invalid configuration at line {line_number}: {line!r} "
|
||||||
|
f"(the value to replace must not be empty)"
|
||||||
|
)
|
||||||
|
|
||||||
pairs.append((value1, value2))
|
pairs.append((value1, value2))
|
||||||
|
|
||||||
return pairs
|
return pairs
|
||||||
@@ -5,9 +5,6 @@ description = "Replace configured values in a text file."
|
|||||||
requires-python = ">=3.9"
|
requires-python = ">=3.9"
|
||||||
dependencies = []
|
dependencies = []
|
||||||
|
|
||||||
[project.optional-dependencies]
|
|
||||||
dev = ["pytest>=7.0"]
|
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
pythonpath = ["."]
|
pythonpath = ["."]
|
||||||
testpaths = ["tests"]
|
testpaths = ["tests"]
|
||||||
|
|||||||
@@ -24,6 +24,8 @@ def replace_line(line: str, pairs: list[tuple[str, str]]) -> tuple[str, int]:
|
|||||||
replaced_symbols = 0
|
replaced_symbols = 0
|
||||||
position = 0
|
position = 0
|
||||||
|
|
||||||
|
# Terminates because every branch below advances `position`, which
|
||||||
|
# holds only while no value1 is empty. `load_config` rejects those.
|
||||||
while position < len(line):
|
while position < len(line):
|
||||||
match = None
|
match = None
|
||||||
|
|
||||||
|
|||||||
@@ -55,4 +55,27 @@ def test_empty_config_file(tmp_path):
|
|||||||
config_file = tmp_path / "config.txt"
|
config_file = tmp_path / "config.txt"
|
||||||
config_file.write_text("", encoding="utf-8")
|
config_file.write_text("", encoding="utf-8")
|
||||||
|
|
||||||
assert load_config(str(config_file)) == []
|
assert load_config(str(config_file)) == []
|
||||||
|
|
||||||
|
def test_empty_value1_raises_value_error(tmp_path):
|
||||||
|
"""A line such as '=z' has no value1 and must be rejected.
|
||||||
|
|
||||||
|
An empty value1 matches at every position and consumes nothing, so
|
||||||
|
the scan in replace_line would never advance past it. Rejecting the
|
||||||
|
pair here keeps that invariant a parsing concern rather than
|
||||||
|
something the replacement loop has to defend against.
|
||||||
|
"""
|
||||||
|
config_file = tmp_path / "config.txt"
|
||||||
|
config_file.write_text("a=z\n=x\n", encoding="utf-8")
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
load_config(str(config_file))
|
||||||
|
|
||||||
|
|
||||||
|
def test_line_that_is_only_an_equals_sign_raises_value_error(tmp_path):
|
||||||
|
"""'=' alone has neither value1 nor value2."""
|
||||||
|
config_file = tmp_path / "config.txt"
|
||||||
|
config_file.write_text("=\n", encoding="utf-8")
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
load_config(str(config_file))
|
||||||
|
|||||||
Reference in New Issue
Block a user