Skip to content

Conftest

Fixtures for doctests.

CustomOutputChecker

Bases: OutputChecker

Custom doctest OutputChecker for ignoring logs from functions.

check_output(want, got, optionflags)

Skips output checking if IGNORE_RESULT flag is present.

Source code in quackosm/conftest.py 
23
24
25
26
27
def check_output(self: doctest.OutputChecker, want: str, got: str, optionflags: int) -> bool:
    """Skips output checking if IGNORE_RESULT flag is present."""
    if IGNORE_RESULT & optionflags:
        return True
    return OutputChecker.check_output(self, want, got, optionflags)


download_osm_extracts_indexes()

Download OSM extract indexes files to cache.

Source code in quackosm/conftest.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@pytest.fixture(autouse=True, scope="session")
def download_osm_extracts_indexes():  # type: ignore
    """Download OSM extract indexes files to cache."""
    download_directory = Path("cache")
    download_directory.mkdir(parents=True, exist_ok=True)

    logger = get_pooch_logger()
    logger.setLevel("WARNING")

    for osm_extract in OsmExtractSource:
        if osm_extract == OsmExtractSource.any:
            continue

        file_name = f"{osm_extract.value.lower()}_index.geojson"
        file_download_url = LFS_DIRECTORY_URL + file_name

        retrieve(
            file_download_url,
            fname=file_name,
            path=download_directory,
            progressbar=False,
            known_hash=None,
        )


add_pbf_files(
    doctest_namespace, download_osm_extracts_indexes
)

Download PBF files used in doctests.

Source code in quackosm/conftest.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@pytest.fixture(autouse=True, scope="session")
def add_pbf_files(doctest_namespace, download_osm_extracts_indexes):  # type: ignore
    """Download PBF files used in doctests."""
    download_directory = Path("files")
    download_directory.mkdir(parents=True, exist_ok=True)

    geofabrik_index = _get_geofabrik_index()
    for extract_name in EXTRACTS_NAMES:
        pbf_file_download_url = LFS_DIRECTORY_URL + f"{extract_name}-latest.osm.pbf"
        pbf_file_path = download_directory / f"{extract_name}.osm.pbf"
        geofabrik_download_path = geofabrik_index[geofabrik_index["name"] == extract_name].iloc[0][
            "file_name"
        ]
        geofabrik_pbf_file_path = download_directory / f"{geofabrik_download_path}.osm.pbf"
        retrieve(
            pbf_file_download_url,
            fname=f"{extract_name}.osm.pbf",
            path=download_directory,
            progressbar=False,
            known_hash=None,
        )
        doctest_namespace[f"{extract_name}_pbf_path"] = pbf_file_path
        shutil.copy(pbf_file_path, geofabrik_pbf_file_path)


install_spatial_extension()

Install duckdb spatial extension.

Source code in quackosm/conftest.py 
87
88
89
90
@pytest.fixture(autouse=True, scope="session")
def install_spatial_extension():  # type: ignore
    """Install duckdb spatial extension."""
    duckdb.install_extension("spatial")


pandas_terminal_width()

Change pandas dataframe display options.

Source code in quackosm/conftest.py 
93
94
95
96
97
@pytest.fixture(autouse=True, scope="session")  # type: ignore
def pandas_terminal_width() -> None:
    """Change pandas dataframe display options."""
    pandas.set_option("display.width", 90)
    pandas.set_option("display.max_colwidth", 35)