Compare commits
24 Commits
content-si
...
mako_chang
| Author | SHA1 | Date | |
|---|---|---|---|
| dfd2dbe20f | |||
| fde1452666 | |||
| c6117a7182 | |||
| 2bee25488b | |||
| 702101bfe2 | |||
| 40132f04dd | |||
| c1ee926211 | |||
| d6d0aab604 | |||
| 90a14cf999 | |||
| 5fb7b5596c | |||
| fa8adc30ca | |||
| 45f0680200 | |||
| 0ed0f57dbb | |||
| 14886106ed | |||
| ec09641545 | |||
| 3ab988d6eb | |||
| 392211af17 | |||
| 0b6e0fbc70 | |||
| 6634de51e6 | |||
| 83b7fc0210 | |||
| 791be0aa56 | |||
| 7c27942cb0 | |||
| 72a8851373 | |||
| dbcae5c64e |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -4,11 +4,12 @@
|
||||
*.xml.xz
|
||||
*.swp
|
||||
|
||||
# Lockfiles
|
||||
uv.lock
|
||||
|
||||
# JetBrains
|
||||
/.idea
|
||||
|
||||
/.claude/settings.local.json*
|
||||
|
||||
# Python build and test output
|
||||
__pycache__/
|
||||
/test/test_output/
|
||||
|
||||
3
.gitmodules
vendored
Normal file
3
.gitmodules
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
[submodule "mediawiki-php-wikidiff2"]
|
||||
path = mediawiki-php-wikidiff2
|
||||
url = https://github.com/wikimedia/mediawiki-php-wikidiff2/
|
||||
73
CHANGELOG.md
73
CHANGELOG.md
@@ -1,73 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## 0.3.0
|
||||
|
||||
Changes relative to what people have been running. Earlier version tags
|
||||
in this repository were internal markers rather than releases, so there
|
||||
is no previous release to compare against.
|
||||
|
||||
### Incompatible changes
|
||||
|
||||
- **Redirect detection is now per revision.** The page-level
|
||||
`redirect_target` column has been replaced by `revision_is_redirect`
|
||||
and `revision_redirect_target`, which classify each revision from its
|
||||
own text. The old column reported a page's redirect status as of the
|
||||
time the dump was exported and applied that single value to every
|
||||
revision in the page's history, which is wrong for any page that was
|
||||
turned into a redirect, or turned back, at some point in its life.
|
||||
Revisions with deleted text report null in both columns rather than
|
||||
false. Wikis using a localized redirect keyword can add it with
|
||||
`--redirect-aliases`; `#REDIRECT` is always recognized.
|
||||
|
||||
Code reading `redirect_target` needs updating.
|
||||
|
||||
- **Parquet output has been removed**, along with the
|
||||
`--partition-namespaces` and `--max-revisions-per-file` options that
|
||||
only applied to it. Use JSONL, which supports `--resume`.
|
||||
|
||||
- **pyspark is no longer a dependency** and the `wikiq-spark` entry point
|
||||
is gone. The second pass of that pipeline was never in this
|
||||
repository.
|
||||
|
||||
- **Python 3.11 or later is required.** Python 3.9 reached end of life in
|
||||
October 2025, and the floor unlocks current pyarrow, more-itertools and
|
||||
pandas, along with the CPython 3.11 speedups on the CPU-bound work
|
||||
wikiq does.
|
||||
|
||||
- **The project is now called wikiq**, rather than mediawiki_dump_tools.
|
||||
|
||||
### Installation
|
||||
|
||||
- **wikiq installs with plain `pip` and needs no C++ compiler.**
|
||||
Previously every install required pywikidiff2, built from an ssh-only
|
||||
git URL, so anyone outside the collective could not install the tool at
|
||||
all. It is now optional and needed only for `--diff` and
|
||||
`-p wikidiff2`.
|
||||
|
||||
- **`-p legacy` needs the new `legacy` extra.** It was the only user of
|
||||
`mediawiki-utilities`, a 2015 package that also pulls in a MySQL client
|
||||
and six other packages. Everyone was paying for that to support one
|
||||
flag.
|
||||
|
||||
- **Dependencies resolve from PyPI** rather than from pinned forks under
|
||||
personal accounts. Requires mwxml >= 0.3.8, which fixes eleven upstream
|
||||
issues; note that mwxml 0.3.7 changed namespace handling to trust the
|
||||
dump's embedded `<ns>` tag.
|
||||
|
||||
### Added
|
||||
|
||||
- `--version`, and the version is printed to stderr on every run so it
|
||||
lands in job logs beside the output.
|
||||
- Licensing: wikiq is GPL-3.0-or-later. See `COPYING`.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Regex matching (`-RP`/`-CP`) crashed with a `TypeError` on revisions
|
||||
whose text or comment was deleted or suppressed. Deleted content now
|
||||
reports null.
|
||||
- Page titles in non-main namespaces were prefixed twice under mwxml
|
||||
0.3.7 and later, producing titles like `Category:Category:Alaska`.
|
||||
- The test suite had 16 failing tests, and `pytest test/` silently
|
||||
collected only half of it because the main test file matched neither of
|
||||
pytest's discovery patterns. It is now `test_wikiq.py` and the suite
|
||||
runs green.
|
||||
70
README.md
70
README.md
@@ -1,53 +1,33 @@
|
||||
# wikiq
|
||||
# mediawiki_dump_tools
|
||||
|
||||
wikiq converts MediaWiki XML database dumps—the "history" dumps that
|
||||
include every revision of every page—into tabular datasets for research.
|
||||
It is a command line program that produces one row per revision with
|
||||
metadata such as the page, namespace, timestamp, editor, text size, and
|
||||
revert status, plus a range of optional computed columns.
|
||||
Tools for converting MediaWiki XML database dumps—the "history" dumps
|
||||
that include every revision of every page—into tabular datasets for
|
||||
research. The main tool is `wikiq`, a command line program that produces
|
||||
one row per revision with metadata such as the page, namespace,
|
||||
timestamp, editor, text size, and revert status, plus a range of
|
||||
optional computed columns.
|
||||
|
||||
## Installation
|
||||
|
||||
wikiq requires Python 3.11 or later. Install it with pip from a clone of
|
||||
this repository:
|
||||
|
||||
git clone https://gitea.communitydata.science/collective/wikiq.git
|
||||
cd wikiq
|
||||
git clone https://gitea.communitydata.science/collective/mediawiki_dump_tools.git
|
||||
cd mediawiki_dump_tools
|
||||
pip install .
|
||||
|
||||
[uv](https://docs.astral.sh/uv/) works too (`uv sync`) and is convenient
|
||||
for development, but it is not required.
|
||||
|
||||
One dependency, `pywikidiff2`, is installed from source and compiles a
|
||||
C++ extension, so a C++ compiler must be available at install time.
|
||||
|
||||
Wikimedia dumps are usually compressed as 7z (most common), gz, or bz2.
|
||||
wikiq reads these by running your system's decompression tools, so it
|
||||
depends on `7za`, `zcat`, and `bzcat` for those respective formats. On
|
||||
Debian or Ubuntu, `apt install 7zip` provides `7za`; the others are
|
||||
standard.
|
||||
|
||||
That is everything most uses need, and none of it requires a compiler.
|
||||
Two further features carry heavier dependencies, so they are kept out of
|
||||
the base install.
|
||||
|
||||
### Diffs and wikidiff2 persistence
|
||||
|
||||
`--diff` and `-p wikidiff2` need
|
||||
[pywikidiff2](https://gitea.communitydata.science/groceryheist/pywikidiff2),
|
||||
a Python binding for MediaWiki's wikidiff2 diff engine. It is not on
|
||||
PyPI and compiles a C++ extension, so it needs a C++ compiler and
|
||||
libthai:
|
||||
|
||||
pip install 'pywikidiff2 @ git+https://gitea.communitydata.science/groceryheist/pywikidiff2.git'
|
||||
|
||||
The other persistence methods, including the default `-p sequence`, do
|
||||
not need it.
|
||||
|
||||
### Legacy persistence
|
||||
|
||||
`-p legacy` needs `mediawiki-utilities`, which is only useful for
|
||||
reproducing results from older research projects:
|
||||
|
||||
pip install '.[legacy]'
|
||||
|
||||
wikiq tells you which of these to install if you use an option that
|
||||
needs one.
|
||||
|
||||
## Usage
|
||||
|
||||
wikiq dump.xml.7z -o output/
|
||||
@@ -85,17 +65,11 @@ The most commonly useful options (`wikiq --help` describes them all):
|
||||
- `--external-links`, `--citations`, `--wikilinks`, `--templates`, and
|
||||
`--headings` parse each revision's wikitext and add a column with the
|
||||
extracted elements.
|
||||
- `--content-sizes` splits each revision into `content_chars`, the
|
||||
information it carries, and `markup_chars`, the wikitext around it. A
|
||||
contributor who does not know wikitext writes `Wonderful Hotel,
|
||||
+15555550123`; someone polishing it later writes
|
||||
`{{listing|name=Wonderful Hotel|phone=+15555550123}}`. Both carry the
|
||||
same information, and the second adds two dozen characters of markup.
|
||||
The two columns sum to the revision's length.
|
||||
- `-RP REGEX -RPl LABEL` searches revision text for a regular expression
|
||||
and reports the matches in a column named by the label; repeat the
|
||||
pair for multiple patterns. `-CP`/`-CPl` do the same for edit
|
||||
summaries.
|
||||
summaries. Adding `-RPc` or `-CPc` reports the number of matches
|
||||
instead of the matched text.
|
||||
- `--resume` continues an interrupted run from the last complete line of
|
||||
an existing JSONL output file. Combined with `--time-limit HOURS`,
|
||||
this supports processing very large dumps in bounded chunks.
|
||||
@@ -106,16 +80,12 @@ The most commonly useful options (`wikiq --help` describes them all):
|
||||
|
||||
From the repository root:
|
||||
|
||||
pip install pytest pandas pytest-asyncio pytest-benchmark
|
||||
pytest test/
|
||||
uv run pytest test/
|
||||
|
||||
Run the suite from the root—some tests open fixture files by paths
|
||||
relative to it. The full suite processes several real dumps from
|
||||
`test/dumps/`; expected outputs live in `test/baseline_output/`.
|
||||
|
||||
Tests covering `--diff`, `-p wikidiff2`, and `-p legacy` skip when their
|
||||
optional dependency is absent, so a base install reports skips rather
|
||||
than failures.
|
||||
`test/dumps/` and takes a couple of minutes; expected outputs live in
|
||||
`test/baseline_output/`.
|
||||
|
||||
## Authors
|
||||
|
||||
|
||||
@@ -1,34 +1,14 @@
|
||||
[project]
|
||||
name = "wikiq"
|
||||
version = "0.3.0"
|
||||
name = "mediawiki-dump-tools"
|
||||
version = "0.2.0"
|
||||
description = "Convert MediaWiki XML database dumps into tabular datasets for research"
|
||||
readme = "README.md"
|
||||
license = "GPL-3.0-or-later"
|
||||
license-files = ["COPYING"]
|
||||
requires-python = ">=3.11"
|
||||
authors = [
|
||||
{ name = "Benjamin Mako Hill" },
|
||||
{ name = "Nathan TeBlunthuis" },
|
||||
{ name = "Will Beason" },
|
||||
{ name = "Sohyeon Hwang" },
|
||||
{ name = "Kaylea Champion" },
|
||||
]
|
||||
keywords = ["mediawiki", "wikipedia", "wiki", "dump", "xml", "revision", "research"]
|
||||
classifiers = [
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Environment :: Console",
|
||||
"Intended Audience :: Science/Research",
|
||||
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
|
||||
"Operating System :: POSIX",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Topic :: Scientific/Engineering :: Information Analysis",
|
||||
"Topic :: Text Processing :: Markup",
|
||||
]
|
||||
dependencies = [
|
||||
"deltas>=0.7.0",
|
||||
"mediawiki-utilities>=0.4.18",
|
||||
"more-itertools>=10.7.0",
|
||||
"mwparserfromhell>=0.6.0",
|
||||
"mwpersistence>=0.2.4",
|
||||
@@ -36,33 +16,10 @@ dependencies = [
|
||||
"mwtypes>=0.4.0",
|
||||
"mwxml>=0.3.8",
|
||||
"pyarrow>=20.0.0",
|
||||
"pywikidiff2 @ git+https://gitea.communitydata.science/groceryheist/pywikidiff2.git",
|
||||
"sortedcontainers>=2.4.0",
|
||||
]
|
||||
|
||||
# Two features carry dependencies that are awkward enough to install that they
|
||||
# are kept out of the base install: -p legacy needs mediawiki-utilities, a 2015
|
||||
# package that also pulls in a MySQL client, and --diff and -p wikidiff2 need
|
||||
# pywikidiff2, which compiles a C++ extension. Everything else, including the
|
||||
# default -p sequence, works with neither.
|
||||
[project.optional-dependencies]
|
||||
legacy = ["mediawiki-utilities>=0.4.18"]
|
||||
# A wikidiff2 extra belongs here too, but pywikidiff2 is not yet published to
|
||||
# PyPI, so an extra naming it could not resolve. Until it is, wikiq reports the
|
||||
# git install command when --diff or -p wikidiff2 is used without it.
|
||||
|
||||
# Duplicated from [dependency-groups] below, which is PEP 735 and so is visible
|
||||
# only to uv. This is what makes `pip install -e '.[dev]'` work.
|
||||
dev = [
|
||||
"pandas>=2.1.0",
|
||||
"pytest>=8.4.1",
|
||||
"pytest-asyncio>=1.0.0",
|
||||
"pytest-benchmark>=5.1.0",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://wiki.communitydata.science/"
|
||||
Repository = "https://gitea.communitydata.science/collective/wikiq"
|
||||
|
||||
[project.scripts]
|
||||
wikiq = "wikiq:main"
|
||||
|
||||
@@ -73,18 +30,8 @@ build-backend = "hatchling.build"
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/wikiq"]
|
||||
|
||||
# Without an explicit list hatchling walks the whole working tree, which sweeps
|
||||
# in any local virtualenv and editor state while still omitting the test dumps,
|
||||
# since those are gitignored. Tests run from a clone of the repository rather
|
||||
# than from the sdist.
|
||||
[tool.hatch.build.targets.sdist]
|
||||
include = [
|
||||
"src/wikiq",
|
||||
"README.md",
|
||||
"CHANGELOG.md",
|
||||
"COPYING",
|
||||
"pyproject.toml",
|
||||
]
|
||||
[tool.hatch.metadata]
|
||||
allow-direct-references = true
|
||||
|
||||
[dependency-groups]
|
||||
dev = [
|
||||
|
||||
@@ -1,6 +1,2 @@
|
||||
#!/usr/bin/env bash
|
||||
# Run the test suite from the repository root, which some tests require
|
||||
# because they open fixture files by relative path.
|
||||
set -euo pipefail
|
||||
cd "$(dirname "$0")"
|
||||
exec python -m pytest test/ "$@"
|
||||
uv run pytest test/test_wiki_diff_matcher.py --capture=tee-sys
|
||||
|
||||
@@ -32,78 +32,37 @@ from collections import deque, defaultdict
|
||||
from hashlib import sha1
|
||||
from io import TextIOWrapper
|
||||
from itertools import groupby
|
||||
from pathlib import Path
|
||||
from subprocess import PIPE, Popen
|
||||
from typing import IO, Any, Generator, TextIO, Union
|
||||
|
||||
import mwpersistence
|
||||
import mwreverts
|
||||
import mwxml
|
||||
import pyarrow as pa
|
||||
import pyarrow.csv as pacsv
|
||||
from deltas import SegmentMatcher, SequenceMatcher
|
||||
import pywikidiff2
|
||||
from deltas.tokenizers import wikitext_split
|
||||
from more_itertools import peekable
|
||||
from mwxml import Dump
|
||||
|
||||
import wikiq.tables as tables
|
||||
from wikiq.resume import get_resume_point
|
||||
from wikiq.tables import RevisionTable
|
||||
from wikiq.wiki_diff_matcher import WikiDiffMatcher
|
||||
from wikiq.wikitext_parser import WikitextParser
|
||||
from wikiq.resume import get_resume_point
|
||||
|
||||
try:
|
||||
from importlib.metadata import PackageNotFoundError
|
||||
from importlib.metadata import version as _package_version
|
||||
__version__ = _package_version("wikiq")
|
||||
__version__ = _package_version("mediawiki-dump-tools")
|
||||
except PackageNotFoundError:
|
||||
__version__ = "unknown"
|
||||
|
||||
TO_ENCODE = ("title", "editor")
|
||||
PERSISTENCE_RADIUS = 7
|
||||
DIFF_TIMEOUT_MS = 60000
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
# Some dependencies serve a single feature and are awkward enough to install
|
||||
# that wikiq leaves them out of the base install. Each is imported inside the
|
||||
# code path that needs it, so importing wikiq works without them and a plain
|
||||
# `pip install` needs no C++ compiler. These helpers do that import and, when
|
||||
# it fails, explain what to install rather than raising an ImportError.
|
||||
|
||||
def require_pywikidiff2(feature: str):
|
||||
"""Import and return pywikidiff2, or exit explaining how to install it.
|
||||
|
||||
feature names the wikiq option that needs it, so the message points at
|
||||
whatever the user actually asked for.
|
||||
"""
|
||||
try:
|
||||
import pywikidiff2
|
||||
except ImportError:
|
||||
raise SystemExit(
|
||||
f"{feature} requires pywikidiff2, which wikiq does not install by "
|
||||
"default because it compiles a C++ extension.\n"
|
||||
"Install it with:\n"
|
||||
" pip install 'pywikidiff2 @ git+"
|
||||
"https://gitea.communitydata.science/groceryheist/pywikidiff2.git'\n"
|
||||
"A C++ compiler and libthai must be available. Other persistence "
|
||||
"methods (-p sequence, -p segment, -p legacy) do not need it."
|
||||
)
|
||||
return pywikidiff2
|
||||
|
||||
|
||||
def require_mw_persistence():
|
||||
"""Import and return mw.lib.persistence, or exit explaining how to get it."""
|
||||
try:
|
||||
from mw.lib import persistence
|
||||
except ImportError:
|
||||
raise SystemExit(
|
||||
"-p legacy requires mediawiki-utilities, which wikiq no longer "
|
||||
"installs by default.\n"
|
||||
"Install it with:\n"
|
||||
" pip install 'wikiq[legacy]'\n"
|
||||
"This method exists to reproduce results from older research "
|
||||
"projects; -p sequence is the current equivalent."
|
||||
)
|
||||
return persistence
|
||||
import pyarrow as pa
|
||||
import pyarrow.csv as pacsv
|
||||
from deltas import SegmentMatcher, SequenceMatcher
|
||||
|
||||
|
||||
def pyarrow_type_to_spark(pa_type):
|
||||
@@ -174,7 +133,6 @@ def build_table(
|
||||
wikilinks: bool = False,
|
||||
templates: bool = False,
|
||||
headings: bool = False,
|
||||
content_sizes: bool = False,
|
||||
redirect_aliases: Union[list[str], None] = None,
|
||||
):
|
||||
"""Build the RevisionTable with appropriate columns based on flags.
|
||||
@@ -214,7 +172,7 @@ def build_table(
|
||||
table.columns.append(tables.RevisionCollapsed())
|
||||
|
||||
wikitext_parser = None
|
||||
if external_links or citations or wikilinks or templates or headings or content_sizes:
|
||||
if external_links or citations or wikilinks or templates or headings:
|
||||
wikitext_parser = WikitextParser()
|
||||
|
||||
if external_links:
|
||||
@@ -232,10 +190,6 @@ def build_table(
|
||||
if headings:
|
||||
table.columns.append(tables.RevisionHeadings(wikitext_parser))
|
||||
|
||||
if content_sizes:
|
||||
table.columns.append(tables.RevisionContentChars(wikitext_parser))
|
||||
table.columns.append(tables.RevisionMarkupChars(wikitext_parser))
|
||||
|
||||
table.columns.append(tables.RevisionParserTimeout(wikitext_parser))
|
||||
|
||||
return table, reverts_column, wikitext_parser
|
||||
@@ -279,10 +233,10 @@ def build_schema(
|
||||
return schema
|
||||
|
||||
|
||||
def make_regex_pairs(patterns, labels) -> list:
|
||||
def make_regex_pairs(patterns, labels, count_only=False) -> list:
|
||||
"""Create RegexPair objects from patterns and labels."""
|
||||
if (patterns is not None and labels is not None) and (len(patterns) == len(labels)):
|
||||
return [RegexPair(pattern, label) for pattern, label in zip(patterns, labels)]
|
||||
return [RegexPair(pattern, label, count_only) for pattern, label in zip(patterns, labels)]
|
||||
elif patterns is None and labels is None:
|
||||
return []
|
||||
else:
|
||||
@@ -507,21 +461,23 @@ If the pattern does not include a capture group, then only one output column wil
|
||||
|
||||
|
||||
class RegexPair(object):
|
||||
def __init__(self, pattern, label):
|
||||
def __init__(self, pattern, label, count_only=False):
|
||||
self.pattern = re.compile(pattern)
|
||||
self.label = label
|
||||
self.count_only = count_only
|
||||
self.has_groups = bool(self.pattern.groupindex)
|
||||
if self.has_groups:
|
||||
self.capture_groups = list(self.pattern.groupindex.keys())
|
||||
|
||||
def get_pyarrow_fields(self):
|
||||
value_type = pa.int64() if self.count_only else pa.string()
|
||||
if self.has_groups:
|
||||
fields = [
|
||||
pa.field(self._make_key(cap_group), pa.string())
|
||||
pa.field(self._make_key(cap_group), value_type)
|
||||
for cap_group in self.capture_groups
|
||||
]
|
||||
else:
|
||||
fields = [pa.field(self.label, pa.string())]
|
||||
fields = [pa.field(self.label, value_type)]
|
||||
|
||||
return fields
|
||||
|
||||
@@ -534,39 +490,50 @@ class RegexPair(object):
|
||||
if self.has_groups:
|
||||
# if there are matches of some sort in this revision content, fill the lists for each cap_group
|
||||
# content can be None when the text or comment was deleted/suppressed
|
||||
if content is not None and self.pattern.search(content) is not None:
|
||||
m = self.pattern.finditer(content)
|
||||
matchobjects = list(m)
|
||||
|
||||
if content is not None and (matchobjects := list(self.pattern.finditer(content))):
|
||||
for cap_group in self.capture_groups:
|
||||
key = self._make_key(cap_group)
|
||||
temp_list = []
|
||||
for match in matchobjects:
|
||||
# we only want to add the match for the capture group if the match is not None
|
||||
if match.group(cap_group) is not None:
|
||||
temp_list.append(match.group(cap_group))
|
||||
if (group := match.group(cap_group)) is not None:
|
||||
temp_list.append(group)
|
||||
|
||||
# if temp_list of matches is empty just make that column None
|
||||
# if temp_list of matches is empty just make that column None (0 in count mode)
|
||||
if len(temp_list) == 0:
|
||||
temp_dict[key] = None
|
||||
if self.count_only:
|
||||
temp_dict[key] = 0
|
||||
else:
|
||||
temp_dict[key] = None
|
||||
# else we put in the list we made in the for-loop above
|
||||
else:
|
||||
temp_dict[key] = ", ".join(temp_list)
|
||||
if self.count_only:
|
||||
temp_dict[key] = len(temp_list)
|
||||
else:
|
||||
temp_dict[key] = ", ".join(temp_list)
|
||||
|
||||
# there are no matches at all in this revision content, we default values to None
|
||||
# there are no matches at all in this revision content, we default values to None (0 in count mode)
|
||||
else:
|
||||
for cap_group in self.capture_groups:
|
||||
key = self._make_key(cap_group)
|
||||
temp_dict[key] = None
|
||||
if self.count_only:
|
||||
temp_dict[key] = 0
|
||||
else:
|
||||
temp_dict[key] = None
|
||||
|
||||
# there are no capture groups, we just search for all the matches of the regex
|
||||
else:
|
||||
# given that there are matches to be made
|
||||
if content is not None and self.pattern.search(content) is not None:
|
||||
m = self.pattern.findall(content)
|
||||
temp_dict[self.label] = ", ".join(m)
|
||||
if content is not None and (matches := self.pattern.findall(content)):
|
||||
if self.count_only:
|
||||
temp_dict[self.label] = len(matches)
|
||||
else:
|
||||
temp_dict[self.label] = ", ".join(matches)
|
||||
else:
|
||||
temp_dict[self.label] = None
|
||||
if self.count_only:
|
||||
temp_dict[self.label] = 0
|
||||
else:
|
||||
temp_dict[self.label] = None
|
||||
|
||||
return temp_dict
|
||||
|
||||
@@ -580,6 +547,8 @@ class WikiqParser:
|
||||
regex_match_comment: list[str],
|
||||
regex_revision_label: list[str],
|
||||
regex_comment_label: list[str],
|
||||
regex_revision_output_count: bool = False,
|
||||
regex_comment_output_count: bool = False,
|
||||
text: bool = False,
|
||||
diff: bool = False,
|
||||
collapse_user: bool = False,
|
||||
@@ -595,7 +564,6 @@ class WikiqParser:
|
||||
wikilinks: bool = False,
|
||||
templates: bool = False,
|
||||
headings: bool = False,
|
||||
content_sizes: bool = False,
|
||||
redirect_aliases: Union[list[str], None] = None,
|
||||
time_limit_seconds: Union[float, None] = None,
|
||||
input_filename: Union[str, None] = None,
|
||||
@@ -622,7 +590,6 @@ class WikiqParser:
|
||||
self.wikilinks = wikilinks
|
||||
self.templates = templates
|
||||
self.headings = headings
|
||||
self.content_sizes = content_sizes
|
||||
self.redirect_aliases = redirect_aliases
|
||||
self.shutdown_requested = False
|
||||
self.time_limit_seconds = time_limit_seconds
|
||||
@@ -633,10 +600,10 @@ class WikiqParser:
|
||||
|
||||
self.regex_schemas = []
|
||||
self.regex_revision_pairs: list[RegexPair] = self.make_matchmake_pairs(
|
||||
regex_match_revision, regex_revision_label
|
||||
regex_match_revision, regex_revision_label, regex_revision_output_count
|
||||
)
|
||||
self.regex_comment_pairs: list[RegexPair] = self.make_matchmake_pairs(
|
||||
regex_match_comment, regex_comment_label
|
||||
regex_match_comment, regex_comment_label, regex_comment_output_count
|
||||
)
|
||||
|
||||
# Initialize output
|
||||
@@ -679,13 +646,13 @@ class WikiqParser:
|
||||
if timer is not None:
|
||||
timer.cancel()
|
||||
|
||||
def make_matchmake_pairs(self, patterns, labels) -> list[RegexPair]:
|
||||
def make_matchmake_pairs(self, patterns, labels, count_only=False) -> list[RegexPair]:
|
||||
if (patterns is not None and labels is not None) and (
|
||||
len(patterns) == len(labels)
|
||||
):
|
||||
result: list[RegexPair] = []
|
||||
for pattern, label in zip(patterns, labels):
|
||||
rp = RegexPair(pattern, label)
|
||||
rp = RegexPair(pattern, label, count_only)
|
||||
result.append(rp)
|
||||
self.regex_schemas = self.regex_schemas + rp.get_pyarrow_fields()
|
||||
return result
|
||||
@@ -749,7 +716,6 @@ class WikiqParser:
|
||||
wikilinks=self.wikilinks,
|
||||
templates=self.templates,
|
||||
headings=self.headings,
|
||||
content_sizes=self.content_sizes,
|
||||
redirect_aliases=self.redirect_aliases,
|
||||
)
|
||||
|
||||
@@ -803,7 +769,6 @@ class WikiqParser:
|
||||
differ = None
|
||||
fast_differ = None
|
||||
if self.diff:
|
||||
pywikidiff2 = require_pywikidiff2("--diff")
|
||||
differ = pywikidiff2.pywikidiff2(
|
||||
num_context_lines=1000000,
|
||||
max_word_level_diff_complexity=-1,
|
||||
@@ -891,14 +856,12 @@ class WikiqParser:
|
||||
revert_radius=PERSISTENCE_RADIUS,
|
||||
)
|
||||
elif self.persist == PersistMethod.wikidiff2:
|
||||
require_pywikidiff2("-p wikidiff2")
|
||||
from wikiq.wiki_diff_matcher import WikiDiffMatcher
|
||||
wikidiff_matcher = WikiDiffMatcher(tokenizer=wikitext_split)
|
||||
persist_state = mwpersistence.DiffState(
|
||||
wikidiff_matcher, revert_radius=PERSISTENCE_RADIUS
|
||||
)
|
||||
else:
|
||||
persistence = require_mw_persistence()
|
||||
from mw.lib import persistence
|
||||
persist_state = persistence.State()
|
||||
|
||||
# Pending persistence values waiting for window to fill
|
||||
@@ -1228,6 +1191,14 @@ def main():
|
||||
help="The label for the outputted column based on matching the regex in revision text.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"-RPc",
|
||||
"--revision-pattern-count",
|
||||
dest="regex_revision_output_count",
|
||||
action="store_true",
|
||||
help="If present, this will cause the revision patterns to return counts of the number of matches instead of the text of the matches themselves. It will affect all revision patterns.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"-CP",
|
||||
"--comment-pattern",
|
||||
@@ -1248,6 +1219,14 @@ def main():
|
||||
help="The label for the outputted column based on matching the regex in comments.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"-CPc",
|
||||
"--comment-pattern-count",
|
||||
dest="regex_comment_output_count",
|
||||
action="store_true",
|
||||
help="If present, this will cause the comment patterns to return counts of the number of matches instead of the text of the matches themselves. It will affect all comment patterns.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"-d",
|
||||
"--diff",
|
||||
@@ -1306,14 +1285,6 @@ def main():
|
||||
help="Extract section headings from each revision.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--content-sizes",
|
||||
dest="content_sizes",
|
||||
action="store_true",
|
||||
default=False,
|
||||
help="Split each revision into content_chars, the information it carries, and markup_chars, the wikitext formatting around it. Content is what someone who did not know wikitext would have typed: words, link labels, and template parameter values. The two columns sum to the revision length.",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--redirect-aliases",
|
||||
dest="redirect_aliases",
|
||||
@@ -1368,15 +1339,6 @@ def main():
|
||||
else:
|
||||
persist = PersistMethod.sequence
|
||||
|
||||
# Check for the optional dependencies up front. Both are used deep in the
|
||||
# per-revision loop, and a run can stream for hours before reaching them.
|
||||
if args.diff:
|
||||
require_pywikidiff2("--diff")
|
||||
if persist == PersistMethod.wikidiff2:
|
||||
require_pywikidiff2("-p wikidiff2")
|
||||
elif persist == PersistMethod.legacy:
|
||||
require_mw_persistence()
|
||||
|
||||
if args.namespace_filter is not None:
|
||||
namespaces = args.namespace_filter
|
||||
else:
|
||||
@@ -1394,8 +1356,8 @@ def main():
|
||||
|
||||
# Handle --print-schema: build and output schema, then exit
|
||||
if args.print_schema:
|
||||
regex_revision_pairs = make_regex_pairs(args.regex_match_revision, args.regex_revision_label)
|
||||
regex_comment_pairs = make_regex_pairs(args.regex_match_comment, args.regex_comment_label)
|
||||
regex_revision_pairs = make_regex_pairs(args.regex_match_revision, args.regex_revision_label, args.regex_revision_output_count)
|
||||
regex_comment_pairs = make_regex_pairs(args.regex_match_comment, args.regex_comment_label, args.regex_comment_output_count)
|
||||
|
||||
table, _, _ = build_table(
|
||||
text=args.text,
|
||||
@@ -1405,7 +1367,6 @@ def main():
|
||||
wikilinks=args.wikilinks,
|
||||
templates=args.templates,
|
||||
headings=args.headings,
|
||||
content_sizes=args.content_sizes,
|
||||
redirect_aliases=redirect_aliases,
|
||||
)
|
||||
schema = build_schema(
|
||||
@@ -1474,8 +1435,10 @@ def main():
|
||||
revert_radius=args.revert_radius,
|
||||
regex_match_revision=args.regex_match_revision,
|
||||
regex_revision_label=args.regex_revision_label,
|
||||
regex_revision_output_count=args.regex_revision_output_count,
|
||||
regex_match_comment=args.regex_match_comment,
|
||||
regex_comment_label=args.regex_comment_label,
|
||||
regex_comment_output_count=args.regex_comment_output_count,
|
||||
text=args.text,
|
||||
diff=args.diff,
|
||||
output_jsonl=output_jsonl,
|
||||
@@ -1487,7 +1450,6 @@ def main():
|
||||
wikilinks=args.wikilinks,
|
||||
templates=args.templates,
|
||||
headings=args.headings,
|
||||
content_sizes=args.content_sizes,
|
||||
redirect_aliases=redirect_aliases,
|
||||
time_limit_seconds=time_limit_seconds,
|
||||
input_filename=filename,
|
||||
@@ -1532,8 +1494,10 @@ def main():
|
||||
revert_radius=args.revert_radius,
|
||||
regex_match_revision=args.regex_match_revision,
|
||||
regex_revision_label=args.regex_revision_label,
|
||||
regex_revision_output_count=args.regex_revision_output_count,
|
||||
regex_match_comment=args.regex_match_comment,
|
||||
regex_comment_label=args.regex_comment_label,
|
||||
regex_comment_output_count=args.regex_comment_output_count,
|
||||
diff=args.diff,
|
||||
text=args.text,
|
||||
batch_size=args.batch_size,
|
||||
@@ -1543,7 +1507,6 @@ def main():
|
||||
wikilinks=args.wikilinks,
|
||||
templates=args.templates,
|
||||
headings=args.headings,
|
||||
content_sizes=args.content_sizes,
|
||||
redirect_aliases=redirect_aliases,
|
||||
time_limit_seconds=time_limit_seconds,
|
||||
)
|
||||
|
||||
@@ -384,50 +384,6 @@ class RevisionHeadings(RevisionField[Union[list[dict], None]]):
|
||||
return self.wikitext_parser.extract_headings(revision.text)
|
||||
|
||||
|
||||
class RevisionContentChars(RevisionField[Union[int, None]]):
|
||||
"""Count the characters of information a revision carries.
|
||||
|
||||
The words, link labels and template parameter values -- what someone
|
||||
who did not know wikitext would have typed. See
|
||||
WikitextParser.content_sizes().
|
||||
"""
|
||||
|
||||
field = pa.field("content_chars", pa.int64(), nullable=True)
|
||||
|
||||
def __init__(self, wikitext_parser: "WikitextParser"):
|
||||
super().__init__()
|
||||
self.wikitext_parser = wikitext_parser
|
||||
|
||||
def extract(self, page: mwtypes.Page, revisions: list[mwxml.Revision]) -> Union[int, None]:
|
||||
revision = revisions[-1]
|
||||
if revision.deleted.text:
|
||||
return None
|
||||
sizes = self.wikitext_parser.content_sizes(revision.text)
|
||||
return None if sizes is None else sizes[0]
|
||||
|
||||
|
||||
class RevisionMarkupChars(RevisionField[Union[int, None]]):
|
||||
"""Count the characters of markup wrapped around a revision's content.
|
||||
|
||||
Braces, pipes, parameter names, tag names and attributes, link targets
|
||||
and comments. Together with content_chars this sums to the revision
|
||||
length.
|
||||
"""
|
||||
|
||||
field = pa.field("markup_chars", pa.int64(), nullable=True)
|
||||
|
||||
def __init__(self, wikitext_parser: "WikitextParser"):
|
||||
super().__init__()
|
||||
self.wikitext_parser = wikitext_parser
|
||||
|
||||
def extract(self, page: mwtypes.Page, revisions: list[mwxml.Revision]) -> Union[int, None]:
|
||||
revision = revisions[-1]
|
||||
if revision.deleted.text:
|
||||
return None
|
||||
sizes = self.wikitext_parser.content_sizes(revision.text)
|
||||
return None if sizes is None else sizes[1]
|
||||
|
||||
|
||||
class RevisionParserTimeout(RevisionField[bool]):
|
||||
"""Track whether the wikitext parser timed out for this revision."""
|
||||
|
||||
|
||||
@@ -26,6 +26,7 @@ from mwpersistence import Token
|
||||
from sortedcontainers import SortedDict
|
||||
|
||||
TOKENIZER = tokenizers.wikitext_split
|
||||
import pywikidiff2
|
||||
|
||||
|
||||
class DiffToOperationMap:
|
||||
@@ -347,11 +348,6 @@ class WikiDiffMatcher:
|
||||
|
||||
class Processor(DiffEngine.Processor):
|
||||
def __init__(self, tokenizer=None):
|
||||
# imported here rather than at module scope so that importing
|
||||
# wikiq does not require the pywikidiff2 C++ extension
|
||||
from wikiq import require_pywikidiff2
|
||||
|
||||
pywikidiff2 = require_pywikidiff2("-p wikidiff2")
|
||||
self.tokenizer = tokenizer or TOKENIZER
|
||||
self.last_tokens = []
|
||||
self.previous_text = ""
|
||||
|
||||
@@ -20,17 +20,6 @@ from __future__ import annotations
|
||||
import signal
|
||||
|
||||
import mwparserfromhell
|
||||
from mwparserfromhell.nodes import (
|
||||
Argument,
|
||||
Comment,
|
||||
ExternalLink,
|
||||
Heading,
|
||||
HTMLEntity,
|
||||
Tag,
|
||||
Template,
|
||||
Text,
|
||||
Wikilink,
|
||||
)
|
||||
|
||||
PARSER_TIMEOUT = 60 # seconds
|
||||
|
||||
@@ -49,8 +38,6 @@ class WikitextParser:
|
||||
self._cached_text: str | None = None
|
||||
self._cached_wikicode = None
|
||||
self.last_parse_timed_out: bool = False
|
||||
self._sizes_text: str | None = None
|
||||
self._cached_sizes: tuple[int, int] | None = None
|
||||
|
||||
def _timeout_handler(self, signum, frame):
|
||||
raise TimeoutError("mwparserfromhell parse exceeded timeout")
|
||||
@@ -159,85 +146,6 @@ class WikitextParser:
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
def _count_content(self, wikicode, counts: list[int]) -> None:
|
||||
"""Walk a wikicode tree adding the length of rendered content.
|
||||
|
||||
counts is a one-element list holding the running content total.
|
||||
Anything not counted here is markup; content_sizes() derives the
|
||||
markup total by subtraction, so every character lands in one column
|
||||
or the other.
|
||||
"""
|
||||
for node in wikicode.nodes:
|
||||
if isinstance(node, Text):
|
||||
counts[0] += len(node.value)
|
||||
elif isinstance(node, HTMLEntity):
|
||||
# an entity stands in for the character it renders as, so
|
||||
# only that character is content and the escaping is markup
|
||||
counts[0] += len(node.normalize())
|
||||
elif isinstance(node, Comment):
|
||||
# never reaches a reader, so it is not information
|
||||
continue
|
||||
elif isinstance(node, Template):
|
||||
# the parameter values are the information; the template
|
||||
# name, parameter names and delimiters are the polish that
|
||||
# someone later wrapped around it
|
||||
for param in node.params:
|
||||
self._count_content(param.value, counts)
|
||||
elif isinstance(node, Tag):
|
||||
# tag contents are information; the tag name and attributes
|
||||
# are markup. This covers ''italic'' and '''bold''', which
|
||||
# mwparserfromhell represents as i and b tags
|
||||
if node.contents is not None:
|
||||
self._count_content(node.contents, counts)
|
||||
elif isinstance(node, Wikilink):
|
||||
# the label if present, otherwise the target, is what a
|
||||
# reader sees; the brackets and the link target are markup
|
||||
rendered = node.text if node.text is not None else node.title
|
||||
self._count_content(rendered, counts)
|
||||
elif isinstance(node, ExternalLink):
|
||||
# both halves are information someone typed: a contributor
|
||||
# who did not know wikitext would still have written the URL
|
||||
counts[0] += len(str(node.url))
|
||||
if node.title is not None:
|
||||
self._count_content(node.title, counts)
|
||||
elif isinstance(node, Heading):
|
||||
self._count_content(node.title, counts)
|
||||
elif isinstance(node, Argument):
|
||||
if node.default is not None:
|
||||
self._count_content(node.default, counts)
|
||||
|
||||
def content_sizes(self, text: str | None) -> tuple[int, int] | None:
|
||||
"""Split a revision into the information it carries and the markup
|
||||
around it.
|
||||
|
||||
Returns (content_chars, markup_chars), which sum to len(text).
|
||||
|
||||
Content is what a contributor who did not know wikitext would have
|
||||
typed: the words, the link labels, the values inside template
|
||||
parameters. Markup is everything a later editor added to format it —
|
||||
braces, pipes, parameter names, tag names and attributes, link
|
||||
targets, quote marks, and comments.
|
||||
|
||||
So "Wonderful Hotel, +15555550123" is almost all content, while
|
||||
"{{listing|name=Wonderful Hotel|phone=+15555550123}}" carries the
|
||||
same information with two dozen characters of markup around it.
|
||||
"""
|
||||
if text is None:
|
||||
return None
|
||||
if text == self._sizes_text:
|
||||
return self._cached_sizes
|
||||
try:
|
||||
wikicode = self._get_wikicode(text)
|
||||
counts = [0]
|
||||
self._count_content(wikicode, counts)
|
||||
content = min(counts[0], len(text))
|
||||
result = (content, len(text) - content)
|
||||
except Exception:
|
||||
result = None
|
||||
self._sizes_text = text
|
||||
self._cached_sizes = result
|
||||
return result
|
||||
|
||||
def extract_headings(self, text: str | None) -> list[dict] | None:
|
||||
"""Extract all section headings with their levels."""
|
||||
if text is None:
|
||||
|
||||
@@ -12,7 +12,7 @@ import pytest
|
||||
from pandas import DataFrame
|
||||
from pandas.testing import assert_frame_equal, assert_series_equal
|
||||
|
||||
from wikiq import build_table, build_schema, RegexPair, WikitextParser
|
||||
from wikiq import build_table, build_schema, RegexPair
|
||||
from wikiq_test_utils import (
|
||||
BASELINE_DIR,
|
||||
IKWIKI,
|
||||
@@ -23,8 +23,6 @@ from wikiq_test_utils import (
|
||||
TWINPEAKS,
|
||||
WIKIQ,
|
||||
WikiqTester,
|
||||
requires_mediawiki_utilities,
|
||||
requires_pywikidiff2,
|
||||
)
|
||||
|
||||
|
||||
@@ -207,7 +205,6 @@ def test_collapse_user():
|
||||
baseline = pd.read_table(tester.baseline_file)
|
||||
assert_frame_equal(test, baseline, check_like=True)
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_pwr_wikidiff2():
|
||||
tester = WikiqTester(SAILORMOON, "persistence_wikidiff2", in_compression="7z")
|
||||
|
||||
@@ -232,7 +229,6 @@ def test_pwr_segment():
|
||||
baseline = pd.read_table(tester.baseline_file)
|
||||
assert_frame_equal(test, baseline, check_like=True)
|
||||
|
||||
@requires_mediawiki_utilities
|
||||
def test_pwr_legacy():
|
||||
tester = WikiqTester(SAILORMOON, "persistence_legacy", in_compression="7z")
|
||||
|
||||
@@ -259,7 +255,6 @@ def test_pwr():
|
||||
test = test.reindex(columns=sorted(test.columns))
|
||||
assert_frame_equal(test, baseline, check_like=True)
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_diff():
|
||||
tester = WikiqTester(SAILORMOON, "diff", in_compression="7z", out_format='jsonl')
|
||||
|
||||
@@ -273,7 +268,6 @@ def test_diff():
|
||||
assert "diff_timeout" in test.columns, "diff_timeout column should exist"
|
||||
assert len(test) > 0, "Should have output rows"
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_diff_plus_pwr():
|
||||
tester = WikiqTester(SAILORMOON, "diff_pwr", in_compression="7z", out_format='jsonl')
|
||||
|
||||
@@ -287,7 +281,6 @@ def test_diff_plus_pwr():
|
||||
assert "token_revs" in test.columns, "token_revs column should exist"
|
||||
assert len(test) > 0, "Should have output rows"
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_text():
|
||||
tester = WikiqTester(SAILORMOON, "text", in_compression="7z", out_format='jsonl')
|
||||
|
||||
@@ -427,6 +420,55 @@ def test_regex_deleted_revisions():
|
||||
assert deleted["npov_npov"].isna().all()
|
||||
assert deleted["talk_talk"].isna().all()
|
||||
|
||||
def test_regex_count_only():
|
||||
# count mode returns match counts instead of the matched text, with 0
|
||||
# (never None) for revisions with no matches or deleted content
|
||||
pair = RegexPair(r"\bcat\b", "cats", count_only=True)
|
||||
assert pair.matchmake("cat cat dog cat") == {"cats": 3}
|
||||
assert pair.matchmake("dog") == {"cats": 0}
|
||||
assert pair.matchmake(None) == {"cats": 0}
|
||||
assert pair.get_pyarrow_fields()[0].type == pa.int64()
|
||||
|
||||
pair = RegexPair(r"(?P<a>\bcat\b)|(?P<b>\bdog\b)", "pets", count_only=True)
|
||||
assert pair.matchmake("cat dog cat") == {"pets_a": 2, "pets_b": 1}
|
||||
assert pair.matchmake("bird") == {"pets_a": 0, "pets_b": 0}
|
||||
assert pair.matchmake(None) == {"pets_a": 0, "pets_b": 0}
|
||||
assert all(f.type == pa.int64() for f in pair.get_pyarrow_fields())
|
||||
|
||||
# without count_only the original behavior is unchanged
|
||||
pair = RegexPair(r"\bcat\b", "cats")
|
||||
assert pair.matchmake("cat cat dog cat") == {"cats": "cat, cat, cat"}
|
||||
assert pair.get_pyarrow_fields()[0].type == pa.string()
|
||||
|
||||
def test_regex_count_e2e():
|
||||
# -RPc/-CPc produce integer columns whose values equal the number of
|
||||
# matches in the revision text and comment respectively
|
||||
tester = WikiqTester(wiki=REGEXTEST, case_name="regex_count")
|
||||
|
||||
try:
|
||||
tester.call_wikiq(
|
||||
"--text",
|
||||
"-RP 'TestCase' -RPl testcases -RPc",
|
||||
"-CP '\\b[Cc]hevalier\\b' -CPl chev -CPc",
|
||||
)
|
||||
except subprocess.CalledProcessError as exc:
|
||||
pytest.fail(exc.stderr.decode("utf8"))
|
||||
|
||||
import re
|
||||
test = pd.read_table(tester.output)
|
||||
|
||||
assert test["testcases"].dtype == "int64"
|
||||
assert test["chev"].dtype == "int64"
|
||||
|
||||
for _, row in test.iterrows():
|
||||
text = row["text"] if isinstance(row["text"], str) else None
|
||||
expected = len(re.findall("TestCase", text)) if text is not None else 0
|
||||
assert row["testcases"] == expected, f"revid {row['revid']}: {row['testcases']} != {expected}"
|
||||
|
||||
comment = row["edit_summary"] if isinstance(row["edit_summary"], str) else None
|
||||
expected = len(re.findall(r"\b[Cc]hevalier\b", comment)) if comment is not None else 0
|
||||
assert row["chev"] == expected, f"revid {row['revid']}: {row['chev']} != {expected}"
|
||||
|
||||
def test_redirect_detection():
|
||||
from wikiq.tables import RedirectDetector
|
||||
|
||||
@@ -484,71 +526,6 @@ def test_redirect_columns_e2e():
|
||||
assert len(redirects) > 0
|
||||
assert redirects["revision_redirect_target"].notna().all()
|
||||
|
||||
def test_content_sizes():
|
||||
# hand-computed fixtures: (text, content_chars, markup_chars)
|
||||
cases = [
|
||||
# plain text is all content
|
||||
("Hello world.", 12, 0),
|
||||
# the same information written by someone who knows wikitext: the
|
||||
# values survive as content, the scaffolding around them is markup
|
||||
("Wonderful Hotel, +15555550123", 29, 0),
|
||||
("{{listing|name=Wonderful Hotel|phone=+15555550123}}", 27, 24),
|
||||
# emphasis is markup applied to content, not content itself
|
||||
("''whatever''", 8, 4),
|
||||
("Some '''bold''' prose.", 16, 6),
|
||||
# tag contents are content; the tag name and attributes are not
|
||||
('Before <span class="x">inner text</span> after', 23, 23),
|
||||
# a wikilink renders its label, so the target is markup
|
||||
("[[Main Page|the main page]]", 13, 14),
|
||||
# an unlabeled wikilink renders its target, which is then content
|
||||
("[[Help]]", 4, 4),
|
||||
# both halves of an external link are information someone typed
|
||||
("[http://x.com label]", 17, 3),
|
||||
# comments never reach a reader, so they are entirely markup
|
||||
("Text <!-- hidden --> more", 10, 15),
|
||||
# nesting: values at any depth are content
|
||||
("{{outer|a={{inner|b=deep}} shallow}}", 12, 24),
|
||||
]
|
||||
|
||||
parser = WikitextParser()
|
||||
for text, content, markup in cases:
|
||||
result = parser.content_sizes(text)
|
||||
assert result == (content, markup), f"{text!r}: got {result}, want {(content, markup)}"
|
||||
# every character lands in exactly one column
|
||||
assert result[0] + result[1] == len(text), f"{text!r}: columns do not sum to length"
|
||||
|
||||
assert parser.content_sizes(None) is None
|
||||
|
||||
def test_content_sizes_e2e():
|
||||
# the ikwiki dump contains revisions with deleted text, which must get
|
||||
# null content sizes; for every other revision the two columns must
|
||||
# account for the whole revision
|
||||
tester = WikiqTester(IKWIKI, "content_sizes")
|
||||
|
||||
try:
|
||||
tester.call_wikiq("--content-sizes", "--text")
|
||||
except subprocess.CalledProcessError as exc:
|
||||
pytest.fail(exc.stderr.decode("utf8"))
|
||||
|
||||
test = pd.read_table(tester.output)
|
||||
|
||||
assert "content_chars" in test.columns
|
||||
assert "markup_chars" in test.columns
|
||||
|
||||
deleted = test[test["deleted"]]
|
||||
assert len(deleted) > 0
|
||||
assert deleted["content_chars"].isna().all()
|
||||
assert deleted["markup_chars"].isna().all()
|
||||
|
||||
present = test[~test["deleted"] & test["text"].notna() & test["content_chars"].notna()]
|
||||
assert len(present) > 0
|
||||
total = present["content_chars"] + present["markup_chars"]
|
||||
assert (total == present["text"].str.len()).all()
|
||||
# a real wiki has both kinds of revision: some almost pure text, some
|
||||
# carrying a lot of markup
|
||||
assert (present["markup_chars"] == 0).any()
|
||||
assert (present["markup_chars"] > 0).any()
|
||||
|
||||
def test_external_links_only():
|
||||
"""Test that --external-links extracts external links correctly."""
|
||||
import mwparserfromhell
|
||||
@@ -15,7 +15,6 @@ from wikiq_test_utils import (
|
||||
TEST_OUTPUT_DIR,
|
||||
WIKIQ,
|
||||
WikiqTester,
|
||||
requires_pywikidiff2,
|
||||
)
|
||||
|
||||
|
||||
@@ -66,7 +65,6 @@ def test_resume():
|
||||
assert_frame_equal(df_full, df_resumed)
|
||||
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_resume_with_diff():
|
||||
"""Test that --resume correctly computes diff values after resume.
|
||||
|
||||
@@ -307,7 +305,6 @@ def test_resume_data_equivalence():
|
||||
assert_frame_equal(df_full, df_resumed)
|
||||
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_resume_with_persistence():
|
||||
"""Test that --resume correctly handles persistence state after resume.
|
||||
|
||||
@@ -406,7 +403,6 @@ def test_resume_corrupted_jsonl_last_line():
|
||||
assert_frame_equal(df_full, df_resumed)
|
||||
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_resume_diff_persistence_combined():
|
||||
"""Test that --resume correctly handles both diff and persistence state together.
|
||||
|
||||
@@ -452,7 +448,6 @@ def test_resume_diff_persistence_combined():
|
||||
assert_frame_equal(df_full, df_resumed)
|
||||
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_resume_mid_page():
|
||||
"""Test resume from the middle of a page with many revisions.
|
||||
|
||||
@@ -506,7 +501,6 @@ def test_resume_mid_page():
|
||||
assert_frame_equal(df_full, df_resumed)
|
||||
|
||||
|
||||
@requires_pywikidiff2
|
||||
def test_resume_page_boundary():
|
||||
"""Test resume at the exact start of a new page.
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
from itertools import chain
|
||||
from functools import partial
|
||||
import os
|
||||
import re
|
||||
import pytest
|
||||
import pytest_asyncio
|
||||
@@ -7,10 +8,6 @@ from typing import List
|
||||
from deltas import Delete, Equal, Insert, wikitext_split
|
||||
from mwpersistence import Token
|
||||
from wikiq.wiki_diff_matcher import WikiDiffMatcher
|
||||
from wikiq_test_utils import requires_pywikidiff2
|
||||
|
||||
# every test here drives wikidiff2 directly
|
||||
pytestmark = requires_pywikidiff2
|
||||
|
||||
def _replace_whitespace(match):
|
||||
if match.group(1): # If spaces matched (e.g., ' ')
|
||||
@@ -280,6 +277,10 @@ def test_paragraph_move_and_change():
|
||||
assert_equal_enough(a, rev1)
|
||||
assert_equal_enough(b, rev2)
|
||||
|
||||
@pytest.mark.skipif(
|
||||
not os.path.exists("test/test_diff_revisions/test_infobox_from"),
|
||||
reason="test_infobox_from/_to fixture files are not in the repository",
|
||||
)
|
||||
def test_infobox():
|
||||
rev1 = open("test/test_diff_revisions/test_infobox_from").read()
|
||||
rev2 = open("test/test_diff_revisions/test_infobox_to").read()
|
||||
|
||||
@@ -1,27 +1,8 @@
|
||||
import importlib.util
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
from typing import Final, Union
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
def _installed(module: str) -> bool:
|
||||
return importlib.util.find_spec(module) is not None
|
||||
|
||||
|
||||
# wikiq's two optional dependencies. Tests exercising --diff, -p wikidiff2, or
|
||||
# -p legacy cannot run on a base install, so they skip rather than fail.
|
||||
requires_pywikidiff2 = pytest.mark.skipif(
|
||||
not _installed("pywikidiff2"),
|
||||
reason="needs the optional pywikidiff2 extension (--diff, -p wikidiff2)",
|
||||
)
|
||||
requires_mediawiki_utilities = pytest.mark.skipif(
|
||||
not _installed("mw"),
|
||||
reason="needs the optional mediawiki-utilities package (-p legacy)",
|
||||
)
|
||||
|
||||
TEST_DIR: Final[str] = os.path.dirname(os.path.realpath(__file__))
|
||||
WIKIQ: Final[str] = os.path.join(os.path.join(TEST_DIR, ".."), "src/wikiq/__init__.py")
|
||||
TEST_OUTPUT_DIR: Final[str] = os.path.join(TEST_DIR, "test_output")
|
||||
|
||||
Reference in New Issue
Block a user