Skip to content

Commit 70808be

Browse files
committed
add type annotations for osmium base functions
1 parent 4cce0be commit 70808be

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

src/osmium/_osmium.pyi

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
from typing import overload, ByteString, Union
2+
import os
3+
4+
import osmium.index
5+
import osmium.io
6+
7+
StrPath = Union[str, 'os.PathLike[str]']
8+
9+
class InvalidLocationError(Exception): ...
10+
11+
class NodeLocationsForWays:
12+
def __init__(self, locations: osmium.index.LocationTable) -> None: ...
13+
def ignore_errors(self) -> None: ...
14+
15+
class BaseHandler: ...
16+
17+
class SimpleHandler(BaseHandler):
18+
def __init__(self) -> None: ...
19+
def apply_buffer(self, buffer: ByteString, format: str, locations: bool = ..., idx: str = ...) -> None: ...
20+
def apply_file(self, filename: StrPath, locations: bool = ..., idx: str = ...) -> None: ...
21+
22+
class MergeInputReader:
23+
def __init__(self) -> None: ...
24+
def add_buffer(self, buffer: ByteString, format: str) -> int: ...
25+
def add_file(self, file: str) -> int: ...
26+
def apply(self, handler: BaseHandler, idx: str = ..., simplify: bool = ...) -> None: ...
27+
def apply_to_reader(self, reader: osmium.io.Reader, writer: osmium.io.Writer, with_history: bool = ...) -> None: ...
28+
29+
class WriteHandler(BaseHandler):
30+
@overload
31+
def __init__(self, filename: str, bufsz: int, filetype: str) -> None: ...
32+
@overload
33+
def __init__(self, filename: str, bufsz: int) -> None: ...
34+
@overload
35+
def __init__(self, filename: str) -> None: ...
36+
def close(self) -> None: ...
37+
38+
class SimpleWriter:
39+
@overload
40+
def __init__(self, filename: str, bufsz: int, header: osmium.io.Header) -> None: ...
41+
@overload
42+
def __init__(self, filename: str, bufsz: int) -> None: ...
43+
@overload
44+
def __init__(self, filename: str) -> None: ...
45+
def add_node(self, node: object) -> None: ...
46+
def add_relation(self, relation: object) -> None: ...
47+
def add_way(self, way: object) -> None: ...
48+
def close(self) -> None: ...
49+
50+
@overload
51+
def apply(reader: osmium.io.Reader, handler: BaseHandler) -> None: ...
52+
@overload
53+
def apply(reader: osmium.io.Reader, node_handler: NodeLocationsForWays) -> None: ...
54+
@overload
55+
def apply(reader: osmium.io.Reader, node_handler: NodeLocationsForWays, handler: BaseHandler) -> None: ...

0 commit comments

Comments
 (0)