-#!/usr/bin/python3.4
-# $Id$
-# $HeadURL$
"""This module contains winterrodeln specific functions that are processing the MediaWiki markup.
"""
import re
import xml.etree.ElementTree
import collections
-import mwparserfromhell
+from typing import Tuple, Optional, List, OrderedDict, Union, Dict, Any
+
+import jinja2
+from mwparserfromhell.nodes import Template, Wikilink
+
import wrpylib.wrvalidators
import wrpylib.mwmarkup
import wrpylib.wrmwdb
+from wrpylib.lib_sledrun_wikitext_from_json import strip_eol
from wrpylib.wrvalidators import LonLat, opt_lonlat_from_str, opt_lonlat_to_str, opt_uint_from_str, opt_uint_to_str, \
opt_str_opt_comment_enum_to_str, lift_german_to_str, webauskunft_to_str, cachet_german_to_str, \
- opt_phone_comment_enum_to_str, lift_german_from_str, GASTHAUSBOX_DICT
+ opt_phone_comment_enum_to_str, lift_german_from_str, GASTHAUSBOX_DICT, opt_difficulty_german_from_str, \
+ opt_avalanches_german_from_str, opt_public_transport_german_from_str, \
+ opt_tristate_german_comment_from_str, rodelbahnbox_to_str, lonlat_to_str, opt_no_or_str_to_str, \
+ opt_no_or_str_from_str, opt_tristate_german_from_str
+
+
+def split_lon_lat(value: Optional[LonLat]) -> Union[LonLat, Tuple[None, None]]:
+ if value is None:
+ return None, None
+ return value
-def sledrun_from_rodelbahnbox(value, sledrun):
+def join_lon_lat(lon: Optional[float], lat: Optional[float]) -> Optional[LonLat]:
+ if lon is None or lat is None:
+ return None
+ return LonLat(lon, lat)
+
+
+def sledrun_from_rodelbahnbox(value: OrderedDict, sledrun: object):
"""Takes a Rodelbahnbox as returned by rodelbahnbox_from_str (that is, an OrderedDict) and
updates the sledrun instance with all values present in the Rodelbahnbox. Other values are not
updated. Does not validate the arguments."""
# sledrun.page_id = None # this field is not updated because it is not present in the RodelbahnBox
# sledrun.page_title = None # this field is not updated because it is not present in the RodelbahnBox
# sledrun.name_url = None # this field is not updated because it is not present in the RodelbahnBox
- sledrun.position_longitude, sledrun.position_latitude = value['Position']
- sledrun.top_longitude, sledrun.top_latitude = value['Position oben']
+ sledrun.position_longitude, sledrun.position_latitude = split_lon_lat(value['Position'])
+ sledrun.top_longitude, sledrun.top_latitude = split_lon_lat(value['Position oben'])
sledrun.top_elevation = value['Höhe oben']
- sledrun.bottom_longitude, sledrun.bottom_latitude = value['Position unten']
+ sledrun.bottom_longitude, sledrun.bottom_latitude = split_lon_lat(value['Position unten'])
sledrun.bottom_elevation = value['Höhe unten']
sledrun.length = value['Länge']
sledrun.difficulty = value['Schwierigkeit']
sledrun.avalanches = value['Lawinen']
- sledrun.operator = value['Betreiber']
+ sledrun.operator = opt_no_or_str_to_str(value['Betreiber'])
sledrun.public_transport = value['Öffentliche Anreise']
sledrun.walkup_possible = value['Aufstieg möglich']
sledrun.walkup_time = value['Gehzeit']
return sledrun
-def sledrun_to_rodelbahnbox(sledrun):
+def sledrun_to_rodelbahnbox(sledrun) -> collections.OrderedDict:
"""Takes a sledrun instance that might come from the database and converts it to a OrderedDict ready
to be formatted as RodelbahnBox."""
value = collections.OrderedDict()
- value['Position'] = LonLat(sledrun.position_longitude, sledrun.position_latitude)
- value['Position oben'] = LonLat(sledrun.top_longitude, sledrun.top_latitude)
+ value['Position'] = join_lon_lat(sledrun.position_longitude, sledrun.position_latitude)
+ value['Position oben'] = join_lon_lat(sledrun.top_longitude, sledrun.top_latitude)
value['Höhe oben'] = sledrun.top_elevation
- value['Position unten'] = LonLat(sledrun.bottom_longitude, sledrun.bottom_latitude)
+ value['Position unten'] = join_lon_lat(sledrun.bottom_longitude, sledrun.bottom_latitude)
value['Höhe unten'] = sledrun.bottom_elevation
value['Länge'] = sledrun.length
value['Schwierigkeit'] = sledrun.difficulty
value['Lawinen'] = sledrun.avalanches
- value['Betreiber'] = sledrun.operator
+ value['Betreiber'] = opt_no_or_str_from_str(sledrun.operator)
value['Öffentliche Anreise'] = sledrun.public_transport
value['Aufstieg möglich'] = sledrun.walkup_possible
value['Gehzeit'] = sledrun.walkup_time
value is a dict of properties as returned by gasthausbox_from_str."""
# page_id = None # this field is not updated because it is not present in the Gasthausbox
# page_title = None # this field is not updated because it is not present in the Gasthausbox
- def convtodb(value, key):
- v = GASTHAUSBOX_DICT[key].to_str(value[key])
+ def convtodb(val, key):
+ v = GASTHAUSBOX_DICT[key].to_str(val[key])
if v == '':
return None
return v
- inn.position_longitude, inn.position_latitude = value['Position']
+ inn.position_longitude, inn.position_latitude = split_lon_lat(value['Position'])
inn.position_elevation = value['Höhe']
inn.operator = value['Betreiber']
inn.seats = value['Sitzplätze']
return inn
-def inn_to_gasthausbox(inn):
- """Converts an inn class to a dict of Gasthausbox properties. value is an Inn instance."""
- def convfromdb(value, key):
- v = '' if value is None else value
+def inn_to_gasthausbox(inn) -> collections.OrderedDict:
+ """Converts an inn class to a dict of Gasthausbox properties. inn is an Inn instance."""
+ def convfromdb(val, key):
+ v = '' if val is None else val
return GASTHAUSBOX_DICT[key].from_str(v)
value = collections.OrderedDict()
- value['Position'] = LonLat(inn.position_longitude, inn.position_latitude)
+ value['Position'] = join_lon_lat(inn.position_longitude, inn.position_latitude)
value['Höhe'] = inn.position_elevation
value['Betreiber'] = inn.operator
value['Sitzplätze'] = inn.seats
value['Übernachtung'] = (inn.overnight, inn.overnight_comment)
- value['Rauchfrei'] = {(False, True): 0.0, (True, True): 0.5, (True, False): 1.0}.get((inn.nonsmoker_area, inn.smoker_area), None)
+ value['Rauchfrei'] = {(False, True): 0.0, (True, True): 0.5, (True, False): 1.0} \
+ .get((inn.nonsmoker_area, inn.smoker_area), None)
value['Rodelverleih'] = (inn.sled_rental, inn.sled_rental_comment)
value['Handyempfang'] = convfromdb(inn.mobile_provider, 'Handyempfang')
value['Homepage'] = convfromdb(inn.homepage, 'Homepage')
return value
-def lonlat_ele_from_template(template):
- """Template is a mwparserfromhell.nodes.template.Template instance. Returns (lonlat, ele)."""
+def lonlat_ele_from_template(template) -> Tuple[Optional[LonLat], Optional[int]]:
+ """Template is a `mwparserfromhell.nodes.template.Template` instance. Returns (lonlat, ele)."""
lonlat = opt_lonlat_from_str(template.params[0].strip())
ele = opt_uint_from_str(template.params[1].strip())
return lonlat, ele
-def latlon_ele_to_template(lonlat_ele, name):
+def latlon_ele_to_template(lonlat_ele: Tuple[Optional[LonLat], Optional[int]], name: str) -> Template:
lonlat, ele = lonlat_ele
- template = mwparserfromhell.nodes.template.Template(name)
+ template = Template(name)
template.add(1, opt_lonlat_to_str(lonlat))
template.add(2, opt_uint_to_str(ele))
wrpylib.mwmarkup.format_template_oneline(template)
return template
+def lonlat_to_json(lonlat: LonLat) -> dict:
+ return {'longitude': lonlat.lon, 'latitude': lonlat.lat}
+
+
+def lonlat_ele_to_json(lonlat: Optional[LonLat], ele: Optional[int]) -> dict:
+ result = {}
+ if lonlat is not None:
+ result['position'] = lonlat_to_json(lonlat)
+ if ele is not None:
+ result['elevation'] = ele
+ return result
+
+
class ParseError(RuntimeError):
"""Exception used by some of the functions"""
pass
-def parse_wrmap_coordinates(coords):
+def parse_wrmap_coordinates(coords: str) -> List[List[float]]:
"""gets a string coordinates and returns an array of lon/lat coordinate pairs, e.g.
47.12 N 11.87 E
47.13 N 11.70 E
else:
if pos == len(coords):
return result
- raise RuntimeError('Wrong coordinate format: {}'.format(coords))
+ raise RuntimeError(f'Wrong coordinate format: {coords}')
WRMAP_POINT_TYPES = ['gasthaus', 'haltestelle', 'parkplatz', 'achtung', 'foto', 'verleih', 'punkt']
WRMAP_LINE_TYPES = ['rodelbahn', 'gehweg', 'alternative', 'lift', 'anfahrt', 'linie']
-def parse_wrmap(wikitext):
- """Parses the (unicode) u'<wrmap ...>content</wrmap>' of the Winterrodeln wrmap extension.
+def parse_wrmap(wikitext: str) -> dict:
+ """Parses the '<wrmap ...>content</wrmap>' of the Winterrodeln wrmap extension.
If wikitext does not contain the <wrmap> tag or if the <wrmap> tag contains
invalid formatted lines, a ParseError is raised.
Use wrpylib.mwmarkup.find_tag(wikitext, 'wrmap') to find the wrmap tag within an arbitrary
:param wikitext: wikitext containing only the template. Example:
- wikitext = u'''
+ wikitext = '''
<wrmap lat="47.2417134" lon="11.21408895" zoom="14" width="700" height="400">
<gasthaus name="Rosskogelhütte" wiki="Rosskogelhütte">47.240689 11.190454</gasthaus>
<parkplatz>47.245789 11.238971</parkplatz>
"""
# parse XML
try:
- wrmap_xml = xml.etree.ElementTree.fromstring(wikitext.encode('utf-8'))
+ wrmap_xml = xml.etree.ElementTree.fromstring(wikitext)
except xml.etree.ElementTree.ParseError as e:
row, column = e.position
- raise ParseError("XML parse error on row {}, column {}: {}".format(row, column, e))
+ raise ParseError(f"XML parse error on row {row}, column {column}: {e}")
if wrmap_xml.tag not in ['wrmap', 'wrgmap']:
raise ParseError('No valid tag name')
# determine feature type
is_point = feature.tag in WRMAP_POINT_TYPES
is_line = feature.tag in WRMAP_LINE_TYPES
- if (not is_point and not is_line):
- raise ParseError('Unknown element <{}>.'.format(feature.tag))
+ if not is_point and not is_line:
+ raise ParseError(f'Unknown element <{feature.tag}>.')
# point
if is_point:
allowed_properties = {'name', 'wiki'}
wrong_properties = set(feature.attrib.keys()) - allowed_properties
if len(wrong_properties) > 0:
- raise ParseError("The attribute '{}' is not allowed at <{}>.".format(list(wrong_properties)[0], feature.tag))
+ raise ParseError(f"The attribute '{list(wrong_properties)[0]}' is not allowed at <{feature.tag}>.")
properties.update(feature.attrib)
coordinates = parse_wrmap_coordinates(feature.text)
if len(coordinates) != 1:
- raise ParseError('The element <{}> has to have exactly one coordinate pair.'.format(feature.tag))
+ raise ParseError(f'The element <{feature.tag}> has to have exactly one coordinate pair.')
json_features.append({
'type': 'Feature',
'geometry': {'type': 'Point', 'coordinates': coordinates[0]},
allowed_properties = {'farbe', 'dicke'}
wrong_properties = set(feature.attrib.keys()) - allowed_properties
if len(wrong_properties) > 0:
- raise ParseError("The attribute '{}' is not allowed at <{}>.".format(list(wrong_properties)[0], feature.tag))
+ raise ParseError(f"The attribute '{list(wrong_properties)[0]}' is not allowed at <{feature.tag}>.")
if 'farbe' in feature.attrib:
if not re.match('#[0-9a-fA-F]{6}$', feature.attrib['farbe']):
raise ParseError('The attribute "farbe" has to have a format like "#a0bb43".')
- properties['strokeColor'] = feature.attrib['farbe'] # e.g. #a200b7
+ properties['strokeColor'] = feature.attrib['farbe'] # e.g. #a200b7
if 'dicke' in feature.attrib:
try:
- properties['strokeWidth'] = int(feature.attrib['dicke']) # e.g. 6
+ properties['strokeWidth'] = int(feature.attrib['dicke']) # e.g. 6
except ValueError:
raise ParseError('The attribute "dicke" has to be an integer.')
json_features.append({
try:
properties[k] = float(v)
except ValueError:
- raise ParseError('Attribute "{}" has to be a float value.'.format(k))
+ raise ParseError(f'Attribute "{k}" has to be a float value.')
elif k in ['zoom', 'width', 'height']:
try:
properties[k] = int(v)
except ValueError:
- raise ParseError('Attribute "{}" has to be an integer value.'.format(k))
+ raise ParseError(f'Attribute "{k}" has to be an integer value.')
else:
- raise ParseError('Unknown attribute "{}".'.format(k))
+ raise ParseError(f'Unknown attribute "{k}".')
geojson = {
'type': 'FeatureCollection',
def create_wrmap_coordinates(coords):
result = []
for coord in coords:
- result.append('{:.6f} N {:.6f} E'.format(coord[1], coord[0]))
+ result.append(f'{coord[1]:.6f} N {coord[0]:.6f} E')
return '\n'.join(result)
-def create_wrmap(geojson):
+def create_wrmap(geojson: Dict) -> str:
"""Creates a <wrmap> wikitext from geojson (as python types)."""
wrmap_xml = xml.etree.ElementTree.Element('wrmap')
wrmap_xml.text = '\n\n'
for k, v in geojson['properties'].items():
if k in ['lon', 'lat']:
- wrmap_xml.attrib[k] = '{:.6f}'.format(v)
+ wrmap_xml.attrib[k] = f'{v:.6f}'
else:
wrmap_xml.attrib[k] = str(v)
last_json_feature.tail = '\n\n'
feature_xml.text = '\n' + create_wrmap_coordinates(geo['coordinates']) + '\n'
last_json_feature = feature_xml
- feature_xml.attrib = json_feature['properties']
+ feature_xml.attrib = json_feature['properties'].copy()
del feature_xml.attrib['type']
if last_json_feature is not None:
last_json_feature.tail = '\n\n'
return xml.etree.ElementTree.tostring(wrmap_xml, encoding='utf-8').decode('utf-8')
+
+
+def german_bool(value: Union[bool, jinja2.Undefined]) -> Union[str, jinja2.Undefined]:
+ if jinja2.is_undefined(value):
+ return value
+ return wrpylib.wrvalidators.bool_german_to_str(value)
+
+
+class Jinja2Tools:
+ def create_wrmap(self, geojson: Dict) -> str:
+ return create_wrmap(geojson)
+
+ def json_position(self, value: dict) -> str:
+ lon_lat = LonLat(value['longitude'], value['latitude'])
+ return lonlat_to_str(lon_lat)
+
+ def json_pos_ele_position(self, value: dict) -> str:
+ pos = value.get('position')
+ if pos is None:
+ return ''
+ return self.json_position(pos)
+
+ def json_pos_ele_elevation(self, value: dict) -> str:
+ return value.get('elevation', '')
+
+ def json_wr_page(self, value: dict) -> str:
+ return str(Wikilink(value['title'], value.get('text')))
+
+ def list_template(self, name: str, value: List[str]) -> str:
+ return str(wrpylib.mwmarkup.create_template(name, value))
+
+ def key_value_template(self, name: str, value: Dict[str, Any], keep_empty: bool = False) -> str:
+ value = {k: str(v) for k, v in value.items()
+ if keep_empty or (v is not None and not isinstance(v, jinja2.Undefined) and str(v).strip() != '')}
+ return str(wrpylib.mwmarkup.create_template(name, [], value))
+
+ def json_template(self, value) -> str:
+ args = []
+ kwargs = {}
+ for p in value.get('parameter', []):
+ v = p.get('value', '')
+ if 'key' in p:
+ kwargs[p['key']] = v
+ else:
+ args.append(v)
+ return str(wrpylib.mwmarkup.create_template(value['name'], args, kwargs))
+
+
+def create_sledrun_wiki(sledrun_json: Dict, map_json: Optional[Dict], impressions_title: Optional[str] = None) -> str:
+ env = jinja2.Environment(
+ loader=jinja2.PackageLoader("wrpylib"),
+ autoescape=jinja2.select_autoescape(),
+ )
+ env.filters["german_bool"] = german_bool
+ template = env.get_template("sledrun_wikitext.txt")
+
+ def position_to_lon_lat(value: Optional[dict]) -> Optional[LonLat]:
+ if value is not None:
+ lon = value.get('longitude')
+ lat = value.get('latitude')
+ if lon is not None and lat is not None:
+ return LonLat(lon, lat)
+ return None
+
+ def position_ele_to_lon_lat(value: Optional[dict]) -> Optional[LonLat]:
+ if value is not None:
+ return position_to_lon_lat(value.get("position"))
+ return None
+
+ def position_ele_to_ele(value: Optional[dict]) -> Optional[int]:
+ if value is not None:
+ ele = value.get('elevation')
+ if ele is not None:
+ return int(ele)
+ return None
+
+ def aufstiegshilfe() -> Optional[List[Tuple[str, Optional[str]]]]:
+ ws = sledrun_json.get('walkup_supports')
+ if ws is None:
+ return None
+ return [(w['type'], w.get('note')) for w in ws]
+
+ def rodelverleih() -> Optional[List[Tuple[str, Optional[str]]]]:
+ v = sledrun_json.get('sled_rental')
+ if v is None:
+ return None
+ w = []
+ for x in v:
+ n = x.get('name')
+ c = x.get('note')
+ p = x.get('wr_page')
+ if p is not None:
+ n = Jinja2Tools().json_wr_page(p)
+ w.append((n, c))
+ return w
+
+ def cachet() -> Optional[List]:
+ v = sledrun_json.get('cachet')
+ if v is not None:
+ if not v:
+ return []
+ return None
+
+ def webauskunft() -> Tuple[Optional[bool], Optional[str]]:
+ info_web = sledrun_json.get('info_web')
+ if info_web is None:
+ return None, None
+ if len(info_web) == 0:
+ return False, None
+ return True, info_web[0]['url']
+
+ def telefonauskunft() -> Optional[List[Tuple[str, str]]]:
+ info_phone = sledrun_json.get('info_phone')
+ if info_phone is None:
+ return None
+ return [(pc['phone'], pc['name']) for pc in info_phone]
+
+ def betreiber() -> str:
+ has_operator = sledrun_json.get('has_operator')
+ if has_operator is None:
+ return sledrun_json.get('operator')
+ if has_operator:
+ return sledrun_json.get('operator')
+ return 'Nein'
+
+ sledrun_rbb_json = collections.OrderedDict([
+ ('Position', position_to_lon_lat(sledrun_json.get('position'))),
+ ('Position oben', position_ele_to_lon_lat(sledrun_json.get('top'))),
+ ('Höhe oben', position_ele_to_ele(sledrun_json.get('top'))),
+ ('Position unten', position_ele_to_lon_lat(sledrun_json.get('bottom'))),
+ ('Höhe unten', position_ele_to_ele(sledrun_json.get('bottom'))),
+ ('Länge', sledrun_json.get('length')),
+ ('Schwierigkeit', opt_difficulty_german_from_str(sledrun_json.get('difficulty', ''))),
+ ('Lawinen', opt_avalanches_german_from_str(sledrun_json.get('avalanches', ''))),
+ ('Betreiber', (sledrun_json.get('has_operator'), sledrun_json.get('operator'))),
+ ('Öffentliche Anreise', opt_public_transport_german_from_str(sledrun_json.get('public_transport', ''))),
+ ('Aufstieg möglich', sledrun_json.get('walkup_possible')),
+ ('Aufstieg getrennt', opt_tristate_german_comment_from_str(sledrun_json.get('walkup_separate', ''))),
+ ('Gehzeit', sledrun_json.get('walkup_time')),
+ ('Aufstiegshilfe', aufstiegshilfe()),
+ ('Beleuchtungsanlage', (opt_tristate_german_from_str(sledrun_json.get('nightlight_possible', '')),
+ sledrun_json.get('nightlight_possible_note'))),
+ ('Beleuchtungstage', (sledrun_json.get('nightlight_weekdays_count'),
+ sledrun_json.get('nightlight_weekdays_note'))),
+ ('Rodelverleih', rodelverleih()),
+ ('Gütesiegel', cachet()),
+ ('Webauskunft', webauskunft()),
+ ('Telefonauskunft', telefonauskunft()),
+ ('Bild', sledrun_json.get('image')),
+ ('In Übersichtskarte', sledrun_json.get('show_in_overview')),
+ ('Forumid', sledrun_json.get('forum_id'))
+ ])
+
+ rodelbahnbox = rodelbahnbox_to_str(sledrun_rbb_json)
+
+ text = template.render(sledrun_json=sledrun_json,
+ rodelbahnbox=rodelbahnbox,
+ map_json=map_json, impressions_title=impressions_title,
+ h=Jinja2Tools(), **sledrun_json)
+ return strip_eol(text)
ToastFreeware / philipp / winterrodeln / wrpylib.git / blobdiff