1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
"""
Way operations for the OpenStreetMap API.
This module provides pythonic (snake_case) methods for working with OSM ways.
"""
from typing import Any, Optional, TYPE_CHECKING, cast
from xml.dom.minidom import Element
from . import dom, parser
if TYPE_CHECKING:
from .OsmApi import OsmApi
class WayMixin:
"""Mixin providing way-related operations with pythonic method names."""
def way_get(self: "OsmApi", way_id: int, way_version: int = -1) -> dict[str, Any]:
"""
Returns way with `way_id` as a dict:
#!python
{
'id': id of way,
'tag': {} tags of this way,
'nd': [] list of nodes belonging to this way
'changeset': id of changeset of last change,
'version': version number of way,
'user': username of user that made the last change,
'uid': id of user that made the last change,
'timestamp': timestamp of last change,
'visible': True|False
}
If `way_version` is supplied, this specific version is returned,
otherwise the latest version is returned.
If the requested element has been deleted,
`OsmApi.ElementDeletedApiError` is raised.
If the requested element can not be found,
`OsmApi.ElementNotFoundApiError` is raised.
"""
uri = f"/api/0.6/way/{way_id}"
if way_version != -1:
uri += f"/{way_version}"
data = self._session._get(uri)
way = cast(Element, dom.OsmResponseToDom(data, tag="way", single=True))
return dom.dom_parse_way(way)
def way_create(
self: "OsmApi", way_data: dict[str, Any]
) -> Optional[dict[str, Any]]:
"""
Creates a way based on the supplied `way_data` dict:
#!python
{
'nd': [] list of nodes,
'tag': {} dict of tags,
}
Returns updated `way_data` (without timestamp):
#!python
{
'id': id of node,
'nd': [] list of nodes,
'tag': {} dict of tags,
'changeset': id of changeset of last change,
'version': version number of way,
'user': username of last change,
'uid': id of user of last change,
'visible': True|False
}
If no authentication information are provided,
`OsmApi.UsernamePasswordMissingError` is raised.
If the supplied information contain an existing node,
`OsmApi.OsmTypeAlreadyExistsError` is raised.
If there is no open changeset,
`OsmApi.NoChangesetOpenError` is raised.
If there is already an open changeset,
`OsmApi.ChangesetAlreadyOpenError` is raised.
If the changeset is already closed,
`OsmApi.ChangesetClosedApiError` is raised.
"""
return self._do("create", "way", way_data)
def way_update(
self: "OsmApi", way_data: dict[str, Any]
) -> Optional[dict[str, Any]]:
"""
Updates way with the supplied `way_data` dict:
#!python
{
'id': id of way,
'nd': [] list of nodes,
'tag': {},
'version': version number of way,
}
Returns updated `way_data` (without timestamp):
#!python
{
'id': id of node,
'nd': [] list of nodes,
'tag': {} dict of tags,
'changeset': id of changeset of last change,
'version': version number of way,
'user': username of last change,
'uid': id of user of last change,
'visible': True|False
}
If no authentication information are provided,
`OsmApi.UsernamePasswordMissingError` is raised.
If there is no open changeset,
`OsmApi.NoChangesetOpenError` is raised.
If there is already an open changeset,
`OsmApi.ChangesetAlreadyOpenError` is raised.
If the changeset is already closed,
`OsmApi.ChangesetClosedApiError` is raised.
"""
return self._do("modify", "way", way_data)
def way_delete(
self: "OsmApi", way_data: dict[str, Any]
) -> Optional[dict[str, Any]]:
"""
Delete way with `way_data`:
#!python
{
'id': id of way,
'nd': [] list of nodes,
'tag': dict of tags,
'version': version number of way,
}
Returns updated `way_data` (without timestamp):
#!python
{
'id': id of way,
'nd': [] list of nodes,
'tag': dict of tags,
'changeset': id of changeset of last change,
'version': version number of way,
'user': username of last change,
'uid': id of user of last change,
'visible': True|False
}
If no authentication information are provided,
`OsmApi.UsernamePasswordMissingError` is raised.
If there is no open changeset,
`OsmApi.NoChangesetOpenError` is raised.
If the changeset is already closed,
`OsmApi.ChangesetClosedApiError` is raised.
"""
return self._do("delete", "way", way_data)
def way_history(self: "OsmApi", way_id: int) -> dict[int, dict[str, Any]]:
"""
Returns dict with version as key:
#!python
{
1: dict of way version 1,
2: dict of way version 2,
...
}
If the requested element can not be found,
`OsmApi.ElementNotFoundApiError` is raised.
"""
uri = f"/api/0.6/way/{way_id}/history"
data = self._session._get(uri)
ways = cast(list[Element], dom.OsmResponseToDom(data, tag="way"))
result: dict[int, dict[str, Any]] = {}
for way in ways:
way_data = dom.dom_parse_way(way)
result[way_data["version"]] = way_data
return result
def way_relations(self: "OsmApi", way_id: int) -> list[dict[str, Any]]:
"""
Returns a list of dicts of relation data containing way `way_id`:
#!python
[
{
'id': id of Relation,
'member': [
{
'ref': ID of referenced element,
'role': optional description of role in relation
'type': node|way|relation
},
{
...
}
]
'tag': {} dict of tags,
'changeset': id of changeset of last change,
'version': version number of Way,
'user': username of user that made the last change,
'uid': id of user that made the last change,
'visible': True|False
},
{
...
},
]
The `way_id` is a unique identifier for a way.
"""
uri = f"/api/0.6/way/{way_id}/relations"
data = self._session._get(uri)
relations = cast(
list[Element], dom.OsmResponseToDom(data, tag="relation", allow_empty=True)
)
result: list[dict[str, Any]] = []
for relation in relations:
relation_data = dom.dom_parse_relation(relation)
result.append(relation_data)
return result
def way_full(self: "OsmApi", way_id: int) -> list[dict[str, Any]]:
"""
Returns the full data for way `way_id` as list of dicts:
#!python
[
{
'type': node|way|relation,
'data': {} data dict for node|way|relation
},
{ ... }
]
The `way_id` is a unique identifier for a way.
If the requested element has been deleted,
`OsmApi.ElementDeletedApiError` is raised.
If the requested element can not be found,
`OsmApi.ElementNotFoundApiError` is raised.
"""
uri = f"/api/0.6/way/{way_id}/full"
data = self._session._get(uri)
return parser.parse_osm(data)
def ways_get(self: "OsmApi", way_id_list: list[int]) -> dict[int, dict[str, Any]]:
"""
Returns dict with the id of the way as a key for
each way in `way_id_list`:
#!python
{
'1234': dict of way data,
'5678': dict of way data,
...
}
`way_id_list` is a list containing unique identifiers for multiple ways.
"""
way_list = ",".join([str(x) for x in way_id_list])
uri = f"/api/0.6/ways?ways={way_list}"
data = self._session._get(uri)
ways = cast(list[Element], dom.OsmResponseToDom(data, tag="way"))
result: dict[int, dict[str, Any]] = {}
for way in ways:
way_data = dom.dom_parse_way(way)
result[way_data["id"]] = way_data
return result
|
